1 /****************************************************************************** 2 * 3 * Name: aclocal.h - Internal data types used across the ACPI subsystem 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2011, 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 __ACLOCAL_H__ 45 #define __ACLOCAL_H__ 46 47 /* acpisrc:struct_defs -- for acpisrc conversion */ 48 49 #define ACPI_SERIALIZED 0xFF 50 51 typedef u32 acpi_mutex_handle; 52 #define ACPI_GLOBAL_LOCK (acpi_semaphore) (-1) 53 54 /* Total number of aml opcodes defined */ 55 56 #define AML_NUM_OPCODES 0x7F 57 58 /* Forward declarations */ 59 60 struct acpi_walk_state; 61 struct acpi_obj_mutex; 62 union acpi_parse_object; 63 64 /***************************************************************************** 65 * 66 * Mutex typedefs and structs 67 * 68 ****************************************************************************/ 69 70 /* 71 * Predefined handles for the mutex objects used within the subsystem 72 * All mutex objects are automatically created by acpi_ut_mutex_initialize. 73 * 74 * The acquire/release ordering protocol is implied via this list. Mutexes 75 * with a lower value must be acquired before mutexes with a higher value. 76 * 77 * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names 78 * table below also! 79 */ 80 #define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */ 81 #define ACPI_MTX_NAMESPACE 1 /* ACPI Namespace */ 82 #define ACPI_MTX_TABLES 2 /* Data for ACPI tables */ 83 #define ACPI_MTX_EVENTS 3 /* Data for ACPI events */ 84 #define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */ 85 #define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */ 86 #define ACPI_MTX_DEBUG_CMD_COMPLETE 6 /* AML debugger */ 87 #define ACPI_MTX_DEBUG_CMD_READY 7 /* AML debugger */ 88 89 #define ACPI_MAX_MUTEX 7 90 #define ACPI_NUM_MUTEX ACPI_MAX_MUTEX+1 91 92 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) 93 #ifdef DEFINE_ACPI_GLOBALS 94 95 /* Debug names for the mutexes above */ 96 97 static char *acpi_gbl_mutex_names[ACPI_NUM_MUTEX] = { 98 "ACPI_MTX_Interpreter", 99 "ACPI_MTX_Namespace", 100 "ACPI_MTX_Tables", 101 "ACPI_MTX_Events", 102 "ACPI_MTX_Caches", 103 "ACPI_MTX_Memory", 104 "ACPI_MTX_CommandComplete", 105 "ACPI_MTX_CommandReady" 106 }; 107 108 #endif 109 #endif 110 111 /* Lock structure for reader/writer interfaces */ 112 113 struct acpi_rw_lock { 114 acpi_mutex writer_mutex; 115 acpi_mutex reader_mutex; 116 u32 num_readers; 117 }; 118 119 /* 120 * Predefined handles for spinlocks used within the subsystem. 121 * These spinlocks are created by acpi_ut_mutex_initialize 122 */ 123 #define ACPI_LOCK_GPES 0 124 #define ACPI_LOCK_HARDWARE 1 125 126 #define ACPI_MAX_LOCK 1 127 #define ACPI_NUM_LOCK ACPI_MAX_LOCK+1 128 129 /* This Thread ID means that the mutex is not in use (unlocked) */ 130 131 #define ACPI_MUTEX_NOT_ACQUIRED (acpi_thread_id) 0 132 133 /* Table for the global mutexes */ 134 135 struct acpi_mutex_info { 136 acpi_mutex mutex; 137 u32 use_count; 138 acpi_thread_id thread_id; 139 }; 140 141 /* Lock flag parameter for various interfaces */ 142 143 #define ACPI_MTX_DO_NOT_LOCK 0 144 #define ACPI_MTX_LOCK 1 145 146 /* Field access granularities */ 147 148 #define ACPI_FIELD_BYTE_GRANULARITY 1 149 #define ACPI_FIELD_WORD_GRANULARITY 2 150 #define ACPI_FIELD_DWORD_GRANULARITY 4 151 #define ACPI_FIELD_QWORD_GRANULARITY 8 152 153 #define ACPI_ENTRY_NOT_FOUND NULL 154 155 /***************************************************************************** 156 * 157 * Namespace typedefs and structs 158 * 159 ****************************************************************************/ 160 161 /* Operational modes of the AML interpreter/scanner */ 162 163 typedef enum { 164 ACPI_IMODE_LOAD_PASS1 = 0x01, 165 ACPI_IMODE_LOAD_PASS2 = 0x02, 166 ACPI_IMODE_EXECUTE = 0x03 167 } acpi_interpreter_mode; 168 169 /* 170 * The Namespace Node describes a named object that appears in the AML. 171 * descriptor_type is used to differentiate between internal descriptors. 172 * 173 * The node is optimized for both 32-bit and 64-bit platforms: 174 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case. 175 * 176 * Note: The descriptor_type and Type fields must appear in the identical 177 * position in both the struct acpi_namespace_node and union acpi_operand_object 178 * structures. 179 */ 180 struct acpi_namespace_node { 181 union acpi_operand_object *object; /* Interpreter object */ 182 u8 descriptor_type; /* Differentiate object descriptor types */ 183 u8 type; /* ACPI Type associated with this name */ 184 u8 flags; /* Miscellaneous flags */ 185 acpi_owner_id owner_id; /* Node creator */ 186 union acpi_name_union name; /* ACPI Name, always 4 chars per ACPI spec */ 187 struct acpi_namespace_node *parent; /* Parent node */ 188 struct acpi_namespace_node *child; /* First child */ 189 struct acpi_namespace_node *peer; /* First peer */ 190 191 /* 192 * The following fields are used by the ASL compiler and disassembler only 193 */ 194 #ifdef ACPI_LARGE_NAMESPACE_NODE 195 union acpi_parse_object *op; 196 u32 value; 197 u32 length; 198 #endif 199 }; 200 201 /* Namespace Node flags */ 202 203 #define ANOBJ_RESERVED 0x01 /* Available for use */ 204 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */ 205 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */ 206 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */ 207 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */ 208 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */ 209 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (install_method) */ 210 211 #define ANOBJ_IS_EXTERNAL 0x08 /* i_aSL only: This object created via External() */ 212 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* i_aSL only: Method has no return value */ 213 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* i_aSL only: Method has at least one return value */ 214 #define ANOBJ_IS_BIT_OFFSET 0x40 /* i_aSL only: Reference is a bit offset */ 215 #define ANOBJ_IS_REFERENCED 0x80 /* i_aSL only: Object was referenced */ 216 217 /* Internal ACPI table management - master table list */ 218 219 struct acpi_table_list { 220 struct acpi_table_desc *tables; /* Table descriptor array */ 221 u32 current_table_count; /* Tables currently in the array */ 222 u32 max_table_count; /* Max tables array will hold */ 223 u8 flags; 224 }; 225 226 /* Flags for above */ 227 228 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */ 229 #define ACPI_ROOT_ORIGIN_ALLOCATED (1) 230 #define ACPI_ROOT_ALLOW_RESIZE (2) 231 232 /* Predefined (fixed) table indexes */ 233 234 #define ACPI_TABLE_INDEX_DSDT (0) 235 #define ACPI_TABLE_INDEX_FACS (1) 236 237 struct acpi_find_context { 238 char *search_for; 239 acpi_handle *list; 240 u32 *count; 241 }; 242 243 struct acpi_ns_search_data { 244 struct acpi_namespace_node *node; 245 }; 246 247 /* Object types used during package copies */ 248 249 #define ACPI_COPY_TYPE_SIMPLE 0 250 #define ACPI_COPY_TYPE_PACKAGE 1 251 252 /* Info structure used to convert external<->internal namestrings */ 253 254 struct acpi_namestring_info { 255 const char *external_name; 256 const char *next_external_char; 257 char *internal_name; 258 u32 length; 259 u32 num_segments; 260 u32 num_carats; 261 u8 fully_qualified; 262 }; 263 264 /* Field creation info */ 265 266 struct acpi_create_field_info { 267 struct acpi_namespace_node *region_node; 268 struct acpi_namespace_node *field_node; 269 struct acpi_namespace_node *register_node; 270 struct acpi_namespace_node *data_register_node; 271 u32 bank_value; 272 u32 field_bit_position; 273 u32 field_bit_length; 274 u8 field_flags; 275 u8 attribute; 276 u8 field_type; 277 }; 278 279 typedef 280 acpi_status(*ACPI_INTERNAL_METHOD) (struct acpi_walk_state * walk_state); 281 282 /* 283 * Bitmapped ACPI types. Used internally only 284 */ 285 #define ACPI_BTYPE_ANY 0x00000000 286 #define ACPI_BTYPE_INTEGER 0x00000001 287 #define ACPI_BTYPE_STRING 0x00000002 288 #define ACPI_BTYPE_BUFFER 0x00000004 289 #define ACPI_BTYPE_PACKAGE 0x00000008 290 #define ACPI_BTYPE_FIELD_UNIT 0x00000010 291 #define ACPI_BTYPE_DEVICE 0x00000020 292 #define ACPI_BTYPE_EVENT 0x00000040 293 #define ACPI_BTYPE_METHOD 0x00000080 294 #define ACPI_BTYPE_MUTEX 0x00000100 295 #define ACPI_BTYPE_REGION 0x00000200 296 #define ACPI_BTYPE_POWER 0x00000400 297 #define ACPI_BTYPE_PROCESSOR 0x00000800 298 #define ACPI_BTYPE_THERMAL 0x00001000 299 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000 300 #define ACPI_BTYPE_DDB_HANDLE 0x00004000 301 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000 302 #define ACPI_BTYPE_REFERENCE 0x00010000 303 #define ACPI_BTYPE_RESOURCE 0x00020000 304 305 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER) 306 307 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE) 308 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE) 309 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR) 310 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */ 311 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF 312 313 /* 314 * Information structure for ACPI predefined names. 315 * Each entry in the table contains the following items: 316 * 317 * Name - The ACPI reserved name 318 * param_count - Number of arguments to the method 319 * expected_return_btypes - Allowed type(s) for the return value 320 */ 321 struct acpi_name_info { 322 char name[ACPI_NAME_SIZE]; 323 u8 param_count; 324 u8 expected_btypes; 325 }; 326 327 /* 328 * Secondary information structures for ACPI predefined objects that return 329 * package objects. This structure appears as the next entry in the table 330 * after the NAME_INFO structure above. 331 * 332 * The reason for this is to minimize the size of the predefined name table. 333 */ 334 335 /* 336 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2, 337 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT 338 */ 339 struct acpi_package_info { 340 u8 type; 341 u8 object_type1; 342 u8 count1; 343 u8 object_type2; 344 u8 count2; 345 u8 reserved; 346 }; 347 348 /* Used for ACPI_PTYPE2_FIXED */ 349 350 struct acpi_package_info2 { 351 u8 type; 352 u8 count; 353 u8 object_type[4]; 354 }; 355 356 /* Used for ACPI_PTYPE1_OPTION */ 357 358 struct acpi_package_info3 { 359 u8 type; 360 u8 count; 361 u8 object_type[2]; 362 u8 tail_object_type; 363 u8 reserved; 364 }; 365 366 union acpi_predefined_info { 367 struct acpi_name_info info; 368 struct acpi_package_info ret_info; 369 struct acpi_package_info2 ret_info2; 370 struct acpi_package_info3 ret_info3; 371 }; 372 373 /* Data block used during object validation */ 374 375 struct acpi_predefined_data { 376 char *pathname; 377 const union acpi_predefined_info *predefined; 378 union acpi_operand_object *parent_package; 379 u32 flags; 380 u8 node_flags; 381 }; 382 383 /* Defines for Flags field above */ 384 385 #define ACPI_OBJECT_REPAIRED 1 386 387 /* 388 * Bitmapped return value types 389 * Note: the actual data types must be contiguous, a loop in nspredef.c 390 * depends on this. 391 */ 392 #define ACPI_RTYPE_ANY 0x00 393 #define ACPI_RTYPE_NONE 0x01 394 #define ACPI_RTYPE_INTEGER 0x02 395 #define ACPI_RTYPE_STRING 0x04 396 #define ACPI_RTYPE_BUFFER 0x08 397 #define ACPI_RTYPE_PACKAGE 0x10 398 #define ACPI_RTYPE_REFERENCE 0x20 399 #define ACPI_RTYPE_ALL 0x3F 400 401 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */ 402 403 /***************************************************************************** 404 * 405 * Event typedefs and structs 406 * 407 ****************************************************************************/ 408 409 /* Dispatch info for each GPE -- either a method or handler, cannot be both */ 410 411 struct acpi_gpe_handler_info { 412 acpi_gpe_handler address; /* Address of handler, if any */ 413 void *context; /* Context to be passed to handler */ 414 struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */ 415 u8 original_flags; /* Original (pre-handler) GPE info */ 416 u8 originally_enabled; /* True if GPE was originally enabled */ 417 }; 418 419 union acpi_gpe_dispatch_info { 420 struct acpi_namespace_node *method_node; /* Method node for this GPE level */ 421 struct acpi_gpe_handler_info *handler; /* Installed GPE handler */ 422 struct acpi_namespace_node *device_node; /* Parent _PRW device for implicit notify */ 423 }; 424 425 /* 426 * Information about a GPE, one per each GPE in an array. 427 * NOTE: Important to keep this struct as small as possible. 428 */ 429 struct acpi_gpe_event_info { 430 union acpi_gpe_dispatch_info dispatch; /* Either Method or Handler */ 431 struct acpi_gpe_register_info *register_info; /* Backpointer to register info */ 432 u8 flags; /* Misc info about this GPE */ 433 u8 gpe_number; /* This GPE */ 434 u8 runtime_count; /* References to a run GPE */ 435 }; 436 437 /* Information about a GPE register pair, one per each status/enable pair in an array */ 438 439 struct acpi_gpe_register_info { 440 struct acpi_generic_address status_address; /* Address of status reg */ 441 struct acpi_generic_address enable_address; /* Address of enable reg */ 442 u8 enable_for_wake; /* GPEs to keep enabled when sleeping */ 443 u8 enable_for_run; /* GPEs to keep enabled when running */ 444 u8 base_gpe_number; /* Base GPE number for this register */ 445 }; 446 447 /* 448 * Information about a GPE register block, one per each installed block -- 449 * GPE0, GPE1, and one per each installed GPE Block Device. 450 */ 451 struct acpi_gpe_block_info { 452 struct acpi_namespace_node *node; 453 struct acpi_gpe_block_info *previous; 454 struct acpi_gpe_block_info *next; 455 struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */ 456 struct acpi_gpe_register_info *register_info; /* One per GPE register pair */ 457 struct acpi_gpe_event_info *event_info; /* One for each GPE */ 458 struct acpi_generic_address block_address; /* Base address of the block */ 459 u32 register_count; /* Number of register pairs in block */ 460 u16 gpe_count; /* Number of individual GPEs in block */ 461 u8 block_base_number; /* Base GPE number for this block */ 462 u8 initialized; /* TRUE if this block is initialized */ 463 }; 464 465 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */ 466 467 struct acpi_gpe_xrupt_info { 468 struct acpi_gpe_xrupt_info *previous; 469 struct acpi_gpe_xrupt_info *next; 470 struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */ 471 u32 interrupt_number; /* System interrupt number */ 472 }; 473 474 struct acpi_gpe_walk_info { 475 struct acpi_namespace_node *gpe_device; 476 struct acpi_gpe_block_info *gpe_block; 477 u16 count; 478 acpi_owner_id owner_id; 479 u8 execute_by_owner_id; 480 }; 481 482 struct acpi_gpe_device_info { 483 u32 index; 484 u32 next_block_base_index; 485 acpi_status status; 486 struct acpi_namespace_node *gpe_device; 487 }; 488 489 typedef acpi_status(*acpi_gpe_callback) (struct acpi_gpe_xrupt_info *gpe_xrupt_info, 490 struct acpi_gpe_block_info *gpe_block, void *context); 491 492 /* Information about each particular fixed event */ 493 494 struct acpi_fixed_event_handler { 495 acpi_event_handler handler; /* Address of handler. */ 496 void *context; /* Context to be passed to handler */ 497 }; 498 499 struct acpi_fixed_event_info { 500 u8 status_register_id; 501 u8 enable_register_id; 502 u16 status_bit_mask; 503 u16 enable_bit_mask; 504 }; 505 506 /* Information used during field processing */ 507 508 struct acpi_field_info { 509 u8 skip_field; 510 u8 field_flag; 511 u32 pkg_length; 512 }; 513 514 /***************************************************************************** 515 * 516 * Generic "state" object for stacks 517 * 518 ****************************************************************************/ 519 520 #define ACPI_CONTROL_NORMAL 0xC0 521 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1 522 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2 523 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3 524 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4 525 526 #define ACPI_STATE_COMMON \ 527 void *next; \ 528 u8 descriptor_type; /* To differentiate various internal objs */\ 529 u8 flags; \ 530 u16 value; \ 531 u16 state; 532 533 /* There are 2 bytes available here until the next natural alignment boundary */ 534 535 struct acpi_common_state { 536 ACPI_STATE_COMMON}; 537 538 /* 539 * Update state - used to traverse complex objects such as packages 540 */ 541 struct acpi_update_state { 542 ACPI_STATE_COMMON union acpi_operand_object *object; 543 }; 544 545 /* 546 * Pkg state - used to traverse nested package structures 547 */ 548 struct acpi_pkg_state { 549 ACPI_STATE_COMMON u16 index; 550 union acpi_operand_object *source_object; 551 union acpi_operand_object *dest_object; 552 struct acpi_walk_state *walk_state; 553 void *this_target_obj; 554 u32 num_packages; 555 }; 556 557 /* 558 * Control state - one per if/else and while constructs. 559 * Allows nesting of these constructs 560 */ 561 struct acpi_control_state { 562 ACPI_STATE_COMMON u16 opcode; 563 union acpi_parse_object *predicate_op; 564 u8 *aml_predicate_start; /* Start of if/while predicate */ 565 u8 *package_end; /* End of if/while block */ 566 u32 loop_count; /* While() loop counter */ 567 }; 568 569 /* 570 * Scope state - current scope during namespace lookups 571 */ 572 struct acpi_scope_state { 573 ACPI_STATE_COMMON struct acpi_namespace_node *node; 574 }; 575 576 struct acpi_pscope_state { 577 ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */ 578 union acpi_parse_object *op; /* Current op being parsed */ 579 u8 *arg_end; /* Current argument end */ 580 u8 *pkg_end; /* Current package end */ 581 u32 arg_list; /* Next argument to parse */ 582 }; 583 584 /* 585 * Thread state - one per thread across multiple walk states. Multiple walk 586 * states are created when there are nested control methods executing. 587 */ 588 struct acpi_thread_state { 589 ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */ 590 struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */ 591 union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */ 592 acpi_thread_id thread_id; /* Running thread ID */ 593 }; 594 595 /* 596 * Result values - used to accumulate the results of nested 597 * AML arguments 598 */ 599 struct acpi_result_values { 600 ACPI_STATE_COMMON 601 union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM]; 602 }; 603 604 typedef 605 acpi_status(*acpi_parse_downwards) (struct acpi_walk_state * walk_state, 606 union acpi_parse_object ** out_op); 607 608 typedef acpi_status(*acpi_parse_upwards) (struct acpi_walk_state * walk_state); 609 610 /* 611 * Notify info - used to pass info to the deferred notify 612 * handler/dispatcher. 613 */ 614 struct acpi_notify_info { 615 ACPI_STATE_COMMON struct acpi_namespace_node *node; 616 union acpi_operand_object *handler_obj; 617 }; 618 619 /* Generic state is union of structs above */ 620 621 union acpi_generic_state { 622 struct acpi_common_state common; 623 struct acpi_control_state control; 624 struct acpi_update_state update; 625 struct acpi_scope_state scope; 626 struct acpi_pscope_state parse_scope; 627 struct acpi_pkg_state pkg; 628 struct acpi_thread_state thread; 629 struct acpi_result_values results; 630 struct acpi_notify_info notify; 631 }; 632 633 /***************************************************************************** 634 * 635 * Interpreter typedefs and structs 636 * 637 ****************************************************************************/ 638 639 typedef acpi_status(*ACPI_EXECUTE_OP) (struct acpi_walk_state * walk_state); 640 641 /***************************************************************************** 642 * 643 * Parser typedefs and structs 644 * 645 ****************************************************************************/ 646 647 /* 648 * AML opcode, name, and argument layout 649 */ 650 struct acpi_opcode_info { 651 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT) 652 char *name; /* Opcode name (disassembler/debug only) */ 653 #endif 654 u32 parse_args; /* Grammar/Parse time arguments */ 655 u32 runtime_args; /* Interpret time arguments */ 656 u16 flags; /* Misc flags */ 657 u8 object_type; /* Corresponding internal object type */ 658 u8 class; /* Opcode class */ 659 u8 type; /* Opcode type */ 660 }; 661 662 union acpi_parse_value { 663 u64 integer; /* Integer constant (Up to 64 bits) */ 664 u32 size; /* bytelist or field size */ 665 char *string; /* NULL terminated string */ 666 u8 *buffer; /* buffer or string */ 667 char *name; /* NULL terminated string */ 668 union acpi_parse_object *arg; /* arguments and contained ops */ 669 }; 670 671 #ifdef ACPI_DISASSEMBLER 672 #define ACPI_DISASM_ONLY_MEMBERS(a) a; 673 #else 674 #define ACPI_DISASM_ONLY_MEMBERS(a) 675 #endif 676 677 #define ACPI_PARSE_COMMON \ 678 union acpi_parse_object *parent; /* Parent op */\ 679 u8 descriptor_type; /* To differentiate various internal objs */\ 680 u8 flags; /* Type of Op */\ 681 u16 aml_opcode; /* AML opcode */\ 682 u32 aml_offset; /* Offset of declaration in AML */\ 683 union acpi_parse_object *next; /* Next op */\ 684 struct acpi_namespace_node *node; /* For use by interpreter */\ 685 union acpi_parse_value value; /* Value or args associated with the opcode */\ 686 u8 arg_list_length; /* Number of elements in the arg list */\ 687 ACPI_DISASM_ONLY_MEMBERS (\ 688 u8 disasm_flags; /* Used during AML disassembly */\ 689 u8 disasm_opcode; /* Subtype used for disassembly */\ 690 char aml_op_name[16]) /* Op name (debug only) */ 691 692 #define ACPI_DASM_BUFFER 0x00 693 #define ACPI_DASM_RESOURCE 0x01 694 #define ACPI_DASM_STRING 0x02 695 #define ACPI_DASM_UNICODE 0x03 696 #define ACPI_DASM_EISAID 0x04 697 #define ACPI_DASM_MATCHOP 0x05 698 #define ACPI_DASM_LNOT_PREFIX 0x06 699 #define ACPI_DASM_LNOT_SUFFIX 0x07 700 #define ACPI_DASM_IGNORE 0x08 701 702 /* 703 * Generic operation (for example: If, While, Store) 704 */ 705 struct acpi_parse_obj_common { 706 ACPI_PARSE_COMMON}; 707 708 /* 709 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions), 710 * and bytelists. 711 */ 712 struct acpi_parse_obj_named { 713 ACPI_PARSE_COMMON u8 *path; 714 u8 *data; /* AML body or bytelist data */ 715 u32 length; /* AML length */ 716 u32 name; /* 4-byte name or zero if no name */ 717 }; 718 719 /* This version is used by the i_aSL compiler only */ 720 721 #define ACPI_MAX_PARSEOP_NAME 20 722 723 struct acpi_parse_obj_asl { 724 ACPI_PARSE_COMMON union acpi_parse_object *child; 725 union acpi_parse_object *parent_method; 726 char *filename; 727 char *external_name; 728 char *namepath; 729 char name_seg[4]; 730 u32 extra_value; 731 u32 column; 732 u32 line_number; 733 u32 logical_line_number; 734 u32 logical_byte_offset; 735 u32 end_line; 736 u32 end_logical_line; 737 u32 acpi_btype; 738 u32 aml_length; 739 u32 aml_subtree_length; 740 u32 final_aml_length; 741 u32 final_aml_offset; 742 u32 compile_flags; 743 u16 parse_opcode; 744 u8 aml_opcode_length; 745 u8 aml_pkg_len_bytes; 746 u8 extra; 747 char parse_op_name[ACPI_MAX_PARSEOP_NAME]; 748 }; 749 750 union acpi_parse_object { 751 struct acpi_parse_obj_common common; 752 struct acpi_parse_obj_named named; 753 struct acpi_parse_obj_asl asl; 754 }; 755 756 /* 757 * Parse state - one state per parser invocation and each control 758 * method. 759 */ 760 struct acpi_parse_state { 761 u8 *aml_start; /* First AML byte */ 762 u8 *aml; /* Next AML byte */ 763 u8 *aml_end; /* (last + 1) AML byte */ 764 u8 *pkg_start; /* Current package begin */ 765 u8 *pkg_end; /* Current package end */ 766 union acpi_parse_object *start_op; /* Root of parse tree */ 767 struct acpi_namespace_node *start_node; 768 union acpi_generic_state *scope; /* Current scope */ 769 union acpi_parse_object *start_scope; 770 u32 aml_size; 771 }; 772 773 /* Parse object flags */ 774 775 #define ACPI_PARSEOP_GENERIC 0x01 776 #define ACPI_PARSEOP_NAMED 0x02 777 #define ACPI_PARSEOP_DEFERRED 0x04 778 #define ACPI_PARSEOP_BYTELIST 0x08 779 #define ACPI_PARSEOP_IN_STACK 0x10 780 #define ACPI_PARSEOP_TARGET 0x20 781 #define ACPI_PARSEOP_IN_CACHE 0x80 782 783 /* Parse object disasm_flags */ 784 785 #define ACPI_PARSEOP_IGNORE 0x01 786 #define ACPI_PARSEOP_PARAMLIST 0x02 787 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x04 788 #define ACPI_PARSEOP_SPECIAL 0x10 789 790 /***************************************************************************** 791 * 792 * Hardware (ACPI registers) and PNP 793 * 794 ****************************************************************************/ 795 796 struct acpi_bit_register_info { 797 u8 parent_register; 798 u8 bit_position; 799 u16 access_bit_mask; 800 }; 801 802 /* 803 * Some ACPI registers have bits that must be ignored -- meaning that they 804 * must be preserved. 805 */ 806 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */ 807 808 /* Write-only bits must be zeroed by software */ 809 810 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */ 811 812 /* For control registers, both ignored and reserved bits must be preserved */ 813 814 /* 815 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the 816 * ACPI specification to be a "preserved" bit - "OSPM always preserves this 817 * bit position", section 4.7.3.2.1. However, on some machines the OS must 818 * write a one to this bit after resume for the machine to work properly. 819 * To enable this, we no longer attempt to preserve this bit. No machines 820 * are known to fail if the bit is not preserved. (May 2009) 821 */ 822 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */ 823 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */ 824 #define ACPI_PM1_CONTROL_PRESERVED_BITS \ 825 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS) 826 827 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */ 828 829 /* 830 * Register IDs 831 * These are the full ACPI registers 832 */ 833 #define ACPI_REGISTER_PM1_STATUS 0x01 834 #define ACPI_REGISTER_PM1_ENABLE 0x02 835 #define ACPI_REGISTER_PM1_CONTROL 0x03 836 #define ACPI_REGISTER_PM2_CONTROL 0x04 837 #define ACPI_REGISTER_PM_TIMER 0x05 838 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06 839 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07 840 841 /* Masks used to access the bit_registers */ 842 843 #define ACPI_BITMASK_TIMER_STATUS 0x0001 844 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010 845 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020 846 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100 847 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200 848 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400 849 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */ 850 #define ACPI_BITMASK_WAKE_STATUS 0x8000 851 852 #define ACPI_BITMASK_ALL_FIXED_STATUS (\ 853 ACPI_BITMASK_TIMER_STATUS | \ 854 ACPI_BITMASK_BUS_MASTER_STATUS | \ 855 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \ 856 ACPI_BITMASK_POWER_BUTTON_STATUS | \ 857 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \ 858 ACPI_BITMASK_RT_CLOCK_STATUS | \ 859 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \ 860 ACPI_BITMASK_WAKE_STATUS) 861 862 #define ACPI_BITMASK_TIMER_ENABLE 0x0001 863 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020 864 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100 865 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200 866 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400 867 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */ 868 869 #define ACPI_BITMASK_SCI_ENABLE 0x0001 870 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002 871 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004 872 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00 873 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000 874 875 #define ACPI_BITMASK_ARB_DISABLE 0x0001 876 877 /* Raw bit position of each bit_register */ 878 879 #define ACPI_BITPOSITION_TIMER_STATUS 0x00 880 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04 881 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05 882 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08 883 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09 884 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A 885 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */ 886 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F 887 888 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00 889 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05 890 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08 891 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09 892 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A 893 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */ 894 895 #define ACPI_BITPOSITION_SCI_ENABLE 0x00 896 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01 897 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02 898 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A 899 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D 900 901 #define ACPI_BITPOSITION_ARB_DISABLE 0x00 902 903 /* Structs and definitions for _OSI support and I/O port validation */ 904 905 #define ACPI_OSI_WIN_2000 0x01 906 #define ACPI_OSI_WIN_XP 0x02 907 #define ACPI_OSI_WIN_XP_SP1 0x03 908 #define ACPI_OSI_WINSRV_2003 0x04 909 #define ACPI_OSI_WIN_XP_SP2 0x05 910 #define ACPI_OSI_WINSRV_2003_SP1 0x06 911 #define ACPI_OSI_WIN_VISTA 0x07 912 #define ACPI_OSI_WINSRV_2008 0x08 913 #define ACPI_OSI_WIN_VISTA_SP1 0x09 914 #define ACPI_OSI_WIN_VISTA_SP2 0x0A 915 #define ACPI_OSI_WIN_7 0x0B 916 917 #define ACPI_ALWAYS_ILLEGAL 0x00 918 919 struct acpi_interface_info { 920 char *name; 921 struct acpi_interface_info *next; 922 u8 flags; 923 u8 value; 924 }; 925 926 #define ACPI_OSI_INVALID 0x01 927 #define ACPI_OSI_DYNAMIC 0x02 928 929 struct acpi_port_info { 930 char *name; 931 u16 start; 932 u16 end; 933 u8 osi_dependency; 934 }; 935 936 /***************************************************************************** 937 * 938 * Resource descriptors 939 * 940 ****************************************************************************/ 941 942 /* resource_type values */ 943 944 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0 945 #define ACPI_ADDRESS_TYPE_IO_RANGE 1 946 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2 947 948 /* Resource descriptor types and masks */ 949 950 #define ACPI_RESOURCE_NAME_LARGE 0x80 951 #define ACPI_RESOURCE_NAME_SMALL 0x00 952 953 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */ 954 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */ 955 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */ 956 957 /* 958 * Small resource descriptor "names" as defined by the ACPI specification. 959 * Note: Bits 2:0 are used for the descriptor length 960 */ 961 #define ACPI_RESOURCE_NAME_IRQ 0x20 962 #define ACPI_RESOURCE_NAME_DMA 0x28 963 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30 964 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38 965 #define ACPI_RESOURCE_NAME_IO 0x40 966 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48 967 #define ACPI_RESOURCE_NAME_RESERVED_S1 0x50 968 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58 969 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60 970 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68 971 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70 972 #define ACPI_RESOURCE_NAME_END_TAG 0x78 973 974 /* 975 * Large resource descriptor "names" as defined by the ACPI specification. 976 * Note: includes the Large Descriptor bit in bit[7] 977 */ 978 #define ACPI_RESOURCE_NAME_MEMORY24 0x81 979 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82 980 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83 981 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84 982 #define ACPI_RESOURCE_NAME_MEMORY32 0x85 983 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86 984 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87 985 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88 986 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89 987 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A 988 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B 989 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8B 990 991 /***************************************************************************** 992 * 993 * Miscellaneous 994 * 995 ****************************************************************************/ 996 997 #define ACPI_ASCII_ZERO 0x30 998 999 /***************************************************************************** 1000 * 1001 * Debugger 1002 * 1003 ****************************************************************************/ 1004 1005 struct acpi_db_method_info { 1006 acpi_handle main_thread_gate; 1007 acpi_handle thread_complete_gate; 1008 acpi_thread_id *threads; 1009 u32 num_threads; 1010 u32 num_created; 1011 u32 num_completed; 1012 1013 char *name; 1014 u32 flags; 1015 u32 num_loops; 1016 char pathname[128]; 1017 char **args; 1018 1019 /* 1020 * Arguments to be passed to method for the command 1021 * Threads - 1022 * the Number of threads, ID of current thread and 1023 * Index of current thread inside all them created. 1024 */ 1025 char init_args; 1026 char *arguments[4]; 1027 char num_threads_str[11]; 1028 char id_of_thread_str[11]; 1029 char index_of_thread_str[11]; 1030 }; 1031 1032 struct acpi_integrity_info { 1033 u32 nodes; 1034 u32 objects; 1035 }; 1036 1037 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01 1038 #define ACPI_DB_CONSOLE_OUTPUT 0x02 1039 #define ACPI_DB_DUPLICATE_OUTPUT 0x03 1040 1041 /***************************************************************************** 1042 * 1043 * Debug 1044 * 1045 ****************************************************************************/ 1046 1047 /* Entry for a memory allocation (debug only) */ 1048 1049 #define ACPI_MEM_MALLOC 0 1050 #define ACPI_MEM_CALLOC 1 1051 #define ACPI_MAX_MODULE_NAME 16 1052 1053 #define ACPI_COMMON_DEBUG_MEM_HEADER \ 1054 struct acpi_debug_mem_block *previous; \ 1055 struct acpi_debug_mem_block *next; \ 1056 u32 size; \ 1057 u32 component; \ 1058 u32 line; \ 1059 char module[ACPI_MAX_MODULE_NAME]; \ 1060 u8 alloc_type; 1061 1062 struct acpi_debug_mem_header { 1063 ACPI_COMMON_DEBUG_MEM_HEADER}; 1064 1065 struct acpi_debug_mem_block { 1066 ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space; 1067 }; 1068 1069 #define ACPI_MEM_LIST_GLOBAL 0 1070 #define ACPI_MEM_LIST_NSNODE 1 1071 #define ACPI_MEM_LIST_MAX 1 1072 #define ACPI_NUM_MEM_LISTS 2 1073 1074 #endif /* __ACLOCAL_H__ */ 1075