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