Loading...
1/******************************************************************************
2 *
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#ifndef _ACUTILS_H
45#define _ACUTILS_H
46
47extern const u8 acpi_gbl_resource_aml_sizes[];
48
49/* Strings used by the disassembler and debugger resource dump routines */
50
51#if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
52
53extern const char *acpi_gbl_bm_decode[];
54extern const char *acpi_gbl_config_decode[];
55extern const char *acpi_gbl_consume_decode[];
56extern const char *acpi_gbl_dec_decode[];
57extern const char *acpi_gbl_he_decode[];
58extern const char *acpi_gbl_io_decode[];
59extern const char *acpi_gbl_ll_decode[];
60extern const char *acpi_gbl_max_decode[];
61extern const char *acpi_gbl_mem_decode[];
62extern const char *acpi_gbl_min_decode[];
63extern const char *acpi_gbl_mtp_decode[];
64extern const char *acpi_gbl_rng_decode[];
65extern const char *acpi_gbl_rw_decode[];
66extern const char *acpi_gbl_shr_decode[];
67extern const char *acpi_gbl_siz_decode[];
68extern const char *acpi_gbl_trs_decode[];
69extern const char *acpi_gbl_ttp_decode[];
70extern const char *acpi_gbl_typ_decode[];
71#endif
72
73/* Types for Resource descriptor entries */
74
75#define ACPI_INVALID_RESOURCE 0
76#define ACPI_FIXED_LENGTH 1
77#define ACPI_VARIABLE_LENGTH 2
78#define ACPI_SMALL_VARIABLE_LENGTH 3
79
80typedef
81acpi_status(*acpi_walk_aml_callback) (u8 * aml,
82 u32 length,
83 u32 offset,
84 u8 resource_index, void **context);
85
86typedef
87acpi_status(*acpi_pkg_callback) (u8 object_type,
88 union acpi_operand_object * source_object,
89 union acpi_generic_state * state,
90 void *context);
91
92struct acpi_pkg_info {
93 u8 *free_space;
94 acpi_size length;
95 u32 object_space;
96 u32 num_packages;
97};
98
99#define REF_INCREMENT (u16) 0
100#define REF_DECREMENT (u16) 1
101#define REF_FORCE_DELETE (u16) 2
102
103/* acpi_ut_dump_buffer */
104
105#define DB_BYTE_DISPLAY 1
106#define DB_WORD_DISPLAY 2
107#define DB_DWORD_DISPLAY 4
108#define DB_QWORD_DISPLAY 8
109
110/*
111 * utglobal - Global data structures and procedures
112 */
113acpi_status acpi_ut_init_globals(void);
114
115#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
116
117char *acpi_ut_get_mutex_name(u32 mutex_id);
118
119const char *acpi_ut_get_notify_name(u32 notify_value);
120
121#endif
122
123char *acpi_ut_get_type_name(acpi_object_type type);
124
125char *acpi_ut_get_node_name(void *object);
126
127char *acpi_ut_get_descriptor_name(void *object);
128
129const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
130
131char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
132
133char *acpi_ut_get_region_name(u8 space_id);
134
135char *acpi_ut_get_event_name(u32 event_id);
136
137char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
138
139u8 acpi_ut_valid_object_type(acpi_object_type type);
140
141/*
142 * utinit - miscellaneous initialization and shutdown
143 */
144acpi_status acpi_ut_hardware_initialize(void);
145
146void acpi_ut_subsystem_shutdown(void);
147
148/*
149 * utclib - Local implementations of C library functions
150 */
151#ifndef ACPI_USE_SYSTEM_CLIBRARY
152
153acpi_size acpi_ut_strlen(const char *string);
154
155char *acpi_ut_strcpy(char *dst_string, const char *src_string);
156
157char *acpi_ut_strncpy(char *dst_string,
158 const char *src_string, acpi_size count);
159
160int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
161
162int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
163
164int acpi_ut_strcmp(const char *string1, const char *string2);
165
166char *acpi_ut_strcat(char *dst_string, const char *src_string);
167
168char *acpi_ut_strncat(char *dst_string,
169 const char *src_string, acpi_size count);
170
171u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
172
173char *acpi_ut_strstr(char *string1, char *string2);
174
175void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
176
177void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
178
179int acpi_ut_to_upper(int c);
180
181int acpi_ut_to_lower(int c);
182
183extern const u8 _acpi_ctype[];
184
185#define _ACPI_XA 0x00 /* extra alphabetic - not supported */
186#define _ACPI_XS 0x40 /* extra space */
187#define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
188#define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
189#define _ACPI_DI 0x04 /* '0'-'9' */
190#define _ACPI_LO 0x02 /* 'a'-'z' */
191#define _ACPI_PU 0x10 /* punctuation */
192#define _ACPI_SP 0x08 /* space */
193#define _ACPI_UP 0x01 /* 'A'-'Z' */
194#define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
195
196#define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
197#define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
198#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
199#define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
200#define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
201#define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
202#define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
203
204#endif /* ACPI_USE_SYSTEM_CLIBRARY */
205
206/*
207 * utcopy - Object construction and conversion interfaces
208 */
209acpi_status
210acpi_ut_build_simple_object(union acpi_operand_object *obj,
211 union acpi_object *user_obj,
212 u8 * data_space, u32 * buffer_space_used);
213
214acpi_status
215acpi_ut_build_package_object(union acpi_operand_object *obj,
216 u8 * buffer, u32 * space_used);
217
218acpi_status
219acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
220 struct acpi_buffer *ret_buffer);
221
222acpi_status
223acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
224 union acpi_operand_object **internal_obj);
225
226acpi_status
227acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
228 union acpi_operand_object *dest_obj);
229
230acpi_status
231acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
232 union acpi_operand_object **dest_desc,
233 struct acpi_walk_state *walk_state);
234
235/*
236 * utcreate - Object creation
237 */
238acpi_status
239acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
240
241/*
242 * utdebug - Debug interfaces
243 */
244void acpi_ut_init_stack_ptr_trace(void);
245
246void acpi_ut_track_stack_ptr(void);
247
248void
249acpi_ut_trace(u32 line_number,
250 const char *function_name,
251 const char *module_name, u32 component_id);
252
253void
254acpi_ut_trace_ptr(u32 line_number,
255 const char *function_name,
256 const char *module_name, u32 component_id, void *pointer);
257
258void
259acpi_ut_trace_u32(u32 line_number,
260 const char *function_name,
261 const char *module_name, u32 component_id, u32 integer);
262
263void
264acpi_ut_trace_str(u32 line_number,
265 const char *function_name,
266 const char *module_name, u32 component_id, char *string);
267
268void
269acpi_ut_exit(u32 line_number,
270 const char *function_name,
271 const char *module_name, u32 component_id);
272
273void
274acpi_ut_status_exit(u32 line_number,
275 const char *function_name,
276 const char *module_name,
277 u32 component_id, acpi_status status);
278
279void
280acpi_ut_value_exit(u32 line_number,
281 const char *function_name,
282 const char *module_name, u32 component_id, u64 value);
283
284void
285acpi_ut_ptr_exit(u32 line_number,
286 const char *function_name,
287 const char *module_name, u32 component_id, u8 *ptr);
288
289void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
290
291void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display);
292
293void acpi_ut_report_error(char *module_name, u32 line_number);
294
295void acpi_ut_report_info(char *module_name, u32 line_number);
296
297void acpi_ut_report_warning(char *module_name, u32 line_number);
298
299/*
300 * utdelete - Object deletion and reference counts
301 */
302void acpi_ut_add_reference(union acpi_operand_object *object);
303
304void acpi_ut_remove_reference(union acpi_operand_object *object);
305
306void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
307
308void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
309
310void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
311
312/*
313 * uteval - object evaluation
314 */
315acpi_status
316acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
317 char *path,
318 u32 expected_return_btypes,
319 union acpi_operand_object **return_desc);
320
321acpi_status
322acpi_ut_evaluate_numeric_object(char *object_name,
323 struct acpi_namespace_node *device_node,
324 u64 *value);
325
326acpi_status
327acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
328
329acpi_status
330acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
331 const char **method_names,
332 u8 method_count, u8 *out_values);
333
334/*
335 * utids - device ID support
336 */
337acpi_status
338acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
339 struct acpica_device_id **return_id);
340
341acpi_status
342acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
343 struct acpica_device_id **return_id);
344
345acpi_status
346acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
347 struct acpica_device_id_list **return_cid_list);
348
349/*
350 * utlock - reader/writer locks
351 */
352acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
353
354void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
355
356acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
357
358acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
359
360acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
361
362void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
363
364/*
365 * utobject - internal object create/delete/cache routines
366 */
367union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
368 *module_name,
369 u32 line_number,
370 u32 component_id,
371 acpi_object_type
372 type);
373
374void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
375 u32 line_number, u32 component_id);
376
377#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
378#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
379
380void acpi_ut_delete_object_desc(union acpi_operand_object *object);
381
382u8 acpi_ut_valid_internal_object(void *object);
383
384union acpi_operand_object *acpi_ut_create_package_object(u32 count);
385
386union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
387
388union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
389
390union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
391
392acpi_status
393acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
394
395/*
396 * utosi - Support for the _OSI predefined control method
397 */
398acpi_status acpi_ut_initialize_interfaces(void);
399
400void acpi_ut_interface_terminate(void);
401
402acpi_status acpi_ut_install_interface(acpi_string interface_name);
403
404acpi_status acpi_ut_remove_interface(acpi_string interface_name);
405
406struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
407
408acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
409
410/*
411 * utstate - Generic state creation/cache routines
412 */
413void
414acpi_ut_push_generic_state(union acpi_generic_state **list_head,
415 union acpi_generic_state *state);
416
417union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
418 **list_head);
419
420union acpi_generic_state *acpi_ut_create_generic_state(void);
421
422struct acpi_thread_state *acpi_ut_create_thread_state(void);
423
424union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
425 *object, u16 action);
426
427union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
428 void *external_object,
429 u16 index);
430
431acpi_status
432acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
433 u16 action,
434 union acpi_generic_state **state_list);
435
436#ifdef ACPI_FUTURE_USAGE
437acpi_status
438acpi_ut_create_pkg_state_and_push(void *internal_object,
439 void *external_object,
440 u16 index,
441 union acpi_generic_state **state_list);
442#endif /* ACPI_FUTURE_USAGE */
443
444union acpi_generic_state *acpi_ut_create_control_state(void);
445
446void acpi_ut_delete_generic_state(union acpi_generic_state *state);
447
448/*
449 * utmath
450 */
451acpi_status
452acpi_ut_divide(u64 in_dividend,
453 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
454
455acpi_status
456acpi_ut_short_divide(u64 in_dividend,
457 u32 divisor, u64 *out_quotient, u32 *out_remainder);
458
459/*
460 * utmisc
461 */
462const char *acpi_ut_validate_exception(acpi_status status);
463
464u8 acpi_ut_is_pci_root_bridge(char *id);
465
466u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
467
468acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
469
470void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
471
472acpi_status
473acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
474 void *target_object,
475 acpi_pkg_callback walk_callback, void *context);
476
477void acpi_ut_strupr(char *src_string);
478
479void acpi_ut_print_string(char *string, u8 max_length);
480
481u8 acpi_ut_valid_acpi_name(u32 name);
482
483acpi_name acpi_ut_repair_name(char *name);
484
485u8 acpi_ut_valid_acpi_char(char character, u32 position);
486
487acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 * ret_integer);
488
489/* Values for Base above (16=Hex, 10=Decimal) */
490
491#define ACPI_ANY_BASE 0
492
493u32 acpi_ut_dword_byte_swap(u32 value);
494
495void acpi_ut_set_integer_width(u8 revision);
496
497#ifdef ACPI_DEBUG_OUTPUT
498void
499acpi_ut_display_init_pathname(u8 type,
500 struct acpi_namespace_node *obj_handle,
501 char *path);
502#endif
503
504/*
505 * utresrc
506 */
507acpi_status
508acpi_ut_walk_aml_resources(u8 * aml,
509 acpi_size aml_length,
510 acpi_walk_aml_callback user_function,
511 void **context);
512
513acpi_status acpi_ut_validate_resource(void *aml, u8 * return_index);
514
515u32 acpi_ut_get_descriptor_length(void *aml);
516
517u16 acpi_ut_get_resource_length(void *aml);
518
519u8 acpi_ut_get_resource_header_length(void *aml);
520
521u8 acpi_ut_get_resource_type(void *aml);
522
523acpi_status
524acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc,
525 u8 ** end_tag);
526
527/*
528 * utmutex - mutex support
529 */
530acpi_status acpi_ut_mutex_initialize(void);
531
532void acpi_ut_mutex_terminate(void);
533
534acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
535
536acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
537
538/*
539 * utalloc - memory allocation and object caching
540 */
541acpi_status acpi_ut_create_caches(void);
542
543acpi_status acpi_ut_delete_caches(void);
544
545acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
546
547acpi_status
548acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
549 acpi_size required_length);
550
551void *acpi_ut_allocate(acpi_size size,
552 u32 component, const char *module, u32 line);
553
554void *acpi_ut_allocate_zeroed(acpi_size size,
555 u32 component, const char *module, u32 line);
556
557#ifdef ACPI_DBG_TRACK_ALLOCATIONS
558void *acpi_ut_allocate_and_track(acpi_size size,
559 u32 component, const char *module, u32 line);
560
561void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
562 u32 component,
563 const char *module, u32 line);
564
565void
566acpi_ut_free_and_track(void *address,
567 u32 component, const char *module, u32 line);
568
569#ifdef ACPI_FUTURE_USAGE
570void acpi_ut_dump_allocation_info(void);
571#endif /* ACPI_FUTURE_USAGE */
572
573void acpi_ut_dump_allocations(u32 component, const char *module);
574
575acpi_status
576acpi_ut_create_list(char *list_name,
577 u16 object_size, struct acpi_memory_list **return_cache);
578
579#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
580
581/*
582 * utxferror - various error/warning output functions
583 */
584void ACPI_INTERNAL_VAR_XFACE
585acpi_ut_predefined_warning(const char *module_name,
586 u32 line_number,
587 char *pathname,
588 u8 node_flags, const char *format, ...);
589
590void ACPI_INTERNAL_VAR_XFACE
591acpi_ut_predefined_info(const char *module_name,
592 u32 line_number,
593 char *pathname, u8 node_flags, const char *format, ...);
594
595void
596acpi_ut_namespace_error(const char *module_name,
597 u32 line_number,
598 const char *internal_name, acpi_status lookup_status);
599
600void
601acpi_ut_method_error(const char *module_name,
602 u32 line_number,
603 const char *message,
604 struct acpi_namespace_node *node,
605 const char *path, acpi_status lookup_status);
606
607#endif /* _ACUTILS_H */
1/******************************************************************************
2 *
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2016, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#ifndef _ACUTILS_H
45#define _ACUTILS_H
46
47extern const u8 acpi_gbl_resource_aml_sizes[];
48extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
49
50/* Strings used by the disassembler and debugger resource dump routines */
51
52#if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
53
54extern const char *acpi_gbl_bm_decode[];
55extern const char *acpi_gbl_config_decode[];
56extern const char *acpi_gbl_consume_decode[];
57extern const char *acpi_gbl_dec_decode[];
58extern const char *acpi_gbl_he_decode[];
59extern const char *acpi_gbl_io_decode[];
60extern const char *acpi_gbl_ll_decode[];
61extern const char *acpi_gbl_max_decode[];
62extern const char *acpi_gbl_mem_decode[];
63extern const char *acpi_gbl_min_decode[];
64extern const char *acpi_gbl_mtp_decode[];
65extern const char *acpi_gbl_rng_decode[];
66extern const char *acpi_gbl_rw_decode[];
67extern const char *acpi_gbl_shr_decode[];
68extern const char *acpi_gbl_siz_decode[];
69extern const char *acpi_gbl_trs_decode[];
70extern const char *acpi_gbl_ttp_decode[];
71extern const char *acpi_gbl_typ_decode[];
72extern const char *acpi_gbl_ppc_decode[];
73extern const char *acpi_gbl_ior_decode[];
74extern const char *acpi_gbl_dts_decode[];
75extern const char *acpi_gbl_ct_decode[];
76extern const char *acpi_gbl_sbt_decode[];
77extern const char *acpi_gbl_am_decode[];
78extern const char *acpi_gbl_sm_decode[];
79extern const char *acpi_gbl_wm_decode[];
80extern const char *acpi_gbl_cph_decode[];
81extern const char *acpi_gbl_cpo_decode[];
82extern const char *acpi_gbl_dp_decode[];
83extern const char *acpi_gbl_ed_decode[];
84extern const char *acpi_gbl_bpb_decode[];
85extern const char *acpi_gbl_sb_decode[];
86extern const char *acpi_gbl_fc_decode[];
87extern const char *acpi_gbl_pt_decode[];
88#endif
89
90/*
91 * For the iASL compiler case, the output is redirected to stderr so that
92 * any of the various ACPI errors and warnings do not appear in the output
93 * files, for either the compiler or disassembler portions of the tool.
94 */
95#ifdef ACPI_ASL_COMPILER
96
97#include <stdio.h>
98
99#define ACPI_MSG_REDIRECT_BEGIN \
100 FILE *output_file = acpi_gbl_output_file; \
101 acpi_os_redirect_output (stderr);
102
103#define ACPI_MSG_REDIRECT_END \
104 acpi_os_redirect_output (output_file);
105
106#else
107/*
108 * non-iASL case - no redirection, nothing to do
109 */
110#define ACPI_MSG_REDIRECT_BEGIN
111#define ACPI_MSG_REDIRECT_END
112#endif
113
114/*
115 * Common error message prefixes
116 */
117#ifndef ACPI_MSG_ERROR
118#define ACPI_MSG_ERROR "ACPI Error: "
119#endif
120#ifndef ACPI_MSG_EXCEPTION
121#define ACPI_MSG_EXCEPTION "ACPI Exception: "
122#endif
123#ifndef ACPI_MSG_WARNING
124#define ACPI_MSG_WARNING "ACPI Warning: "
125#endif
126#ifndef ACPI_MSG_INFO
127#define ACPI_MSG_INFO "ACPI: "
128#endif
129
130#ifndef ACPI_MSG_BIOS_ERROR
131#define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): "
132#endif
133#ifndef ACPI_MSG_BIOS_WARNING
134#define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): "
135#endif
136
137/*
138 * Common message suffix
139 */
140#define ACPI_MSG_SUFFIX \
141 acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
142
143/* Types for Resource descriptor entries */
144
145#define ACPI_INVALID_RESOURCE 0
146#define ACPI_FIXED_LENGTH 1
147#define ACPI_VARIABLE_LENGTH 2
148#define ACPI_SMALL_VARIABLE_LENGTH 3
149
150typedef
151acpi_status (*acpi_walk_aml_callback) (u8 *aml,
152 u32 length,
153 u32 offset,
154 u8 resource_index, void **context);
155
156typedef
157acpi_status (*acpi_pkg_callback) (u8 object_type,
158 union acpi_operand_object * source_object,
159 union acpi_generic_state * state,
160 void *context);
161
162struct acpi_pkg_info {
163 u8 *free_space;
164 acpi_size length;
165 u32 object_space;
166 u32 num_packages;
167};
168
169/* Object reference counts */
170
171#define REF_INCREMENT (u16) 0
172#define REF_DECREMENT (u16) 1
173
174/* acpi_ut_dump_buffer */
175
176#define DB_BYTE_DISPLAY 1
177#define DB_WORD_DISPLAY 2
178#define DB_DWORD_DISPLAY 4
179#define DB_QWORD_DISPLAY 8
180
181/*
182 * utascii - ASCII utilities
183 */
184u8 acpi_ut_valid_nameseg(char *signature);
185
186u8 acpi_ut_valid_name_char(char character, u32 position);
187
188void acpi_ut_check_and_repair_ascii(u8 *name, char *repaired_name, u32 count);
189
190/*
191 * utnonansi - Non-ANSI C library functions
192 */
193void acpi_ut_strupr(char *src_string);
194
195void acpi_ut_strlwr(char *src_string);
196
197int acpi_ut_stricmp(char *string1, char *string2);
198
199acpi_status acpi_ut_strtoul64(char *string, u32 flags, u64 *ret_integer);
200
201/*
202 * Values for Flags above
203 * Note: LIMIT values correspond to acpi_gbl_integer_byte_width values (4/8)
204 */
205#define ACPI_STRTOUL_32BIT 0x04 /* 4 bytes */
206#define ACPI_STRTOUL_64BIT 0x08 /* 8 bytes */
207#define ACPI_STRTOUL_BASE16 0x10 /* Default: Base10/16 */
208
209/*
210 * utglobal - Global data structures and procedures
211 */
212acpi_status acpi_ut_init_globals(void);
213
214#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
215
216const char *acpi_ut_get_mutex_name(u32 mutex_id);
217
218const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
219#endif
220
221const char *acpi_ut_get_type_name(acpi_object_type type);
222
223const char *acpi_ut_get_node_name(void *object);
224
225const char *acpi_ut_get_descriptor_name(void *object);
226
227const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
228
229const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
230
231const char *acpi_ut_get_region_name(u8 space_id);
232
233const char *acpi_ut_get_event_name(u32 event_id);
234
235const char *acpi_ut_get_argument_type_name(u32 arg_type);
236
237char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
238
239acpi_status acpi_ut_ascii_to_hex_byte(char *two_ascii_chars, u8 *return_byte);
240
241u8 acpi_ut_ascii_char_to_hex(int hex_char);
242
243u8 acpi_ut_valid_object_type(acpi_object_type type);
244
245/*
246 * utinit - miscellaneous initialization and shutdown
247 */
248acpi_status acpi_ut_hardware_initialize(void);
249
250void acpi_ut_subsystem_shutdown(void);
251
252/*
253 * utcopy - Object construction and conversion interfaces
254 */
255acpi_status
256acpi_ut_build_simple_object(union acpi_operand_object *obj,
257 union acpi_object *user_obj,
258 u8 *data_space, u32 *buffer_space_used);
259
260acpi_status
261acpi_ut_build_package_object(union acpi_operand_object *obj,
262 u8 *buffer, u32 *space_used);
263
264acpi_status
265acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
266 struct acpi_buffer *ret_buffer);
267
268acpi_status
269acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
270 union acpi_operand_object **internal_obj);
271
272acpi_status
273acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
274 union acpi_operand_object *dest_obj);
275
276acpi_status
277acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
278 union acpi_operand_object **dest_desc,
279 struct acpi_walk_state *walk_state);
280
281/*
282 * utcreate - Object creation
283 */
284acpi_status
285acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
286
287/*
288 * utdebug - Debug interfaces
289 */
290void acpi_ut_init_stack_ptr_trace(void);
291
292void acpi_ut_track_stack_ptr(void);
293
294void
295acpi_ut_trace(u32 line_number,
296 const char *function_name,
297 const char *module_name, u32 component_id);
298
299void
300acpi_ut_trace_ptr(u32 line_number,
301 const char *function_name,
302 const char *module_name,
303 u32 component_id, const void *pointer);
304
305void
306acpi_ut_trace_u32(u32 line_number,
307 const char *function_name,
308 const char *module_name, u32 component_id, u32 integer);
309
310void
311acpi_ut_trace_str(u32 line_number,
312 const char *function_name,
313 const char *module_name,
314 u32 component_id, const char *string);
315
316void
317acpi_ut_exit(u32 line_number,
318 const char *function_name,
319 const char *module_name, u32 component_id);
320
321void
322acpi_ut_status_exit(u32 line_number,
323 const char *function_name,
324 const char *module_name,
325 u32 component_id, acpi_status status);
326
327void
328acpi_ut_value_exit(u32 line_number,
329 const char *function_name,
330 const char *module_name, u32 component_id, u64 value);
331
332void
333acpi_ut_ptr_exit(u32 line_number,
334 const char *function_name,
335 const char *module_name, u32 component_id, u8 *ptr);
336
337void
338acpi_ut_str_exit(u32 line_number,
339 const char *function_name,
340 const char *module_name, u32 component_id, const char *string);
341
342void
343acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
344
345void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
346
347#ifdef ACPI_APPLICATION
348void
349acpi_ut_dump_buffer_to_file(ACPI_FILE file,
350 u8 *buffer,
351 u32 count, u32 display, u32 base_offset);
352#endif
353
354void acpi_ut_report_error(char *module_name, u32 line_number);
355
356void acpi_ut_report_info(char *module_name, u32 line_number);
357
358void acpi_ut_report_warning(char *module_name, u32 line_number);
359
360/*
361 * utdelete - Object deletion and reference counts
362 */
363void acpi_ut_add_reference(union acpi_operand_object *object);
364
365void acpi_ut_remove_reference(union acpi_operand_object *object);
366
367void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
368
369void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
370
371void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
372
373/*
374 * uteval - object evaluation
375 */
376acpi_status
377acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
378 const char *path,
379 u32 expected_return_btypes,
380 union acpi_operand_object **return_desc);
381
382acpi_status
383acpi_ut_evaluate_numeric_object(const char *object_name,
384 struct acpi_namespace_node *device_node,
385 u64 *value);
386
387acpi_status
388acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
389
390acpi_status
391acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
392 const char **method_names,
393 u8 method_count, u8 *out_values);
394
395/*
396 * utids - device ID support
397 */
398acpi_status
399acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
400 struct acpi_pnp_device_id ** return_id);
401
402acpi_status
403acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
404 struct acpi_pnp_device_id ** return_id);
405
406acpi_status
407acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
408 struct acpi_pnp_device_id_list ** return_cid_list);
409
410acpi_status
411acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
412 struct acpi_pnp_device_id **return_id);
413
414/*
415 * utlock - reader/writer locks
416 */
417acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
418
419void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
420
421acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
422
423acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
424
425acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
426
427void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
428
429/*
430 * utobject - internal object create/delete/cache routines
431 */
432union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
433 *module_name,
434 u32 line_number,
435 u32 component_id,
436 acpi_object_type
437 type);
438
439void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
440 u32 line_number, u32 component_id);
441
442#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
443#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
444
445void acpi_ut_delete_object_desc(union acpi_operand_object *object);
446
447u8 acpi_ut_valid_internal_object(void *object);
448
449union acpi_operand_object *acpi_ut_create_package_object(u32 count);
450
451union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
452
453union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
454
455union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
456
457acpi_status
458acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length);
459
460/*
461 * utosi - Support for the _OSI predefined control method
462 */
463acpi_status acpi_ut_initialize_interfaces(void);
464
465acpi_status acpi_ut_interface_terminate(void);
466
467acpi_status acpi_ut_install_interface(acpi_string interface_name);
468
469acpi_status acpi_ut_remove_interface(acpi_string interface_name);
470
471acpi_status acpi_ut_update_interfaces(u8 action);
472
473struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
474
475acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
476
477/*
478 * utpredef - support for predefined names
479 */
480const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
481 acpi_predefined_info
482 *this_name);
483
484const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
485
486void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
487
488#if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
489const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
490
491void
492acpi_ut_display_predefined_method(char *buffer,
493 const union acpi_predefined_info *this_name,
494 u8 multi_line);
495
496u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
497#endif
498
499/*
500 * utstate - Generic state creation/cache routines
501 */
502void
503acpi_ut_push_generic_state(union acpi_generic_state **list_head,
504 union acpi_generic_state *state);
505
506union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
507 **list_head);
508
509union acpi_generic_state *acpi_ut_create_generic_state(void);
510
511struct acpi_thread_state *acpi_ut_create_thread_state(void);
512
513union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
514 *object, u16 action);
515
516union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
517 void *external_object,
518 u16 index);
519
520acpi_status
521acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
522 u16 action,
523 union acpi_generic_state **state_list);
524
525union acpi_generic_state *acpi_ut_create_control_state(void);
526
527void acpi_ut_delete_generic_state(union acpi_generic_state *state);
528
529/*
530 * utmath
531 */
532acpi_status
533acpi_ut_divide(u64 in_dividend,
534 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
535
536acpi_status
537acpi_ut_short_divide(u64 in_dividend,
538 u32 divisor, u64 *out_quotient, u32 *out_remainder);
539
540/*
541 * utmisc
542 */
543const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
544 status);
545
546u8 acpi_ut_is_pci_root_bridge(char *id);
547
548#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
549u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
550#endif
551
552acpi_status
553acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
554 void *target_object,
555 acpi_pkg_callback walk_callback, void *context);
556
557/* Values for Base above (16=Hex, 10=Decimal) */
558
559#define ACPI_ANY_BASE 0
560
561u32 acpi_ut_dword_byte_swap(u32 value);
562
563void acpi_ut_set_integer_width(u8 revision);
564
565#ifdef ACPI_DEBUG_OUTPUT
566void
567acpi_ut_display_init_pathname(u8 type,
568 struct acpi_namespace_node *obj_handle,
569 const char *path);
570#endif
571
572/*
573 * utownerid - Support for Table/Method Owner IDs
574 */
575acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id);
576
577void acpi_ut_release_owner_id(acpi_owner_id *owner_id);
578
579/*
580 * utresrc
581 */
582acpi_status
583acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
584 u8 *aml,
585 acpi_size aml_length,
586 acpi_walk_aml_callback user_function,
587 void **context);
588
589acpi_status
590acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
591 void *aml, u8 *return_index);
592
593u32 acpi_ut_get_descriptor_length(void *aml);
594
595u16 acpi_ut_get_resource_length(void *aml);
596
597u8 acpi_ut_get_resource_header_length(void *aml);
598
599u8 acpi_ut_get_resource_type(void *aml);
600
601acpi_status
602acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
603
604/*
605 * utstring - String and character utilities
606 */
607void acpi_ut_print_string(char *string, u16 max_length);
608
609#if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
610void ut_convert_backslashes(char *pathname);
611#endif
612
613void acpi_ut_repair_name(char *name);
614
615#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
616u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
617
618u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
619
620u8
621acpi_ut_safe_strncat(char *dest,
622 acpi_size dest_size,
623 char *source, acpi_size max_transfer_length);
624#endif
625
626/*
627 * utmutex - mutex support
628 */
629acpi_status acpi_ut_mutex_initialize(void);
630
631void acpi_ut_mutex_terminate(void);
632
633acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
634
635acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
636
637/*
638 * utalloc - memory allocation and object caching
639 */
640acpi_status acpi_ut_create_caches(void);
641
642acpi_status acpi_ut_delete_caches(void);
643
644acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
645
646acpi_status
647acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
648 acpi_size required_length);
649
650#ifdef ACPI_DBG_TRACK_ALLOCATIONS
651void *acpi_ut_allocate_and_track(acpi_size size,
652 u32 component, const char *module, u32 line);
653
654void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
655 u32 component,
656 const char *module, u32 line);
657
658void
659acpi_ut_free_and_track(void *address,
660 u32 component, const char *module, u32 line);
661
662void acpi_ut_dump_allocation_info(void);
663
664void acpi_ut_dump_allocations(u32 component, const char *module);
665
666acpi_status
667acpi_ut_create_list(const char *list_name,
668 u16 object_size, struct acpi_memory_list **return_cache);
669
670#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
671
672/*
673 * utaddress - address range check
674 */
675acpi_status
676acpi_ut_add_address_range(acpi_adr_space_type space_id,
677 acpi_physical_address address,
678 u32 length, struct acpi_namespace_node *region_node);
679
680void
681acpi_ut_remove_address_range(acpi_adr_space_type space_id,
682 struct acpi_namespace_node *region_node);
683
684u32
685acpi_ut_check_address_range(acpi_adr_space_type space_id,
686 acpi_physical_address address, u32 length, u8 warn);
687
688void acpi_ut_delete_address_lists(void);
689
690/*
691 * utxferror - various error/warning output functions
692 */
693void ACPI_INTERNAL_VAR_XFACE
694acpi_ut_predefined_warning(const char *module_name,
695 u32 line_number,
696 char *pathname,
697 u8 node_flags, const char *format, ...);
698
699void ACPI_INTERNAL_VAR_XFACE
700acpi_ut_predefined_info(const char *module_name,
701 u32 line_number,
702 char *pathname, u8 node_flags, const char *format, ...);
703
704void ACPI_INTERNAL_VAR_XFACE
705acpi_ut_predefined_bios_error(const char *module_name,
706 u32 line_number,
707 char *pathname,
708 u8 node_flags, const char *format, ...);
709
710void
711acpi_ut_namespace_error(const char *module_name,
712 u32 line_number,
713 const char *internal_name, acpi_status lookup_status);
714
715void
716acpi_ut_method_error(const char *module_name,
717 u32 line_number,
718 const char *message,
719 struct acpi_namespace_node *node,
720 const char *path, acpi_status lookup_status);
721
722/*
723 * Utility functions for ACPI names and IDs
724 */
725const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
726
727const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
728
729const char *acpi_ah_match_uuid(u8 *data);
730
731/*
732 * utuuid -- UUID support functions
733 */
734#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
735void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
736#endif
737
738#endif /* _ACUTILS_H */