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