Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
c8100dc4 | 8 | * Copyright (C) 2000 - 2016, 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 | ||
3334861b | 52 | #if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER) |
defba1d8 | 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> | |
b6872ff9 BM |
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 | */ | |
b5c0875a | 117 | #ifndef ACPI_MSG_ERROR |
b6872ff9 | 118 | #define ACPI_MSG_ERROR "ACPI Error: " |
b5c0875a LZ |
119 | #endif |
120 | #ifndef ACPI_MSG_EXCEPTION | |
b6872ff9 | 121 | #define ACPI_MSG_EXCEPTION "ACPI Exception: " |
b5c0875a LZ |
122 | #endif |
123 | #ifndef ACPI_MSG_WARNING | |
b6872ff9 | 124 | #define ACPI_MSG_WARNING "ACPI Warning: " |
b5c0875a LZ |
125 | #endif |
126 | #ifndef ACPI_MSG_INFO | |
b6872ff9 | 127 | #define ACPI_MSG_INFO "ACPI: " |
b5c0875a | 128 | #endif |
b6872ff9 | 129 | |
b5c0875a | 130 | #ifndef ACPI_MSG_BIOS_ERROR |
b6872ff9 | 131 | #define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): " |
b5c0875a LZ |
132 | #endif |
133 | #ifndef ACPI_MSG_BIOS_WARNING | |
b6872ff9 | 134 | #define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): " |
b5c0875a | 135 | #endif |
b6872ff9 BM |
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 | ||
96db255c BM |
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 | ||
61686124 | 150 | typedef |
f5c1e1c5 LZ |
151 | acpi_status (*acpi_walk_aml_callback) (u8 *aml, |
152 | u32 length, | |
153 | u32 offset, | |
154 | u8 resource_index, void **context); | |
61686124 | 155 | |
1da177e4 | 156 | typedef |
f5c1e1c5 LZ |
157 | acpi_status (*acpi_pkg_callback) (u8 object_type, |
158 | union acpi_operand_object * source_object, | |
159 | union acpi_generic_state * state, | |
160 | void *context); | |
4be44fcd LB |
161 | |
162 | struct acpi_pkg_info { | |
163 | u8 *free_space; | |
164 | acpi_size length; | |
165 | u32 object_space; | |
166 | u32 num_packages; | |
1da177e4 LT |
167 | }; |
168 | ||
60f3deb5 BM |
169 | /* Object reference counts */ |
170 | ||
1da177e4 LT |
171 | #define REF_INCREMENT (u16) 0 |
172 | #define REF_DECREMENT (u16) 1 | |
1da177e4 LT |
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 | ||
6a0df32c BM |
181 | /* |
182 | * utascii - ASCII utilities | |
183 | */ | |
184 | u8 acpi_ut_valid_nameseg(char *signature); | |
185 | ||
186 | u8 acpi_ut_valid_name_char(char character, u32 position); | |
187 | ||
188 | void acpi_ut_check_and_repair_ascii(u8 *name, char *repaired_name, u32 count); | |
189 | ||
27629196 BM |
190 | /* |
191 | * utnonansi - Non-ANSI C library functions | |
192 | */ | |
193 | void acpi_ut_strupr(char *src_string); | |
194 | ||
195 | void acpi_ut_strlwr(char *src_string); | |
196 | ||
197 | int acpi_ut_stricmp(char *string1, char *string2); | |
198 | ||
3a05be75 BM |
199 | acpi_status |
200 | acpi_ut_strtoul64(char *string, | |
201 | u32 base, u32 max_integer_byte_width, u64 *ret_integer); | |
202 | ||
203 | /* Values for max_integer_byte_width above */ | |
204 | ||
205 | #define ACPI_MAX32_BYTE_WIDTH 4 | |
206 | #define ACPI_MAX64_BYTE_WIDTH 8 | |
27629196 | 207 | |
1da177e4 | 208 | /* |
44f6c012 | 209 | * utglobal - Global data structures and procedures |
1da177e4 | 210 | */ |
b417d40b | 211 | acpi_status acpi_ut_init_globals(void); |
1da177e4 | 212 | |
1da177e4 LT |
213 | #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) |
214 | ||
c118abc5 | 215 | const char *acpi_ut_get_mutex_name(u32 mutex_id); |
1da177e4 | 216 | |
06a63e33 | 217 | const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type); |
1da177e4 LT |
218 | #endif |
219 | ||
c118abc5 | 220 | const char *acpi_ut_get_type_name(acpi_object_type type); |
1da177e4 | 221 | |
c118abc5 | 222 | const char *acpi_ut_get_node_name(void *object); |
1da177e4 | 223 | |
c118abc5 | 224 | const char *acpi_ut_get_descriptor_name(void *object); |
1da177e4 | 225 | |
f02a99ac BM |
226 | const char *acpi_ut_get_reference_name(union acpi_operand_object *object); |
227 | ||
c118abc5 | 228 | const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc); |
1da177e4 | 229 | |
c118abc5 | 230 | const char *acpi_ut_get_region_name(u8 space_id); |
1da177e4 | 231 | |
c118abc5 | 232 | const char *acpi_ut_get_event_name(u32 event_id); |
1da177e4 | 233 | |
5df7e6cb | 234 | char acpi_ut_hex_to_ascii_char(u64 integer, u32 position); |
1da177e4 | 235 | |
73bbca04 BM |
236 | u8 acpi_ut_ascii_char_to_hex(int hex_char); |
237 | ||
4be44fcd | 238 | u8 acpi_ut_valid_object_type(acpi_object_type type); |
1da177e4 LT |
239 | |
240 | /* | |
44f6c012 | 241 | * utinit - miscellaneous initialization and shutdown |
1da177e4 | 242 | */ |
4be44fcd | 243 | acpi_status acpi_ut_hardware_initialize(void); |
44f6c012 | 244 | |
4be44fcd | 245 | void acpi_ut_subsystem_shutdown(void); |
44f6c012 | 246 | |
1da177e4 | 247 | /* |
44f6c012 | 248 | * utcopy - Object construction and conversion interfaces |
1da177e4 | 249 | */ |
1da177e4 | 250 | acpi_status |
4be44fcd LB |
251 | acpi_ut_build_simple_object(union acpi_operand_object *obj, |
252 | union acpi_object *user_obj, | |
6d33b6be | 253 | u8 *data_space, u32 *buffer_space_used); |
1da177e4 LT |
254 | |
255 | acpi_status | |
4be44fcd | 256 | acpi_ut_build_package_object(union acpi_operand_object *obj, |
6d33b6be | 257 | u8 *buffer, u32 *space_used); |
1da177e4 | 258 | |
1da177e4 | 259 | acpi_status |
4be44fcd LB |
260 | acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj, |
261 | struct acpi_buffer *ret_buffer); | |
1da177e4 | 262 | |
1da177e4 | 263 | acpi_status |
4be44fcd LB |
264 | acpi_ut_copy_eobject_to_iobject(union acpi_object *obj, |
265 | union acpi_operand_object **internal_obj); | |
1da177e4 LT |
266 | |
267 | acpi_status | |
4be44fcd LB |
268 | acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj, |
269 | union acpi_operand_object *dest_obj); | |
1da177e4 | 270 | |
1da177e4 | 271 | acpi_status |
4be44fcd LB |
272 | acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc, |
273 | union acpi_operand_object **dest_desc, | |
274 | struct acpi_walk_state *walk_state); | |
1da177e4 LT |
275 | |
276 | /* | |
44f6c012 | 277 | * utcreate - Object creation |
1da177e4 | 278 | */ |
1da177e4 | 279 | acpi_status |
4be44fcd | 280 | acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action); |
1da177e4 LT |
281 | |
282 | /* | |
44f6c012 | 283 | * utdebug - Debug interfaces |
1da177e4 | 284 | */ |
4be44fcd | 285 | void acpi_ut_init_stack_ptr_trace(void); |
1da177e4 | 286 | |
4be44fcd | 287 | void acpi_ut_track_stack_ptr(void); |
1da177e4 LT |
288 | |
289 | void | |
4be44fcd | 290 | acpi_ut_trace(u32 line_number, |
4b8ed631 BM |
291 | const char *function_name, |
292 | const char *module_name, u32 component_id); | |
1da177e4 LT |
293 | |
294 | void | |
4be44fcd LB |
295 | acpi_ut_trace_ptr(u32 line_number, |
296 | const char *function_name, | |
0dfaaa3d BM |
297 | const char *module_name, |
298 | u32 component_id, const void *pointer); | |
1da177e4 LT |
299 | |
300 | void | |
4be44fcd LB |
301 | acpi_ut_trace_u32(u32 line_number, |
302 | const char *function_name, | |
4b8ed631 | 303 | const char *module_name, u32 component_id, u32 integer); |
1da177e4 LT |
304 | |
305 | void | |
4be44fcd LB |
306 | acpi_ut_trace_str(u32 line_number, |
307 | const char *function_name, | |
0dfaaa3d BM |
308 | const char *module_name, |
309 | u32 component_id, const char *string); | |
1da177e4 LT |
310 | |
311 | void | |
4be44fcd | 312 | acpi_ut_exit(u32 line_number, |
4b8ed631 BM |
313 | const char *function_name, |
314 | const char *module_name, u32 component_id); | |
1da177e4 LT |
315 | |
316 | void | |
4be44fcd LB |
317 | acpi_ut_status_exit(u32 line_number, |
318 | const char *function_name, | |
4b8ed631 BM |
319 | const char *module_name, |
320 | u32 component_id, acpi_status status); | |
1da177e4 LT |
321 | |
322 | void | |
4be44fcd LB |
323 | acpi_ut_value_exit(u32 line_number, |
324 | const char *function_name, | |
5df7e6cb | 325 | const char *module_name, u32 component_id, u64 value); |
1da177e4 LT |
326 | |
327 | void | |
4be44fcd LB |
328 | acpi_ut_ptr_exit(u32 line_number, |
329 | const char *function_name, | |
4b8ed631 | 330 | const char *module_name, u32 component_id, u8 *ptr); |
1da177e4 | 331 | |
4857a94d JK |
332 | void |
333 | acpi_ut_str_exit(u32 line_number, | |
334 | const char *function_name, | |
335 | const char *module_name, u32 component_id, const char *string); | |
336 | ||
97171c6b BM |
337 | void |
338 | acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id); | |
b8e4d893 | 339 | |
97171c6b | 340 | void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset); |
793c2388 | 341 | |
846d6ef4 LZ |
342 | #ifdef ACPI_APPLICATION |
343 | void | |
344 | acpi_ut_dump_buffer_to_file(ACPI_FILE file, | |
345 | u8 *buffer, | |
346 | u32 count, u32 display, u32 base_offset); | |
347 | #endif | |
348 | ||
4a90c7e8 | 349 | void acpi_ut_report_error(char *module_name, u32 line_number); |
1da177e4 | 350 | |
4a90c7e8 | 351 | void acpi_ut_report_info(char *module_name, u32 line_number); |
1da177e4 | 352 | |
4a90c7e8 | 353 | void acpi_ut_report_warning(char *module_name, u32 line_number); |
1da177e4 | 354 | |
1da177e4 | 355 | /* |
44f6c012 | 356 | * utdelete - Object deletion and reference counts |
1da177e4 | 357 | */ |
4be44fcd | 358 | void acpi_ut_add_reference(union acpi_operand_object *object); |
1da177e4 | 359 | |
4be44fcd | 360 | void acpi_ut_remove_reference(union acpi_operand_object *object); |
1da177e4 | 361 | |
4be44fcd | 362 | void acpi_ut_delete_internal_package_object(union acpi_operand_object *object); |
1da177e4 | 363 | |
4be44fcd | 364 | void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object); |
1da177e4 | 365 | |
4be44fcd | 366 | void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list); |
1da177e4 LT |
367 | |
368 | /* | |
44f6c012 | 369 | * uteval - object evaluation |
1da177e4 | 370 | */ |
1da177e4 | 371 | acpi_status |
4be44fcd | 372 | acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node, |
0dfaaa3d | 373 | const char *path, |
4be44fcd LB |
374 | u32 expected_return_btypes, |
375 | union acpi_operand_object **return_desc); | |
1da177e4 LT |
376 | |
377 | acpi_status | |
0dfaaa3d | 378 | acpi_ut_evaluate_numeric_object(const char *object_name, |
4be44fcd | 379 | struct acpi_namespace_node *device_node, |
5df7e6cb | 380 | u64 *value); |
1da177e4 LT |
381 | |
382 | acpi_status | |
15b8dd53 | 383 | acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags); |
1da177e4 LT |
384 | |
385 | acpi_status | |
15b8dd53 BM |
386 | acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node, |
387 | const char **method_names, | |
388 | u8 method_count, u8 *out_values); | |
1da177e4 | 389 | |
15b8dd53 BM |
390 | /* |
391 | * utids - device ID support | |
392 | */ | |
1da177e4 | 393 | acpi_status |
15b8dd53 | 394 | acpi_ut_execute_HID(struct acpi_namespace_node *device_node, |
78e25fef | 395 | struct acpi_pnp_device_id ** return_id); |
1da177e4 LT |
396 | |
397 | acpi_status | |
4be44fcd | 398 | acpi_ut_execute_UID(struct acpi_namespace_node *device_node, |
78e25fef | 399 | struct acpi_pnp_device_id ** return_id); |
1da177e4 LT |
400 | |
401 | acpi_status | |
15b8dd53 | 402 | acpi_ut_execute_CID(struct acpi_namespace_node *device_node, |
78e25fef | 403 | struct acpi_pnp_device_id_list ** return_cid_list); |
1da177e4 | 404 | |
f65358e5 SS |
405 | acpi_status |
406 | acpi_ut_execute_CLS(struct acpi_namespace_node *device_node, | |
407 | struct acpi_pnp_device_id **return_id); | |
408 | ||
8a335a23 BM |
409 | /* |
410 | * utlock - reader/writer locks | |
411 | */ | |
412 | acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock); | |
413 | ||
414 | void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock); | |
415 | ||
416 | acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock); | |
417 | ||
418 | acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock); | |
419 | ||
420 | acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock); | |
421 | ||
422 | void acpi_ut_release_write_lock(struct acpi_rw_lock *lock); | |
423 | ||
1da177e4 | 424 | /* |
44f6c012 | 425 | * utobject - internal object create/delete/cache routines |
1da177e4 | 426 | */ |
4b8ed631 BM |
427 | union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char |
428 | *module_name, | |
4be44fcd LB |
429 | u32 line_number, |
430 | u32 component_id, | |
431 | acpi_object_type | |
432 | type); | |
433 | ||
4b8ed631 | 434 | void *acpi_ut_allocate_object_desc_dbg(const char *module_name, |
4be44fcd | 435 | u32 line_number, u32 component_id); |
1da177e4 | 436 | |
f9f4601f RM |
437 | #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t) |
438 | #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT) | |
1da177e4 | 439 | |
4be44fcd | 440 | void acpi_ut_delete_object_desc(union acpi_operand_object *object); |
1da177e4 | 441 | |
4be44fcd | 442 | u8 acpi_ut_valid_internal_object(void *object); |
1da177e4 | 443 | |
6287ee32 BM |
444 | union acpi_operand_object *acpi_ut_create_package_object(u32 count); |
445 | ||
502f7efa BM |
446 | union acpi_operand_object *acpi_ut_create_integer_object(u64 value); |
447 | ||
4be44fcd | 448 | union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size); |
1da177e4 | 449 | |
4be44fcd | 450 | union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size); |
1da177e4 | 451 | |
1da177e4 | 452 | acpi_status |
f5c1e1c5 | 453 | acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length); |
1da177e4 | 454 | |
b0ed7a91 LM |
455 | /* |
456 | * utosi - Support for the _OSI predefined control method | |
457 | */ | |
458 | acpi_status acpi_ut_initialize_interfaces(void); | |
459 | ||
388a9902 | 460 | acpi_status acpi_ut_interface_terminate(void); |
b0ed7a91 LM |
461 | |
462 | acpi_status acpi_ut_install_interface(acpi_string interface_name); | |
463 | ||
464 | acpi_status acpi_ut_remove_interface(acpi_string interface_name); | |
465 | ||
2cf9f5bc LZ |
466 | acpi_status acpi_ut_update_interfaces(u8 action); |
467 | ||
b0ed7a91 LM |
468 | struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name); |
469 | ||
470 | acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state); | |
471 | ||
c34c82bc BM |
472 | /* |
473 | * utpredef - support for predefined names | |
474 | */ | |
475 | const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union | |
476 | acpi_predefined_info | |
477 | *this_name); | |
478 | ||
479 | const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name); | |
480 | ||
6306bf88 LZ |
481 | void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes); |
482 | ||
483 | #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP) | |
c34c82bc BM |
484 | const union acpi_predefined_info *acpi_ut_match_resource_name(char *name); |
485 | ||
486 | void | |
487 | acpi_ut_display_predefined_method(char *buffer, | |
488 | const union acpi_predefined_info *this_name, | |
489 | u8 multi_line); | |
490 | ||
c34c82bc | 491 | u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types); |
6306bf88 | 492 | #endif |
c34c82bc | 493 | |
1da177e4 | 494 | /* |
44f6c012 | 495 | * utstate - Generic state creation/cache routines |
1da177e4 | 496 | */ |
1da177e4 | 497 | void |
4be44fcd LB |
498 | acpi_ut_push_generic_state(union acpi_generic_state **list_head, |
499 | union acpi_generic_state *state); | |
1da177e4 | 500 | |
4be44fcd LB |
501 | union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state |
502 | **list_head); | |
1da177e4 | 503 | |
4be44fcd | 504 | union acpi_generic_state *acpi_ut_create_generic_state(void); |
1da177e4 | 505 | |
4be44fcd | 506 | struct acpi_thread_state *acpi_ut_create_thread_state(void); |
1da177e4 | 507 | |
4be44fcd LB |
508 | union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object |
509 | *object, u16 action); | |
1da177e4 | 510 | |
4be44fcd LB |
511 | union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object, |
512 | void *external_object, | |
513 | u16 index); | |
1da177e4 LT |
514 | |
515 | acpi_status | |
4be44fcd LB |
516 | acpi_ut_create_update_state_and_push(union acpi_operand_object *object, |
517 | u16 action, | |
518 | union acpi_generic_state **state_list); | |
1da177e4 | 519 | |
4be44fcd | 520 | union acpi_generic_state *acpi_ut_create_control_state(void); |
1da177e4 | 521 | |
4be44fcd | 522 | void acpi_ut_delete_generic_state(union acpi_generic_state *state); |
44f6c012 | 523 | |
1da177e4 | 524 | /* |
44f6c012 | 525 | * utmath |
1da177e4 | 526 | */ |
1da177e4 | 527 | acpi_status |
5df7e6cb BM |
528 | acpi_ut_divide(u64 in_dividend, |
529 | u64 in_divisor, u64 *out_quotient, u64 *out_remainder); | |
1da177e4 LT |
530 | |
531 | acpi_status | |
5df7e6cb BM |
532 | acpi_ut_short_divide(u64 in_dividend, |
533 | u32 divisor, u64 *out_quotient, u32 *out_remainder); | |
1da177e4 | 534 | |
44f6c012 RM |
535 | /* |
536 | * utmisc | |
537 | */ | |
ae1b4769 BM |
538 | const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status |
539 | status); | |
84fb2c97 | 540 | |
15b8dd53 BM |
541 | u8 acpi_ut_is_pci_root_bridge(char *id); |
542 | ||
17dd4dcf | 543 | #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP) |
793c2388 | 544 | u8 acpi_ut_is_aml_table(struct acpi_table_header *table); |
6306bf88 | 545 | #endif |
793c2388 | 546 | |
f9f4601f | 547 | acpi_status |
4be44fcd LB |
548 | acpi_ut_walk_package_tree(union acpi_operand_object *source_object, |
549 | void *target_object, | |
550 | acpi_pkg_callback walk_callback, void *context); | |
44f6c012 | 551 | |
1da177e4 LT |
552 | /* Values for Base above (16=Hex, 10=Decimal) */ |
553 | ||
554 | #define ACPI_ANY_BASE 0 | |
555 | ||
61686124 BM |
556 | u32 acpi_ut_dword_byte_swap(u32 value); |
557 | ||
558 | void acpi_ut_set_integer_width(u8 revision); | |
559 | ||
560 | #ifdef ACPI_DEBUG_OUTPUT | |
561 | void | |
562 | acpi_ut_display_init_pathname(u8 type, | |
563 | struct acpi_namespace_node *obj_handle, | |
0dfaaa3d | 564 | const char *path); |
61686124 BM |
565 | #endif |
566 | ||
42f8fb75 BM |
567 | /* |
568 | * utownerid - Support for Table/Method Owner IDs | |
569 | */ | |
f5c1e1c5 | 570 | acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id); |
42f8fb75 | 571 | |
f5c1e1c5 | 572 | void acpi_ut_release_owner_id(acpi_owner_id *owner_id); |
42f8fb75 | 573 | |
61686124 BM |
574 | /* |
575 | * utresrc | |
576 | */ | |
577 | acpi_status | |
886308ec BM |
578 | acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state, |
579 | u8 *aml, | |
61686124 | 580 | acpi_size aml_length, |
fd350943 LB |
581 | acpi_walk_aml_callback user_function, |
582 | void **context); | |
61686124 | 583 | |
886308ec BM |
584 | acpi_status |
585 | acpi_ut_validate_resource(struct acpi_walk_state *walk_state, | |
586 | void *aml, u8 *return_index); | |
96db255c | 587 | |
0897831b BM |
588 | u32 acpi_ut_get_descriptor_length(void *aml); |
589 | ||
590 | u16 acpi_ut_get_resource_length(void *aml); | |
591 | ||
96db255c BM |
592 | u8 acpi_ut_get_resource_header_length(void *aml); |
593 | ||
0897831b BM |
594 | u8 acpi_ut_get_resource_type(void *aml); |
595 | ||
96db255c | 596 | acpi_status |
6d33b6be | 597 | acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag); |
1da177e4 | 598 | |
42f8fb75 BM |
599 | /* |
600 | * utstring - String and character utilities | |
601 | */ | |
0fb3adf8 | 602 | void acpi_ut_print_string(char *string, u16 max_length); |
42f8fb75 | 603 | |
6306bf88 | 604 | #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP |
42f8fb75 | 605 | void ut_convert_backslashes(char *pathname); |
6306bf88 | 606 | #endif |
42f8fb75 | 607 | |
42f8fb75 BM |
608 | void acpi_ut_repair_name(char *name); |
609 | ||
73424473 BM |
610 | #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION) |
611 | u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source); | |
612 | ||
613 | u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source); | |
614 | ||
615 | u8 | |
616 | acpi_ut_safe_strncat(char *dest, | |
617 | acpi_size dest_size, | |
618 | char *source, acpi_size max_transfer_length); | |
619 | #endif | |
620 | ||
1da177e4 | 621 | /* |
73459f73 | 622 | * utmutex - mutex support |
1da177e4 | 623 | */ |
4be44fcd | 624 | acpi_status acpi_ut_mutex_initialize(void); |
1da177e4 | 625 | |
4be44fcd | 626 | void acpi_ut_mutex_terminate(void); |
73459f73 | 627 | |
4be44fcd | 628 | acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id); |
73459f73 | 629 | |
4be44fcd | 630 | acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id); |
73459f73 RM |
631 | |
632 | /* | |
633 | * utalloc - memory allocation and object caching | |
634 | */ | |
4be44fcd | 635 | acpi_status acpi_ut_create_caches(void); |
73459f73 | 636 | |
4be44fcd | 637 | acpi_status acpi_ut_delete_caches(void); |
1da177e4 | 638 | |
4be44fcd | 639 | acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer); |
1da177e4 LT |
640 | |
641 | acpi_status | |
4be44fcd LB |
642 | acpi_ut_initialize_buffer(struct acpi_buffer *buffer, |
643 | acpi_size required_length); | |
644 | ||
1da177e4 | 645 | #ifdef ACPI_DBG_TRACK_ALLOCATIONS |
4be44fcd | 646 | void *acpi_ut_allocate_and_track(acpi_size size, |
4b8ed631 | 647 | u32 component, const char *module, u32 line); |
4be44fcd | 648 | |
61686124 | 649 | void *acpi_ut_allocate_zeroed_and_track(acpi_size size, |
4b8ed631 BM |
650 | u32 component, |
651 | const char *module, u32 line); | |
1da177e4 LT |
652 | |
653 | void | |
4b8ed631 BM |
654 | acpi_ut_free_and_track(void *address, |
655 | u32 component, const char *module, u32 line); | |
1da177e4 | 656 | |
4be44fcd | 657 | void acpi_ut_dump_allocation_info(void); |
1da177e4 | 658 | |
4b8ed631 | 659 | void acpi_ut_dump_allocations(u32 component, const char *module); |
61686124 BM |
660 | |
661 | acpi_status | |
0dfaaa3d | 662 | acpi_ut_create_list(const char *list_name, |
61686124 BM |
663 | u16 object_size, struct acpi_memory_list **return_cache); |
664 | ||
cc84e262 BM |
665 | #endif /* ACPI_DBG_TRACK_ALLOCATIONS */ |
666 | ||
f654c0fe LM |
667 | /* |
668 | * utaddress - address range check | |
669 | */ | |
670 | acpi_status | |
671 | acpi_ut_add_address_range(acpi_adr_space_type space_id, | |
672 | acpi_physical_address address, | |
673 | u32 length, struct acpi_namespace_node *region_node); | |
674 | ||
675 | void | |
676 | acpi_ut_remove_address_range(acpi_adr_space_type space_id, | |
677 | struct acpi_namespace_node *region_node); | |
678 | ||
679 | u32 | |
680 | acpi_ut_check_address_range(acpi_adr_space_type space_id, | |
681 | acpi_physical_address address, u32 length, u8 warn); | |
682 | ||
683 | void acpi_ut_delete_address_lists(void); | |
684 | ||
cc84e262 BM |
685 | /* |
686 | * utxferror - various error/warning output functions | |
687 | */ | |
688 | void ACPI_INTERNAL_VAR_XFACE | |
689 | acpi_ut_predefined_warning(const char *module_name, | |
690 | u32 line_number, | |
691 | char *pathname, | |
692 | u8 node_flags, const char *format, ...); | |
693 | ||
694 | void ACPI_INTERNAL_VAR_XFACE | |
695 | acpi_ut_predefined_info(const char *module_name, | |
696 | u32 line_number, | |
697 | char *pathname, u8 node_flags, const char *format, ...); | |
698 | ||
e1405ca5 BM |
699 | void ACPI_INTERNAL_VAR_XFACE |
700 | acpi_ut_predefined_bios_error(const char *module_name, | |
701 | u32 line_number, | |
702 | char *pathname, | |
703 | u8 node_flags, const char *format, ...); | |
704 | ||
cc84e262 BM |
705 | void |
706 | acpi_ut_namespace_error(const char *module_name, | |
707 | u32 line_number, | |
708 | const char *internal_name, acpi_status lookup_status); | |
709 | ||
710 | void | |
711 | acpi_ut_method_error(const char *module_name, | |
712 | u32 line_number, | |
713 | const char *message, | |
714 | struct acpi_namespace_node *node, | |
715 | const char *path, acpi_status lookup_status); | |
1da177e4 | 716 | |
b944b29c BM |
717 | /* |
718 | * Utility functions for ACPI names and IDs | |
719 | */ | |
720 | const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg); | |
721 | ||
e2b9035f | 722 | const struct ah_device_id *acpi_ah_match_hardware_id(char *hid); |
b944b29c | 723 | |
73bbca04 BM |
724 | const char *acpi_ah_match_uuid(u8 *data); |
725 | ||
80a648c1 LZ |
726 | /* |
727 | * utprint - printf/vprintf output functions | |
728 | */ | |
729 | const char *acpi_ut_scan_number(const char *string, u64 *number_ptr); | |
730 | ||
731 | const char *acpi_ut_print_number(char *string, u64 number); | |
732 | ||
733 | int | |
734 | acpi_ut_vsnprintf(char *string, | |
735 | acpi_size size, const char *format, va_list args); | |
736 | ||
737 | int acpi_ut_snprintf(char *string, acpi_size size, const char *format, ...); | |
738 | ||
739 | #ifdef ACPI_APPLICATION | |
740 | int acpi_ut_file_vprintf(ACPI_FILE file, const char *format, va_list args); | |
741 | ||
742 | int acpi_ut_file_printf(ACPI_FILE file, const char *format, ...); | |
743 | #endif | |
744 | ||
73bbca04 BM |
745 | /* |
746 | * utuuid -- UUID support functions | |
747 | */ | |
6306bf88 | 748 | #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP) |
73bbca04 | 749 | void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer); |
6306bf88 | 750 | #endif |
73bbca04 | 751 | |
4be44fcd | 752 | #endif /* _ACUTILS_H */ |