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