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