Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
25f044e6 | 8 | * Copyright (C) 2000 - 2013, Intel Corp. |
1da177e4 LT |
9 | * All rights reserved. |
10 | * | |
11 | * Redistribution and use in source and binary forms, with or without | |
12 | * modification, are permitted provided that the following conditions | |
13 | * are met: | |
14 | * 1. Redistributions of source code must retain the above copyright | |
15 | * notice, this list of conditions, and the following disclaimer, | |
16 | * without modification. | |
17 | * 2. Redistributions in binary form must reproduce at minimum a disclaimer | |
18 | * substantially similar to the "NO WARRANTY" disclaimer below | |
19 | * ("Disclaimer") and any redistribution must be conditioned upon | |
20 | * including a substantially similar Disclaimer requirement for further | |
21 | * binary redistribution. | |
22 | * 3. Neither the names of the above-listed copyright holders nor the names | |
23 | * of any contributors may be used to endorse or promote products derived | |
24 | * from this software without specific prior written permission. | |
25 | * | |
26 | * Alternatively, this software may be distributed under the terms of the | |
27 | * GNU General Public License ("GPL") version 2 as published by the Free | |
28 | * Software Foundation. | |
29 | * | |
30 | * NO WARRANTY | |
31 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
32 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
33 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR | |
34 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
35 | * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
36 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
37 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
38 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
39 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
40 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
41 | * POSSIBILITY OF SUCH DAMAGES. | |
42 | */ | |
43 | ||
44 | #ifndef _ACUTILS_H | |
45 | #define _ACUTILS_H | |
46 | ||
96db255c | 47 | extern const u8 acpi_gbl_resource_aml_sizes[]; |
e0fe0a8d | 48 | extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[]; |
96db255c | 49 | |
defba1d8 BM |
50 | /* Strings used by the disassembler and debugger resource dump routines */ |
51 | ||
52 | #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER) | |
53 | ||
b229cf92 BM |
54 | extern const char *acpi_gbl_bm_decode[]; |
55 | extern const char *acpi_gbl_config_decode[]; | |
56 | extern const char *acpi_gbl_consume_decode[]; | |
57 | extern const char *acpi_gbl_dec_decode[]; | |
58 | extern const char *acpi_gbl_he_decode[]; | |
59 | extern const char *acpi_gbl_io_decode[]; | |
60 | extern const char *acpi_gbl_ll_decode[]; | |
61 | extern const char *acpi_gbl_max_decode[]; | |
62 | extern const char *acpi_gbl_mem_decode[]; | |
63 | extern const char *acpi_gbl_min_decode[]; | |
64 | extern const char *acpi_gbl_mtp_decode[]; | |
65 | extern const char *acpi_gbl_rng_decode[]; | |
66 | extern const char *acpi_gbl_rw_decode[]; | |
67 | extern const char *acpi_gbl_shr_decode[]; | |
68 | extern const char *acpi_gbl_siz_decode[]; | |
69 | extern const char *acpi_gbl_trs_decode[]; | |
70 | extern const char *acpi_gbl_ttp_decode[]; | |
71 | extern const char *acpi_gbl_typ_decode[]; | |
6d33b6be LZ |
72 | extern const char *acpi_gbl_ppc_decode[]; |
73 | extern const char *acpi_gbl_ior_decode[]; | |
74 | extern const char *acpi_gbl_dts_decode[]; | |
75 | extern const char *acpi_gbl_ct_decode[]; | |
76 | extern const char *acpi_gbl_sbt_decode[]; | |
77 | extern const char *acpi_gbl_am_decode[]; | |
78 | extern const char *acpi_gbl_sm_decode[]; | |
79 | extern const char *acpi_gbl_wm_decode[]; | |
80 | extern const char *acpi_gbl_cph_decode[]; | |
81 | extern const char *acpi_gbl_cpo_decode[]; | |
82 | extern const char *acpi_gbl_dp_decode[]; | |
83 | extern const char *acpi_gbl_ed_decode[]; | |
84 | extern const char *acpi_gbl_bpb_decode[]; | |
85 | extern const char *acpi_gbl_sb_decode[]; | |
86 | extern const char *acpi_gbl_fc_decode[]; | |
87 | extern const char *acpi_gbl_pt_decode[]; | |
defba1d8 BM |
88 | #endif |
89 | ||
96db255c BM |
90 | /* Types for Resource descriptor entries */ |
91 | ||
92 | #define ACPI_INVALID_RESOURCE 0 | |
93 | #define ACPI_FIXED_LENGTH 1 | |
94 | #define ACPI_VARIABLE_LENGTH 2 | |
95 | #define ACPI_SMALL_VARIABLE_LENGTH 3 | |
96 | ||
61686124 | 97 | typedef |
6d33b6be | 98 | acpi_status(*acpi_walk_aml_callback) (u8 *aml, |
61686124 BM |
99 | u32 length, |
100 | u32 offset, | |
b229cf92 | 101 | u8 resource_index, void **context); |
61686124 | 102 | |
1da177e4 | 103 | typedef |
4be44fcd | 104 | acpi_status(*acpi_pkg_callback) (u8 object_type, |
6d33b6be | 105 | union acpi_operand_object *source_object, |
4be44fcd LB |
106 | union acpi_generic_state * state, |
107 | void *context); | |
108 | ||
109 | struct acpi_pkg_info { | |
110 | u8 *free_space; | |
111 | acpi_size length; | |
112 | u32 object_space; | |
113 | u32 num_packages; | |
1da177e4 LT |
114 | }; |
115 | ||
60f3deb5 BM |
116 | /* Object reference counts */ |
117 | ||
1da177e4 LT |
118 | #define REF_INCREMENT (u16) 0 |
119 | #define REF_DECREMENT (u16) 1 | |
1da177e4 LT |
120 | |
121 | /* acpi_ut_dump_buffer */ | |
122 | ||
123 | #define DB_BYTE_DISPLAY 1 | |
124 | #define DB_WORD_DISPLAY 2 | |
125 | #define DB_DWORD_DISPLAY 4 | |
126 | #define DB_QWORD_DISPLAY 8 | |
127 | ||
1da177e4 | 128 | /* |
44f6c012 | 129 | * utglobal - Global data structures and procedures |
1da177e4 | 130 | */ |
b417d40b | 131 | acpi_status acpi_ut_init_globals(void); |
1da177e4 | 132 | |
1da177e4 LT |
133 | #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) |
134 | ||
4be44fcd | 135 | char *acpi_ut_get_mutex_name(u32 mutex_id); |
1da177e4 | 136 | |
514d18d7 ZR |
137 | const char *acpi_ut_get_notify_name(u32 notify_value); |
138 | ||
1da177e4 LT |
139 | #endif |
140 | ||
4be44fcd | 141 | char *acpi_ut_get_type_name(acpi_object_type type); |
1da177e4 | 142 | |
4be44fcd | 143 | char *acpi_ut_get_node_name(void *object); |
1da177e4 | 144 | |
4be44fcd | 145 | char *acpi_ut_get_descriptor_name(void *object); |
1da177e4 | 146 | |
f02a99ac BM |
147 | const char *acpi_ut_get_reference_name(union acpi_operand_object *object); |
148 | ||
4be44fcd | 149 | char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc); |
1da177e4 | 150 | |
4be44fcd | 151 | char *acpi_ut_get_region_name(u8 space_id); |
1da177e4 | 152 | |
4be44fcd | 153 | char *acpi_ut_get_event_name(u32 event_id); |
1da177e4 | 154 | |
5df7e6cb | 155 | char acpi_ut_hex_to_ascii_char(u64 integer, u32 position); |
1da177e4 | 156 | |
4be44fcd | 157 | u8 acpi_ut_valid_object_type(acpi_object_type type); |
1da177e4 LT |
158 | |
159 | /* | |
44f6c012 | 160 | * utinit - miscellaneous initialization and shutdown |
1da177e4 | 161 | */ |
4be44fcd | 162 | acpi_status acpi_ut_hardware_initialize(void); |
44f6c012 | 163 | |
4be44fcd | 164 | void acpi_ut_subsystem_shutdown(void); |
44f6c012 | 165 | |
44f6c012 RM |
166 | /* |
167 | * utclib - Local implementations of C library functions | |
168 | */ | |
1da177e4 LT |
169 | #ifndef ACPI_USE_SYSTEM_CLIBRARY |
170 | ||
4be44fcd LB |
171 | acpi_size acpi_ut_strlen(const char *string); |
172 | ||
173 | char *acpi_ut_strcpy(char *dst_string, const char *src_string); | |
174 | ||
175 | char *acpi_ut_strncpy(char *dst_string, | |
176 | const char *src_string, acpi_size count); | |
177 | ||
178 | int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count); | |
179 | ||
180 | int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count); | |
181 | ||
182 | int acpi_ut_strcmp(const char *string1, const char *string2); | |
183 | ||
184 | char *acpi_ut_strcat(char *dst_string, const char *src_string); | |
185 | ||
186 | char *acpi_ut_strncat(char *dst_string, | |
187 | const char *src_string, acpi_size count); | |
188 | ||
189 | u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base); | |
190 | ||
191 | char *acpi_ut_strstr(char *string1, char *string2); | |
192 | ||
193 | void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count); | |
194 | ||
67a119f9 | 195 | void *acpi_ut_memset(void *dest, u8 value, acpi_size count); |
4be44fcd LB |
196 | |
197 | int acpi_ut_to_upper(int c); | |
198 | ||
199 | int acpi_ut_to_lower(int c); | |
1da177e4 LT |
200 | |
201 | extern const u8 _acpi_ctype[]; | |
202 | ||
4be44fcd LB |
203 | #define _ACPI_XA 0x00 /* extra alphabetic - not supported */ |
204 | #define _ACPI_XS 0x40 /* extra space */ | |
205 | #define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */ | |
206 | #define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */ | |
207 | #define _ACPI_DI 0x04 /* '0'-'9' */ | |
208 | #define _ACPI_LO 0x02 /* 'a'-'z' */ | |
209 | #define _ACPI_PU 0x10 /* punctuation */ | |
210 | #define _ACPI_SP 0x08 /* space */ | |
211 | #define _ACPI_UP 0x01 /* 'A'-'Z' */ | |
212 | #define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */ | |
1da177e4 LT |
213 | |
214 | #define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI)) | |
215 | #define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP)) | |
216 | #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD)) | |
217 | #define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP)) | |
218 | #define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO)) | |
219 | #define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU)) | |
220 | #define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP)) | |
1da177e4 | 221 | |
6d33b6be LZ |
222 | #endif /* !ACPI_USE_SYSTEM_CLIBRARY */ |
223 | ||
224 | #define ACPI_IS_ASCII(c) ((c) < 0x80) | |
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, | |
4b8ed631 | 276 | const char *module_name, u32 component_id, void *pointer); |
1da177e4 LT |
277 | |
278 | void | |
4be44fcd LB |
279 | acpi_ut_trace_u32(u32 line_number, |
280 | const char *function_name, | |
4b8ed631 | 281 | const char *module_name, u32 component_id, u32 integer); |
1da177e4 LT |
282 | |
283 | void | |
4be44fcd LB |
284 | acpi_ut_trace_str(u32 line_number, |
285 | const char *function_name, | |
4b8ed631 | 286 | const char *module_name, u32 component_id, char *string); |
1da177e4 LT |
287 | |
288 | void | |
4be44fcd | 289 | acpi_ut_exit(u32 line_number, |
4b8ed631 BM |
290 | const char *function_name, |
291 | const char *module_name, u32 component_id); | |
1da177e4 LT |
292 | |
293 | void | |
4be44fcd LB |
294 | acpi_ut_status_exit(u32 line_number, |
295 | const char *function_name, | |
4b8ed631 BM |
296 | const char *module_name, |
297 | u32 component_id, acpi_status status); | |
1da177e4 LT |
298 | |
299 | void | |
4be44fcd LB |
300 | acpi_ut_value_exit(u32 line_number, |
301 | const char *function_name, | |
5df7e6cb | 302 | const char *module_name, u32 component_id, u64 value); |
1da177e4 LT |
303 | |
304 | void | |
4be44fcd LB |
305 | acpi_ut_ptr_exit(u32 line_number, |
306 | const char *function_name, | |
4b8ed631 | 307 | const char *module_name, u32 component_id, u8 *ptr); |
1da177e4 | 308 | |
97171c6b BM |
309 | void |
310 | acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id); | |
b8e4d893 | 311 | |
97171c6b | 312 | void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset); |
793c2388 | 313 | |
4a90c7e8 | 314 | void acpi_ut_report_error(char *module_name, u32 line_number); |
1da177e4 | 315 | |
4a90c7e8 | 316 | void acpi_ut_report_info(char *module_name, u32 line_number); |
1da177e4 | 317 | |
4a90c7e8 | 318 | void acpi_ut_report_warning(char *module_name, u32 line_number); |
1da177e4 | 319 | |
1da177e4 | 320 | /* |
44f6c012 | 321 | * utdelete - Object deletion and reference counts |
1da177e4 | 322 | */ |
4be44fcd | 323 | void acpi_ut_add_reference(union acpi_operand_object *object); |
1da177e4 | 324 | |
4be44fcd | 325 | void acpi_ut_remove_reference(union acpi_operand_object *object); |
1da177e4 | 326 | |
4be44fcd | 327 | void acpi_ut_delete_internal_package_object(union acpi_operand_object *object); |
1da177e4 | 328 | |
4be44fcd | 329 | void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object); |
1da177e4 | 330 | |
4be44fcd | 331 | void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list); |
1da177e4 LT |
332 | |
333 | /* | |
44f6c012 | 334 | * uteval - object evaluation |
1da177e4 | 335 | */ |
1da177e4 | 336 | acpi_status |
4be44fcd LB |
337 | acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node, |
338 | char *path, | |
339 | u32 expected_return_btypes, | |
340 | union acpi_operand_object **return_desc); | |
1da177e4 LT |
341 | |
342 | acpi_status | |
4be44fcd LB |
343 | acpi_ut_evaluate_numeric_object(char *object_name, |
344 | struct acpi_namespace_node *device_node, | |
5df7e6cb | 345 | u64 *value); |
1da177e4 LT |
346 | |
347 | acpi_status | |
15b8dd53 | 348 | acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags); |
1da177e4 LT |
349 | |
350 | acpi_status | |
15b8dd53 BM |
351 | acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node, |
352 | const char **method_names, | |
353 | u8 method_count, u8 *out_values); | |
1da177e4 | 354 | |
15b8dd53 BM |
355 | /* |
356 | * utids - device ID support | |
357 | */ | |
1da177e4 | 358 | acpi_status |
15b8dd53 | 359 | acpi_ut_execute_HID(struct acpi_namespace_node *device_node, |
78e25fef | 360 | struct acpi_pnp_device_id ** return_id); |
1da177e4 LT |
361 | |
362 | acpi_status | |
4be44fcd | 363 | acpi_ut_execute_UID(struct acpi_namespace_node *device_node, |
78e25fef | 364 | struct acpi_pnp_device_id ** return_id); |
1da177e4 | 365 | |
413fc3f5 BM |
366 | acpi_status |
367 | acpi_ut_execute_SUB(struct acpi_namespace_node *device_node, | |
368 | struct acpi_pnp_device_id **return_id); | |
369 | ||
1da177e4 | 370 | acpi_status |
15b8dd53 | 371 | acpi_ut_execute_CID(struct acpi_namespace_node *device_node, |
78e25fef | 372 | struct acpi_pnp_device_id_list ** return_cid_list); |
1da177e4 | 373 | |
8a335a23 BM |
374 | /* |
375 | * utlock - reader/writer locks | |
376 | */ | |
377 | acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock); | |
378 | ||
379 | void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock); | |
380 | ||
381 | acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock); | |
382 | ||
383 | acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock); | |
384 | ||
385 | acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock); | |
386 | ||
387 | void acpi_ut_release_write_lock(struct acpi_rw_lock *lock); | |
388 | ||
1da177e4 | 389 | /* |
44f6c012 | 390 | * utobject - internal object create/delete/cache routines |
1da177e4 | 391 | */ |
4b8ed631 BM |
392 | union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char |
393 | *module_name, | |
4be44fcd LB |
394 | u32 line_number, |
395 | u32 component_id, | |
396 | acpi_object_type | |
397 | type); | |
398 | ||
4b8ed631 | 399 | void *acpi_ut_allocate_object_desc_dbg(const char *module_name, |
4be44fcd | 400 | u32 line_number, u32 component_id); |
1da177e4 | 401 | |
f9f4601f RM |
402 | #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t) |
403 | #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT) | |
1da177e4 | 404 | |
4be44fcd | 405 | void acpi_ut_delete_object_desc(union acpi_operand_object *object); |
1da177e4 | 406 | |
4be44fcd | 407 | u8 acpi_ut_valid_internal_object(void *object); |
1da177e4 | 408 | |
6287ee32 BM |
409 | union acpi_operand_object *acpi_ut_create_package_object(u32 count); |
410 | ||
502f7efa BM |
411 | union acpi_operand_object *acpi_ut_create_integer_object(u64 value); |
412 | ||
4be44fcd | 413 | union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size); |
1da177e4 | 414 | |
4be44fcd | 415 | union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size); |
1da177e4 | 416 | |
1da177e4 | 417 | acpi_status |
4be44fcd | 418 | acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length); |
1da177e4 | 419 | |
b0ed7a91 LM |
420 | /* |
421 | * utosi - Support for the _OSI predefined control method | |
422 | */ | |
423 | acpi_status acpi_ut_initialize_interfaces(void); | |
424 | ||
388a9902 | 425 | acpi_status acpi_ut_interface_terminate(void); |
b0ed7a91 LM |
426 | |
427 | acpi_status acpi_ut_install_interface(acpi_string interface_name); | |
428 | ||
429 | acpi_status acpi_ut_remove_interface(acpi_string interface_name); | |
430 | ||
431 | struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name); | |
432 | ||
433 | acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state); | |
434 | ||
c34c82bc BM |
435 | /* |
436 | * utpredef - support for predefined names | |
437 | */ | |
438 | const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union | |
439 | acpi_predefined_info | |
440 | *this_name); | |
441 | ||
442 | const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name); | |
443 | ||
444 | const union acpi_predefined_info *acpi_ut_match_resource_name(char *name); | |
445 | ||
446 | void | |
447 | acpi_ut_display_predefined_method(char *buffer, | |
448 | const union acpi_predefined_info *this_name, | |
449 | u8 multi_line); | |
450 | ||
451 | void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes); | |
452 | ||
453 | u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types); | |
454 | ||
1da177e4 | 455 | /* |
44f6c012 | 456 | * utstate - Generic state creation/cache routines |
1da177e4 | 457 | */ |
1da177e4 | 458 | void |
4be44fcd LB |
459 | acpi_ut_push_generic_state(union acpi_generic_state **list_head, |
460 | union acpi_generic_state *state); | |
1da177e4 | 461 | |
4be44fcd LB |
462 | union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state |
463 | **list_head); | |
1da177e4 | 464 | |
4be44fcd | 465 | union acpi_generic_state *acpi_ut_create_generic_state(void); |
1da177e4 | 466 | |
4be44fcd | 467 | struct acpi_thread_state *acpi_ut_create_thread_state(void); |
1da177e4 | 468 | |
4be44fcd LB |
469 | union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object |
470 | *object, u16 action); | |
1da177e4 | 471 | |
4be44fcd LB |
472 | union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object, |
473 | void *external_object, | |
474 | u16 index); | |
1da177e4 LT |
475 | |
476 | acpi_status | |
4be44fcd LB |
477 | acpi_ut_create_update_state_and_push(union acpi_operand_object *object, |
478 | u16 action, | |
479 | union acpi_generic_state **state_list); | |
1da177e4 | 480 | |
44f6c012 | 481 | #ifdef ACPI_FUTURE_USAGE |
1da177e4 | 482 | acpi_status |
4be44fcd LB |
483 | acpi_ut_create_pkg_state_and_push(void *internal_object, |
484 | void *external_object, | |
485 | u16 index, | |
486 | union acpi_generic_state **state_list); | |
487 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 | 488 | |
4be44fcd | 489 | union acpi_generic_state *acpi_ut_create_control_state(void); |
1da177e4 | 490 | |
4be44fcd | 491 | void acpi_ut_delete_generic_state(union acpi_generic_state *state); |
44f6c012 | 492 | |
1da177e4 | 493 | /* |
44f6c012 | 494 | * utmath |
1da177e4 | 495 | */ |
1da177e4 | 496 | acpi_status |
5df7e6cb BM |
497 | acpi_ut_divide(u64 in_dividend, |
498 | u64 in_divisor, u64 *out_quotient, u64 *out_remainder); | |
1da177e4 LT |
499 | |
500 | acpi_status | |
5df7e6cb BM |
501 | acpi_ut_short_divide(u64 in_dividend, |
502 | u32 divisor, u64 *out_quotient, u32 *out_remainder); | |
1da177e4 | 503 | |
44f6c012 RM |
504 | /* |
505 | * utmisc | |
506 | */ | |
ae1b4769 BM |
507 | const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status |
508 | status); | |
84fb2c97 | 509 | |
15b8dd53 BM |
510 | u8 acpi_ut_is_pci_root_bridge(char *id); |
511 | ||
793c2388 BM |
512 | u8 acpi_ut_is_aml_table(struct acpi_table_header *table); |
513 | ||
f9f4601f | 514 | acpi_status |
4be44fcd LB |
515 | acpi_ut_walk_package_tree(union acpi_operand_object *source_object, |
516 | void *target_object, | |
517 | acpi_pkg_callback walk_callback, void *context); | |
44f6c012 | 518 | |
1da177e4 LT |
519 | /* Values for Base above (16=Hex, 10=Decimal) */ |
520 | ||
521 | #define ACPI_ANY_BASE 0 | |
522 | ||
61686124 BM |
523 | u32 acpi_ut_dword_byte_swap(u32 value); |
524 | ||
525 | void acpi_ut_set_integer_width(u8 revision); | |
526 | ||
527 | #ifdef ACPI_DEBUG_OUTPUT | |
528 | void | |
529 | acpi_ut_display_init_pathname(u8 type, | |
530 | struct acpi_namespace_node *obj_handle, | |
531 | char *path); | |
532 | #endif | |
533 | ||
42f8fb75 BM |
534 | /* |
535 | * utownerid - Support for Table/Method Owner IDs | |
536 | */ | |
537 | acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id); | |
538 | ||
539 | void acpi_ut_release_owner_id(acpi_owner_id * owner_id); | |
540 | ||
61686124 BM |
541 | /* |
542 | * utresrc | |
543 | */ | |
544 | acpi_status | |
886308ec BM |
545 | acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state, |
546 | u8 *aml, | |
61686124 | 547 | acpi_size aml_length, |
fd350943 LB |
548 | acpi_walk_aml_callback user_function, |
549 | void **context); | |
61686124 | 550 | |
886308ec BM |
551 | acpi_status |
552 | acpi_ut_validate_resource(struct acpi_walk_state *walk_state, | |
553 | void *aml, u8 *return_index); | |
96db255c | 554 | |
0897831b BM |
555 | u32 acpi_ut_get_descriptor_length(void *aml); |
556 | ||
557 | u16 acpi_ut_get_resource_length(void *aml); | |
558 | ||
96db255c BM |
559 | u8 acpi_ut_get_resource_header_length(void *aml); |
560 | ||
0897831b BM |
561 | u8 acpi_ut_get_resource_type(void *aml); |
562 | ||
96db255c | 563 | acpi_status |
6d33b6be | 564 | acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag); |
1da177e4 | 565 | |
42f8fb75 BM |
566 | /* |
567 | * utstring - String and character utilities | |
568 | */ | |
569 | void acpi_ut_strupr(char *src_string); | |
570 | ||
571 | void acpi_ut_strlwr(char *src_string); | |
572 | ||
573 | int acpi_ut_stricmp(char *string1, char *string2); | |
574 | ||
575 | acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer); | |
576 | ||
577 | void acpi_ut_print_string(char *string, u8 max_length); | |
578 | ||
579 | void ut_convert_backslashes(char *pathname); | |
580 | ||
581 | u8 acpi_ut_valid_acpi_name(u32 name); | |
582 | ||
583 | u8 acpi_ut_valid_acpi_char(char character, u32 position); | |
584 | ||
585 | void acpi_ut_repair_name(char *name); | |
586 | ||
1da177e4 | 587 | /* |
73459f73 | 588 | * utmutex - mutex support |
1da177e4 | 589 | */ |
4be44fcd | 590 | acpi_status acpi_ut_mutex_initialize(void); |
1da177e4 | 591 | |
4be44fcd | 592 | void acpi_ut_mutex_terminate(void); |
73459f73 | 593 | |
4be44fcd | 594 | acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id); |
73459f73 | 595 | |
4be44fcd | 596 | acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id); |
73459f73 RM |
597 | |
598 | /* | |
599 | * utalloc - memory allocation and object caching | |
600 | */ | |
4be44fcd | 601 | acpi_status acpi_ut_create_caches(void); |
73459f73 | 602 | |
4be44fcd | 603 | acpi_status acpi_ut_delete_caches(void); |
1da177e4 | 604 | |
4be44fcd | 605 | acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer); |
1da177e4 LT |
606 | |
607 | acpi_status | |
4be44fcd LB |
608 | acpi_ut_initialize_buffer(struct acpi_buffer *buffer, |
609 | acpi_size required_length); | |
610 | ||
4b8ed631 BM |
611 | void *acpi_ut_allocate(acpi_size size, |
612 | u32 component, const char *module, u32 line); | |
4be44fcd | 613 | |
61686124 | 614 | void *acpi_ut_allocate_zeroed(acpi_size size, |
4b8ed631 | 615 | u32 component, const char *module, u32 line); |
1da177e4 | 616 | |
1da177e4 | 617 | #ifdef ACPI_DBG_TRACK_ALLOCATIONS |
4be44fcd | 618 | void *acpi_ut_allocate_and_track(acpi_size size, |
4b8ed631 | 619 | u32 component, const char *module, u32 line); |
4be44fcd | 620 | |
61686124 | 621 | void *acpi_ut_allocate_zeroed_and_track(acpi_size size, |
4b8ed631 BM |
622 | u32 component, |
623 | const char *module, u32 line); | |
1da177e4 LT |
624 | |
625 | void | |
4b8ed631 BM |
626 | acpi_ut_free_and_track(void *address, |
627 | u32 component, const char *module, u32 line); | |
1da177e4 | 628 | |
44f6c012 | 629 | #ifdef ACPI_FUTURE_USAGE |
4be44fcd LB |
630 | void acpi_ut_dump_allocation_info(void); |
631 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 | 632 | |
4b8ed631 | 633 | void acpi_ut_dump_allocations(u32 component, const char *module); |
61686124 BM |
634 | |
635 | acpi_status | |
636 | acpi_ut_create_list(char *list_name, | |
637 | u16 object_size, struct acpi_memory_list **return_cache); | |
638 | ||
cc84e262 BM |
639 | #endif /* ACPI_DBG_TRACK_ALLOCATIONS */ |
640 | ||
f654c0fe LM |
641 | /* |
642 | * utaddress - address range check | |
643 | */ | |
644 | acpi_status | |
645 | acpi_ut_add_address_range(acpi_adr_space_type space_id, | |
646 | acpi_physical_address address, | |
647 | u32 length, struct acpi_namespace_node *region_node); | |
648 | ||
649 | void | |
650 | acpi_ut_remove_address_range(acpi_adr_space_type space_id, | |
651 | struct acpi_namespace_node *region_node); | |
652 | ||
653 | u32 | |
654 | acpi_ut_check_address_range(acpi_adr_space_type space_id, | |
655 | acpi_physical_address address, u32 length, u8 warn); | |
656 | ||
657 | void acpi_ut_delete_address_lists(void); | |
658 | ||
cc84e262 BM |
659 | /* |
660 | * utxferror - various error/warning output functions | |
661 | */ | |
662 | void ACPI_INTERNAL_VAR_XFACE | |
663 | acpi_ut_predefined_warning(const char *module_name, | |
664 | u32 line_number, | |
665 | char *pathname, | |
666 | u8 node_flags, const char *format, ...); | |
667 | ||
668 | void ACPI_INTERNAL_VAR_XFACE | |
669 | acpi_ut_predefined_info(const char *module_name, | |
670 | u32 line_number, | |
671 | char *pathname, u8 node_flags, const char *format, ...); | |
672 | ||
673 | void | |
674 | acpi_ut_namespace_error(const char *module_name, | |
675 | u32 line_number, | |
676 | const char *internal_name, acpi_status lookup_status); | |
677 | ||
678 | void | |
679 | acpi_ut_method_error(const char *module_name, | |
680 | u32 line_number, | |
681 | const char *message, | |
682 | struct acpi_namespace_node *node, | |
683 | const char *path, acpi_status lookup_status); | |
1da177e4 | 684 | |
4be44fcd | 685 | #endif /* _ACUTILS_H */ |