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