drivers/acpi/acpica/acutils.h

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