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