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