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