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