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