]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/acpi/acpica/acutils.h
ACPICA: Fix a macro for the hardware-reduced case
[mirror_ubuntu-artful-kernel.git] / drivers / acpi / acpica / acutils.h
CommitLineData
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 47extern const u8 acpi_gbl_resource_aml_sizes[];
e0fe0a8d 48extern 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
54extern const char *acpi_gbl_bm_decode[];
55extern const char *acpi_gbl_config_decode[];
56extern const char *acpi_gbl_consume_decode[];
57extern const char *acpi_gbl_dec_decode[];
58extern const char *acpi_gbl_he_decode[];
59extern const char *acpi_gbl_io_decode[];
60extern const char *acpi_gbl_ll_decode[];
61extern const char *acpi_gbl_max_decode[];
62extern const char *acpi_gbl_mem_decode[];
63extern const char *acpi_gbl_min_decode[];
64extern const char *acpi_gbl_mtp_decode[];
65extern const char *acpi_gbl_rng_decode[];
66extern const char *acpi_gbl_rw_decode[];
67extern const char *acpi_gbl_shr_decode[];
68extern const char *acpi_gbl_siz_decode[];
69extern const char *acpi_gbl_trs_decode[];
70extern const char *acpi_gbl_ttp_decode[];
71extern const char *acpi_gbl_typ_decode[];
6d33b6be
LZ
72extern const char *acpi_gbl_ppc_decode[];
73extern const char *acpi_gbl_ior_decode[];
74extern const char *acpi_gbl_dts_decode[];
75extern const char *acpi_gbl_ct_decode[];
76extern const char *acpi_gbl_sbt_decode[];
77extern const char *acpi_gbl_am_decode[];
78extern const char *acpi_gbl_sm_decode[];
79extern const char *acpi_gbl_wm_decode[];
80extern const char *acpi_gbl_cph_decode[];
81extern const char *acpi_gbl_cpo_decode[];
82extern const char *acpi_gbl_dp_decode[];
83extern const char *acpi_gbl_ed_decode[];
84extern const char *acpi_gbl_bpb_decode[];
85extern const char *acpi_gbl_sb_decode[];
86extern const char *acpi_gbl_fc_decode[];
87extern 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>
98extern FILE *acpi_gbl_output_file;
99
100#define ACPI_MSG_REDIRECT_BEGIN \
101 FILE *output_file = acpi_gbl_output_file; \
102 acpi_os_redirect_output (stderr);
103
104#define ACPI_MSG_REDIRECT_END \
105 acpi_os_redirect_output (output_file);
106
107#else
108/*
109 * non-iASL case - no redirection, nothing to do
110 */
111#define ACPI_MSG_REDIRECT_BEGIN
112#define ACPI_MSG_REDIRECT_END
113#endif
114
115/*
116 * Common error message prefixes
117 */
118#define ACPI_MSG_ERROR "ACPI Error: "
119#define ACPI_MSG_EXCEPTION "ACPI Exception: "
120#define ACPI_MSG_WARNING "ACPI Warning: "
121#define ACPI_MSG_INFO "ACPI: "
122
123#define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): "
124#define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): "
125
126/*
127 * Common message suffix
128 */
129#define ACPI_MSG_SUFFIX \
130 acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
131
96db255c
BM
132/* Types for Resource descriptor entries */
133
134#define ACPI_INVALID_RESOURCE 0
135#define ACPI_FIXED_LENGTH 1
136#define ACPI_VARIABLE_LENGTH 2
137#define ACPI_SMALL_VARIABLE_LENGTH 3
138
61686124 139typedef
6d33b6be 140acpi_status(*acpi_walk_aml_callback) (u8 *aml,
61686124
BM
141 u32 length,
142 u32 offset,
b229cf92 143 u8 resource_index, void **context);
61686124 144
1da177e4 145typedef
4be44fcd 146acpi_status(*acpi_pkg_callback) (u8 object_type,
6d33b6be 147 union acpi_operand_object *source_object,
4be44fcd
LB
148 union acpi_generic_state * state,
149 void *context);
150
151struct acpi_pkg_info {
152 u8 *free_space;
153 acpi_size length;
154 u32 object_space;
155 u32 num_packages;
1da177e4
LT
156};
157
60f3deb5
BM
158/* Object reference counts */
159
1da177e4
LT
160#define REF_INCREMENT (u16) 0
161#define REF_DECREMENT (u16) 1
1da177e4
LT
162
163/* acpi_ut_dump_buffer */
164
165#define DB_BYTE_DISPLAY 1
166#define DB_WORD_DISPLAY 2
167#define DB_DWORD_DISPLAY 4
168#define DB_QWORD_DISPLAY 8
169
1da177e4 170/*
44f6c012 171 * utglobal - Global data structures and procedures
1da177e4 172 */
b417d40b 173acpi_status acpi_ut_init_globals(void);
1da177e4 174
1da177e4
LT
175#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
176
4be44fcd 177char *acpi_ut_get_mutex_name(u32 mutex_id);
1da177e4 178
514d18d7
ZR
179const char *acpi_ut_get_notify_name(u32 notify_value);
180
1da177e4
LT
181#endif
182
4be44fcd 183char *acpi_ut_get_type_name(acpi_object_type type);
1da177e4 184
4be44fcd 185char *acpi_ut_get_node_name(void *object);
1da177e4 186
4be44fcd 187char *acpi_ut_get_descriptor_name(void *object);
1da177e4 188
f02a99ac
BM
189const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
190
4be44fcd 191char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
1da177e4 192
4be44fcd 193char *acpi_ut_get_region_name(u8 space_id);
1da177e4 194
4be44fcd 195char *acpi_ut_get_event_name(u32 event_id);
1da177e4 196
5df7e6cb 197char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
1da177e4 198
4be44fcd 199u8 acpi_ut_valid_object_type(acpi_object_type type);
1da177e4
LT
200
201/*
44f6c012 202 * utinit - miscellaneous initialization and shutdown
1da177e4 203 */
4be44fcd 204acpi_status acpi_ut_hardware_initialize(void);
44f6c012 205
4be44fcd 206void acpi_ut_subsystem_shutdown(void);
44f6c012 207
44f6c012
RM
208/*
209 * utclib - Local implementations of C library functions
210 */
1da177e4
LT
211#ifndef ACPI_USE_SYSTEM_CLIBRARY
212
4be44fcd
LB
213acpi_size acpi_ut_strlen(const char *string);
214
215char *acpi_ut_strcpy(char *dst_string, const char *src_string);
216
217char *acpi_ut_strncpy(char *dst_string,
218 const char *src_string, acpi_size count);
219
220int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
221
222int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
223
224int acpi_ut_strcmp(const char *string1, const char *string2);
225
226char *acpi_ut_strcat(char *dst_string, const char *src_string);
227
228char *acpi_ut_strncat(char *dst_string,
229 const char *src_string, acpi_size count);
230
231u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
232
233char *acpi_ut_strstr(char *string1, char *string2);
234
235void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
236
67a119f9 237void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
4be44fcd
LB
238
239int acpi_ut_to_upper(int c);
240
241int acpi_ut_to_lower(int c);
1da177e4
LT
242
243extern const u8 _acpi_ctype[];
244
4be44fcd
LB
245#define _ACPI_XA 0x00 /* extra alphabetic - not supported */
246#define _ACPI_XS 0x40 /* extra space */
247#define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
248#define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
249#define _ACPI_DI 0x04 /* '0'-'9' */
250#define _ACPI_LO 0x02 /* 'a'-'z' */
251#define _ACPI_PU 0x10 /* punctuation */
252#define _ACPI_SP 0x08 /* space */
253#define _ACPI_UP 0x01 /* 'A'-'Z' */
254#define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
1da177e4
LT
255
256#define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
257#define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
258#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
259#define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
260#define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
261#define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
262#define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
1da177e4 263
6d33b6be
LZ
264#endif /* !ACPI_USE_SYSTEM_CLIBRARY */
265
266#define ACPI_IS_ASCII(c) ((c) < 0x80)
44f6c012 267
1da177e4 268/*
44f6c012 269 * utcopy - Object construction and conversion interfaces
1da177e4 270 */
1da177e4 271acpi_status
4be44fcd
LB
272acpi_ut_build_simple_object(union acpi_operand_object *obj,
273 union acpi_object *user_obj,
6d33b6be 274 u8 *data_space, u32 *buffer_space_used);
1da177e4
LT
275
276acpi_status
4be44fcd 277acpi_ut_build_package_object(union acpi_operand_object *obj,
6d33b6be 278 u8 *buffer, u32 *space_used);
1da177e4 279
1da177e4 280acpi_status
4be44fcd
LB
281acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
282 struct acpi_buffer *ret_buffer);
1da177e4 283
1da177e4 284acpi_status
4be44fcd
LB
285acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
286 union acpi_operand_object **internal_obj);
1da177e4
LT
287
288acpi_status
4be44fcd
LB
289acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
290 union acpi_operand_object *dest_obj);
1da177e4 291
1da177e4 292acpi_status
4be44fcd
LB
293acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
294 union acpi_operand_object **dest_desc,
295 struct acpi_walk_state *walk_state);
1da177e4
LT
296
297/*
44f6c012 298 * utcreate - Object creation
1da177e4 299 */
1da177e4 300acpi_status
4be44fcd 301acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
1da177e4
LT
302
303/*
44f6c012 304 * utdebug - Debug interfaces
1da177e4 305 */
4be44fcd 306void acpi_ut_init_stack_ptr_trace(void);
1da177e4 307
4be44fcd 308void acpi_ut_track_stack_ptr(void);
1da177e4
LT
309
310void
4be44fcd 311acpi_ut_trace(u32 line_number,
4b8ed631
BM
312 const char *function_name,
313 const char *module_name, u32 component_id);
1da177e4
LT
314
315void
4be44fcd
LB
316acpi_ut_trace_ptr(u32 line_number,
317 const char *function_name,
4b8ed631 318 const char *module_name, u32 component_id, void *pointer);
1da177e4
LT
319
320void
4be44fcd
LB
321acpi_ut_trace_u32(u32 line_number,
322 const char *function_name,
4b8ed631 323 const char *module_name, u32 component_id, u32 integer);
1da177e4
LT
324
325void
4be44fcd
LB
326acpi_ut_trace_str(u32 line_number,
327 const char *function_name,
4b8ed631 328 const char *module_name, u32 component_id, char *string);
1da177e4
LT
329
330void
4be44fcd 331acpi_ut_exit(u32 line_number,
4b8ed631
BM
332 const char *function_name,
333 const char *module_name, u32 component_id);
1da177e4
LT
334
335void
4be44fcd
LB
336acpi_ut_status_exit(u32 line_number,
337 const char *function_name,
4b8ed631
BM
338 const char *module_name,
339 u32 component_id, acpi_status status);
1da177e4
LT
340
341void
4be44fcd
LB
342acpi_ut_value_exit(u32 line_number,
343 const char *function_name,
5df7e6cb 344 const char *module_name, u32 component_id, u64 value);
1da177e4
LT
345
346void
4be44fcd
LB
347acpi_ut_ptr_exit(u32 line_number,
348 const char *function_name,
4b8ed631 349 const char *module_name, u32 component_id, u8 *ptr);
1da177e4 350
97171c6b
BM
351void
352acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
b8e4d893 353
97171c6b 354void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
793c2388 355
4a90c7e8 356void acpi_ut_report_error(char *module_name, u32 line_number);
1da177e4 357
4a90c7e8 358void acpi_ut_report_info(char *module_name, u32 line_number);
1da177e4 359
4a90c7e8 360void acpi_ut_report_warning(char *module_name, u32 line_number);
1da177e4 361
1da177e4 362/*
44f6c012 363 * utdelete - Object deletion and reference counts
1da177e4 364 */
4be44fcd 365void acpi_ut_add_reference(union acpi_operand_object *object);
1da177e4 366
4be44fcd 367void acpi_ut_remove_reference(union acpi_operand_object *object);
1da177e4 368
4be44fcd 369void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
1da177e4 370
4be44fcd 371void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
1da177e4 372
4be44fcd 373void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
1da177e4
LT
374
375/*
44f6c012 376 * uteval - object evaluation
1da177e4 377 */
1da177e4 378acpi_status
4be44fcd
LB
379acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
380 char *path,
381 u32 expected_return_btypes,
382 union acpi_operand_object **return_desc);
1da177e4
LT
383
384acpi_status
4be44fcd
LB
385acpi_ut_evaluate_numeric_object(char *object_name,
386 struct acpi_namespace_node *device_node,
5df7e6cb 387 u64 *value);
1da177e4
LT
388
389acpi_status
15b8dd53 390acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
1da177e4
LT
391
392acpi_status
15b8dd53
BM
393acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
394 const char **method_names,
395 u8 method_count, u8 *out_values);
1da177e4 396
15b8dd53
BM
397/*
398 * utids - device ID support
399 */
1da177e4 400acpi_status
15b8dd53 401acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
78e25fef 402 struct acpi_pnp_device_id ** return_id);
1da177e4
LT
403
404acpi_status
4be44fcd 405acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
78e25fef 406 struct acpi_pnp_device_id ** return_id);
1da177e4 407
413fc3f5
BM
408acpi_status
409acpi_ut_execute_SUB(struct acpi_namespace_node *device_node,
410 struct acpi_pnp_device_id **return_id);
411
1da177e4 412acpi_status
15b8dd53 413acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
78e25fef 414 struct acpi_pnp_device_id_list ** return_cid_list);
1da177e4 415
8a335a23
BM
416/*
417 * utlock - reader/writer locks
418 */
419acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
420
421void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
422
423acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
424
425acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
426
427acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
428
429void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
430
1da177e4 431/*
44f6c012 432 * utobject - internal object create/delete/cache routines
1da177e4 433 */
4b8ed631
BM
434union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
435 *module_name,
4be44fcd
LB
436 u32 line_number,
437 u32 component_id,
438 acpi_object_type
439 type);
440
4b8ed631 441void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
4be44fcd 442 u32 line_number, u32 component_id);
1da177e4 443
f9f4601f
RM
444#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
445#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
1da177e4 446
4be44fcd 447void acpi_ut_delete_object_desc(union acpi_operand_object *object);
1da177e4 448
4be44fcd 449u8 acpi_ut_valid_internal_object(void *object);
1da177e4 450
6287ee32
BM
451union acpi_operand_object *acpi_ut_create_package_object(u32 count);
452
502f7efa
BM
453union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
454
4be44fcd 455union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
1da177e4 456
4be44fcd 457union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
1da177e4 458
1da177e4 459acpi_status
4be44fcd 460acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
1da177e4 461
b0ed7a91
LM
462/*
463 * utosi - Support for the _OSI predefined control method
464 */
465acpi_status acpi_ut_initialize_interfaces(void);
466
388a9902 467acpi_status acpi_ut_interface_terminate(void);
b0ed7a91
LM
468
469acpi_status acpi_ut_install_interface(acpi_string interface_name);
470
471acpi_status acpi_ut_remove_interface(acpi_string interface_name);
472
2cf9f5bc
LZ
473acpi_status acpi_ut_update_interfaces(u8 action);
474
b0ed7a91
LM
475struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
476
477acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
478
c34c82bc
BM
479/*
480 * utpredef - support for predefined names
481 */
482const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
483 acpi_predefined_info
484 *this_name);
485
486const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
487
488const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
489
490void
491acpi_ut_display_predefined_method(char *buffer,
492 const union acpi_predefined_info *this_name,
493 u8 multi_line);
494
495void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
496
497u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
498
1da177e4 499/*
44f6c012 500 * utstate - Generic state creation/cache routines
1da177e4 501 */
1da177e4 502void
4be44fcd
LB
503acpi_ut_push_generic_state(union acpi_generic_state **list_head,
504 union acpi_generic_state *state);
1da177e4 505
4be44fcd
LB
506union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
507 **list_head);
1da177e4 508
4be44fcd 509union acpi_generic_state *acpi_ut_create_generic_state(void);
1da177e4 510
4be44fcd 511struct acpi_thread_state *acpi_ut_create_thread_state(void);
1da177e4 512
4be44fcd
LB
513union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
514 *object, u16 action);
1da177e4 515
4be44fcd
LB
516union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
517 void *external_object,
518 u16 index);
1da177e4
LT
519
520acpi_status
4be44fcd
LB
521acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
522 u16 action,
523 union acpi_generic_state **state_list);
1da177e4 524
44f6c012 525#ifdef ACPI_FUTURE_USAGE
1da177e4 526acpi_status
4be44fcd
LB
527acpi_ut_create_pkg_state_and_push(void *internal_object,
528 void *external_object,
529 u16 index,
530 union acpi_generic_state **state_list);
531#endif /* ACPI_FUTURE_USAGE */
1da177e4 532
4be44fcd 533union acpi_generic_state *acpi_ut_create_control_state(void);
1da177e4 534
4be44fcd 535void acpi_ut_delete_generic_state(union acpi_generic_state *state);
44f6c012 536
1da177e4 537/*
44f6c012 538 * utmath
1da177e4 539 */
1da177e4 540acpi_status
5df7e6cb
BM
541acpi_ut_divide(u64 in_dividend,
542 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
1da177e4
LT
543
544acpi_status
5df7e6cb
BM
545acpi_ut_short_divide(u64 in_dividend,
546 u32 divisor, u64 *out_quotient, u32 *out_remainder);
1da177e4 547
44f6c012
RM
548/*
549 * utmisc
550 */
ae1b4769
BM
551const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
552 status);
84fb2c97 553
15b8dd53
BM
554u8 acpi_ut_is_pci_root_bridge(char *id);
555
793c2388
BM
556u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
557
f9f4601f 558acpi_status
4be44fcd
LB
559acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
560 void *target_object,
561 acpi_pkg_callback walk_callback, void *context);
44f6c012 562
1da177e4
LT
563/* Values for Base above (16=Hex, 10=Decimal) */
564
565#define ACPI_ANY_BASE 0
566
61686124
BM
567u32 acpi_ut_dword_byte_swap(u32 value);
568
569void acpi_ut_set_integer_width(u8 revision);
570
571#ifdef ACPI_DEBUG_OUTPUT
572void
573acpi_ut_display_init_pathname(u8 type,
574 struct acpi_namespace_node *obj_handle,
575 char *path);
576#endif
577
42f8fb75
BM
578/*
579 * utownerid - Support for Table/Method Owner IDs
580 */
581acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
582
583void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
584
61686124
BM
585/*
586 * utresrc
587 */
588acpi_status
886308ec
BM
589acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
590 u8 *aml,
61686124 591 acpi_size aml_length,
fd350943
LB
592 acpi_walk_aml_callback user_function,
593 void **context);
61686124 594
886308ec
BM
595acpi_status
596acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
597 void *aml, u8 *return_index);
96db255c 598
0897831b
BM
599u32 acpi_ut_get_descriptor_length(void *aml);
600
601u16 acpi_ut_get_resource_length(void *aml);
602
96db255c
BM
603u8 acpi_ut_get_resource_header_length(void *aml);
604
0897831b
BM
605u8 acpi_ut_get_resource_type(void *aml);
606
96db255c 607acpi_status
6d33b6be 608acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
1da177e4 609
42f8fb75
BM
610/*
611 * utstring - String and character utilities
612 */
613void acpi_ut_strupr(char *src_string);
614
615void acpi_ut_strlwr(char *src_string);
616
617int acpi_ut_stricmp(char *string1, char *string2);
618
619acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer);
620
0fb3adf8 621void acpi_ut_print_string(char *string, u16 max_length);
42f8fb75
BM
622
623void ut_convert_backslashes(char *pathname);
624
de8e7db7 625u8 acpi_ut_valid_acpi_name(char *name);
42f8fb75
BM
626
627u8 acpi_ut_valid_acpi_char(char character, u32 position);
628
629void acpi_ut_repair_name(char *name);
630
1da177e4 631/*
73459f73 632 * utmutex - mutex support
1da177e4 633 */
4be44fcd 634acpi_status acpi_ut_mutex_initialize(void);
1da177e4 635
4be44fcd 636void acpi_ut_mutex_terminate(void);
73459f73 637
4be44fcd 638acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
73459f73 639
4be44fcd 640acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
73459f73
RM
641
642/*
643 * utalloc - memory allocation and object caching
644 */
4be44fcd 645acpi_status acpi_ut_create_caches(void);
73459f73 646
4be44fcd 647acpi_status acpi_ut_delete_caches(void);
1da177e4 648
4be44fcd 649acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
1da177e4
LT
650
651acpi_status
4be44fcd
LB
652acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
653 acpi_size required_length);
654
4b8ed631
BM
655void *acpi_ut_allocate(acpi_size size,
656 u32 component, const char *module, u32 line);
4be44fcd 657
61686124 658void *acpi_ut_allocate_zeroed(acpi_size size,
4b8ed631 659 u32 component, const char *module, u32 line);
1da177e4 660
1da177e4 661#ifdef ACPI_DBG_TRACK_ALLOCATIONS
4be44fcd 662void *acpi_ut_allocate_and_track(acpi_size size,
4b8ed631 663 u32 component, const char *module, u32 line);
4be44fcd 664
61686124 665void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
4b8ed631
BM
666 u32 component,
667 const char *module, u32 line);
1da177e4
LT
668
669void
4b8ed631
BM
670acpi_ut_free_and_track(void *address,
671 u32 component, const char *module, u32 line);
1da177e4 672
44f6c012 673#ifdef ACPI_FUTURE_USAGE
4be44fcd
LB
674void acpi_ut_dump_allocation_info(void);
675#endif /* ACPI_FUTURE_USAGE */
1da177e4 676
4b8ed631 677void acpi_ut_dump_allocations(u32 component, const char *module);
61686124
BM
678
679acpi_status
680acpi_ut_create_list(char *list_name,
681 u16 object_size, struct acpi_memory_list **return_cache);
682
cc84e262
BM
683#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
684
f654c0fe
LM
685/*
686 * utaddress - address range check
687 */
688acpi_status
689acpi_ut_add_address_range(acpi_adr_space_type space_id,
690 acpi_physical_address address,
691 u32 length, struct acpi_namespace_node *region_node);
692
693void
694acpi_ut_remove_address_range(acpi_adr_space_type space_id,
695 struct acpi_namespace_node *region_node);
696
697u32
698acpi_ut_check_address_range(acpi_adr_space_type space_id,
699 acpi_physical_address address, u32 length, u8 warn);
700
701void acpi_ut_delete_address_lists(void);
702
cc84e262
BM
703/*
704 * utxferror - various error/warning output functions
705 */
706void ACPI_INTERNAL_VAR_XFACE
707acpi_ut_predefined_warning(const char *module_name,
708 u32 line_number,
709 char *pathname,
710 u8 node_flags, const char *format, ...);
711
712void ACPI_INTERNAL_VAR_XFACE
713acpi_ut_predefined_info(const char *module_name,
714 u32 line_number,
715 char *pathname, u8 node_flags, const char *format, ...);
716
e1405ca5
BM
717void ACPI_INTERNAL_VAR_XFACE
718acpi_ut_predefined_bios_error(const char *module_name,
719 u32 line_number,
720 char *pathname,
721 u8 node_flags, const char *format, ...);
722
cc84e262
BM
723void
724acpi_ut_namespace_error(const char *module_name,
725 u32 line_number,
726 const char *internal_name, acpi_status lookup_status);
727
728void
729acpi_ut_method_error(const char *module_name,
730 u32 line_number,
731 const char *message,
732 struct acpi_namespace_node *node,
733 const char *path, acpi_status lookup_status);
1da177e4 734
4be44fcd 735#endif /* _ACUTILS_H */