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