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