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