drivers/acpi/acpica/acutils.h

   1 /******************************************************************************
   2  *
   3  * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2017, Intel Corp.
   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
  47 extern const u8 acpi_gbl_resource_aml_sizes[];
  48 extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
  49
  50 /* Strings used by the disassembler and debugger resource dump routines */
  51
  52 #if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
  53
  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[];
  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[];
  88 extern const char *acpi_gbl_ptyp_decode[];
  89 #endif
  90
  91 /*
  92  * For the iASL compiler case, the output is redirected to stderr so that
  93  * any of the various ACPI errors and warnings do not appear in the output
  94  * files, for either the compiler or disassembler portions of the tool.
  95  */
  96 #ifdef ACPI_ASL_COMPILER
  97
  98 #include <stdio.h>
  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 #ifndef ACPI_MSG_ERROR
 119 #define ACPI_MSG_ERROR          "ACPI Error: "
 120 #endif
 121 #ifndef ACPI_MSG_WARNING
 122 #define ACPI_MSG_WARNING        "ACPI Warning: "
 123 #endif
 124 #ifndef ACPI_MSG_INFO
 125 #define ACPI_MSG_INFO           "ACPI: "
 126 #endif
 127
 128 #ifndef ACPI_MSG_BIOS_ERROR
 129 #define ACPI_MSG_BIOS_ERROR     "Firmware Error (ACPI): "
 130 #endif
 131 #ifndef ACPI_MSG_BIOS_WARNING
 132 #define ACPI_MSG_BIOS_WARNING   "Firmware Warning (ACPI): "
 133 #endif
 134
 135 /*
 136  * Common message suffix
 137  */
 138 #define ACPI_MSG_SUFFIX \
 139         acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
 140
 141 /* Flags to indicate implicit or explicit string-to-integer conversion */
 142
 143 #define ACPI_IMPLICIT_CONVERSION        TRUE
 144 #define ACPI_NO_IMPLICIT_CONVERSION     FALSE
 145
 146 /* Types for Resource descriptor entries */
 147
 148 #define ACPI_INVALID_RESOURCE           0
 149 #define ACPI_FIXED_LENGTH               1
 150 #define ACPI_VARIABLE_LENGTH            2
 151 #define ACPI_SMALL_VARIABLE_LENGTH      3
 152
 153 typedef
 154 acpi_status (*acpi_walk_aml_callback) (u8 *aml,
 155                                        u32 length,
 156                                        u32 offset,
 157                                        u8 resource_index, void **context);
 158
 159 typedef
 160 acpi_status (*acpi_pkg_callback) (u8 object_type,
 161                                   union acpi_operand_object * source_object,
 162                                   union acpi_generic_state * state,
 163                                   void *context);
 164
 165 struct acpi_pkg_info {
 166         u8 *free_space;
 167         acpi_size length;
 168         u32 object_space;
 169         u32 num_packages;
 170 };
 171
 172 /* Object reference counts */
 173
 174 #define REF_INCREMENT       (u16) 0
 175 #define REF_DECREMENT       (u16) 1
 176
 177 /* acpi_ut_dump_buffer */
 178
 179 #define DB_BYTE_DISPLAY     1
 180 #define DB_WORD_DISPLAY     2
 181 #define DB_DWORD_DISPLAY    4
 182 #define DB_QWORD_DISPLAY    8
 183
 184 /*
 185  * utascii - ASCII utilities
 186  */
 187 u8 acpi_ut_valid_nameseg(char *signature);
 188
 189 u8 acpi_ut_valid_name_char(char character, u32 position);
 190
 191 void acpi_ut_check_and_repair_ascii(u8 *name, char *repaired_name, u32 count);
 192
 193 /*
 194  * utnonansi - Non-ANSI C library functions
 195  */
 196 void acpi_ut_strupr(char *src_string);
 197
 198 void acpi_ut_strlwr(char *src_string);
 199
 200 int acpi_ut_stricmp(char *string1, char *string2);
 201
 202 /*
 203  * utstrsuppt - string-to-integer conversion support functions
 204  */
 205 acpi_status acpi_ut_convert_octal_string(char *string, u64 *return_value);
 206
 207 acpi_status acpi_ut_convert_decimal_string(char *string, u64 *return_value_ptr);
 208
 209 acpi_status acpi_ut_convert_hex_string(char *string, u64 *return_value_ptr);
 210
 211 char acpi_ut_remove_whitespace(char **string);
 212
 213 char acpi_ut_remove_leading_zeros(char **string);
 214
 215 u8 acpi_ut_detect_hex_prefix(char **string);
 216
 217 u8 acpi_ut_detect_octal_prefix(char **string);
 218
 219 /*
 220  * utstrtoul64 - string-to-integer conversion functions
 221  */
 222 acpi_status acpi_ut_strtoul64(char *string, u64 *ret_integer);
 223
 224 u64 acpi_ut_explicit_strtoul64(char *string);
 225
 226 u64 acpi_ut_implicit_strtoul64(char *string);
 227
 228 /*
 229  * utglobal - Global data structures and procedures
 230  */
 231 acpi_status acpi_ut_init_globals(void);
 232
 233 const char *acpi_ut_get_mutex_name(u32 mutex_id);
 234
 235 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
 236
 237 const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
 238 #endif
 239
 240 const char *acpi_ut_get_type_name(acpi_object_type type);
 241
 242 const char *acpi_ut_get_node_name(void *object);
 243
 244 const char *acpi_ut_get_descriptor_name(void *object);
 245
 246 const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
 247
 248 const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
 249
 250 const char *acpi_ut_get_region_name(u8 space_id);
 251
 252 const char *acpi_ut_get_event_name(u32 event_id);
 253
 254 const char *acpi_ut_get_argument_type_name(u32 arg_type);
 255
 256 char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
 257
 258 acpi_status acpi_ut_ascii_to_hex_byte(char *two_ascii_chars, u8 *return_byte);
 259
 260 u8 acpi_ut_ascii_char_to_hex(int hex_char);
 261
 262 u8 acpi_ut_valid_object_type(acpi_object_type type);
 263
 264 /*
 265  * utinit - miscellaneous initialization and shutdown
 266  */
 267 acpi_status acpi_ut_hardware_initialize(void);
 268
 269 void acpi_ut_subsystem_shutdown(void);
 270
 271 /*
 272  * utcopy - Object construction and conversion interfaces
 273  */
 274 acpi_status
 275 acpi_ut_build_simple_object(union acpi_operand_object *obj,
 276                             union acpi_object *user_obj,
 277                             u8 *data_space, u32 *buffer_space_used);
 278
 279 acpi_status
 280 acpi_ut_build_package_object(union acpi_operand_object *obj,
 281                              u8 *buffer, u32 *space_used);
 282
 283 acpi_status
 284 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
 285                                 struct acpi_buffer *ret_buffer);
 286
 287 acpi_status
 288 acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
 289                                 union acpi_operand_object **internal_obj);
 290
 291 acpi_status
 292 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
 293                                 union acpi_operand_object *dest_obj);
 294
 295 acpi_status
 296 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
 297                                 union acpi_operand_object **dest_desc,
 298                                 struct acpi_walk_state *walk_state);
 299
 300 /*
 301  * utcreate - Object creation
 302  */
 303 acpi_status
 304 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
 305
 306 /*
 307  * utdebug - Debug interfaces
 308  */
 309 void acpi_ut_init_stack_ptr_trace(void);
 310
 311 void acpi_ut_track_stack_ptr(void);
 312
 313 void
 314 acpi_ut_trace(u32 line_number,
 315               const char *function_name,
 316               const char *module_name, u32 component_id);
 317
 318 void
 319 acpi_ut_trace_ptr(u32 line_number,
 320                   const char *function_name,
 321                   const char *module_name,
 322                   u32 component_id, const void *pointer);
 323
 324 void
 325 acpi_ut_trace_u32(u32 line_number,
 326                   const char *function_name,
 327                   const char *module_name, u32 component_id, u32 integer);
 328
 329 void
 330 acpi_ut_trace_str(u32 line_number,
 331                   const char *function_name,
 332                   const char *module_name,
 333                   u32 component_id, const char *string);
 334
 335 void
 336 acpi_ut_exit(u32 line_number,
 337              const char *function_name,
 338              const char *module_name, u32 component_id);
 339
 340 void
 341 acpi_ut_status_exit(u32 line_number,
 342                     const char *function_name,
 343                     const char *module_name,
 344                     u32 component_id, acpi_status status);
 345
 346 void
 347 acpi_ut_value_exit(u32 line_number,
 348                    const char *function_name,
 349                    const char *module_name, u32 component_id, u64 value);
 350
 351 void
 352 acpi_ut_ptr_exit(u32 line_number,
 353                  const char *function_name,
 354                  const char *module_name, u32 component_id, u8 *ptr);
 355
 356 void
 357 acpi_ut_str_exit(u32 line_number,
 358                  const char *function_name,
 359                  const char *module_name, u32 component_id, const char *string);
 360
 361 void
 362 acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
 363
 364 void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
 365
 366 #ifdef ACPI_APPLICATION
 367 void
 368 acpi_ut_dump_buffer_to_file(ACPI_FILE file,
 369                             u8 *buffer,
 370                             u32 count, u32 display, u32 base_offset);
 371 #endif
 372
 373 void acpi_ut_report_error(char *module_name, u32 line_number);
 374
 375 void acpi_ut_report_info(char *module_name, u32 line_number);
 376
 377 void acpi_ut_report_warning(char *module_name, u32 line_number);
 378
 379 /*
 380  * utdelete - Object deletion and reference counts
 381  */
 382 void acpi_ut_add_reference(union acpi_operand_object *object);
 383
 384 void acpi_ut_remove_reference(union acpi_operand_object *object);
 385
 386 void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
 387
 388 void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
 389
 390 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
 391
 392 /*
 393  * uteval - object evaluation
 394  */
 395 acpi_status
 396 acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
 397                         const char *path,
 398                         u32 expected_return_btypes,
 399                         union acpi_operand_object **return_desc);
 400
 401 acpi_status
 402 acpi_ut_evaluate_numeric_object(const char *object_name,
 403                                 struct acpi_namespace_node *device_node,
 404                                 u64 *value);
 405
 406 acpi_status
 407 acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
 408
 409 acpi_status
 410 acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
 411                               const char **method_names,
 412                               u8 method_count, u8 *out_values);
 413
 414 /*
 415  * utids - device ID support
 416  */
 417 acpi_status
 418 acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
 419                     struct acpi_pnp_device_id ** return_id);
 420
 421 acpi_status
 422 acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
 423                     struct acpi_pnp_device_id ** return_id);
 424
 425 acpi_status
 426 acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
 427                     struct acpi_pnp_device_id_list ** return_cid_list);
 428
 429 acpi_status
 430 acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
 431                     struct acpi_pnp_device_id **return_id);
 432
 433 /*
 434  * utlock - reader/writer locks
 435  */
 436 acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
 437
 438 void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
 439
 440 acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
 441
 442 acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
 443
 444 acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
 445
 446 void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
 447
 448 /*
 449  * utobject - internal object create/delete/cache routines
 450  */
 451 union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
 452                                                               *module_name,
 453                                                               u32 line_number,
 454                                                               u32 component_id,
 455                                                               acpi_object_type
 456                                                               type);
 457
 458 void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
 459                                        u32 line_number, u32 component_id);
 460
 461 #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
 462 #define acpi_ut_allocate_object_desc()  acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
 463
 464 void acpi_ut_delete_object_desc(union acpi_operand_object *object);
 465
 466 u8 acpi_ut_valid_internal_object(void *object);
 467
 468 union acpi_operand_object *acpi_ut_create_package_object(u32 count);
 469
 470 union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
 471
 472 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
 473
 474 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
 475
 476 acpi_status
 477 acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length);
 478
 479 /*
 480  * utosi - Support for the _OSI predefined control method
 481  */
 482 acpi_status acpi_ut_initialize_interfaces(void);
 483
 484 acpi_status acpi_ut_interface_terminate(void);
 485
 486 acpi_status acpi_ut_install_interface(acpi_string interface_name);
 487
 488 acpi_status acpi_ut_remove_interface(acpi_string interface_name);
 489
 490 acpi_status acpi_ut_update_interfaces(u8 action);
 491
 492 struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
 493
 494 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
 495
 496 /*
 497  * utpredef - support for predefined names
 498  */
 499 const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
 500                                                                      acpi_predefined_info
 501                                                                      *this_name);
 502
 503 const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
 504
 505 void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
 506
 507 #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
 508 const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
 509
 510 void
 511 acpi_ut_display_predefined_method(char *buffer,
 512                                   const union acpi_predefined_info *this_name,
 513                                   u8 multi_line);
 514
 515 u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
 516 #endif
 517
 518 /*
 519  * utstate - Generic state creation/cache routines
 520  */
 521 void
 522 acpi_ut_push_generic_state(union acpi_generic_state **list_head,
 523                            union acpi_generic_state *state);
 524
 525 union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
 526                                                     **list_head);
 527
 528 union acpi_generic_state *acpi_ut_create_generic_state(void);
 529
 530 struct acpi_thread_state *acpi_ut_create_thread_state(void);
 531
 532 union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
 533                                                       *object, u16 action);
 534
 535 union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
 536                                                    void *external_object,
 537                                                    u32 index);
 538
 539 acpi_status
 540 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
 541                                      u16 action,
 542                                      union acpi_generic_state **state_list);
 543
 544 union acpi_generic_state *acpi_ut_create_control_state(void);
 545
 546 void acpi_ut_delete_generic_state(union acpi_generic_state *state);
 547
 548 /*
 549  * utmath
 550  */
 551 acpi_status
 552 acpi_ut_divide(u64 in_dividend,
 553                u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
 554
 555 acpi_status
 556 acpi_ut_short_divide(u64 in_dividend,
 557                      u32 divisor, u64 *out_quotient, u32 *out_remainder);
 558
 559 acpi_status
 560 acpi_ut_short_multiply(u64 in_multiplicand, u32 multiplier, u64 *outproduct);
 561
 562 acpi_status acpi_ut_short_shift_left(u64 operand, u32 count, u64 *out_result);
 563
 564 acpi_status acpi_ut_short_shift_right(u64 operand, u32 count, u64 *out_result);
 565
 566 /*
 567  * utmisc
 568  */
 569 const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
 570                                                              status);
 571
 572 u8 acpi_ut_is_pci_root_bridge(char *id);
 573
 574 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
 575 u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
 576 #endif
 577
 578 acpi_status
 579 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
 580                           void *target_object,
 581                           acpi_pkg_callback walk_callback, void *context);
 582
 583 /* Values for Base above (16=Hex, 10=Decimal) */
 584
 585 #define ACPI_ANY_BASE        0
 586
 587 u32 acpi_ut_dword_byte_swap(u32 value);
 588
 589 void acpi_ut_set_integer_width(u8 revision);
 590
 591 #ifdef ACPI_DEBUG_OUTPUT
 592 void
 593 acpi_ut_display_init_pathname(u8 type,
 594                               struct acpi_namespace_node *obj_handle,
 595                               const char *path);
 596 #endif
 597
 598 /*
 599  * utownerid - Support for Table/Method Owner IDs
 600  */
 601 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id);
 602
 603 void acpi_ut_release_owner_id(acpi_owner_id *owner_id);
 604
 605 /*
 606  * utresrc
 607  */
 608 acpi_status
 609 acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
 610                            u8 *aml,
 611                            acpi_size aml_length,
 612                            acpi_walk_aml_callback user_function,
 613                            void **context);
 614
 615 acpi_status
 616 acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
 617                           void *aml, u8 *return_index);
 618
 619 u32 acpi_ut_get_descriptor_length(void *aml);
 620
 621 u16 acpi_ut_get_resource_length(void *aml);
 622
 623 u8 acpi_ut_get_resource_header_length(void *aml);
 624
 625 u8 acpi_ut_get_resource_type(void *aml);
 626
 627 acpi_status
 628 acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
 629
 630 /*
 631  * utstring - String and character utilities
 632  */
 633 void acpi_ut_print_string(char *string, u16 max_length);
 634
 635 #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
 636 void ut_convert_backslashes(char *pathname);
 637 #endif
 638
 639 void acpi_ut_repair_name(char *name);
 640
 641 #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION) || defined (ACPI_DEBUG_OUTPUT)
 642 u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
 643
 644 void acpi_ut_safe_strncpy(char *dest, char *source, acpi_size dest_size);
 645
 646 u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
 647
 648 u8
 649 acpi_ut_safe_strncat(char *dest,
 650                      acpi_size dest_size,
 651                      char *source, acpi_size max_transfer_length);
 652 #endif
 653
 654 /*
 655  * utmutex - mutex support
 656  */
 657 acpi_status acpi_ut_mutex_initialize(void);
 658
 659 void acpi_ut_mutex_terminate(void);
 660
 661 acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
 662
 663 acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
 664
 665 /*
 666  * utalloc - memory allocation and object caching
 667  */
 668 acpi_status acpi_ut_create_caches(void);
 669
 670 acpi_status acpi_ut_delete_caches(void);
 671
 672 acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
 673
 674 acpi_status
 675 acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
 676                           acpi_size required_length);
 677
 678 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 679 void *acpi_ut_allocate_and_track(acpi_size size,
 680                                  u32 component, const char *module, u32 line);
 681
 682 void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
 683                                         u32 component,
 684                                         const char *module, u32 line);
 685
 686 void
 687 acpi_ut_free_and_track(void *address,
 688                        u32 component, const char *module, u32 line);
 689
 690 void acpi_ut_dump_allocation_info(void);
 691
 692 void acpi_ut_dump_allocations(u32 component, const char *module);
 693
 694 acpi_status
 695 acpi_ut_create_list(const char *list_name,
 696                     u16 object_size, struct acpi_memory_list **return_cache);
 697
 698 #endif                          /* ACPI_DBG_TRACK_ALLOCATIONS */
 699
 700 /*
 701  * utaddress - address range check
 702  */
 703 acpi_status
 704 acpi_ut_add_address_range(acpi_adr_space_type space_id,
 705                           acpi_physical_address address,
 706                           u32 length, struct acpi_namespace_node *region_node);
 707
 708 void
 709 acpi_ut_remove_address_range(acpi_adr_space_type space_id,
 710                              struct acpi_namespace_node *region_node);
 711
 712 u32
 713 acpi_ut_check_address_range(acpi_adr_space_type space_id,
 714                             acpi_physical_address address, u32 length, u8 warn);
 715
 716 void acpi_ut_delete_address_lists(void);
 717
 718 /*
 719  * utxferror - various error/warning output functions
 720  */
 721 void ACPI_INTERNAL_VAR_XFACE
 722 acpi_ut_predefined_warning(const char *module_name,
 723                            u32 line_number,
 724                            char *pathname,
 725                            u8 node_flags, const char *format, ...);
 726
 727 void ACPI_INTERNAL_VAR_XFACE
 728 acpi_ut_predefined_info(const char *module_name,
 729                         u32 line_number,
 730                         char *pathname, u8 node_flags, const char *format, ...);
 731
 732 void ACPI_INTERNAL_VAR_XFACE
 733 acpi_ut_predefined_bios_error(const char *module_name,
 734                               u32 line_number,
 735                               char *pathname,
 736                               u8 node_flags, const char *format, ...);
 737
 738 void
 739 acpi_ut_prefixed_namespace_error(const char *module_name,
 740                                  u32 line_number,
 741                                  union acpi_generic_state *prefix_scope,
 742                                  const char *internal_name,
 743                                  acpi_status lookup_status);
 744
 745 void
 746 acpi_ut_method_error(const char *module_name,
 747                      u32 line_number,
 748                      const char *message,
 749                      struct acpi_namespace_node *node,
 750                      const char *path, acpi_status lookup_status);
 751
 752 /*
 753  * Utility functions for ACPI names and IDs
 754  */
 755 const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
 756
 757 const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
 758
 759 const char *acpi_ah_match_uuid(u8 *data);
 760
 761 /*
 762  * utuuid -- UUID support functions
 763  */
 764 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
 765 void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
 766 #endif
 767
 768 #endif                          /* _ACUTILS_H */