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