include/acpi/acutils.h

   1 /******************************************************************************
   2  *
   3  * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2008, 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
  49 /* Strings used by the disassembler and debugger resource dump routines */
  50
  51 #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
  52
  53 extern const char *acpi_gbl_bm_decode[];
  54 extern const char *acpi_gbl_config_decode[];
  55 extern const char *acpi_gbl_consume_decode[];
  56 extern const char *acpi_gbl_dec_decode[];
  57 extern const char *acpi_gbl_he_decode[];
  58 extern const char *acpi_gbl_io_decode[];
  59 extern const char *acpi_gbl_ll_decode[];
  60 extern const char *acpi_gbl_max_decode[];
  61 extern const char *acpi_gbl_mem_decode[];
  62 extern const char *acpi_gbl_min_decode[];
  63 extern const char *acpi_gbl_mtp_decode[];
  64 extern const char *acpi_gbl_rng_decode[];
  65 extern const char *acpi_gbl_rw_decode[];
  66 extern const char *acpi_gbl_shr_decode[];
  67 extern const char *acpi_gbl_siz_decode[];
  68 extern const char *acpi_gbl_trs_decode[];
  69 extern const char *acpi_gbl_ttp_decode[];
  70 extern const char *acpi_gbl_typ_decode[];
  71 #endif
  72
  73 /* Types for Resource descriptor entries */
  74
  75 #define ACPI_INVALID_RESOURCE           0
  76 #define ACPI_FIXED_LENGTH               1
  77 #define ACPI_VARIABLE_LENGTH            2
  78 #define ACPI_SMALL_VARIABLE_LENGTH      3
  79
  80 typedef
  81 acpi_status(*acpi_walk_aml_callback) (u8 * aml,
  82                                       u32 length,
  83                                       u32 offset,
  84                                       u8 resource_index, void **context);
  85
  86 typedef
  87 acpi_status(*acpi_pkg_callback) (u8 object_type,
  88                                  union acpi_operand_object * source_object,
  89                                  union acpi_generic_state * state,
  90                                  void *context);
  91
  92 struct acpi_pkg_info {
  93         u8 *free_space;
  94         acpi_size length;
  95         u32 object_space;
  96         u32 num_packages;
  97 };
  98
  99 #define REF_INCREMENT       (u16) 0
 100 #define REF_DECREMENT       (u16) 1
 101 #define REF_FORCE_DELETE    (u16) 2
 102
 103 /* acpi_ut_dump_buffer */
 104
 105 #define DB_BYTE_DISPLAY     1
 106 #define DB_WORD_DISPLAY     2
 107 #define DB_DWORD_DISPLAY    4
 108 #define DB_QWORD_DISPLAY    8
 109
 110 /*
 111  * utglobal - Global data structures and procedures
 112  */
 113 void acpi_ut_init_globals(void);
 114
 115 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
 116
 117 char *acpi_ut_get_mutex_name(u32 mutex_id);
 118
 119 const char *acpi_ut_get_notify_name(u32 notify_value);
 120
 121 #endif
 122
 123 char *acpi_ut_get_type_name(acpi_object_type type);
 124
 125 char *acpi_ut_get_node_name(void *object);
 126
 127 char *acpi_ut_get_descriptor_name(void *object);
 128
 129 char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
 130
 131 char *acpi_ut_get_region_name(u8 space_id);
 132
 133 char *acpi_ut_get_event_name(u32 event_id);
 134
 135 char acpi_ut_hex_to_ascii_char(acpi_integer integer, u32 position);
 136
 137 u8 acpi_ut_valid_object_type(acpi_object_type type);
 138
 139 /*
 140  * utinit - miscellaneous initialization and shutdown
 141  */
 142 acpi_status acpi_ut_hardware_initialize(void);
 143
 144 void acpi_ut_subsystem_shutdown(void);
 145
 146 /*
 147  * utclib - Local implementations of C library functions
 148  */
 149 #ifndef ACPI_USE_SYSTEM_CLIBRARY
 150
 151 acpi_size acpi_ut_strlen(const char *string);
 152
 153 char *acpi_ut_strcpy(char *dst_string, const char *src_string);
 154
 155 char *acpi_ut_strncpy(char *dst_string,
 156                       const char *src_string, acpi_size count);
 157
 158 int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
 159
 160 int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
 161
 162 int acpi_ut_strcmp(const char *string1, const char *string2);
 163
 164 char *acpi_ut_strcat(char *dst_string, const char *src_string);
 165
 166 char *acpi_ut_strncat(char *dst_string,
 167                       const char *src_string, acpi_size count);
 168
 169 u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
 170
 171 char *acpi_ut_strstr(char *string1, char *string2);
 172
 173 void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
 174
 175 void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
 176
 177 int acpi_ut_to_upper(int c);
 178
 179 int acpi_ut_to_lower(int c);
 180
 181 extern const u8 _acpi_ctype[];
 182
 183 #define _ACPI_XA     0x00       /* extra alphabetic - not supported */
 184 #define _ACPI_XS     0x40       /* extra space */
 185 #define _ACPI_BB     0x00       /* BEL, BS, etc. - not supported */
 186 #define _ACPI_CN     0x20       /* CR, FF, HT, NL, VT */
 187 #define _ACPI_DI     0x04       /* '0'-'9' */
 188 #define _ACPI_LO     0x02       /* 'a'-'z' */
 189 #define _ACPI_PU     0x10       /* punctuation */
 190 #define _ACPI_SP     0x08       /* space */
 191 #define _ACPI_UP     0x01       /* 'A'-'Z' */
 192 #define _ACPI_XD     0x80       /* '0'-'9', 'A'-'F', 'a'-'f' */
 193
 194 #define ACPI_IS_DIGIT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
 195 #define ACPI_IS_SPACE(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
 196 #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
 197 #define ACPI_IS_UPPER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
 198 #define ACPI_IS_LOWER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
 199 #define ACPI_IS_PRINT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
 200 #define ACPI_IS_ALPHA(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
 201
 202 #endif                          /* ACPI_USE_SYSTEM_CLIBRARY */
 203
 204 /*
 205  * utcopy - Object construction and conversion interfaces
 206  */
 207 acpi_status
 208 acpi_ut_build_simple_object(union acpi_operand_object *obj,
 209                             union acpi_object *user_obj,
 210                             u8 * data_space, u32 * buffer_space_used);
 211
 212 acpi_status
 213 acpi_ut_build_package_object(union acpi_operand_object *obj,
 214                              u8 * buffer, u32 * space_used);
 215
 216 acpi_status
 217 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
 218                                 struct acpi_buffer *ret_buffer);
 219
 220 acpi_status
 221 acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
 222                                 union acpi_operand_object **internal_obj);
 223
 224 acpi_status
 225 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
 226                                 union acpi_operand_object *dest_obj);
 227
 228 acpi_status
 229 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
 230                                 union acpi_operand_object **dest_desc,
 231                                 struct acpi_walk_state *walk_state);
 232
 233 /*
 234  * utcreate - Object creation
 235  */
 236 acpi_status
 237 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
 238
 239 /*
 240  * utdebug - Debug interfaces
 241  */
 242 void acpi_ut_init_stack_ptr_trace(void);
 243
 244 void acpi_ut_track_stack_ptr(void);
 245
 246 void
 247 acpi_ut_trace(u32 line_number,
 248               const char *function_name,
 249               const char *module_name, u32 component_id);
 250
 251 void
 252 acpi_ut_trace_ptr(u32 line_number,
 253                   const char *function_name,
 254                   const char *module_name, u32 component_id, void *pointer);
 255
 256 void
 257 acpi_ut_trace_u32(u32 line_number,
 258                   const char *function_name,
 259                   const char *module_name, u32 component_id, u32 integer);
 260
 261 void
 262 acpi_ut_trace_str(u32 line_number,
 263                   const char *function_name,
 264                   const char *module_name, u32 component_id, char *string);
 265
 266 void
 267 acpi_ut_exit(u32 line_number,
 268              const char *function_name,
 269              const char *module_name, u32 component_id);
 270
 271 void
 272 acpi_ut_status_exit(u32 line_number,
 273                     const char *function_name,
 274                     const char *module_name,
 275                     u32 component_id, acpi_status status);
 276
 277 void
 278 acpi_ut_value_exit(u32 line_number,
 279                    const char *function_name,
 280                    const char *module_name,
 281                    u32 component_id, acpi_integer value);
 282
 283 void
 284 acpi_ut_ptr_exit(u32 line_number,
 285                  const char *function_name,
 286                  const char *module_name, u32 component_id, u8 *ptr);
 287
 288 void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
 289
 290 void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display);
 291
 292 void acpi_ut_report_error(char *module_name, u32 line_number);
 293
 294 void acpi_ut_report_info(char *module_name, u32 line_number);
 295
 296 void acpi_ut_report_warning(char *module_name, u32 line_number);
 297
 298 /* Error and message reporting interfaces */
 299
 300 void ACPI_INTERNAL_VAR_XFACE
 301 acpi_ut_debug_print(u32 requested_debug_level,
 302                     u32 line_number,
 303                     const char *function_name,
 304                     const char *module_name,
 305                     u32 component_id,
 306                     const char *format, ...) ACPI_PRINTF_LIKE(6);
 307
 308 void ACPI_INTERNAL_VAR_XFACE
 309 acpi_ut_debug_print_raw(u32 requested_debug_level,
 310                         u32 line_number,
 311                         const char *function_name,
 312                         const char *module_name,
 313                         u32 component_id,
 314                         const char *format, ...) ACPI_PRINTF_LIKE(6);
 315
 316 void ACPI_INTERNAL_VAR_XFACE
 317 acpi_ut_error(const char *module_name,
 318               u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 319
 320 void ACPI_INTERNAL_VAR_XFACE
 321 acpi_ut_exception(const char *module_name,
 322                   u32 line_number,
 323                   acpi_status status,
 324                   const char *format, ...) ACPI_PRINTF_LIKE(4);
 325
 326 void ACPI_INTERNAL_VAR_XFACE
 327 acpi_ut_warning(const char *module_name,
 328                 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 329
 330 void ACPI_INTERNAL_VAR_XFACE
 331 acpi_ut_info(const char *module_name,
 332              u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
 333
 334 /*
 335  * utdelete - Object deletion and reference counts
 336  */
 337 void acpi_ut_add_reference(union acpi_operand_object *object);
 338
 339 void acpi_ut_remove_reference(union acpi_operand_object *object);
 340
 341 void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
 342
 343 void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
 344
 345 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
 346
 347 /*
 348  * uteval - object evaluation
 349  */
 350 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
 351
 352 acpi_status
 353 acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
 354                         char *path,
 355                         u32 expected_return_btypes,
 356                         union acpi_operand_object **return_desc);
 357
 358 acpi_status
 359 acpi_ut_evaluate_numeric_object(char *object_name,
 360                                 struct acpi_namespace_node *device_node,
 361                                 acpi_integer * address);
 362
 363 acpi_status
 364 acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
 365                     struct acpica_device_id *hid);
 366
 367 acpi_status
 368 acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
 369                     struct acpi_compatible_id_list **return_cid_list);
 370
 371 acpi_status
 372 acpi_ut_execute_STA(struct acpi_namespace_node *device_node,
 373                     u32 * status_flags);
 374
 375 acpi_status
 376 acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
 377                     struct acpica_device_id *uid);
 378
 379 acpi_status
 380 acpi_ut_execute_sxds(struct acpi_namespace_node *device_node, u8 * highest);
 381
 382 /*
 383  * utobject - internal object create/delete/cache routines
 384  */
 385 union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
 386                                                               *module_name,
 387                                                               u32 line_number,
 388                                                               u32 component_id,
 389                                                               acpi_object_type
 390                                                               type);
 391
 392 void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
 393                                        u32 line_number, u32 component_id);
 394
 395 #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
 396 #define acpi_ut_allocate_object_desc()  acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
 397
 398 void acpi_ut_delete_object_desc(union acpi_operand_object *object);
 399
 400 u8 acpi_ut_valid_internal_object(void *object);
 401
 402 union acpi_operand_object *acpi_ut_create_package_object(u32 count);
 403
 404 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
 405
 406 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
 407
 408 acpi_status
 409 acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
 410
 411 /*
 412  * utstate - Generic state creation/cache routines
 413  */
 414 void
 415 acpi_ut_push_generic_state(union acpi_generic_state **list_head,
 416                            union acpi_generic_state *state);
 417
 418 union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
 419                                                     **list_head);
 420
 421 union acpi_generic_state *acpi_ut_create_generic_state(void);
 422
 423 struct acpi_thread_state *acpi_ut_create_thread_state(void);
 424
 425 union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
 426                                                       *object, u16 action);
 427
 428 union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
 429                                                    void *external_object,
 430                                                    u16 index);
 431
 432 acpi_status
 433 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
 434                                      u16 action,
 435                                      union acpi_generic_state **state_list);
 436
 437 #ifdef  ACPI_FUTURE_USAGE
 438 acpi_status
 439 acpi_ut_create_pkg_state_and_push(void *internal_object,
 440                                   void *external_object,
 441                                   u16 index,
 442                                   union acpi_generic_state **state_list);
 443 #endif                          /* ACPI_FUTURE_USAGE */
 444
 445 union acpi_generic_state *acpi_ut_create_control_state(void);
 446
 447 void acpi_ut_delete_generic_state(union acpi_generic_state *state);
 448
 449 /*
 450  * utmath
 451  */
 452 acpi_status
 453 acpi_ut_divide(acpi_integer in_dividend,
 454                acpi_integer in_divisor,
 455                acpi_integer * out_quotient, acpi_integer * out_remainder);
 456
 457 acpi_status
 458 acpi_ut_short_divide(acpi_integer in_dividend,
 459                      u32 divisor,
 460                      acpi_integer * out_quotient, u32 * out_remainder);
 461
 462 /*
 463  * utmisc
 464  */
 465 const char *acpi_ut_validate_exception(acpi_status status);
 466
 467 u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
 468
 469 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
 470
 471 void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
 472
 473 acpi_status
 474 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
 475                           void *target_object,
 476                           acpi_pkg_callback walk_callback, void *context);
 477
 478 void acpi_ut_strupr(char *src_string);
 479
 480 void acpi_ut_print_string(char *string, u8 max_length);
 481
 482 u8 acpi_ut_valid_acpi_name(u32 name);
 483
 484 acpi_name acpi_ut_repair_name(char *name);
 485
 486 u8 acpi_ut_valid_acpi_char(char character, u32 position);
 487
 488 acpi_status
 489 acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer);
 490
 491 /* Values for Base above (16=Hex, 10=Decimal) */
 492
 493 #define ACPI_ANY_BASE        0
 494
 495 u32 acpi_ut_dword_byte_swap(u32 value);
 496
 497 void acpi_ut_set_integer_width(u8 revision);
 498
 499 #ifdef ACPI_DEBUG_OUTPUT
 500 void
 501 acpi_ut_display_init_pathname(u8 type,
 502                               struct acpi_namespace_node *obj_handle,
 503                               char *path);
 504 #endif
 505
 506 /*
 507  * utresrc
 508  */
 509 acpi_status
 510 acpi_ut_walk_aml_resources(u8 * aml,
 511                            acpi_size aml_length,
 512                            acpi_walk_aml_callback user_function,
 513                            void **context);
 514
 515 acpi_status acpi_ut_validate_resource(void *aml, u8 * return_index);
 516
 517 u32 acpi_ut_get_descriptor_length(void *aml);
 518
 519 u16 acpi_ut_get_resource_length(void *aml);
 520
 521 u8 acpi_ut_get_resource_header_length(void *aml);
 522
 523 u8 acpi_ut_get_resource_type(void *aml);
 524
 525 acpi_status
 526 acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc,
 527                              u8 ** end_tag);
 528
 529 /*
 530  * utmutex - mutex support
 531  */
 532 acpi_status acpi_ut_mutex_initialize(void);
 533
 534 void acpi_ut_mutex_terminate(void);
 535
 536 acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
 537
 538 acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
 539
 540 /*
 541  * utalloc - memory allocation and object caching
 542  */
 543 acpi_status acpi_ut_create_caches(void);
 544
 545 acpi_status acpi_ut_delete_caches(void);
 546
 547 acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
 548
 549 acpi_status
 550 acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
 551                           acpi_size required_length);
 552
 553 void *acpi_ut_allocate(acpi_size size,
 554                        u32 component, const char *module, u32 line);
 555
 556 void *acpi_ut_allocate_zeroed(acpi_size size,
 557                               u32 component, const char *module, u32 line);
 558
 559 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 560 void *acpi_ut_allocate_and_track(acpi_size size,
 561                                  u32 component, const char *module, u32 line);
 562
 563 void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
 564                                         u32 component,
 565                                         const char *module, u32 line);
 566
 567 void
 568 acpi_ut_free_and_track(void *address,
 569                        u32 component, const char *module, u32 line);
 570
 571 #ifdef  ACPI_FUTURE_USAGE
 572 void acpi_ut_dump_allocation_info(void);
 573 #endif                          /* ACPI_FUTURE_USAGE */
 574
 575 void acpi_ut_dump_allocations(u32 component, const char *module);
 576
 577 acpi_status
 578 acpi_ut_create_list(char *list_name,
 579                     u16 object_size, struct acpi_memory_list **return_cache);
 580
 581 #endif
 582
 583 #endif                          /* _ACUTILS_H */