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