1 /****************************************************************************** 2 * 3 * Name: aclocal.h - Internal data types used across the ACPI subsystem 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2022, 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 MERCHANTABILITY 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 48 /* acpisrc:StructDefs -- for acpisrc conversion */ 49 50 #define ACPI_SERIALIZED 0xFF 51 52 typedef UINT32 ACPI_MUTEX_HANDLE; 53 #define ACPI_GLOBAL_LOCK (ACPI_SEMAPHORE) (-1) 54 55 /* Total number of aml opcodes defined */ 56 57 #define AML_NUM_OPCODES 0x83 58 59 60 /* Forward declarations */ 61 62 struct acpi_walk_state; 63 struct acpi_obj_mutex; 64 union acpi_parse_object; 65 66 67 /***************************************************************************** 68 * 69 * Mutex typedefs and structs 70 * 71 ****************************************************************************/ 72 73 74 /* 75 * Predefined handles for the mutex objects used within the subsystem 76 * All mutex objects are automatically created by AcpiUtMutexInitialize. 77 * 78 * The acquire/release ordering protocol is implied via this list. Mutexes 79 * with a lower value must be acquired before mutexes with a higher value. 80 * 81 * NOTE: any changes here must be reflected in the AcpiGbl_MutexNames 82 * table below also! 83 */ 84 #define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */ 85 #define ACPI_MTX_NAMESPACE 1 /* ACPI Namespace */ 86 #define ACPI_MTX_TABLES 2 /* Data for ACPI tables */ 87 #define ACPI_MTX_EVENTS 3 /* Data for ACPI events */ 88 #define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */ 89 #define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */ 90 91 #define ACPI_MAX_MUTEX 5 92 #define ACPI_NUM_MUTEX (ACPI_MAX_MUTEX+1) 93 94 95 /* Lock structure for reader/writer interfaces */ 96 97 typedef struct acpi_rw_lock 98 { 99 ACPI_MUTEX WriterMutex; 100 ACPI_MUTEX ReaderMutex; 101 UINT32 NumReaders; 102 103 } ACPI_RW_LOCK; 104 105 106 /* 107 * Predefined handles for spinlocks used within the subsystem. 108 * These spinlocks are created by AcpiUtMutexInitialize 109 */ 110 #define ACPI_LOCK_GPES 0 111 #define ACPI_LOCK_HARDWARE 1 112 113 #define ACPI_MAX_LOCK 1 114 #define ACPI_NUM_LOCK (ACPI_MAX_LOCK+1) 115 116 117 /* This Thread ID means that the mutex is not in use (unlocked) */ 118 119 #define ACPI_MUTEX_NOT_ACQUIRED ((ACPI_THREAD_ID) -1) 120 121 /* This Thread ID means an invalid thread ID */ 122 123 #ifdef ACPI_OS_INVALID_THREAD_ID 124 #define ACPI_INVALID_THREAD_ID ACPI_OS_INVALID_THREAD_ID 125 #else 126 #define ACPI_INVALID_THREAD_ID ((ACPI_THREAD_ID) 0xFFFFFFFF) 127 #endif 128 129 /* Table for the global mutexes */ 130 131 typedef struct acpi_mutex_info 132 { 133 ACPI_MUTEX Mutex; 134 UINT32 UseCount; 135 ACPI_THREAD_ID ThreadId; 136 137 } ACPI_MUTEX_INFO; 138 139 140 /* Lock flag parameter for various interfaces */ 141 142 #define ACPI_MTX_DO_NOT_LOCK 0 143 #define ACPI_MTX_LOCK 1 144 145 146 /* Field access granularities */ 147 148 #define ACPI_FIELD_BYTE_GRANULARITY 1 149 #define ACPI_FIELD_WORD_GRANULARITY 2 150 #define ACPI_FIELD_DWORD_GRANULARITY 4 151 #define ACPI_FIELD_QWORD_GRANULARITY 8 152 153 154 #define ACPI_ENTRY_NOT_FOUND NULL 155 156 157 /***************************************************************************** 158 * 159 * Namespace typedefs and structs 160 * 161 ****************************************************************************/ 162 163 /* Operational modes of the AML interpreter/scanner */ 164 165 typedef enum 166 { 167 ACPI_IMODE_LOAD_PASS1 = 0x01, 168 ACPI_IMODE_LOAD_PASS2 = 0x02, 169 ACPI_IMODE_EXECUTE = 0x03 170 171 } ACPI_INTERPRETER_MODE; 172 173 174 /* 175 * The Namespace Node describes a named object that appears in the AML. 176 * DescriptorType is used to differentiate between internal descriptors. 177 * 178 * The node is optimized for both 32-bit and 64-bit platforms: 179 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case. 180 * 181 * Note: The DescriptorType and Type fields must appear in the identical 182 * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT 183 * structures. 184 */ 185 typedef struct acpi_namespace_node 186 { 187 union acpi_operand_object *Object; /* Interpreter object */ 188 UINT8 DescriptorType; /* Differentiate object descriptor types */ 189 UINT8 Type; /* ACPI Type associated with this name */ 190 UINT16 Flags; /* Miscellaneous flags */ 191 ACPI_NAME_UNION Name; /* ACPI Name, always 4 chars per ACPI spec */ 192 struct acpi_namespace_node *Parent; /* Parent node */ 193 struct acpi_namespace_node *Child; /* First child */ 194 struct acpi_namespace_node *Peer; /* First peer */ 195 ACPI_OWNER_ID OwnerId; /* Node creator */ 196 197 /* 198 * The following fields are used by the ASL compiler and disassembler only 199 */ 200 #ifdef ACPI_LARGE_NAMESPACE_NODE 201 union acpi_parse_object *Op; 202 void *MethodLocals; 203 void *MethodArgs; 204 UINT32 Value; 205 UINT32 Length; 206 UINT8 ArgCount; 207 208 #endif 209 210 } ACPI_NAMESPACE_NODE; 211 212 213 /* Namespace Node flags */ 214 215 #define ANOBJ_RESERVED 0x01 /* Available for use */ 216 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */ 217 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */ 218 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */ 219 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */ 220 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */ 221 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (InstallMethod) */ 222 #define ANOBJ_NODE_EARLY_INIT 0x80 /* AcpiExec only: Node was create via init file (-fi) */ 223 224 #define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */ 225 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */ 226 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */ 227 #define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */ 228 229 230 /* Internal ACPI table management - master table list */ 231 232 typedef struct acpi_table_list 233 { 234 ACPI_TABLE_DESC *Tables; /* Table descriptor array */ 235 UINT32 CurrentTableCount; /* Tables currently in the array */ 236 UINT32 MaxTableCount; /* Max tables array will hold */ 237 UINT8 Flags; 238 239 } ACPI_TABLE_LIST; 240 241 /* Flags for above */ 242 243 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */ 244 #define ACPI_ROOT_ORIGIN_ALLOCATED (1) 245 #define ACPI_ROOT_ALLOW_RESIZE (2) 246 247 248 /* List to manage incoming ACPI tables */ 249 250 typedef struct acpi_new_table_desc 251 { 252 ACPI_TABLE_HEADER *Table; 253 struct acpi_new_table_desc *Next; 254 255 } ACPI_NEW_TABLE_DESC; 256 257 258 /* Predefined table indexes */ 259 260 #define ACPI_INVALID_TABLE_INDEX (0xFFFFFFFF) 261 262 263 typedef struct acpi_find_context 264 { 265 char *SearchFor; 266 ACPI_HANDLE *List; 267 UINT32 *Count; 268 269 } ACPI_FIND_CONTEXT; 270 271 272 typedef struct acpi_ns_search_data 273 { 274 ACPI_NAMESPACE_NODE *Node; 275 276 } ACPI_NS_SEARCH_DATA; 277 278 279 /* Object types used during package copies */ 280 281 #define ACPI_COPY_TYPE_SIMPLE 0 282 #define ACPI_COPY_TYPE_PACKAGE 1 283 284 285 /* Info structure used to convert external<->internal namestrings */ 286 287 typedef struct acpi_namestring_info 288 { 289 const char *ExternalName; 290 const char *NextExternalChar; 291 char *InternalName; 292 UINT32 Length; 293 UINT32 NumSegments; 294 UINT32 NumCarats; 295 BOOLEAN FullyQualified; 296 297 } ACPI_NAMESTRING_INFO; 298 299 300 /* Field creation info */ 301 302 typedef struct acpi_create_field_info 303 { 304 ACPI_NAMESPACE_NODE *RegionNode; 305 ACPI_NAMESPACE_NODE *FieldNode; 306 ACPI_NAMESPACE_NODE *RegisterNode; 307 ACPI_NAMESPACE_NODE *DataRegisterNode; 308 ACPI_NAMESPACE_NODE *ConnectionNode; 309 UINT8 *ResourceBuffer; 310 UINT32 BankValue; 311 UINT32 FieldBitPosition; 312 UINT32 FieldBitLength; 313 UINT16 ResourceLength; 314 UINT16 PinNumberIndex; 315 UINT8 FieldFlags; 316 UINT8 Attribute; 317 UINT8 FieldType; 318 UINT8 AccessLength; 319 320 } ACPI_CREATE_FIELD_INFO; 321 322 323 typedef 324 ACPI_STATUS (*ACPI_INTERNAL_METHOD) ( 325 struct acpi_walk_state *WalkState); 326 327 328 /* 329 * Bitmapped ACPI types. Used internally only 330 */ 331 #define ACPI_BTYPE_ANY 0x00000000 332 #define ACPI_BTYPE_INTEGER 0x00000001 333 #define ACPI_BTYPE_STRING 0x00000002 334 #define ACPI_BTYPE_BUFFER 0x00000004 335 #define ACPI_BTYPE_PACKAGE 0x00000008 336 #define ACPI_BTYPE_FIELD_UNIT 0x00000010 337 #define ACPI_BTYPE_DEVICE 0x00000020 338 #define ACPI_BTYPE_EVENT 0x00000040 339 #define ACPI_BTYPE_METHOD 0x00000080 340 #define ACPI_BTYPE_MUTEX 0x00000100 341 #define ACPI_BTYPE_REGION 0x00000200 342 #define ACPI_BTYPE_POWER 0x00000400 343 #define ACPI_BTYPE_PROCESSOR 0x00000800 344 #define ACPI_BTYPE_THERMAL 0x00001000 345 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000 346 #define ACPI_BTYPE_DDB_HANDLE 0x00004000 347 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000 348 #define ACPI_BTYPE_REFERENCE_OBJECT 0x00010000 /* From Index(), RefOf(), etc (Type6Opcodes) */ 349 #define ACPI_BTYPE_RESOURCE 0x00020000 350 #define ACPI_BTYPE_NAMED_REFERENCE 0x00040000 /* Generic unresolved Name or Namepath */ 351 352 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER) 353 354 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE) 355 356 /* Used by Copy, DeRefOf, Store, Printf, Fprintf */ 357 358 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE_OBJECT | ACPI_BTYPE_DDB_HANDLE) 359 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR) 360 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */ 361 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF 362 363 #pragma pack(1) 364 365 /* 366 * Information structure for ACPI predefined names. 367 * Each entry in the table contains the following items: 368 * 369 * Name - The ACPI reserved name 370 * ParamCount - Number of arguments to the method 371 * ExpectedReturnBtypes - Allowed type(s) for the return value 372 */ 373 typedef struct acpi_name_info 374 { 375 char Name[ACPI_NAMESEG_SIZE]; 376 UINT16 ArgumentList; 377 UINT8 ExpectedBtypes; 378 379 } ACPI_NAME_INFO; 380 381 /* 382 * Secondary information structures for ACPI predefined objects that return 383 * package objects. This structure appears as the next entry in the table 384 * after the NAME_INFO structure above. 385 * 386 * The reason for this is to minimize the size of the predefined name table. 387 */ 388 389 /* 390 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2, 391 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT, 392 * ACPI_PTYPE2_FIX_VAR 393 */ 394 typedef struct acpi_package_info 395 { 396 UINT8 Type; 397 UINT8 ObjectType1; 398 UINT8 Count1; 399 UINT8 ObjectType2; 400 UINT8 Count2; 401 UINT16 Reserved; 402 403 } ACPI_PACKAGE_INFO; 404 405 /* Used for ACPI_PTYPE2_FIXED */ 406 407 typedef struct acpi_package_info2 408 { 409 UINT8 Type; 410 UINT8 Count; 411 UINT8 ObjectType[4]; 412 UINT8 Reserved; 413 414 } ACPI_PACKAGE_INFO2; 415 416 /* Used for ACPI_PTYPE1_OPTION */ 417 418 typedef struct acpi_package_info3 419 { 420 UINT8 Type; 421 UINT8 Count; 422 UINT8 ObjectType[2]; 423 UINT8 TailObjectType; 424 UINT16 Reserved; 425 426 } ACPI_PACKAGE_INFO3; 427 428 typedef struct acpi_package_info4 429 { 430 UINT8 Type; 431 UINT8 ObjectType1; 432 UINT8 Count1; 433 UINT8 SubObjectTypes; 434 UINT8 PkgCount; 435 UINT16 Reserved; 436 437 } ACPI_PACKAGE_INFO4; 438 439 typedef union acpi_predefined_info 440 { 441 ACPI_NAME_INFO Info; 442 ACPI_PACKAGE_INFO RetInfo; 443 ACPI_PACKAGE_INFO2 RetInfo2; 444 ACPI_PACKAGE_INFO3 RetInfo3; 445 ACPI_PACKAGE_INFO4 RetInfo4; 446 447 } ACPI_PREDEFINED_INFO; 448 449 /* Reset to default packing */ 450 451 #pragma pack() 452 453 454 /* Return object auto-repair info */ 455 456 typedef ACPI_STATUS (*ACPI_OBJECT_CONVERTER) ( 457 struct acpi_namespace_node *Scope, 458 union acpi_operand_object *OriginalObject, 459 union acpi_operand_object **ConvertedObject); 460 461 typedef struct acpi_simple_repair_info 462 { 463 char Name[ACPI_NAMESEG_SIZE]; 464 UINT32 UnexpectedBtypes; 465 UINT32 PackageIndex; 466 ACPI_OBJECT_CONVERTER ObjectConverter; 467 468 } ACPI_SIMPLE_REPAIR_INFO; 469 470 471 /* 472 * Bitmapped return value types 473 * Note: the actual data types must be contiguous, a loop in nspredef.c 474 * depends on this. 475 */ 476 #define ACPI_RTYPE_ANY 0x00 477 #define ACPI_RTYPE_NONE 0x01 478 #define ACPI_RTYPE_INTEGER 0x02 479 #define ACPI_RTYPE_STRING 0x04 480 #define ACPI_RTYPE_BUFFER 0x08 481 #define ACPI_RTYPE_PACKAGE 0x10 482 #define ACPI_RTYPE_REFERENCE 0x20 483 #define ACPI_RTYPE_ALL 0x3F 484 485 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */ 486 487 488 /* Info for running the _REG methods */ 489 490 typedef struct acpi_reg_walk_info 491 { 492 UINT32 Function; 493 UINT32 RegRunCount; 494 ACPI_ADR_SPACE_TYPE SpaceId; 495 496 } ACPI_REG_WALK_INFO; 497 498 499 /***************************************************************************** 500 * 501 * Event typedefs and structs 502 * 503 ****************************************************************************/ 504 505 /* Dispatch info for each host-installed SCI handler */ 506 507 typedef struct acpi_sci_handler_info 508 { 509 struct acpi_sci_handler_info *Next; 510 ACPI_SCI_HANDLER Address; /* Address of handler */ 511 void *Context; /* Context to be passed to handler */ 512 513 } ACPI_SCI_HANDLER_INFO; 514 515 /* Dispatch info for each GPE -- either a method or handler, cannot be both */ 516 517 typedef struct acpi_gpe_handler_info 518 { 519 ACPI_GPE_HANDLER Address; /* Address of handler, if any */ 520 void *Context; /* Context to be passed to handler */ 521 ACPI_NAMESPACE_NODE *MethodNode; /* Method node for this GPE level (saved) */ 522 UINT8 OriginalFlags; /* Original (pre-handler) GPE info */ 523 BOOLEAN OriginallyEnabled; /* True if GPE was originally enabled */ 524 525 } ACPI_GPE_HANDLER_INFO; 526 527 /* Notify info for implicit notify, multiple device objects */ 528 529 typedef struct acpi_gpe_notify_info 530 { 531 ACPI_NAMESPACE_NODE *DeviceNode; /* Device to be notified */ 532 struct acpi_gpe_notify_info *Next; 533 534 } ACPI_GPE_NOTIFY_INFO; 535 536 /* 537 * GPE dispatch info. At any time, the GPE can have at most one type 538 * of dispatch - Method, Handler, or Implicit Notify. 539 */ 540 typedef union acpi_gpe_dispatch_info 541 { 542 ACPI_NAMESPACE_NODE *MethodNode; /* Method node for this GPE level */ 543 ACPI_GPE_HANDLER_INFO *Handler; /* Installed GPE handler */ 544 ACPI_GPE_NOTIFY_INFO *NotifyList; /* List of _PRW devices for implicit notifies */ 545 546 } ACPI_GPE_DISPATCH_INFO; 547 548 /* 549 * Information about a GPE, one per each GPE in an array. 550 * NOTE: Important to keep this struct as small as possible. 551 */ 552 typedef struct acpi_gpe_event_info 553 { 554 union acpi_gpe_dispatch_info Dispatch; /* Either Method, Handler, or NotifyList */ 555 struct acpi_gpe_register_info *RegisterInfo; /* Backpointer to register info */ 556 UINT8 Flags; /* Misc info about this GPE */ 557 UINT8 GpeNumber; /* This GPE */ 558 UINT8 RuntimeCount; /* References to a run GPE */ 559 BOOLEAN DisableForDispatch; /* Masked during dispatching */ 560 561 } ACPI_GPE_EVENT_INFO; 562 563 /* Information about a GPE register pair, one per each status/enable pair in an array */ 564 565 typedef struct acpi_gpe_register_info 566 { 567 ACPI_GENERIC_ADDRESS StatusAddress; /* Address of status reg */ 568 ACPI_GENERIC_ADDRESS EnableAddress; /* Address of enable reg */ 569 UINT16 BaseGpeNumber; /* Base GPE number for this register */ 570 UINT8 EnableForWake; /* GPEs to keep enabled when sleeping */ 571 UINT8 EnableForRun; /* GPEs to keep enabled when running */ 572 UINT8 MaskForRun; /* GPEs to keep masked when running */ 573 UINT8 EnableMask; /* Current mask of enabled GPEs */ 574 575 } ACPI_GPE_REGISTER_INFO; 576 577 /* 578 * Information about a GPE register block, one per each installed block -- 579 * GPE0, GPE1, and one per each installed GPE Block Device. 580 */ 581 typedef struct acpi_gpe_block_info 582 { 583 ACPI_NAMESPACE_NODE *Node; 584 struct acpi_gpe_block_info *Previous; 585 struct acpi_gpe_block_info *Next; 586 struct acpi_gpe_xrupt_info *XruptBlock; /* Backpointer to interrupt block */ 587 ACPI_GPE_REGISTER_INFO *RegisterInfo; /* One per GPE register pair */ 588 ACPI_GPE_EVENT_INFO *EventInfo; /* One for each GPE */ 589 UINT64 Address; /* Base address of the block */ 590 UINT32 RegisterCount; /* Number of register pairs in block */ 591 UINT16 GpeCount; /* Number of individual GPEs in block */ 592 UINT16 BlockBaseNumber;/* Base GPE number for this block */ 593 UINT8 SpaceId; 594 BOOLEAN Initialized; /* TRUE if this block is initialized */ 595 596 } ACPI_GPE_BLOCK_INFO; 597 598 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */ 599 600 typedef struct acpi_gpe_xrupt_info 601 { 602 struct acpi_gpe_xrupt_info *Previous; 603 struct acpi_gpe_xrupt_info *Next; 604 ACPI_GPE_BLOCK_INFO *GpeBlockListHead; /* List of GPE blocks for this xrupt */ 605 UINT32 InterruptNumber; /* System interrupt number */ 606 607 } ACPI_GPE_XRUPT_INFO; 608 609 typedef struct acpi_gpe_walk_info 610 { 611 ACPI_NAMESPACE_NODE *GpeDevice; 612 ACPI_GPE_BLOCK_INFO *GpeBlock; 613 UINT16 Count; 614 ACPI_OWNER_ID OwnerId; 615 BOOLEAN ExecuteByOwnerId; 616 617 } ACPI_GPE_WALK_INFO; 618 619 typedef struct acpi_gpe_device_info 620 { 621 UINT32 Index; 622 UINT32 NextBlockBaseIndex; 623 ACPI_STATUS Status; 624 ACPI_NAMESPACE_NODE *GpeDevice; 625 626 } ACPI_GPE_DEVICE_INFO; 627 628 typedef ACPI_STATUS (*ACPI_GPE_CALLBACK) ( 629 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 630 ACPI_GPE_BLOCK_INFO *GpeBlock, 631 void *Context); 632 633 634 /* Information about each particular fixed event */ 635 636 typedef struct acpi_fixed_event_handler 637 { 638 ACPI_EVENT_HANDLER Handler; /* Address of handler. */ 639 void *Context; /* Context to be passed to handler */ 640 641 } ACPI_FIXED_EVENT_HANDLER; 642 643 typedef struct acpi_fixed_event_info 644 { 645 UINT8 StatusRegisterId; 646 UINT8 EnableRegisterId; 647 UINT16 StatusBitMask; 648 UINT16 EnableBitMask; 649 650 } ACPI_FIXED_EVENT_INFO; 651 652 /* Information used during field processing */ 653 654 typedef struct acpi_field_info 655 { 656 UINT8 SkipField; 657 UINT8 FieldFlag; 658 UINT32 PkgLength; 659 660 } ACPI_FIELD_INFO; 661 662 663 /***************************************************************************** 664 * 665 * Generic "state" object for stacks 666 * 667 ****************************************************************************/ 668 669 #define ACPI_CONTROL_NORMAL 0xC0 670 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1 671 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2 672 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3 673 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4 674 675 676 #define ACPI_STATE_COMMON \ 677 void *Next; \ 678 UINT8 DescriptorType; /* To differentiate various internal objs */\ 679 UINT8 Flags; \ 680 UINT16 Value; \ 681 UINT16 State; 682 683 /* There are 2 bytes available here until the next natural alignment boundary */ 684 685 typedef struct acpi_common_state 686 { 687 ACPI_STATE_COMMON 688 } ACPI_COMMON_STATE; 689 690 691 /* 692 * Update state - used to traverse complex objects such as packages 693 */ 694 typedef struct acpi_update_state 695 { 696 ACPI_STATE_COMMON 697 union acpi_operand_object *Object; 698 699 } ACPI_UPDATE_STATE; 700 701 702 /* 703 * Pkg state - used to traverse nested package structures 704 */ 705 typedef struct acpi_pkg_state 706 { 707 ACPI_STATE_COMMON 708 UINT32 Index; 709 union acpi_operand_object *SourceObject; 710 union acpi_operand_object *DestObject; 711 struct acpi_walk_state *WalkState; 712 void *ThisTargetObj; 713 UINT32 NumPackages; 714 715 } ACPI_PKG_STATE; 716 717 718 /* 719 * Control state - one per if/else and while constructs. 720 * Allows nesting of these constructs 721 */ 722 typedef struct acpi_control_state 723 { 724 ACPI_STATE_COMMON 725 UINT16 Opcode; 726 union acpi_parse_object *PredicateOp; 727 UINT8 *AmlPredicateStart; /* Start of if/while predicate */ 728 UINT8 *PackageEnd; /* End of if/while block */ 729 UINT64 LoopTimeout; /* While() loop timeout */ 730 731 } ACPI_CONTROL_STATE; 732 733 734 /* 735 * Scope state - current scope during namespace lookups 736 */ 737 typedef struct acpi_scope_state 738 { 739 ACPI_STATE_COMMON 740 ACPI_NAMESPACE_NODE *Node; 741 742 } ACPI_SCOPE_STATE; 743 744 745 typedef struct acpi_pscope_state 746 { 747 ACPI_STATE_COMMON 748 UINT32 ArgCount; /* Number of fixed arguments */ 749 union acpi_parse_object *Op; /* Current op being parsed */ 750 UINT8 *ArgEnd; /* Current argument end */ 751 UINT8 *PkgEnd; /* Current package end */ 752 UINT32 ArgList; /* Next argument to parse */ 753 754 } ACPI_PSCOPE_STATE; 755 756 757 /* 758 * Thread state - one per thread across multiple walk states. Multiple walk 759 * states are created when there are nested control methods executing. 760 */ 761 typedef struct acpi_thread_state 762 { 763 ACPI_STATE_COMMON 764 UINT8 CurrentSyncLevel; /* Mutex Sync (nested acquire) level */ 765 struct acpi_walk_state *WalkStateList; /* Head of list of WalkStates for this thread */ 766 union acpi_operand_object *AcquiredMutexList; /* List of all currently acquired mutexes */ 767 ACPI_THREAD_ID ThreadId; /* Running thread ID */ 768 769 } ACPI_THREAD_STATE; 770 771 772 /* 773 * Result values - used to accumulate the results of nested 774 * AML arguments 775 */ 776 typedef struct acpi_result_values 777 { 778 ACPI_STATE_COMMON 779 union acpi_operand_object *ObjDesc [ACPI_RESULTS_FRAME_OBJ_NUM]; 780 781 } ACPI_RESULT_VALUES; 782 783 784 typedef 785 ACPI_STATUS (*ACPI_PARSE_DOWNWARDS) ( 786 struct acpi_walk_state *WalkState, 787 union acpi_parse_object **OutOp); 788 789 typedef 790 ACPI_STATUS (*ACPI_PARSE_UPWARDS) ( 791 struct acpi_walk_state *WalkState); 792 793 794 /* Global handlers for AML Notifies */ 795 796 typedef struct acpi_global_notify_handler 797 { 798 ACPI_NOTIFY_HANDLER Handler; 799 void *Context; 800 801 } ACPI_GLOBAL_NOTIFY_HANDLER; 802 803 /* 804 * Notify info - used to pass info to the deferred notify 805 * handler/dispatcher. 806 */ 807 typedef struct acpi_notify_info 808 { 809 ACPI_STATE_COMMON 810 UINT8 HandlerListId; 811 ACPI_NAMESPACE_NODE *Node; 812 union acpi_operand_object *HandlerListHead; 813 ACPI_GLOBAL_NOTIFY_HANDLER *Global; 814 815 } ACPI_NOTIFY_INFO; 816 817 818 /* Generic state is union of structs above */ 819 820 typedef union acpi_generic_state 821 { 822 ACPI_COMMON_STATE Common; 823 ACPI_CONTROL_STATE Control; 824 ACPI_UPDATE_STATE Update; 825 ACPI_SCOPE_STATE Scope; 826 ACPI_PSCOPE_STATE ParseScope; 827 ACPI_PKG_STATE Pkg; 828 ACPI_THREAD_STATE Thread; 829 ACPI_RESULT_VALUES Results; 830 ACPI_NOTIFY_INFO Notify; 831 832 } ACPI_GENERIC_STATE; 833 834 835 /***************************************************************************** 836 * 837 * Interpreter typedefs and structs 838 * 839 ****************************************************************************/ 840 841 typedef 842 ACPI_STATUS (*ACPI_EXECUTE_OP) ( 843 struct acpi_walk_state *WalkState); 844 845 /* Address Range info block */ 846 847 typedef struct acpi_address_range 848 { 849 struct acpi_address_range *Next; 850 ACPI_NAMESPACE_NODE *RegionNode; 851 ACPI_PHYSICAL_ADDRESS StartAddress; 852 ACPI_PHYSICAL_ADDRESS EndAddress; 853 854 } ACPI_ADDRESS_RANGE; 855 856 857 /***************************************************************************** 858 * 859 * Parser typedefs and structs 860 * 861 ****************************************************************************/ 862 863 /* 864 * AML opcode, name, and argument layout 865 */ 866 typedef struct acpi_opcode_info 867 { 868 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT) 869 const char *Name; /* Opcode name (disassembler/debug only) */ 870 #endif 871 UINT32 ParseArgs; /* Grammar/Parse time arguments */ 872 UINT32 RuntimeArgs; /* Interpret time arguments */ 873 UINT16 Flags; /* Misc flags */ 874 UINT8 ObjectType; /* Corresponding internal object type */ 875 UINT8 Class; /* Opcode class */ 876 UINT8 Type; /* Opcode type */ 877 878 } ACPI_OPCODE_INFO; 879 880 /* Structure for Resource Tag information */ 881 882 typedef struct acpi_tag_info 883 { 884 UINT32 BitOffset; 885 UINT32 BitLength; 886 887 } ACPI_TAG_INFO; 888 889 /* Value associated with the parse object */ 890 891 typedef union acpi_parse_value 892 { 893 UINT64 Integer; /* Integer constant (Up to 64 bits) */ 894 UINT32 Size; /* bytelist or field size */ 895 char *String; /* NULL terminated string */ 896 UINT8 *Buffer; /* buffer or string */ 897 char *Name; /* NULL terminated string */ 898 union acpi_parse_object *Arg; /* arguments and contained ops */ 899 ACPI_TAG_INFO Tag; /* Resource descriptor tag info */ 900 901 } ACPI_PARSE_VALUE; 902 903 904 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT) 905 #define ACPI_DISASM_ONLY_MEMBERS(a) a; 906 #else 907 #define ACPI_DISASM_ONLY_MEMBERS(a) 908 #endif 909 910 #if defined(ACPI_ASL_COMPILER) 911 #define ACPI_CONVERTER_ONLY_MEMBERS(a) a; 912 #else 913 #define ACPI_CONVERTER_ONLY_MEMBERS(a) 914 #endif 915 916 #define ACPI_PARSE_COMMON \ 917 union acpi_parse_object *Parent; /* Parent op */\ 918 UINT8 DescriptorType; /* To differentiate various internal objs */\ 919 UINT8 Flags; /* Type of Op */\ 920 UINT16 AmlOpcode; /* AML opcode */\ 921 UINT8 *Aml; /* Address of declaration in AML */\ 922 union acpi_parse_object *Next; /* Next op */\ 923 ACPI_NAMESPACE_NODE *Node; /* For use by interpreter */\ 924 ACPI_PARSE_VALUE Value; /* Value or args associated with the opcode */\ 925 UINT8 ArgListLength; /* Number of elements in the arg list */\ 926 ACPI_DISASM_ONLY_MEMBERS (\ 927 UINT16 DisasmFlags; /* Used during AML disassembly */\ 928 UINT8 DisasmOpcode; /* Subtype used for disassembly */\ 929 const char *OperatorSymbol; /* Used for C-style operator name strings */\ 930 char AmlOpName[16]) /* Op name (debug only) */\ 931 ACPI_CONVERTER_ONLY_MEMBERS (\ 932 char *InlineComment; /* Inline comment */\ 933 char *EndNodeComment; /* End of node comment */\ 934 char *NameComment; /* Comment associated with the first parameter of the name node */\ 935 char *CloseBraceComment; /* Comments that come after } on the same as } */\ 936 ACPI_COMMENT_NODE *CommentList; /* comments that appears before this node */\ 937 ACPI_COMMENT_NODE *EndBlkComment; /* comments that at the end of a block but before ) or } */\ 938 char *CvFilename; /* Filename associated with this node. Used for ASL/ASL+ converter */\ 939 char *CvParentFilename) /* Parent filename associated with this node. Used for ASL/ASL+ converter */ 940 941 942 /* categories of comments */ 943 944 typedef enum 945 { 946 STANDARD_COMMENT = 1, 947 INLINE_COMMENT, 948 ENDNODE_COMMENT, 949 OPENBRACE_COMMENT, 950 CLOSE_BRACE_COMMENT, 951 STD_DEFBLK_COMMENT, 952 END_DEFBLK_COMMENT, 953 FILENAME_COMMENT, 954 PARENTFILENAME_COMMENT, 955 ENDBLK_COMMENT, 956 INCLUDE_COMMENT 957 958 } ASL_COMMENT_TYPES; 959 960 961 /* Internal opcodes for DisasmOpcode field above */ 962 963 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */ 964 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */ 965 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */ 966 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */ 967 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */ 968 #define ACPI_DASM_UUID 0x05 /* Buffer is a UUID/GUID */ 969 #define ACPI_DASM_EISAID 0x06 /* Integer is an EISAID */ 970 #define ACPI_DASM_MATCHOP 0x07 /* Parent opcode is a Match() operator */ 971 #define ACPI_DASM_LNOT_PREFIX 0x08 /* Start of a LNotEqual (etc.) pair of opcodes */ 972 #define ACPI_DASM_LNOT_SUFFIX 0x09 /* End of a LNotEqual (etc.) pair of opcodes */ 973 #define ACPI_DASM_HID_STRING 0x0A /* String is a _HID or _CID */ 974 #define ACPI_DASM_IGNORE_SINGLE 0x0B /* Ignore the opcode but not it's children */ 975 #define ACPI_DASM_SWITCH 0x0C /* While is a Switch */ 976 #define ACPI_DASM_SWITCH_PREDICATE 0x0D /* Object is a predicate for a Switch or Case block */ 977 #define ACPI_DASM_CASE 0x0E /* If/Else is a Case in a Switch/Case block */ 978 #define ACPI_DASM_DEFAULT 0x0F /* Else is a Default in a Switch/Case block */ 979 980 981 /* 982 * List struct used in the -ca option 983 */ 984 typedef struct acpi_comment_node 985 { 986 char *Comment; 987 struct acpi_comment_node *Next; 988 989 } ACPI_COMMENT_NODE; 990 991 992 typedef struct acpi_comment_addr_node 993 { 994 UINT8 *Addr; 995 struct acpi_comment_addr_node *Next; 996 } ACPI_COMMENT_ADDR_NODE; 997 998 /* 999 * File node - used for "Include" operator file stack and 1000 * dependency tree for the -ca option 1001 */ 1002 typedef struct acpi_file_node 1003 { 1004 void *File; 1005 char *Filename; 1006 char *FileStart; /* Points to AML and indicates when the AML for this particular file starts. */ 1007 char *FileEnd; /* Points to AML and indicates when the AML for this particular file ends. */ 1008 struct acpi_file_node *Next; 1009 struct acpi_file_node *Parent; 1010 BOOLEAN IncludeWritten; 1011 ACPI_COMMENT_NODE *IncludeComment; 1012 1013 } ACPI_FILE_NODE; 1014 1015 1016 /* 1017 * Generic operation (for example: If, While, Store) 1018 */ 1019 typedef struct acpi_parse_obj_common 1020 { 1021 ACPI_PARSE_COMMON 1022 } ACPI_PARSE_OBJ_COMMON; 1023 1024 1025 /* 1026 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and OpRegions), 1027 * and bytelists. 1028 */ 1029 typedef struct acpi_parse_obj_named 1030 { 1031 ACPI_PARSE_COMMON 1032 char *Path; 1033 UINT8 *Data; /* AML body or bytelist data */ 1034 UINT32 Length; /* AML length */ 1035 UINT32 Name; /* 4-byte name or zero if no name */ 1036 1037 } ACPI_PARSE_OBJ_NAMED; 1038 1039 1040 /* This version is used by the iASL compiler only */ 1041 1042 #define ACPI_MAX_PARSEOP_NAME 20 1043 1044 typedef struct acpi_parse_obj_asl 1045 { 1046 ACPI_PARSE_COMMON 1047 union acpi_parse_object *Child; 1048 union acpi_parse_object *ParentMethod; 1049 char *Filename; 1050 BOOLEAN FileChanged; 1051 char *ParentFilename; 1052 char *ExternalName; 1053 char *Namepath; 1054 char NameSeg[4]; 1055 UINT32 ExtraValue; 1056 UINT32 Column; 1057 UINT32 LineNumber; 1058 UINT32 LogicalLineNumber; 1059 UINT32 LogicalByteOffset; 1060 UINT32 EndLine; 1061 UINT32 EndLogicalLine; 1062 UINT32 AcpiBtype; 1063 UINT32 AmlLength; 1064 UINT32 AmlSubtreeLength; 1065 UINT32 FinalAmlLength; 1066 UINT32 FinalAmlOffset; 1067 UINT32 CompileFlags; 1068 UINT16 ParseOpcode; 1069 UINT8 AmlOpcodeLength; 1070 UINT8 AmlPkgLenBytes; 1071 UINT8 Extra; 1072 char ParseOpName[ACPI_MAX_PARSEOP_NAME]; 1073 1074 } ACPI_PARSE_OBJ_ASL; 1075 1076 typedef union acpi_parse_object 1077 { 1078 ACPI_PARSE_OBJ_COMMON Common; 1079 ACPI_PARSE_OBJ_NAMED Named; 1080 ACPI_PARSE_OBJ_ASL Asl; 1081 1082 } ACPI_PARSE_OBJECT; 1083 1084 typedef struct asl_comment_state 1085 { 1086 UINT8 CommentType; 1087 UINT32 SpacesBefore; 1088 ACPI_PARSE_OBJECT *LatestParseOp; 1089 ACPI_PARSE_OBJECT *ParsingParenBraceNode; 1090 BOOLEAN CaptureComments; 1091 1092 } ASL_COMMENT_STATE; 1093 1094 1095 /* 1096 * Parse state - one state per parser invocation and each control 1097 * method. 1098 */ 1099 typedef struct acpi_parse_state 1100 { 1101 UINT8 *AmlStart; /* First AML byte */ 1102 UINT8 *Aml; /* Next AML byte */ 1103 UINT8 *AmlEnd; /* (last + 1) AML byte */ 1104 UINT8 *PkgStart; /* Current package begin */ 1105 UINT8 *PkgEnd; /* Current package end */ 1106 union acpi_parse_object *StartOp; /* Root of parse tree */ 1107 struct acpi_namespace_node *StartNode; 1108 union acpi_generic_state *Scope; /* Current scope */ 1109 union acpi_parse_object *StartScope; 1110 UINT32 AmlSize; 1111 1112 } ACPI_PARSE_STATE; 1113 1114 1115 /* Parse object flags */ 1116 1117 #define ACPI_PARSEOP_GENERIC 0x01 1118 #define ACPI_PARSEOP_NAMED_OBJECT 0x02 1119 #define ACPI_PARSEOP_DEFERRED 0x04 1120 #define ACPI_PARSEOP_BYTELIST 0x08 1121 #define ACPI_PARSEOP_IN_STACK 0x10 1122 #define ACPI_PARSEOP_TARGET 0x20 1123 #define ACPI_PARSEOP_IN_CACHE 0x80 1124 1125 /* Parse object DisasmFlags */ 1126 1127 #define ACPI_PARSEOP_IGNORE 0x0001 1128 #define ACPI_PARSEOP_PARAMETER_LIST 0x0002 1129 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x0004 1130 #define ACPI_PARSEOP_PREDEFINED_CHECKED 0x0008 1131 #define ACPI_PARSEOP_CLOSING_PAREN 0x0010 1132 #define ACPI_PARSEOP_COMPOUND_ASSIGNMENT 0x0020 1133 #define ACPI_PARSEOP_ASSIGNMENT 0x0040 1134 #define ACPI_PARSEOP_ELSEIF 0x0080 1135 #define ACPI_PARSEOP_LEGACY_ASL_ONLY 0x0100 1136 1137 1138 /***************************************************************************** 1139 * 1140 * Hardware (ACPI registers) and PNP 1141 * 1142 ****************************************************************************/ 1143 1144 typedef struct acpi_bit_register_info 1145 { 1146 UINT8 ParentRegister; 1147 UINT8 BitPosition; 1148 UINT16 AccessBitMask; 1149 1150 } ACPI_BIT_REGISTER_INFO; 1151 1152 1153 /* 1154 * Some ACPI registers have bits that must be ignored -- meaning that they 1155 * must be preserved. 1156 */ 1157 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */ 1158 1159 /* Write-only bits must be zeroed by software */ 1160 1161 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */ 1162 1163 /* For control registers, both ignored and reserved bits must be preserved */ 1164 1165 /* 1166 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the 1167 * ACPI specification to be a "preserved" bit - "OSPM always preserves this 1168 * bit position", section 4.7.3.2.1. However, on some machines the OS must 1169 * write a one to this bit after resume for the machine to work properly. 1170 * To enable this, we no longer attempt to preserve this bit. No machines 1171 * are known to fail if the bit is not preserved. (May 2009) 1172 */ 1173 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */ 1174 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */ 1175 #define ACPI_PM1_CONTROL_PRESERVED_BITS \ 1176 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS) 1177 1178 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */ 1179 1180 /* 1181 * Register IDs 1182 * These are the full ACPI registers 1183 */ 1184 #define ACPI_REGISTER_PM1_STATUS 0x01 1185 #define ACPI_REGISTER_PM1_ENABLE 0x02 1186 #define ACPI_REGISTER_PM1_CONTROL 0x03 1187 #define ACPI_REGISTER_PM2_CONTROL 0x04 1188 #define ACPI_REGISTER_PM_TIMER 0x05 1189 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06 1190 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07 1191 1192 1193 /* Masks used to access the BitRegisters */ 1194 1195 #define ACPI_BITMASK_TIMER_STATUS 0x0001 1196 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010 1197 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020 1198 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100 1199 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200 1200 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400 1201 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */ 1202 #define ACPI_BITMASK_WAKE_STATUS 0x8000 1203 1204 #define ACPI_BITMASK_ALL_FIXED_STATUS (\ 1205 ACPI_BITMASK_TIMER_STATUS | \ 1206 ACPI_BITMASK_BUS_MASTER_STATUS | \ 1207 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \ 1208 ACPI_BITMASK_POWER_BUTTON_STATUS | \ 1209 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \ 1210 ACPI_BITMASK_RT_CLOCK_STATUS | \ 1211 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \ 1212 ACPI_BITMASK_WAKE_STATUS) 1213 1214 #define ACPI_BITMASK_TIMER_ENABLE 0x0001 1215 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020 1216 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100 1217 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200 1218 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400 1219 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */ 1220 1221 #define ACPI_BITMASK_SCI_ENABLE 0x0001 1222 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002 1223 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004 1224 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00 1225 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000 1226 1227 #define ACPI_BITMASK_ARB_DISABLE 0x0001 1228 1229 1230 /* Raw bit position of each BitRegister */ 1231 1232 #define ACPI_BITPOSITION_TIMER_STATUS 0x00 1233 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04 1234 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05 1235 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08 1236 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09 1237 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A 1238 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */ 1239 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F 1240 1241 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00 1242 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05 1243 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08 1244 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09 1245 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A 1246 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */ 1247 1248 #define ACPI_BITPOSITION_SCI_ENABLE 0x00 1249 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01 1250 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02 1251 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A 1252 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D 1253 1254 #define ACPI_BITPOSITION_ARB_DISABLE 0x00 1255 1256 1257 /* Structs and definitions for _OSI support and I/O port validation */ 1258 1259 #define ACPI_ALWAYS_ILLEGAL 0x00 1260 1261 typedef struct acpi_interface_info 1262 { 1263 const char *Name; 1264 struct acpi_interface_info *Next; 1265 UINT8 Flags; 1266 UINT8 Value; 1267 1268 } ACPI_INTERFACE_INFO; 1269 1270 #define ACPI_OSI_INVALID 0x01 1271 #define ACPI_OSI_DYNAMIC 0x02 1272 #define ACPI_OSI_FEATURE 0x04 1273 #define ACPI_OSI_DEFAULT_INVALID 0x08 1274 #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID) 1275 1276 typedef struct acpi_port_info 1277 { 1278 const char *Name; 1279 UINT16 Start; 1280 UINT16 End; 1281 UINT8 OsiDependency; 1282 1283 } ACPI_PORT_INFO; 1284 1285 1286 /***************************************************************************** 1287 * 1288 * Resource descriptors 1289 * 1290 ****************************************************************************/ 1291 1292 /* ResourceType values */ 1293 1294 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0 1295 #define ACPI_ADDRESS_TYPE_IO_RANGE 1 1296 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2 1297 1298 /* Resource descriptor types and masks */ 1299 1300 #define ACPI_RESOURCE_NAME_LARGE 0x80 1301 #define ACPI_RESOURCE_NAME_SMALL 0x00 1302 1303 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */ 1304 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */ 1305 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */ 1306 1307 1308 /* 1309 * Small resource descriptor "names" as defined by the ACPI specification. 1310 * Note: Bits 2:0 are used for the descriptor length 1311 */ 1312 #define ACPI_RESOURCE_NAME_IRQ 0x20 1313 #define ACPI_RESOURCE_NAME_DMA 0x28 1314 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30 1315 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38 1316 #define ACPI_RESOURCE_NAME_IO 0x40 1317 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48 1318 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50 1319 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58 1320 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60 1321 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68 1322 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70 1323 #define ACPI_RESOURCE_NAME_END_TAG 0x78 1324 1325 /* 1326 * Large resource descriptor "names" as defined by the ACPI specification. 1327 * Note: includes the Large Descriptor bit in bit[7] 1328 */ 1329 #define ACPI_RESOURCE_NAME_MEMORY24 0x81 1330 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82 1331 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83 1332 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84 1333 #define ACPI_RESOURCE_NAME_MEMORY32 0x85 1334 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86 1335 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87 1336 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88 1337 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89 1338 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A 1339 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B 1340 #define ACPI_RESOURCE_NAME_GPIO 0x8C 1341 #define ACPI_RESOURCE_NAME_PIN_FUNCTION 0x8D 1342 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E 1343 #define ACPI_RESOURCE_NAME_PIN_CONFIG 0x8F 1344 #define ACPI_RESOURCE_NAME_PIN_GROUP 0x90 1345 #define ACPI_RESOURCE_NAME_PIN_GROUP_FUNCTION 0x91 1346 #define ACPI_RESOURCE_NAME_PIN_GROUP_CONFIG 0x92 1347 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x92 1348 1349 1350 /***************************************************************************** 1351 * 1352 * Miscellaneous 1353 * 1354 ****************************************************************************/ 1355 1356 #define ACPI_ASCII_ZERO 0x30 1357 1358 1359 /***************************************************************************** 1360 * 1361 * Disassembler 1362 * 1363 ****************************************************************************/ 1364 1365 typedef struct acpi_external_list 1366 { 1367 char *Path; 1368 char *InternalPath; 1369 struct acpi_external_list *Next; 1370 UINT32 Value; 1371 UINT16 Length; 1372 UINT16 Flags; 1373 UINT8 Type; 1374 1375 } ACPI_EXTERNAL_LIST; 1376 1377 /* Values for Flags field above */ 1378 1379 #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */ 1380 #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */ 1381 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */ 1382 #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */ 1383 #define ACPI_EXT_ORIGIN_FROM_OPCODE 0x10 /* External came from a External() opcode */ 1384 #define ACPI_EXT_CONFLICTING_DECLARATION 0x20 /* External has a conflicting declaration within AML */ 1385 1386 1387 typedef struct acpi_external_file 1388 { 1389 char *Path; 1390 struct acpi_external_file *Next; 1391 1392 } ACPI_EXTERNAL_FILE; 1393 1394 1395 typedef struct acpi_parse_object_list 1396 { 1397 ACPI_PARSE_OBJECT *Op; 1398 struct acpi_parse_object_list *Next; 1399 1400 } ACPI_PARSE_OBJECT_LIST; 1401 1402 /***************************************************************************** 1403 * 1404 * Debugger 1405 * 1406 ****************************************************************************/ 1407 1408 typedef struct acpi_db_method_info 1409 { 1410 ACPI_HANDLE Method; 1411 ACPI_HANDLE MainThreadGate; 1412 ACPI_HANDLE ThreadCompleteGate; 1413 ACPI_HANDLE InfoGate; 1414 ACPI_THREAD_ID *Threads; 1415 UINT32 NumThreads; 1416 UINT32 NumCreated; 1417 UINT32 NumCompleted; 1418 1419 char *Name; 1420 UINT32 Flags; 1421 UINT32 NumLoops; 1422 char Pathname[ACPI_DB_LINE_BUFFER_SIZE]; 1423 char **Args; 1424 ACPI_OBJECT_TYPE *Types; 1425 1426 /* 1427 * Arguments to be passed to method for the commands Threads and 1428 * Background. Note, ACPI specifies a maximum of 7 arguments (0 - 6). 1429 * 1430 * For the Threads command, the Number of threads, ID of current 1431 * thread and Index of current thread inside all them created. 1432 */ 1433 char InitArgs; 1434 #ifdef ACPI_DEBUGGER 1435 ACPI_OBJECT_TYPE ArgTypes[ACPI_METHOD_NUM_ARGS]; 1436 #endif 1437 char *Arguments[ACPI_METHOD_NUM_ARGS]; 1438 char NumThreadsStr[11]; 1439 char IdOfThreadStr[11]; 1440 char IndexOfThreadStr[11]; 1441 1442 } ACPI_DB_METHOD_INFO; 1443 1444 typedef struct acpi_integrity_info 1445 { 1446 UINT32 Nodes; 1447 UINT32 Objects; 1448 1449 } ACPI_INTEGRITY_INFO; 1450 1451 1452 #define ACPI_DB_DISABLE_OUTPUT 0x00 1453 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01 1454 #define ACPI_DB_CONSOLE_OUTPUT 0x02 1455 #define ACPI_DB_DUPLICATE_OUTPUT 0x03 1456 1457 1458 typedef struct acpi_object_info 1459 { 1460 UINT32 Types[ACPI_TOTAL_TYPES]; 1461 1462 } ACPI_OBJECT_INFO; 1463 1464 1465 /***************************************************************************** 1466 * 1467 * Debug 1468 * 1469 ****************************************************************************/ 1470 1471 /* Entry for a memory allocation (debug only) */ 1472 1473 #define ACPI_MEM_MALLOC 0 1474 #define ACPI_MEM_CALLOC 1 1475 #define ACPI_MAX_MODULE_NAME 16 1476 1477 #define ACPI_COMMON_DEBUG_MEM_HEADER \ 1478 struct acpi_debug_mem_block *Previous; \ 1479 struct acpi_debug_mem_block *Next; \ 1480 UINT32 Size; \ 1481 UINT32 Component; \ 1482 UINT32 Line; \ 1483 char Module[ACPI_MAX_MODULE_NAME]; \ 1484 UINT8 AllocType; 1485 1486 typedef struct acpi_debug_mem_header 1487 { 1488 ACPI_COMMON_DEBUG_MEM_HEADER 1489 1490 } ACPI_DEBUG_MEM_HEADER; 1491 1492 typedef struct acpi_debug_mem_block 1493 { 1494 ACPI_COMMON_DEBUG_MEM_HEADER 1495 UINT64 UserSpace; 1496 1497 } ACPI_DEBUG_MEM_BLOCK; 1498 1499 1500 #define ACPI_MEM_LIST_GLOBAL 0 1501 #define ACPI_MEM_LIST_NSNODE 1 1502 #define ACPI_MEM_LIST_MAX 1 1503 #define ACPI_NUM_MEM_LISTS 2 1504 1505 1506 /***************************************************************************** 1507 * 1508 * Info/help support 1509 * 1510 ****************************************************************************/ 1511 1512 typedef struct ah_predefined_name 1513 { 1514 char *Name; 1515 char *Description; 1516 #ifndef ACPI_ASL_COMPILER 1517 char *Action; 1518 #endif 1519 1520 } AH_PREDEFINED_NAME; 1521 1522 typedef struct ah_device_id 1523 { 1524 const char *Name; 1525 const char *Description; 1526 1527 } AH_DEVICE_ID; 1528 1529 typedef struct ah_uuid 1530 { 1531 const char *Description; 1532 const char *String; 1533 1534 } AH_UUID; 1535 1536 typedef struct ah_table 1537 { 1538 char *Signature; 1539 char *Description; 1540 1541 } AH_TABLE; 1542 1543 #endif /* __ACLOCAL_H__ */ 1544