1 /****************************************************************************** 2 * 3 * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT (Internal object only) 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 _ACOBJECT_H 153 #define _ACOBJECT_H 154 155 /* acpisrc:StructDefs -- for acpisrc conversion */ 156 157 158 /* 159 * The ACPI_OPERAND_OBJECT is used to pass AML operands from the dispatcher 160 * to the interpreter, and to keep track of the various handlers such as 161 * address space handlers and notify handlers. The object is a constant 162 * size in order to allow it to be cached and reused. 163 * 164 * Note: The object is optimized to be aligned and will not work if it is 165 * byte-packed. 166 */ 167 #if ACPI_MACHINE_WIDTH == 64 168 #pragma pack(8) 169 #else 170 #pragma pack(4) 171 #endif 172 173 /******************************************************************************* 174 * 175 * Common Descriptors 176 * 177 ******************************************************************************/ 178 179 /* 180 * Common area for all objects. 181 * 182 * DescriptorType is used to differentiate between internal descriptors, and 183 * must be in the same place across all descriptors 184 * 185 * Note: The DescriptorType and Type fields must appear in the identical 186 * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT 187 * structures. 188 */ 189 #define ACPI_OBJECT_COMMON_HEADER \ 190 union acpi_operand_object *NextObject; /* Objects linked to parent NS node */\ 191 UINT8 DescriptorType; /* To differentiate various internal objs */\ 192 UINT8 Type; /* ACPI_OBJECT_TYPE */\ 193 UINT16 ReferenceCount; /* For object deletion management */\ 194 UINT8 Flags; 195 /* 196 * Note: There are 3 bytes available here before the 197 * next natural alignment boundary (for both 32/64 cases) 198 */ 199 200 /* Values for Flag byte above */ 201 202 #define AOPOBJ_AML_CONSTANT 0x01 /* Integer is an AML constant */ 203 #define AOPOBJ_STATIC_POINTER 0x02 /* Data is part of an ACPI table, don't delete */ 204 #define AOPOBJ_DATA_VALID 0x04 /* Object is initialized and data is valid */ 205 #define AOPOBJ_OBJECT_INITIALIZED 0x08 /* Region is initialized */ 206 #define AOPOBJ_REG_CONNECTED 0x10 /* _REG was run */ 207 #define AOPOBJ_SETUP_COMPLETE 0x20 /* Region setup is complete */ 208 #define AOPOBJ_INVALID 0x40 /* Host OS won't allow a Region address */ 209 210 211 /****************************************************************************** 212 * 213 * Basic data types 214 * 215 *****************************************************************************/ 216 217 typedef struct acpi_object_common 218 { 219 ACPI_OBJECT_COMMON_HEADER 220 221 } ACPI_OBJECT_COMMON; 222 223 224 typedef struct acpi_object_integer 225 { 226 ACPI_OBJECT_COMMON_HEADER 227 UINT8 Fill[3]; /* Prevent warning on some compilers */ 228 UINT64 Value; 229 230 } ACPI_OBJECT_INTEGER; 231 232 233 /* 234 * Note: The String and Buffer object must be identical through the 235 * pointer and length elements. There is code that depends on this. 236 * 237 * Fields common to both Strings and Buffers 238 */ 239 #define ACPI_COMMON_BUFFER_INFO(_Type) \ 240 _Type *Pointer; \ 241 UINT32 Length; 242 243 244 typedef struct acpi_object_string /* Null terminated, ASCII characters only */ 245 { 246 ACPI_OBJECT_COMMON_HEADER 247 ACPI_COMMON_BUFFER_INFO (char) /* String in AML stream or allocated string */ 248 249 } ACPI_OBJECT_STRING; 250 251 252 typedef struct acpi_object_buffer 253 { 254 ACPI_OBJECT_COMMON_HEADER 255 ACPI_COMMON_BUFFER_INFO (UINT8) /* Buffer in AML stream or allocated buffer */ 256 UINT32 AmlLength; 257 UINT8 *AmlStart; 258 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 259 260 } ACPI_OBJECT_BUFFER; 261 262 263 typedef struct acpi_object_package 264 { 265 ACPI_OBJECT_COMMON_HEADER 266 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 267 union acpi_operand_object **Elements; /* Array of pointers to AcpiObjects */ 268 UINT8 *AmlStart; 269 UINT32 AmlLength; 270 UINT32 Count; /* # of elements in package */ 271 272 } ACPI_OBJECT_PACKAGE; 273 274 275 /****************************************************************************** 276 * 277 * Complex data types 278 * 279 *****************************************************************************/ 280 281 typedef struct acpi_object_event 282 { 283 ACPI_OBJECT_COMMON_HEADER 284 ACPI_SEMAPHORE OsSemaphore; /* Actual OS synchronization object */ 285 286 } ACPI_OBJECT_EVENT; 287 288 289 typedef struct acpi_object_mutex 290 { 291 ACPI_OBJECT_COMMON_HEADER 292 UINT8 SyncLevel; /* 0-15, specified in Mutex() call */ 293 UINT16 AcquisitionDepth; /* Allow multiple Acquires, same thread */ 294 ACPI_MUTEX OsMutex; /* Actual OS synchronization object */ 295 ACPI_THREAD_ID ThreadId; /* Current owner of the mutex */ 296 struct acpi_thread_state *OwnerThread; /* Current owner of the mutex */ 297 union acpi_operand_object *Prev; /* Link for list of acquired mutexes */ 298 union acpi_operand_object *Next; /* Link for list of acquired mutexes */ 299 ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */ 300 UINT8 OriginalSyncLevel; /* Owner's original sync level (0-15) */ 301 302 } ACPI_OBJECT_MUTEX; 303 304 305 typedef struct acpi_object_region 306 { 307 ACPI_OBJECT_COMMON_HEADER 308 UINT8 SpaceId; 309 ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */ 310 union acpi_operand_object *Handler; /* Handler for region access */ 311 union acpi_operand_object *Next; 312 ACPI_PHYSICAL_ADDRESS Address; 313 UINT32 Length; 314 315 } ACPI_OBJECT_REGION; 316 317 318 typedef struct acpi_object_method 319 { 320 ACPI_OBJECT_COMMON_HEADER 321 UINT8 InfoFlags; 322 UINT8 ParamCount; 323 UINT8 SyncLevel; 324 union acpi_operand_object *Mutex; 325 union acpi_operand_object *Node; 326 UINT8 *AmlStart; 327 union 328 { 329 ACPI_INTERNAL_METHOD Implementation; 330 union acpi_operand_object *Handler; 331 } Dispatch; 332 333 UINT32 AmlLength; 334 UINT8 ThreadCount; 335 ACPI_OWNER_ID OwnerId; 336 337 } ACPI_OBJECT_METHOD; 338 339 /* Flags for InfoFlags field above */ 340 341 #define ACPI_METHOD_MODULE_LEVEL 0x01 /* Method is actually module-level code */ 342 #define ACPI_METHOD_INTERNAL_ONLY 0x02 /* Method is implemented internally (_OSI) */ 343 #define ACPI_METHOD_SERIALIZED 0x04 /* Method is serialized */ 344 #define ACPI_METHOD_SERIALIZED_PENDING 0x08 /* Method is to be marked serialized */ 345 #define ACPI_METHOD_IGNORE_SYNC_LEVEL 0x10 /* Method was auto-serialized at table load time */ 346 #define ACPI_METHOD_MODIFIED_NAMESPACE 0x20 /* Method modified the namespace */ 347 348 349 /****************************************************************************** 350 * 351 * Objects that can be notified. All share a common NotifyInfo area. 352 * 353 *****************************************************************************/ 354 355 /* 356 * Common fields for objects that support ASL notifications 357 */ 358 #define ACPI_COMMON_NOTIFY_INFO \ 359 union acpi_operand_object *NotifyList[2]; /* Handlers for system/device notifies */\ 360 union acpi_operand_object *Handler; /* Handler for Address space */ 361 362 363 typedef struct acpi_object_notify_common /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */ 364 { 365 ACPI_OBJECT_COMMON_HEADER 366 ACPI_COMMON_NOTIFY_INFO 367 368 } ACPI_OBJECT_NOTIFY_COMMON; 369 370 371 typedef struct acpi_object_device 372 { 373 ACPI_OBJECT_COMMON_HEADER 374 ACPI_COMMON_NOTIFY_INFO 375 ACPI_GPE_BLOCK_INFO *GpeBlock; 376 377 } ACPI_OBJECT_DEVICE; 378 379 380 typedef struct acpi_object_power_resource 381 { 382 ACPI_OBJECT_COMMON_HEADER 383 ACPI_COMMON_NOTIFY_INFO 384 UINT32 SystemLevel; 385 UINT32 ResourceOrder; 386 387 } ACPI_OBJECT_POWER_RESOURCE; 388 389 390 typedef struct acpi_object_processor 391 { 392 ACPI_OBJECT_COMMON_HEADER 393 394 /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */ 395 396 UINT8 ProcId; 397 UINT8 Length; 398 ACPI_COMMON_NOTIFY_INFO 399 ACPI_IO_ADDRESS Address; 400 401 } ACPI_OBJECT_PROCESSOR; 402 403 404 typedef struct acpi_object_thermal_zone 405 { 406 ACPI_OBJECT_COMMON_HEADER 407 ACPI_COMMON_NOTIFY_INFO 408 409 } ACPI_OBJECT_THERMAL_ZONE; 410 411 412 /****************************************************************************** 413 * 414 * Fields. All share a common header/info field. 415 * 416 *****************************************************************************/ 417 418 /* 419 * Common bitfield for the field objects 420 * "Field Datum" -- a datum from the actual field object 421 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field 422 */ 423 #define ACPI_COMMON_FIELD_INFO \ 424 UINT8 FieldFlags; /* Access, update, and lock bits */\ 425 UINT8 Attribute; /* From AccessAs keyword */\ 426 UINT8 AccessByteWidth; /* Read/Write size in bytes */\ 427 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */\ 428 UINT32 BitLength; /* Length of field in bits */\ 429 UINT32 BaseByteOffset; /* Byte offset within containing object */\ 430 UINT32 Value; /* Value to store into the Bank or Index register */\ 431 UINT8 StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\ 432 UINT8 AccessLength; /* For serial regions/fields */ 433 434 435 typedef struct acpi_object_field_common /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */ 436 { 437 ACPI_OBJECT_COMMON_HEADER 438 ACPI_COMMON_FIELD_INFO 439 union acpi_operand_object *RegionObj; /* Parent Operation Region object (REGION/BANK fields only) */ 440 441 } ACPI_OBJECT_FIELD_COMMON; 442 443 444 typedef struct acpi_object_region_field 445 { 446 ACPI_OBJECT_COMMON_HEADER 447 ACPI_COMMON_FIELD_INFO 448 UINT16 ResourceLength; 449 union acpi_operand_object *RegionObj; /* Containing OpRegion object */ 450 UINT8 *ResourceBuffer; /* ResourceTemplate for serial regions/fields */ 451 UINT16 PinNumberIndex; /* Index relative to previous Connection/Template */ 452 453 } ACPI_OBJECT_REGION_FIELD; 454 455 456 typedef struct acpi_object_bank_field 457 { 458 ACPI_OBJECT_COMMON_HEADER 459 ACPI_COMMON_FIELD_INFO 460 union acpi_operand_object *RegionObj; /* Containing OpRegion object */ 461 union acpi_operand_object *BankObj; /* BankSelect Register object */ 462 463 } ACPI_OBJECT_BANK_FIELD; 464 465 466 typedef struct acpi_object_index_field 467 { 468 ACPI_OBJECT_COMMON_HEADER 469 ACPI_COMMON_FIELD_INFO 470 471 /* 472 * No "RegionObj" pointer needed since the Index and Data registers 473 * are each field definitions unto themselves. 474 */ 475 union acpi_operand_object *IndexObj; /* Index register */ 476 union acpi_operand_object *DataObj; /* Data register */ 477 478 } ACPI_OBJECT_INDEX_FIELD; 479 480 481 /* The BufferField is different in that it is part of a Buffer, not an OpRegion */ 482 483 typedef struct acpi_object_buffer_field 484 { 485 ACPI_OBJECT_COMMON_HEADER 486 ACPI_COMMON_FIELD_INFO 487 union acpi_operand_object *BufferObj; /* Containing Buffer object */ 488 489 } ACPI_OBJECT_BUFFER_FIELD; 490 491 492 /****************************************************************************** 493 * 494 * Objects for handlers 495 * 496 *****************************************************************************/ 497 498 typedef struct acpi_object_notify_handler 499 { 500 ACPI_OBJECT_COMMON_HEADER 501 ACPI_NAMESPACE_NODE *Node; /* Parent device */ 502 UINT32 HandlerType; /* Type: Device/System/Both */ 503 ACPI_NOTIFY_HANDLER Handler; /* Handler address */ 504 void *Context; 505 union acpi_operand_object *Next[2]; /* Device and System handler lists */ 506 507 } ACPI_OBJECT_NOTIFY_HANDLER; 508 509 510 typedef struct acpi_object_addr_handler 511 { 512 ACPI_OBJECT_COMMON_HEADER 513 UINT8 SpaceId; 514 UINT8 HandlerFlags; 515 ACPI_ADR_SPACE_HANDLER Handler; 516 ACPI_NAMESPACE_NODE *Node; /* Parent device */ 517 void *Context; 518 ACPI_ADR_SPACE_SETUP Setup; 519 union acpi_operand_object *RegionList; /* Regions using this handler */ 520 union acpi_operand_object *Next; 521 522 } ACPI_OBJECT_ADDR_HANDLER; 523 524 /* Flags for address handler (HandlerFlags) */ 525 526 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01 527 528 529 /****************************************************************************** 530 * 531 * Special internal objects 532 * 533 *****************************************************************************/ 534 535 /* 536 * The Reference object is used for these opcodes: 537 * Arg[0-6], Local[0-7], IndexOp, NameOp, RefOfOp, LoadOp, LoadTableOp, DebugOp 538 * The Reference.Class differentiates these types. 539 */ 540 typedef struct acpi_object_reference 541 { 542 ACPI_OBJECT_COMMON_HEADER 543 UINT8 Class; /* Reference Class */ 544 UINT8 TargetType; /* Used for Index Op */ 545 UINT8 Reserved; 546 void *Object; /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */ 547 ACPI_NAMESPACE_NODE *Node; /* RefOf or Namepath */ 548 union acpi_operand_object **Where; /* Target of Index */ 549 UINT8 *IndexPointer; /* Used for Buffers and Strings */ 550 UINT32 Value; /* Used for Local/Arg/Index/DdbHandle */ 551 552 } ACPI_OBJECT_REFERENCE; 553 554 /* Values for Reference.Class above */ 555 556 typedef enum 557 { 558 ACPI_REFCLASS_LOCAL = 0, /* Method local */ 559 ACPI_REFCLASS_ARG = 1, /* Method argument */ 560 ACPI_REFCLASS_REFOF = 2, /* Result of RefOf() TBD: Split to Ref/Node and Ref/OperandObj? */ 561 ACPI_REFCLASS_INDEX = 3, /* Result of Index() */ 562 ACPI_REFCLASS_TABLE = 4, /* DdbHandle - Load(), LoadTable() */ 563 ACPI_REFCLASS_NAME = 5, /* Reference to a named object */ 564 ACPI_REFCLASS_DEBUG = 6, /* Debug object */ 565 566 ACPI_REFCLASS_MAX = 6 567 568 } ACPI_REFERENCE_CLASSES; 569 570 571 /* 572 * Extra object is used as additional storage for types that 573 * have AML code in their declarations (TermArgs) that must be 574 * evaluated at run time. 575 * 576 * Currently: Region and FieldUnit types 577 */ 578 typedef struct acpi_object_extra 579 { 580 ACPI_OBJECT_COMMON_HEADER 581 ACPI_NAMESPACE_NODE *Method_REG; /* _REG method for this region (if any) */ 582 ACPI_NAMESPACE_NODE *ScopeNode; 583 void *RegionContext; /* Region-specific data */ 584 UINT8 *AmlStart; 585 UINT32 AmlLength; 586 587 } ACPI_OBJECT_EXTRA; 588 589 590 /* Additional data that can be attached to namespace nodes */ 591 592 typedef struct acpi_object_data 593 { 594 ACPI_OBJECT_COMMON_HEADER 595 ACPI_OBJECT_HANDLER Handler; 596 void *Pointer; 597 598 } ACPI_OBJECT_DATA; 599 600 601 /* Structure used when objects are cached for reuse */ 602 603 typedef struct acpi_object_cache_list 604 { 605 ACPI_OBJECT_COMMON_HEADER 606 union acpi_operand_object *Next; /* Link for object cache and internal lists*/ 607 608 } ACPI_OBJECT_CACHE_LIST; 609 610 611 /****************************************************************************** 612 * 613 * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above 614 * 615 *****************************************************************************/ 616 617 typedef union acpi_operand_object 618 { 619 ACPI_OBJECT_COMMON Common; 620 ACPI_OBJECT_INTEGER Integer; 621 ACPI_OBJECT_STRING String; 622 ACPI_OBJECT_BUFFER Buffer; 623 ACPI_OBJECT_PACKAGE Package; 624 ACPI_OBJECT_EVENT Event; 625 ACPI_OBJECT_METHOD Method; 626 ACPI_OBJECT_MUTEX Mutex; 627 ACPI_OBJECT_REGION Region; 628 ACPI_OBJECT_NOTIFY_COMMON CommonNotify; 629 ACPI_OBJECT_DEVICE Device; 630 ACPI_OBJECT_POWER_RESOURCE PowerResource; 631 ACPI_OBJECT_PROCESSOR Processor; 632 ACPI_OBJECT_THERMAL_ZONE ThermalZone; 633 ACPI_OBJECT_FIELD_COMMON CommonField; 634 ACPI_OBJECT_REGION_FIELD Field; 635 ACPI_OBJECT_BUFFER_FIELD BufferField; 636 ACPI_OBJECT_BANK_FIELD BankField; 637 ACPI_OBJECT_INDEX_FIELD IndexField; 638 ACPI_OBJECT_NOTIFY_HANDLER Notify; 639 ACPI_OBJECT_ADDR_HANDLER AddressSpace; 640 ACPI_OBJECT_REFERENCE Reference; 641 ACPI_OBJECT_EXTRA Extra; 642 ACPI_OBJECT_DATA Data; 643 ACPI_OBJECT_CACHE_LIST Cache; 644 645 /* 646 * Add namespace node to union in order to simplify code that accepts both 647 * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share 648 * a common DescriptorType field in order to differentiate them. 649 */ 650 ACPI_NAMESPACE_NODE Node; 651 652 } ACPI_OPERAND_OBJECT; 653 654 655 /****************************************************************************** 656 * 657 * ACPI_DESCRIPTOR - objects that share a common descriptor identifier 658 * 659 *****************************************************************************/ 660 661 /* Object descriptor types */ 662 663 #define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */ 664 #define ACPI_DESC_TYPE_STATE 0x02 665 #define ACPI_DESC_TYPE_STATE_UPDATE 0x03 666 #define ACPI_DESC_TYPE_STATE_PACKAGE 0x04 667 #define ACPI_DESC_TYPE_STATE_CONTROL 0x05 668 #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06 669 #define ACPI_DESC_TYPE_STATE_PSCOPE 0x07 670 #define ACPI_DESC_TYPE_STATE_WSCOPE 0x08 671 #define ACPI_DESC_TYPE_STATE_RESULT 0x09 672 #define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A 673 #define ACPI_DESC_TYPE_STATE_THREAD 0x0B 674 #define ACPI_DESC_TYPE_WALK 0x0C 675 #define ACPI_DESC_TYPE_PARSER 0x0D 676 #define ACPI_DESC_TYPE_OPERAND 0x0E 677 #define ACPI_DESC_TYPE_NAMED 0x0F 678 #define ACPI_DESC_TYPE_MAX 0x0F 679 680 681 typedef struct acpi_common_descriptor 682 { 683 void *CommonPointer; 684 UINT8 DescriptorType; /* To differentiate various internal objs */ 685 686 } ACPI_COMMON_DESCRIPTOR; 687 688 typedef union acpi_descriptor 689 { 690 ACPI_COMMON_DESCRIPTOR Common; 691 ACPI_OPERAND_OBJECT Object; 692 ACPI_NAMESPACE_NODE Node; 693 ACPI_PARSE_OBJECT Op; 694 695 } ACPI_DESCRIPTOR; 696 697 #pragma pack() 698 699 #endif /* _ACOBJECT_H */ 700