Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
25f044e6 | 8 | * Copyright (C) 2000 - 2013, Intel Corp. |
1da177e4 LT |
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 | ||
96db255c | 47 | extern const u8 acpi_gbl_resource_aml_sizes[]; |
e0fe0a8d | 48 | extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[]; |
96db255c | 49 | |
defba1d8 BM |
50 | /* Strings used by the disassembler and debugger resource dump routines */ |
51 | ||
52 | #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER) | |
53 | ||
b229cf92 BM |
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[]; | |
6d33b6be LZ |
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[]; | |
defba1d8 BM |
88 | #endif |
89 | ||
b6872ff9 BM |
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 | extern FILE *acpi_gbl_output_file; | |
99 | ||
100 | #define ACPI_MSG_REDIRECT_BEGIN \ | |
101 | FILE *output_file = acpi_gbl_output_file; \ | |
102 | acpi_os_redirect_output (stderr); | |
103 | ||
104 | #define ACPI_MSG_REDIRECT_END \ | |
105 | acpi_os_redirect_output (output_file); | |
106 | ||
107 | #else | |
108 | /* | |
109 | * non-iASL case - no redirection, nothing to do | |
110 | */ | |
111 | #define ACPI_MSG_REDIRECT_BEGIN | |
112 | #define ACPI_MSG_REDIRECT_END | |
113 | #endif | |
114 | ||
115 | /* | |
116 | * Common error message prefixes | |
117 | */ | |
118 | #define ACPI_MSG_ERROR "ACPI Error: " | |
119 | #define ACPI_MSG_EXCEPTION "ACPI Exception: " | |
120 | #define ACPI_MSG_WARNING "ACPI Warning: " | |
121 | #define ACPI_MSG_INFO "ACPI: " | |
122 | ||
123 | #define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): " | |
124 | #define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): " | |
125 | ||
126 | /* | |
127 | * Common message suffix | |
128 | */ | |
129 | #define ACPI_MSG_SUFFIX \ | |
130 | acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number) | |
131 | ||
96db255c BM |
132 | /* Types for Resource descriptor entries */ |
133 | ||
134 | #define ACPI_INVALID_RESOURCE 0 | |
135 | #define ACPI_FIXED_LENGTH 1 | |
136 | #define ACPI_VARIABLE_LENGTH 2 | |
137 | #define ACPI_SMALL_VARIABLE_LENGTH 3 | |
138 | ||
61686124 | 139 | typedef |
6d33b6be | 140 | acpi_status(*acpi_walk_aml_callback) (u8 *aml, |
61686124 BM |
141 | u32 length, |
142 | u32 offset, | |
b229cf92 | 143 | u8 resource_index, void **context); |
61686124 | 144 | |
1da177e4 | 145 | typedef |
4be44fcd | 146 | acpi_status(*acpi_pkg_callback) (u8 object_type, |
6d33b6be | 147 | union acpi_operand_object *source_object, |
4be44fcd LB |
148 | union acpi_generic_state * state, |
149 | void *context); | |
150 | ||
151 | struct acpi_pkg_info { | |
152 | u8 *free_space; | |
153 | acpi_size length; | |
154 | u32 object_space; | |
155 | u32 num_packages; | |
1da177e4 LT |
156 | }; |
157 | ||
60f3deb5 BM |
158 | /* Object reference counts */ |
159 | ||
1da177e4 LT |
160 | #define REF_INCREMENT (u16) 0 |
161 | #define REF_DECREMENT (u16) 1 | |
1da177e4 LT |
162 | |
163 | /* acpi_ut_dump_buffer */ | |
164 | ||
165 | #define DB_BYTE_DISPLAY 1 | |
166 | #define DB_WORD_DISPLAY 2 | |
167 | #define DB_DWORD_DISPLAY 4 | |
168 | #define DB_QWORD_DISPLAY 8 | |
169 | ||
1da177e4 | 170 | /* |
44f6c012 | 171 | * utglobal - Global data structures and procedures |
1da177e4 | 172 | */ |
b417d40b | 173 | acpi_status acpi_ut_init_globals(void); |
1da177e4 | 174 | |
1da177e4 LT |
175 | #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) |
176 | ||
4be44fcd | 177 | char *acpi_ut_get_mutex_name(u32 mutex_id); |
1da177e4 | 178 | |
514d18d7 ZR |
179 | const char *acpi_ut_get_notify_name(u32 notify_value); |
180 | ||
1da177e4 LT |
181 | #endif |
182 | ||
4be44fcd | 183 | char *acpi_ut_get_type_name(acpi_object_type type); |
1da177e4 | 184 | |
4be44fcd | 185 | char *acpi_ut_get_node_name(void *object); |
1da177e4 | 186 | |
4be44fcd | 187 | char *acpi_ut_get_descriptor_name(void *object); |
1da177e4 | 188 | |
f02a99ac BM |
189 | const char *acpi_ut_get_reference_name(union acpi_operand_object *object); |
190 | ||
4be44fcd | 191 | char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc); |
1da177e4 | 192 | |
4be44fcd | 193 | char *acpi_ut_get_region_name(u8 space_id); |
1da177e4 | 194 | |
4be44fcd | 195 | char *acpi_ut_get_event_name(u32 event_id); |
1da177e4 | 196 | |
5df7e6cb | 197 | char acpi_ut_hex_to_ascii_char(u64 integer, u32 position); |
1da177e4 | 198 | |
4be44fcd | 199 | u8 acpi_ut_valid_object_type(acpi_object_type type); |
1da177e4 LT |
200 | |
201 | /* | |
44f6c012 | 202 | * utinit - miscellaneous initialization and shutdown |
1da177e4 | 203 | */ |
4be44fcd | 204 | acpi_status acpi_ut_hardware_initialize(void); |
44f6c012 | 205 | |
4be44fcd | 206 | void acpi_ut_subsystem_shutdown(void); |
44f6c012 | 207 | |
44f6c012 RM |
208 | /* |
209 | * utclib - Local implementations of C library functions | |
210 | */ | |
1da177e4 LT |
211 | #ifndef ACPI_USE_SYSTEM_CLIBRARY |
212 | ||
4be44fcd LB |
213 | acpi_size acpi_ut_strlen(const char *string); |
214 | ||
215 | char *acpi_ut_strcpy(char *dst_string, const char *src_string); | |
216 | ||
217 | char *acpi_ut_strncpy(char *dst_string, | |
218 | const char *src_string, acpi_size count); | |
219 | ||
220 | int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count); | |
221 | ||
222 | int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count); | |
223 | ||
224 | int acpi_ut_strcmp(const char *string1, const char *string2); | |
225 | ||
226 | char *acpi_ut_strcat(char *dst_string, const char *src_string); | |
227 | ||
228 | char *acpi_ut_strncat(char *dst_string, | |
229 | const char *src_string, acpi_size count); | |
230 | ||
231 | u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base); | |
232 | ||
233 | char *acpi_ut_strstr(char *string1, char *string2); | |
234 | ||
235 | void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count); | |
236 | ||
67a119f9 | 237 | void *acpi_ut_memset(void *dest, u8 value, acpi_size count); |
4be44fcd LB |
238 | |
239 | int acpi_ut_to_upper(int c); | |
240 | ||
241 | int acpi_ut_to_lower(int c); | |
1da177e4 LT |
242 | |
243 | extern const u8 _acpi_ctype[]; | |
244 | ||
4be44fcd LB |
245 | #define _ACPI_XA 0x00 /* extra alphabetic - not supported */ |
246 | #define _ACPI_XS 0x40 /* extra space */ | |
247 | #define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */ | |
248 | #define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */ | |
249 | #define _ACPI_DI 0x04 /* '0'-'9' */ | |
250 | #define _ACPI_LO 0x02 /* 'a'-'z' */ | |
251 | #define _ACPI_PU 0x10 /* punctuation */ | |
252 | #define _ACPI_SP 0x08 /* space */ | |
253 | #define _ACPI_UP 0x01 /* 'A'-'Z' */ | |
254 | #define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */ | |
1da177e4 LT |
255 | |
256 | #define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI)) | |
257 | #define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP)) | |
258 | #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD)) | |
259 | #define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP)) | |
260 | #define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO)) | |
261 | #define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU)) | |
262 | #define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP)) | |
1da177e4 | 263 | |
6d33b6be LZ |
264 | #endif /* !ACPI_USE_SYSTEM_CLIBRARY */ |
265 | ||
266 | #define ACPI_IS_ASCII(c) ((c) < 0x80) | |
44f6c012 | 267 | |
1da177e4 | 268 | /* |
44f6c012 | 269 | * utcopy - Object construction and conversion interfaces |
1da177e4 | 270 | */ |
1da177e4 | 271 | acpi_status |
4be44fcd LB |
272 | acpi_ut_build_simple_object(union acpi_operand_object *obj, |
273 | union acpi_object *user_obj, | |
6d33b6be | 274 | u8 *data_space, u32 *buffer_space_used); |
1da177e4 LT |
275 | |
276 | acpi_status | |
4be44fcd | 277 | acpi_ut_build_package_object(union acpi_operand_object *obj, |
6d33b6be | 278 | u8 *buffer, u32 *space_used); |
1da177e4 | 279 | |
1da177e4 | 280 | acpi_status |
4be44fcd LB |
281 | acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj, |
282 | struct acpi_buffer *ret_buffer); | |
1da177e4 | 283 | |
1da177e4 | 284 | acpi_status |
4be44fcd LB |
285 | acpi_ut_copy_eobject_to_iobject(union acpi_object *obj, |
286 | union acpi_operand_object **internal_obj); | |
1da177e4 LT |
287 | |
288 | acpi_status | |
4be44fcd LB |
289 | acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj, |
290 | union acpi_operand_object *dest_obj); | |
1da177e4 | 291 | |
1da177e4 | 292 | acpi_status |
4be44fcd LB |
293 | acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc, |
294 | union acpi_operand_object **dest_desc, | |
295 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
296 | |
297 | /* | |
44f6c012 | 298 | * utcreate - Object creation |
1da177e4 | 299 | */ |
1da177e4 | 300 | acpi_status |
4be44fcd | 301 | acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action); |
1da177e4 LT |
302 | |
303 | /* | |
44f6c012 | 304 | * utdebug - Debug interfaces |
1da177e4 | 305 | */ |
4be44fcd | 306 | void acpi_ut_init_stack_ptr_trace(void); |
1da177e4 | 307 | |
4be44fcd | 308 | void acpi_ut_track_stack_ptr(void); |
1da177e4 LT |
309 | |
310 | void | |
4be44fcd | 311 | acpi_ut_trace(u32 line_number, |
4b8ed631 BM |
312 | const char *function_name, |
313 | const char *module_name, u32 component_id); | |
1da177e4 LT |
314 | |
315 | void | |
4be44fcd LB |
316 | acpi_ut_trace_ptr(u32 line_number, |
317 | const char *function_name, | |
4b8ed631 | 318 | const char *module_name, u32 component_id, void *pointer); |
1da177e4 LT |
319 | |
320 | void | |
4be44fcd LB |
321 | acpi_ut_trace_u32(u32 line_number, |
322 | const char *function_name, | |
4b8ed631 | 323 | const char *module_name, u32 component_id, u32 integer); |
1da177e4 LT |
324 | |
325 | void | |
4be44fcd LB |
326 | acpi_ut_trace_str(u32 line_number, |
327 | const char *function_name, | |
4b8ed631 | 328 | const char *module_name, u32 component_id, char *string); |
1da177e4 LT |
329 | |
330 | void | |
4be44fcd | 331 | acpi_ut_exit(u32 line_number, |
4b8ed631 BM |
332 | const char *function_name, |
333 | const char *module_name, u32 component_id); | |
1da177e4 LT |
334 | |
335 | void | |
4be44fcd LB |
336 | acpi_ut_status_exit(u32 line_number, |
337 | const char *function_name, | |
4b8ed631 BM |
338 | const char *module_name, |
339 | u32 component_id, acpi_status status); | |
1da177e4 LT |
340 | |
341 | void | |
4be44fcd LB |
342 | acpi_ut_value_exit(u32 line_number, |
343 | const char *function_name, | |
5df7e6cb | 344 | const char *module_name, u32 component_id, u64 value); |
1da177e4 LT |
345 | |
346 | void | |
4be44fcd LB |
347 | acpi_ut_ptr_exit(u32 line_number, |
348 | const char *function_name, | |
4b8ed631 | 349 | const char *module_name, u32 component_id, u8 *ptr); |
1da177e4 | 350 | |
97171c6b BM |
351 | void |
352 | acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id); | |
b8e4d893 | 353 | |
97171c6b | 354 | void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset); |
793c2388 | 355 | |
4a90c7e8 | 356 | void acpi_ut_report_error(char *module_name, u32 line_number); |
1da177e4 | 357 | |
4a90c7e8 | 358 | void acpi_ut_report_info(char *module_name, u32 line_number); |
1da177e4 | 359 | |
4a90c7e8 | 360 | void acpi_ut_report_warning(char *module_name, u32 line_number); |
1da177e4 | 361 | |
1da177e4 | 362 | /* |
44f6c012 | 363 | * utdelete - Object deletion and reference counts |
1da177e4 | 364 | */ |
4be44fcd | 365 | void acpi_ut_add_reference(union acpi_operand_object *object); |
1da177e4 | 366 | |
4be44fcd | 367 | void acpi_ut_remove_reference(union acpi_operand_object *object); |
1da177e4 | 368 | |
4be44fcd | 369 | void acpi_ut_delete_internal_package_object(union acpi_operand_object *object); |
1da177e4 | 370 | |
4be44fcd | 371 | void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object); |
1da177e4 | 372 | |
4be44fcd | 373 | void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list); |
1da177e4 LT |
374 | |
375 | /* | |
44f6c012 | 376 | * uteval - object evaluation |
1da177e4 | 377 | */ |
1da177e4 | 378 | acpi_status |
4be44fcd LB |
379 | acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node, |
380 | char *path, | |
381 | u32 expected_return_btypes, | |
382 | union acpi_operand_object **return_desc); | |
1da177e4 LT |
383 | |
384 | acpi_status | |
4be44fcd LB |
385 | acpi_ut_evaluate_numeric_object(char *object_name, |
386 | struct acpi_namespace_node *device_node, | |
5df7e6cb | 387 | u64 *value); |
1da177e4 LT |
388 | |
389 | acpi_status | |
15b8dd53 | 390 | acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags); |
1da177e4 LT |
391 | |
392 | acpi_status | |
15b8dd53 BM |
393 | acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node, |
394 | const char **method_names, | |
395 | u8 method_count, u8 *out_values); | |
1da177e4 | 396 | |
15b8dd53 BM |
397 | /* |
398 | * utids - device ID support | |
399 | */ | |
1da177e4 | 400 | acpi_status |
15b8dd53 | 401 | acpi_ut_execute_HID(struct acpi_namespace_node *device_node, |
78e25fef | 402 | struct acpi_pnp_device_id ** return_id); |
1da177e4 LT |
403 | |
404 | acpi_status | |
4be44fcd | 405 | acpi_ut_execute_UID(struct acpi_namespace_node *device_node, |
78e25fef | 406 | struct acpi_pnp_device_id ** return_id); |
1da177e4 | 407 | |
413fc3f5 BM |
408 | acpi_status |
409 | acpi_ut_execute_SUB(struct acpi_namespace_node *device_node, | |
410 | struct acpi_pnp_device_id **return_id); | |
411 | ||
1da177e4 | 412 | acpi_status |
15b8dd53 | 413 | acpi_ut_execute_CID(struct acpi_namespace_node *device_node, |
78e25fef | 414 | struct acpi_pnp_device_id_list ** return_cid_list); |
1da177e4 | 415 | |
8a335a23 BM |
416 | /* |
417 | * utlock - reader/writer locks | |
418 | */ | |
419 | acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock); | |
420 | ||
421 | void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock); | |
422 | ||
423 | acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock); | |
424 | ||
425 | acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock); | |
426 | ||
427 | acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock); | |
428 | ||
429 | void acpi_ut_release_write_lock(struct acpi_rw_lock *lock); | |
430 | ||
1da177e4 | 431 | /* |
44f6c012 | 432 | * utobject - internal object create/delete/cache routines |
1da177e4 | 433 | */ |
4b8ed631 BM |
434 | union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char |
435 | *module_name, | |
4be44fcd LB |
436 | u32 line_number, |
437 | u32 component_id, | |
438 | acpi_object_type | |
439 | type); | |
440 | ||
4b8ed631 | 441 | void *acpi_ut_allocate_object_desc_dbg(const char *module_name, |
4be44fcd | 442 | u32 line_number, u32 component_id); |
1da177e4 | 443 | |
f9f4601f RM |
444 | #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t) |
445 | #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT) | |
1da177e4 | 446 | |
4be44fcd | 447 | void acpi_ut_delete_object_desc(union acpi_operand_object *object); |
1da177e4 | 448 | |
4be44fcd | 449 | u8 acpi_ut_valid_internal_object(void *object); |
1da177e4 | 450 | |
6287ee32 BM |
451 | union acpi_operand_object *acpi_ut_create_package_object(u32 count); |
452 | ||
502f7efa BM |
453 | union acpi_operand_object *acpi_ut_create_integer_object(u64 value); |
454 | ||
4be44fcd | 455 | union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size); |
1da177e4 | 456 | |
4be44fcd | 457 | union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size); |
1da177e4 | 458 | |
1da177e4 | 459 | acpi_status |
4be44fcd | 460 | acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length); |
1da177e4 | 461 | |
b0ed7a91 LM |
462 | /* |
463 | * utosi - Support for the _OSI predefined control method | |
464 | */ | |
465 | acpi_status acpi_ut_initialize_interfaces(void); | |
466 | ||
388a9902 | 467 | acpi_status acpi_ut_interface_terminate(void); |
b0ed7a91 LM |
468 | |
469 | acpi_status acpi_ut_install_interface(acpi_string interface_name); | |
470 | ||
471 | acpi_status acpi_ut_remove_interface(acpi_string interface_name); | |
472 | ||
473 | struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name); | |
474 | ||
475 | acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state); | |
476 | ||
c34c82bc BM |
477 | /* |
478 | * utpredef - support for predefined names | |
479 | */ | |
480 | const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union | |
481 | acpi_predefined_info | |
482 | *this_name); | |
483 | ||
484 | const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name); | |
485 | ||
486 | const union acpi_predefined_info *acpi_ut_match_resource_name(char *name); | |
487 | ||
488 | void | |
489 | acpi_ut_display_predefined_method(char *buffer, | |
490 | const union acpi_predefined_info *this_name, | |
491 | u8 multi_line); | |
492 | ||
493 | void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes); | |
494 | ||
495 | u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types); | |
496 | ||
1da177e4 | 497 | /* |
44f6c012 | 498 | * utstate - Generic state creation/cache routines |
1da177e4 | 499 | */ |
1da177e4 | 500 | void |
4be44fcd LB |
501 | acpi_ut_push_generic_state(union acpi_generic_state **list_head, |
502 | union acpi_generic_state *state); | |
1da177e4 | 503 | |
4be44fcd LB |
504 | union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state |
505 | **list_head); | |
1da177e4 | 506 | |
4be44fcd | 507 | union acpi_generic_state *acpi_ut_create_generic_state(void); |
1da177e4 | 508 | |
4be44fcd | 509 | struct acpi_thread_state *acpi_ut_create_thread_state(void); |
1da177e4 | 510 | |
4be44fcd LB |
511 | union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object |
512 | *object, u16 action); | |
1da177e4 | 513 | |
4be44fcd LB |
514 | union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object, |
515 | void *external_object, | |
516 | u16 index); | |
1da177e4 LT |
517 | |
518 | acpi_status | |
4be44fcd LB |
519 | acpi_ut_create_update_state_and_push(union acpi_operand_object *object, |
520 | u16 action, | |
521 | union acpi_generic_state **state_list); | |
1da177e4 | 522 | |
44f6c012 | 523 | #ifdef ACPI_FUTURE_USAGE |
1da177e4 | 524 | acpi_status |
4be44fcd LB |
525 | acpi_ut_create_pkg_state_and_push(void *internal_object, |
526 | void *external_object, | |
527 | u16 index, | |
528 | union acpi_generic_state **state_list); | |
529 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 | 530 | |
4be44fcd | 531 | union acpi_generic_state *acpi_ut_create_control_state(void); |
1da177e4 | 532 | |
4be44fcd | 533 | void acpi_ut_delete_generic_state(union acpi_generic_state *state); |
44f6c012 | 534 | |
1da177e4 | 535 | /* |
44f6c012 | 536 | * utmath |
1da177e4 | 537 | */ |
1da177e4 | 538 | acpi_status |
5df7e6cb BM |
539 | acpi_ut_divide(u64 in_dividend, |
540 | u64 in_divisor, u64 *out_quotient, u64 *out_remainder); | |
1da177e4 LT |
541 | |
542 | acpi_status | |
5df7e6cb BM |
543 | acpi_ut_short_divide(u64 in_dividend, |
544 | u32 divisor, u64 *out_quotient, u32 *out_remainder); | |
1da177e4 | 545 | |
44f6c012 RM |
546 | /* |
547 | * utmisc | |
548 | */ | |
ae1b4769 BM |
549 | const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status |
550 | status); | |
84fb2c97 | 551 | |
15b8dd53 BM |
552 | u8 acpi_ut_is_pci_root_bridge(char *id); |
553 | ||
793c2388 BM |
554 | u8 acpi_ut_is_aml_table(struct acpi_table_header *table); |
555 | ||
f9f4601f | 556 | acpi_status |
4be44fcd LB |
557 | acpi_ut_walk_package_tree(union acpi_operand_object *source_object, |
558 | void *target_object, | |
559 | acpi_pkg_callback walk_callback, void *context); | |
44f6c012 | 560 | |
1da177e4 LT |
561 | /* Values for Base above (16=Hex, 10=Decimal) */ |
562 | ||
563 | #define ACPI_ANY_BASE 0 | |
564 | ||
61686124 BM |
565 | u32 acpi_ut_dword_byte_swap(u32 value); |
566 | ||
567 | void acpi_ut_set_integer_width(u8 revision); | |
568 | ||
569 | #ifdef ACPI_DEBUG_OUTPUT | |
570 | void | |
571 | acpi_ut_display_init_pathname(u8 type, | |
572 | struct acpi_namespace_node *obj_handle, | |
573 | char *path); | |
574 | #endif | |
575 | ||
42f8fb75 BM |
576 | /* |
577 | * utownerid - Support for Table/Method Owner IDs | |
578 | */ | |
579 | acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id); | |
580 | ||
581 | void acpi_ut_release_owner_id(acpi_owner_id * owner_id); | |
582 | ||
61686124 BM |
583 | /* |
584 | * utresrc | |
585 | */ | |
586 | acpi_status | |
886308ec BM |
587 | acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state, |
588 | u8 *aml, | |
61686124 | 589 | acpi_size aml_length, |
fd350943 LB |
590 | acpi_walk_aml_callback user_function, |
591 | void **context); | |
61686124 | 592 | |
886308ec BM |
593 | acpi_status |
594 | acpi_ut_validate_resource(struct acpi_walk_state *walk_state, | |
595 | void *aml, u8 *return_index); | |
96db255c | 596 | |
0897831b BM |
597 | u32 acpi_ut_get_descriptor_length(void *aml); |
598 | ||
599 | u16 acpi_ut_get_resource_length(void *aml); | |
600 | ||
96db255c BM |
601 | u8 acpi_ut_get_resource_header_length(void *aml); |
602 | ||
0897831b BM |
603 | u8 acpi_ut_get_resource_type(void *aml); |
604 | ||
96db255c | 605 | acpi_status |
6d33b6be | 606 | acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag); |
1da177e4 | 607 | |
42f8fb75 BM |
608 | /* |
609 | * utstring - String and character utilities | |
610 | */ | |
611 | void acpi_ut_strupr(char *src_string); | |
612 | ||
613 | void acpi_ut_strlwr(char *src_string); | |
614 | ||
615 | int acpi_ut_stricmp(char *string1, char *string2); | |
616 | ||
617 | acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer); | |
618 | ||
619 | void acpi_ut_print_string(char *string, u8 max_length); | |
620 | ||
621 | void ut_convert_backslashes(char *pathname); | |
622 | ||
623 | u8 acpi_ut_valid_acpi_name(u32 name); | |
624 | ||
625 | u8 acpi_ut_valid_acpi_char(char character, u32 position); | |
626 | ||
627 | void acpi_ut_repair_name(char *name); | |
628 | ||
1da177e4 | 629 | /* |
73459f73 | 630 | * utmutex - mutex support |
1da177e4 | 631 | */ |
4be44fcd | 632 | acpi_status acpi_ut_mutex_initialize(void); |
1da177e4 | 633 | |
4be44fcd | 634 | void acpi_ut_mutex_terminate(void); |
73459f73 | 635 | |
4be44fcd | 636 | acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id); |
73459f73 | 637 | |
4be44fcd | 638 | acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id); |
73459f73 RM |
639 | |
640 | /* | |
641 | * utalloc - memory allocation and object caching | |
642 | */ | |
4be44fcd | 643 | acpi_status acpi_ut_create_caches(void); |
73459f73 | 644 | |
4be44fcd | 645 | acpi_status acpi_ut_delete_caches(void); |
1da177e4 | 646 | |
4be44fcd | 647 | acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer); |
1da177e4 LT |
648 | |
649 | acpi_status | |
4be44fcd LB |
650 | acpi_ut_initialize_buffer(struct acpi_buffer *buffer, |
651 | acpi_size required_length); | |
652 | ||
4b8ed631 BM |
653 | void *acpi_ut_allocate(acpi_size size, |
654 | u32 component, const char *module, u32 line); | |
4be44fcd | 655 | |
61686124 | 656 | void *acpi_ut_allocate_zeroed(acpi_size size, |
4b8ed631 | 657 | u32 component, const char *module, u32 line); |
1da177e4 | 658 | |
1da177e4 | 659 | #ifdef ACPI_DBG_TRACK_ALLOCATIONS |
4be44fcd | 660 | void *acpi_ut_allocate_and_track(acpi_size size, |
4b8ed631 | 661 | u32 component, const char *module, u32 line); |
4be44fcd | 662 | |
61686124 | 663 | void *acpi_ut_allocate_zeroed_and_track(acpi_size size, |
4b8ed631 BM |
664 | u32 component, |
665 | const char *module, u32 line); | |
1da177e4 LT |
666 | |
667 | void | |
4b8ed631 BM |
668 | acpi_ut_free_and_track(void *address, |
669 | u32 component, const char *module, u32 line); | |
1da177e4 | 670 | |
44f6c012 | 671 | #ifdef ACPI_FUTURE_USAGE |
4be44fcd LB |
672 | void acpi_ut_dump_allocation_info(void); |
673 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 | 674 | |
4b8ed631 | 675 | void acpi_ut_dump_allocations(u32 component, const char *module); |
61686124 BM |
676 | |
677 | acpi_status | |
678 | acpi_ut_create_list(char *list_name, | |
679 | u16 object_size, struct acpi_memory_list **return_cache); | |
680 | ||
cc84e262 BM |
681 | #endif /* ACPI_DBG_TRACK_ALLOCATIONS */ |
682 | ||
f654c0fe LM |
683 | /* |
684 | * utaddress - address range check | |
685 | */ | |
686 | acpi_status | |
687 | acpi_ut_add_address_range(acpi_adr_space_type space_id, | |
688 | acpi_physical_address address, | |
689 | u32 length, struct acpi_namespace_node *region_node); | |
690 | ||
691 | void | |
692 | acpi_ut_remove_address_range(acpi_adr_space_type space_id, | |
693 | struct acpi_namespace_node *region_node); | |
694 | ||
695 | u32 | |
696 | acpi_ut_check_address_range(acpi_adr_space_type space_id, | |
697 | acpi_physical_address address, u32 length, u8 warn); | |
698 | ||
699 | void acpi_ut_delete_address_lists(void); | |
700 | ||
cc84e262 BM |
701 | /* |
702 | * utxferror - various error/warning output functions | |
703 | */ | |
704 | void ACPI_INTERNAL_VAR_XFACE | |
705 | acpi_ut_predefined_warning(const char *module_name, | |
706 | u32 line_number, | |
707 | char *pathname, | |
708 | u8 node_flags, const char *format, ...); | |
709 | ||
710 | void ACPI_INTERNAL_VAR_XFACE | |
711 | acpi_ut_predefined_info(const char *module_name, | |
712 | u32 line_number, | |
713 | char *pathname, u8 node_flags, const char *format, ...); | |
714 | ||
e1405ca5 BM |
715 | void ACPI_INTERNAL_VAR_XFACE |
716 | acpi_ut_predefined_bios_error(const char *module_name, | |
717 | u32 line_number, | |
718 | char *pathname, | |
719 | u8 node_flags, const char *format, ...); | |
720 | ||
cc84e262 BM |
721 | void |
722 | acpi_ut_namespace_error(const char *module_name, | |
723 | u32 line_number, | |
724 | const char *internal_name, acpi_status lookup_status); | |
725 | ||
726 | void | |
727 | acpi_ut_method_error(const char *module_name, | |
728 | u32 line_number, | |
729 | const char *message, | |
730 | struct acpi_namespace_node *node, | |
731 | const char *path, acpi_status lookup_status); | |
1da177e4 | 732 | |
4be44fcd | 733 | #endif /* _ACUTILS_H */ |