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