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