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