1
/******************************************************************************
3
* Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
5
*****************************************************************************/
8
* Copyright (C) 2000 - 2011, 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[];
49
/* Strings used by the disassembler and debugger resource dump routines */
51
#if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
53
extern const char *acpi_gbl_bm_decode[];
54
extern const char *acpi_gbl_config_decode[];
55
extern const char *acpi_gbl_consume_decode[];
56
extern const char *acpi_gbl_dec_decode[];
57
extern const char *acpi_gbl_he_decode[];
58
extern const char *acpi_gbl_io_decode[];
59
extern const char *acpi_gbl_ll_decode[];
60
extern const char *acpi_gbl_max_decode[];
61
extern const char *acpi_gbl_mem_decode[];
62
extern const char *acpi_gbl_min_decode[];
63
extern const char *acpi_gbl_mtp_decode[];
64
extern const char *acpi_gbl_rng_decode[];
65
extern const char *acpi_gbl_rw_decode[];
66
extern const char *acpi_gbl_shr_decode[];
67
extern const char *acpi_gbl_siz_decode[];
68
extern const char *acpi_gbl_trs_decode[];
69
extern const char *acpi_gbl_ttp_decode[];
70
extern const char *acpi_gbl_typ_decode[];
73
/* Types for Resource descriptor entries */
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
81
acpi_status(*acpi_walk_aml_callback) (u8 * aml,
84
u8 resource_index, void **context);
87
acpi_status(*acpi_pkg_callback) (u8 object_type,
88
union acpi_operand_object * source_object,
89
union acpi_generic_state * state,
92
struct acpi_pkg_info {
99
#define REF_INCREMENT (u16) 0
100
#define REF_DECREMENT (u16) 1
101
#define REF_FORCE_DELETE (u16) 2
103
/* acpi_ut_dump_buffer */
105
#define DB_BYTE_DISPLAY 1
106
#define DB_WORD_DISPLAY 2
107
#define DB_DWORD_DISPLAY 4
108
#define DB_QWORD_DISPLAY 8
111
* utglobal - Global data structures and procedures
113
acpi_status acpi_ut_init_globals(void);
115
#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
117
char *acpi_ut_get_mutex_name(u32 mutex_id);
119
const char *acpi_ut_get_notify_name(u32 notify_value);
123
char *acpi_ut_get_type_name(acpi_object_type type);
125
char *acpi_ut_get_node_name(void *object);
127
char *acpi_ut_get_descriptor_name(void *object);
129
const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
131
char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
133
char *acpi_ut_get_region_name(u8 space_id);
135
char *acpi_ut_get_event_name(u32 event_id);
137
char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
139
u8 acpi_ut_valid_object_type(acpi_object_type type);
142
* utinit - miscellaneous initialization and shutdown
144
acpi_status acpi_ut_hardware_initialize(void);
146
void acpi_ut_subsystem_shutdown(void);
149
* utclib - Local implementations of C library functions
151
#ifndef ACPI_USE_SYSTEM_CLIBRARY
153
acpi_size acpi_ut_strlen(const char *string);
155
char *acpi_ut_strcpy(char *dst_string, const char *src_string);
157
char *acpi_ut_strncpy(char *dst_string,
158
const char *src_string, acpi_size count);
160
int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
162
int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
164
int acpi_ut_strcmp(const char *string1, const char *string2);
166
char *acpi_ut_strcat(char *dst_string, const char *src_string);
168
char *acpi_ut_strncat(char *dst_string,
169
const char *src_string, acpi_size count);
171
u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
173
char *acpi_ut_strstr(char *string1, char *string2);
175
void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
177
void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
179
int acpi_ut_to_upper(int c);
181
int acpi_ut_to_lower(int c);
183
extern const u8 _acpi_ctype[];
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' */
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))
204
#endif /* ACPI_USE_SYSTEM_CLIBRARY */
207
* utcopy - Object construction and conversion interfaces
210
acpi_ut_build_simple_object(union acpi_operand_object *obj,
211
union acpi_object *user_obj,
212
u8 * data_space, u32 * buffer_space_used);
215
acpi_ut_build_package_object(union acpi_operand_object *obj,
216
u8 * buffer, u32 * space_used);
219
acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
220
struct acpi_buffer *ret_buffer);
223
acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
224
union acpi_operand_object **internal_obj);
227
acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
228
union acpi_operand_object *dest_obj);
231
acpi_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);
236
* utcreate - Object creation
239
acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
242
* utdebug - Debug interfaces
244
void acpi_ut_init_stack_ptr_trace(void);
246
void acpi_ut_track_stack_ptr(void);
249
acpi_ut_trace(u32 line_number,
250
const char *function_name,
251
const char *module_name, u32 component_id);
254
acpi_ut_trace_ptr(u32 line_number,
255
const char *function_name,
256
const char *module_name, u32 component_id, void *pointer);
259
acpi_ut_trace_u32(u32 line_number,
260
const char *function_name,
261
const char *module_name, u32 component_id, u32 integer);
264
acpi_ut_trace_str(u32 line_number,
265
const char *function_name,
266
const char *module_name, u32 component_id, char *string);
269
acpi_ut_exit(u32 line_number,
270
const char *function_name,
271
const char *module_name, u32 component_id);
274
acpi_ut_status_exit(u32 line_number,
275
const char *function_name,
276
const char *module_name,
277
u32 component_id, acpi_status status);
280
acpi_ut_value_exit(u32 line_number,
281
const char *function_name,
282
const char *module_name, u32 component_id, u64 value);
285
acpi_ut_ptr_exit(u32 line_number,
286
const char *function_name,
287
const char *module_name, u32 component_id, u8 *ptr);
289
void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
291
void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display);
293
void acpi_ut_report_error(char *module_name, u32 line_number);
295
void acpi_ut_report_info(char *module_name, u32 line_number);
297
void acpi_ut_report_warning(char *module_name, u32 line_number);
300
* utdelete - Object deletion and reference counts
302
void acpi_ut_add_reference(union acpi_operand_object *object);
304
void acpi_ut_remove_reference(union acpi_operand_object *object);
306
void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
308
void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
310
void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
313
* uteval - object evaluation
316
acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
318
u32 expected_return_btypes,
319
union acpi_operand_object **return_desc);
322
acpi_ut_evaluate_numeric_object(char *object_name,
323
struct acpi_namespace_node *device_node,
327
acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
330
acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
331
const char **method_names,
332
u8 method_count, u8 *out_values);
335
* utids - device ID support
338
acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
339
struct acpica_device_id **return_id);
342
acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
343
struct acpica_device_id **return_id);
346
acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
347
struct acpica_device_id_list **return_cid_list);
350
* utlock - reader/writer locks
352
acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
354
void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
356
acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
358
acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
360
acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
362
void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
365
* utobject - internal object create/delete/cache routines
367
union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
374
void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
375
u32 line_number, u32 component_id);
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)
380
void acpi_ut_delete_object_desc(union acpi_operand_object *object);
382
u8 acpi_ut_valid_internal_object(void *object);
384
union acpi_operand_object *acpi_ut_create_package_object(u32 count);
386
union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
388
union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
390
union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
393
acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
396
* utosi - Support for the _OSI predefined control method
398
acpi_status acpi_ut_initialize_interfaces(void);
400
void acpi_ut_interface_terminate(void);
402
acpi_status acpi_ut_install_interface(acpi_string interface_name);
404
acpi_status acpi_ut_remove_interface(acpi_string interface_name);
406
struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
408
acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
411
* utstate - Generic state creation/cache routines
414
acpi_ut_push_generic_state(union acpi_generic_state **list_head,
415
union acpi_generic_state *state);
417
union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
420
union acpi_generic_state *acpi_ut_create_generic_state(void);
422
struct acpi_thread_state *acpi_ut_create_thread_state(void);
424
union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
425
*object, u16 action);
427
union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
428
void *external_object,
432
acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
434
union acpi_generic_state **state_list);
436
#ifdef ACPI_FUTURE_USAGE
438
acpi_ut_create_pkg_state_and_push(void *internal_object,
439
void *external_object,
441
union acpi_generic_state **state_list);
442
#endif /* ACPI_FUTURE_USAGE */
444
union acpi_generic_state *acpi_ut_create_control_state(void);
446
void acpi_ut_delete_generic_state(union acpi_generic_state *state);
452
acpi_ut_divide(u64 in_dividend,
453
u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
456
acpi_ut_short_divide(u64 in_dividend,
457
u32 divisor, u64 *out_quotient, u32 *out_remainder);
462
const char *acpi_ut_validate_exception(acpi_status status);
464
u8 acpi_ut_is_pci_root_bridge(char *id);
466
u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
468
acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
470
void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
473
acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
475
acpi_pkg_callback walk_callback, void *context);
477
void acpi_ut_strupr(char *src_string);
479
void acpi_ut_print_string(char *string, u8 max_length);
481
u8 acpi_ut_valid_acpi_name(u32 name);
483
acpi_name acpi_ut_repair_name(char *name);
485
u8 acpi_ut_valid_acpi_char(char character, u32 position);
487
acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 * ret_integer);
489
/* Values for Base above (16=Hex, 10=Decimal) */
491
#define ACPI_ANY_BASE 0
493
u32 acpi_ut_dword_byte_swap(u32 value);
495
void acpi_ut_set_integer_width(u8 revision);
497
#ifdef ACPI_DEBUG_OUTPUT
499
acpi_ut_display_init_pathname(u8 type,
500
struct acpi_namespace_node *obj_handle,
508
acpi_ut_walk_aml_resources(u8 * aml,
509
acpi_size aml_length,
510
acpi_walk_aml_callback user_function,
513
acpi_status acpi_ut_validate_resource(void *aml, u8 * return_index);
515
u32 acpi_ut_get_descriptor_length(void *aml);
517
u16 acpi_ut_get_resource_length(void *aml);
519
u8 acpi_ut_get_resource_header_length(void *aml);
521
u8 acpi_ut_get_resource_type(void *aml);
524
acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc,
528
* utmutex - mutex support
530
acpi_status acpi_ut_mutex_initialize(void);
532
void acpi_ut_mutex_terminate(void);
534
acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
536
acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
539
* utalloc - memory allocation and object caching
541
acpi_status acpi_ut_create_caches(void);
543
acpi_status acpi_ut_delete_caches(void);
545
acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
548
acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
549
acpi_size required_length);
551
void *acpi_ut_allocate(acpi_size size,
552
u32 component, const char *module, u32 line);
554
void *acpi_ut_allocate_zeroed(acpi_size size,
555
u32 component, const char *module, u32 line);
557
#ifdef ACPI_DBG_TRACK_ALLOCATIONS
558
void *acpi_ut_allocate_and_track(acpi_size size,
559
u32 component, const char *module, u32 line);
561
void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
563
const char *module, u32 line);
566
acpi_ut_free_and_track(void *address,
567
u32 component, const char *module, u32 line);
569
#ifdef ACPI_FUTURE_USAGE
570
void acpi_ut_dump_allocation_info(void);
571
#endif /* ACPI_FUTURE_USAGE */
573
void acpi_ut_dump_allocations(u32 component, const char *module);
576
acpi_ut_create_list(char *list_name,
577
u16 object_size, struct acpi_memory_list **return_cache);
579
#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
582
* utxferror - various error/warning output functions
584
void ACPI_INTERNAL_VAR_XFACE
585
acpi_ut_predefined_warning(const char *module_name,
588
u8 node_flags, const char *format, ...);
590
void ACPI_INTERNAL_VAR_XFACE
591
acpi_ut_predefined_info(const char *module_name,
593
char *pathname, u8 node_flags, const char *format, ...);
596
acpi_ut_namespace_error(const char *module_name,
598
const char *internal_name, acpi_status lookup_status);
601
acpi_ut_method_error(const char *module_name,
604
struct acpi_namespace_node *node,
605
const char *path, acpi_status lookup_status);
607
#endif /* _ACUTILS_H */