1 /******************************************************************************
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
47 extern const u8 acpi_gbl_resource_aml_sizes[];
48 extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
50 /* Strings used by the disassembler and debugger resource dump routines */
52 #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
54 extern const char *acpi_gbl_bm_decode[];
55 extern const char *acpi_gbl_config_decode[];
56 extern const char *acpi_gbl_consume_decode[];
57 extern const char *acpi_gbl_dec_decode[];
58 extern const char *acpi_gbl_he_decode[];
59 extern const char *acpi_gbl_io_decode[];
60 extern const char *acpi_gbl_ll_decode[];
61 extern const char *acpi_gbl_max_decode[];
62 extern const char *acpi_gbl_mem_decode[];
63 extern const char *acpi_gbl_min_decode[];
64 extern const char *acpi_gbl_mtp_decode[];
65 extern const char *acpi_gbl_rng_decode[];
66 extern const char *acpi_gbl_rw_decode[];
67 extern const char *acpi_gbl_shr_decode[];
68 extern const char *acpi_gbl_siz_decode[];
69 extern const char *acpi_gbl_trs_decode[];
70 extern const char *acpi_gbl_ttp_decode[];
71 extern const char *acpi_gbl_typ_decode[];
72 extern const char *acpi_gbl_ppc_decode[];
73 extern const char *acpi_gbl_ior_decode[];
74 extern const char *acpi_gbl_dts_decode[];
75 extern const char *acpi_gbl_ct_decode[];
76 extern const char *acpi_gbl_sbt_decode[];
77 extern const char *acpi_gbl_am_decode[];
78 extern const char *acpi_gbl_sm_decode[];
79 extern const char *acpi_gbl_wm_decode[];
80 extern const char *acpi_gbl_cph_decode[];
81 extern const char *acpi_gbl_cpo_decode[];
82 extern const char *acpi_gbl_dp_decode[];
83 extern const char *acpi_gbl_ed_decode[];
84 extern const char *acpi_gbl_bpb_decode[];
85 extern const char *acpi_gbl_sb_decode[];
86 extern const char *acpi_gbl_fc_decode[];
87 extern const char *acpi_gbl_pt_decode[];
90 /* Types for Resource descriptor entries */
92 #define ACPI_INVALID_RESOURCE 0
93 #define ACPI_FIXED_LENGTH 1
94 #define ACPI_VARIABLE_LENGTH 2
95 #define ACPI_SMALL_VARIABLE_LENGTH 3
98 acpi_status(*acpi_walk_aml_callback) (u8 *aml,
101 u8 resource_index, void **context);
104 acpi_status(*acpi_pkg_callback) (u8 object_type,
105 union acpi_operand_object *source_object,
106 union acpi_generic_state * state,
109 struct acpi_pkg_info {
116 /* Object reference counts */
118 #define REF_INCREMENT (u16) 0
119 #define REF_DECREMENT (u16) 1
121 /* acpi_ut_dump_buffer */
123 #define DB_BYTE_DISPLAY 1
124 #define DB_WORD_DISPLAY 2
125 #define DB_DWORD_DISPLAY 4
126 #define DB_QWORD_DISPLAY 8
129 * utglobal - Global data structures and procedures
131 acpi_status acpi_ut_init_globals(void);
133 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
135 char *acpi_ut_get_mutex_name(u32 mutex_id);
137 const char *acpi_ut_get_notify_name(u32 notify_value);
141 char *acpi_ut_get_type_name(acpi_object_type type);
143 char *acpi_ut_get_node_name(void *object);
145 char *acpi_ut_get_descriptor_name(void *object);
147 const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
149 char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
151 char *acpi_ut_get_region_name(u8 space_id);
153 char *acpi_ut_get_event_name(u32 event_id);
155 char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
157 u8 acpi_ut_valid_object_type(acpi_object_type type);
160 * utinit - miscellaneous initialization and shutdown
162 acpi_status acpi_ut_hardware_initialize(void);
164 void acpi_ut_subsystem_shutdown(void);
167 * utclib - Local implementations of C library functions
169 #ifndef ACPI_USE_SYSTEM_CLIBRARY
171 acpi_size acpi_ut_strlen(const char *string);
173 char *acpi_ut_strcpy(char *dst_string, const char *src_string);
175 char *acpi_ut_strncpy(char *dst_string,
176 const char *src_string, acpi_size count);
178 int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
180 int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
182 int acpi_ut_strcmp(const char *string1, const char *string2);
184 char *acpi_ut_strcat(char *dst_string, const char *src_string);
186 char *acpi_ut_strncat(char *dst_string,
187 const char *src_string, acpi_size count);
189 u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
191 char *acpi_ut_strstr(char *string1, char *string2);
193 void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
195 void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
197 int acpi_ut_to_upper(int c);
199 int acpi_ut_to_lower(int c);
201 extern const u8 _acpi_ctype[];
203 #define _ACPI_XA 0x00 /* extra alphabetic - not supported */
204 #define _ACPI_XS 0x40 /* extra space */
205 #define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
206 #define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
207 #define _ACPI_DI 0x04 /* '0'-'9' */
208 #define _ACPI_LO 0x02 /* 'a'-'z' */
209 #define _ACPI_PU 0x10 /* punctuation */
210 #define _ACPI_SP 0x08 /* space */
211 #define _ACPI_UP 0x01 /* 'A'-'Z' */
212 #define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
214 #define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
215 #define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
216 #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
217 #define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
218 #define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
219 #define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
220 #define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
222 #endif /* !ACPI_USE_SYSTEM_CLIBRARY */
224 #define ACPI_IS_ASCII(c) ((c) < 0x80)
227 * utcopy - Object construction and conversion interfaces
230 acpi_ut_build_simple_object(union acpi_operand_object *obj,
231 union acpi_object *user_obj,
232 u8 *data_space, u32 *buffer_space_used);
235 acpi_ut_build_package_object(union acpi_operand_object *obj,
236 u8 *buffer, u32 *space_used);
239 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
240 struct acpi_buffer *ret_buffer);
243 acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
244 union acpi_operand_object **internal_obj);
247 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
248 union acpi_operand_object *dest_obj);
251 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
252 union acpi_operand_object **dest_desc,
253 struct acpi_walk_state *walk_state);
256 * utcreate - Object creation
259 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
262 * utdebug - Debug interfaces
264 void acpi_ut_init_stack_ptr_trace(void);
266 void acpi_ut_track_stack_ptr(void);
269 acpi_ut_trace(u32 line_number,
270 const char *function_name,
271 const char *module_name, u32 component_id);
274 acpi_ut_trace_ptr(u32 line_number,
275 const char *function_name,
276 const char *module_name, u32 component_id, void *pointer);
279 acpi_ut_trace_u32(u32 line_number,
280 const char *function_name,
281 const char *module_name, u32 component_id, u32 integer);
284 acpi_ut_trace_str(u32 line_number,
285 const char *function_name,
286 const char *module_name, u32 component_id, char *string);
289 acpi_ut_exit(u32 line_number,
290 const char *function_name,
291 const char *module_name, u32 component_id);
294 acpi_ut_status_exit(u32 line_number,
295 const char *function_name,
296 const char *module_name,
297 u32 component_id, acpi_status status);
300 acpi_ut_value_exit(u32 line_number,
301 const char *function_name,
302 const char *module_name, u32 component_id, u64 value);
305 acpi_ut_ptr_exit(u32 line_number,
306 const char *function_name,
307 const char *module_name, u32 component_id, u8 *ptr);
310 acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
312 void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
314 void acpi_ut_report_error(char *module_name, u32 line_number);
316 void acpi_ut_report_info(char *module_name, u32 line_number);
318 void acpi_ut_report_warning(char *module_name, u32 line_number);
321 * utdelete - Object deletion and reference counts
323 void acpi_ut_add_reference(union acpi_operand_object *object);
325 void acpi_ut_remove_reference(union acpi_operand_object *object);
327 void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
329 void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
331 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
334 * uteval - object evaluation
337 acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
339 u32 expected_return_btypes,
340 union acpi_operand_object **return_desc);
343 acpi_ut_evaluate_numeric_object(char *object_name,
344 struct acpi_namespace_node *device_node,
348 acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
351 acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
352 const char **method_names,
353 u8 method_count, u8 *out_values);
356 * utids - device ID support
359 acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
360 struct acpi_pnp_device_id ** return_id);
363 acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
364 struct acpi_pnp_device_id ** return_id);
367 acpi_ut_execute_SUB(struct acpi_namespace_node *device_node,
368 struct acpi_pnp_device_id **return_id);
371 acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
372 struct acpi_pnp_device_id_list ** return_cid_list);
375 * utlock - reader/writer locks
377 acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
379 void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
381 acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
383 acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
385 acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
387 void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
390 * utobject - internal object create/delete/cache routines
392 union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
399 void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
400 u32 line_number, u32 component_id);
402 #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
403 #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
405 void acpi_ut_delete_object_desc(union acpi_operand_object *object);
407 u8 acpi_ut_valid_internal_object(void *object);
409 union acpi_operand_object *acpi_ut_create_package_object(u32 count);
411 union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
413 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
415 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
418 acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
421 * utosi - Support for the _OSI predefined control method
423 acpi_status acpi_ut_initialize_interfaces(void);
425 acpi_status acpi_ut_interface_terminate(void);
427 acpi_status acpi_ut_install_interface(acpi_string interface_name);
429 acpi_status acpi_ut_remove_interface(acpi_string interface_name);
431 struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
433 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
436 * utpredef - support for predefined names
438 const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
442 const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
444 const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
447 acpi_ut_display_predefined_method(char *buffer,
448 const union acpi_predefined_info *this_name,
451 void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
453 u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
456 * utstate - Generic state creation/cache routines
459 acpi_ut_push_generic_state(union acpi_generic_state **list_head,
460 union acpi_generic_state *state);
462 union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
465 union acpi_generic_state *acpi_ut_create_generic_state(void);
467 struct acpi_thread_state *acpi_ut_create_thread_state(void);
469 union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
470 *object, u16 action);
472 union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
473 void *external_object,
477 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
479 union acpi_generic_state **state_list);
481 #ifdef ACPI_FUTURE_USAGE
483 acpi_ut_create_pkg_state_and_push(void *internal_object,
484 void *external_object,
486 union acpi_generic_state **state_list);
487 #endif /* ACPI_FUTURE_USAGE */
489 union acpi_generic_state *acpi_ut_create_control_state(void);
491 void acpi_ut_delete_generic_state(union acpi_generic_state *state);
497 acpi_ut_divide(u64 in_dividend,
498 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
501 acpi_ut_short_divide(u64 in_dividend,
502 u32 divisor, u64 *out_quotient, u32 *out_remainder);
507 const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
510 u8 acpi_ut_is_pci_root_bridge(char *id);
512 u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
515 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
517 acpi_pkg_callback walk_callback, void *context);
519 /* Values for Base above (16=Hex, 10=Decimal) */
521 #define ACPI_ANY_BASE 0
523 u32 acpi_ut_dword_byte_swap(u32 value);
525 void acpi_ut_set_integer_width(u8 revision);
527 #ifdef ACPI_DEBUG_OUTPUT
529 acpi_ut_display_init_pathname(u8 type,
530 struct acpi_namespace_node *obj_handle,
535 * utownerid - Support for Table/Method Owner IDs
537 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
539 void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
545 acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
547 acpi_size aml_length,
548 acpi_walk_aml_callback user_function,
552 acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
553 void *aml, u8 *return_index);
555 u32 acpi_ut_get_descriptor_length(void *aml);
557 u16 acpi_ut_get_resource_length(void *aml);
559 u8 acpi_ut_get_resource_header_length(void *aml);
561 u8 acpi_ut_get_resource_type(void *aml);
564 acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
567 * utstring - String and character utilities
569 void acpi_ut_strupr(char *src_string);
571 void acpi_ut_strlwr(char *src_string);
573 int acpi_ut_stricmp(char *string1, char *string2);
575 acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer);
577 void acpi_ut_print_string(char *string, u8 max_length);
579 void ut_convert_backslashes(char *pathname);
581 u8 acpi_ut_valid_acpi_name(u32 name);
583 u8 acpi_ut_valid_acpi_char(char character, u32 position);
585 void acpi_ut_repair_name(char *name);
588 * utmutex - mutex support
590 acpi_status acpi_ut_mutex_initialize(void);
592 void acpi_ut_mutex_terminate(void);
594 acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
596 acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
599 * utalloc - memory allocation and object caching
601 acpi_status acpi_ut_create_caches(void);
603 acpi_status acpi_ut_delete_caches(void);
605 acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
608 acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
609 acpi_size required_length);
611 void *acpi_ut_allocate(acpi_size size,
612 u32 component, const char *module, u32 line);
614 void *acpi_ut_allocate_zeroed(acpi_size size,
615 u32 component, const char *module, u32 line);
617 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
618 void *acpi_ut_allocate_and_track(acpi_size size,
619 u32 component, const char *module, u32 line);
621 void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
623 const char *module, u32 line);
626 acpi_ut_free_and_track(void *address,
627 u32 component, const char *module, u32 line);
629 #ifdef ACPI_FUTURE_USAGE
630 void acpi_ut_dump_allocation_info(void);
631 #endif /* ACPI_FUTURE_USAGE */
633 void acpi_ut_dump_allocations(u32 component, const char *module);
636 acpi_ut_create_list(char *list_name,
637 u16 object_size, struct acpi_memory_list **return_cache);
639 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
642 * utaddress - address range check
645 acpi_ut_add_address_range(acpi_adr_space_type space_id,
646 acpi_physical_address address,
647 u32 length, struct acpi_namespace_node *region_node);
650 acpi_ut_remove_address_range(acpi_adr_space_type space_id,
651 struct acpi_namespace_node *region_node);
654 acpi_ut_check_address_range(acpi_adr_space_type space_id,
655 acpi_physical_address address, u32 length, u8 warn);
657 void acpi_ut_delete_address_lists(void);
660 * utxferror - various error/warning output functions
662 void ACPI_INTERNAL_VAR_XFACE
663 acpi_ut_predefined_warning(const char *module_name,
666 u8 node_flags, const char *format, ...);
668 void ACPI_INTERNAL_VAR_XFACE
669 acpi_ut_predefined_info(const char *module_name,
671 char *pathname, u8 node_flags, const char *format, ...);
674 acpi_ut_namespace_error(const char *module_name,
676 const char *internal_name, acpi_status lookup_status);
679 acpi_ut_method_error(const char *module_name,
682 struct acpi_namespace_node *node,
683 const char *path, acpi_status lookup_status);
685 #endif /* _ACUTILS_H */