acobject.h revision 102550
1 2/****************************************************************************** 3 * 4 * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT (Internal object only) 5 * $Revision: 113 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp. 14 * All rights reserved. 15 * 16 * 2. License 17 * 18 * 2.1. This is your license from Intel Corp. under its intellectual property 19 * rights. You may have additional license terms from the party that provided 20 * you this software, covering your right to use that party's intellectual 21 * property rights. 22 * 23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 24 * copy of the source code appearing in this file ("Covered Code") an 25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 26 * base code distributed originally by Intel ("Original Intel Code") to copy, 27 * make derivatives, distribute, use and display any portion of the Covered 28 * Code in any form, with the right to sublicense such rights; and 29 * 30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31 * license (with the right to sublicense), under only those claims of Intel 32 * patents that are infringed by the Original Intel Code, to make, use, sell, 33 * offer to sell, and import the Covered Code and derivative works thereof 34 * solely to the minimum extent necessary to exercise the above copyright 35 * license, and in no event shall the patent license extend to any additions 36 * to or modifications of the Original Intel Code. No other license or right 37 * is granted directly or by implication, estoppel or otherwise; 38 * 39 * The above copyright and patent license is granted only if the following 40 * conditions are met: 41 * 42 * 3. Conditions 43 * 44 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45 * Redistribution of source code of any substantial portion of the Covered 46 * Code or modification with rights to further distribute source must include 47 * the above Copyright Notice, the above License, this list of Conditions, 48 * and the following Disclaimer and Export Compliance provision. In addition, 49 * Licensee must cause all Covered Code to which Licensee contributes to 50 * contain a file documenting the changes Licensee made to create that Covered 51 * Code and the date of any change. Licensee must include in that file the 52 * documentation of any changes made by any predecessor Licensee. Licensee 53 * must include a prominent statement that the modification is derived, 54 * directly or indirectly, from Original Intel Code. 55 * 56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 57 * Redistribution of source code of any substantial portion of the Covered 58 * Code or modification without rights to further distribute source must 59 * include the following Disclaimer and Export Compliance provision in the 60 * documentation and/or other materials provided with distribution. In 61 * addition, Licensee may not authorize further sublicense of source of any 62 * portion of the Covered Code, and must include terms to the effect that the 63 * license from Licensee to its licensee is limited to the intellectual 64 * property embodied in the software Licensee provides to its licensee, and 65 * not to intellectual property embodied in modifications its licensee may 66 * make. 67 * 68 * 3.3. Redistribution of Executable. Redistribution in executable form of any 69 * substantial portion of the Covered Code or modification must reproduce the 70 * above Copyright Notice, and the following Disclaimer and Export Compliance 71 * provision in the documentation and/or other materials provided with the 72 * distribution. 73 * 74 * 3.4. Intel retains all right, title, and interest in and to the Original 75 * Intel Code. 76 * 77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78 * Intel shall be used in advertising or otherwise to promote the sale, use or 79 * other dealings in products derived from or relating to the Covered Code 80 * without prior written authorization from Intel. 81 * 82 * 4. Disclaimer and Export Compliance 83 * 84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90 * PARTICULAR PURPOSE. 91 * 92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99 * LIMITED REMEDY. 100 * 101 * 4.3. Licensee shall not export, either directly or indirectly, any of this 102 * software or system incorporating such software without first obtaining any 103 * required license or other approval from the U. S. Department of Commerce or 104 * any other agency or department of the United States Government. In the 105 * event Licensee exports any such software from the United States or 106 * re-exports any such software from a foreign destination, Licensee shall 107 * ensure that the distribution and export/re-export of the software is in 108 * compliance with all laws, regulations, orders, or other restrictions of the 109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 110 * any of its subsidiaries will export/re-export any technical data, process, 111 * software, or service, directly or indirectly, to any country for which the 112 * United States government or any agency thereof requires an export license, 113 * other governmental approval, or letter of assurance, without first obtaining 114 * such license, approval or letter. 115 * 116 *****************************************************************************/ 117 118#ifndef _ACOBJECT_H 119#define _ACOBJECT_H 120 121 122/* 123 * The ACPI_OPERAND_OBJECT is used to pass AML operands from the dispatcher 124 * to the interpreter, and to keep track of the various handlers such as 125 * address space handlers and notify handlers. The object is a constant 126 * size in order to allow it to be cached and reused. 127 */ 128 129/******************************************************************************* 130 * 131 * Common Descriptors 132 * 133 ******************************************************************************/ 134 135/* 136 * Common area for all objects. 137 * 138 * DataType is used to differentiate between internal descriptors, and MUST 139 * be the first byte in this structure. 140 */ 141#define ACPI_OBJECT_COMMON_HEADER /* SIZE/ALIGNMENT: 32 bits, one ptr plus trailing 8-bit flag */\ 142 UINT8 Descriptor; /* To differentiate various internal objs */\ 143 UINT8 Type; /* ACPI_OBJECT_TYPE */\ 144 UINT16 ReferenceCount; /* For object deletion management */\ 145 union acpi_operand_obj *NextObject; /* Objects linked to parent NS node */\ 146 UINT8 Flags; \ 147 148/* Values for flag byte above */ 149 150#define AOPOBJ_AML_CONSTANT 0x01 151#define AOPOBJ_STATIC_POINTER 0x02 152#define AOPOBJ_DATA_VALID 0x04 153#define AOPOBJ_OBJECT_INITIALIZED 0x08 154#define AOPOBJ_SETUP_COMPLETE 0x10 155#define AOPOBJ_SINGLE_DATUM 0x20 156 157 158/* 159 * Common bitfield for the field objects 160 * "Field Datum" -- a datum from the actual field object 161 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field 162 */ 163#define ACPI_COMMON_FIELD_INFO /* SIZE/ALIGNMENT: 24 bits + three 32-bit values */\ 164 UINT8 FieldFlags; /* Access, update, and lock bits */\ 165 UINT8 Attribute; /* From AccessAs keyword */\ 166 UINT8 AccessByteWidth; /* Read/Write size in bytes */\ 167 UINT32 BitLength; /* Length of field in bits */\ 168 UINT32 BaseByteOffset; /* Byte offset within containing object */\ 169 UINT8 StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\ 170 UINT8 DatumValidBits; /* Valid bit in first "Field datum" */\ 171 UINT8 EndFieldValidBits; /* Valid bits in the last "field datum" */\ 172 UINT8 EndBufferValidBits; /* Valid bits in the last "buffer datum" */\ 173 UINT32 Value; /* Value to store into the Bank or Index register */\ 174 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 175 176 177/* 178 * Fields common to both Strings and Buffers 179 */ 180#define ACPI_COMMON_BUFFER_INFO \ 181 UINT32 Length; 182 183 184/* 185 * Common fields for objects that support ASL notifications 186 */ 187#define ACPI_COMMON_NOTIFY_INFO \ 188 union acpi_operand_obj *SysHandler; /* Handler for system notifies */\ 189 union acpi_operand_obj *DrvHandler; /* Handler for driver notifies */\ 190 union acpi_operand_obj *AddrHandler; /* Handler for Address space */ 191 192 193/****************************************************************************** 194 * 195 * Basic data types 196 * 197 *****************************************************************************/ 198 199typedef struct AcpiObjectCommon 200{ 201 ACPI_OBJECT_COMMON_HEADER 202 203} ACPI_OBJECT_COMMON; 204 205 206typedef struct AcpiObjectInteger 207{ 208 ACPI_OBJECT_COMMON_HEADER 209 210 ACPI_INTEGER Value; 211 212} ACPI_OBJECT_INTEGER; 213 214 215typedef struct AcpiObjectString /* Null terminated, ASCII characters only */ 216{ 217 ACPI_OBJECT_COMMON_HEADER 218 ACPI_COMMON_BUFFER_INFO 219 NATIVE_CHAR *Pointer; /* String in AML stream or allocated string */ 220 221} ACPI_OBJECT_STRING; 222 223 224typedef struct AcpiObjectBuffer 225{ 226 ACPI_OBJECT_COMMON_HEADER 227 ACPI_COMMON_BUFFER_INFO 228 UINT8 *Pointer; /* Buffer in AML stream or allocated buffer */ 229 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 230 UINT8 *AmlStart; 231 UINT32 AmlLength; 232 233} ACPI_OBJECT_BUFFER; 234 235 236typedef struct AcpiObjectPackage 237{ 238 ACPI_OBJECT_COMMON_HEADER 239 240 UINT32 Count; /* # of elements in package */ 241 UINT32 AmlLength; 242 UINT8 *AmlStart; 243 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 244 union acpi_operand_obj **Elements; /* Array of pointers to AcpiObjects */ 245 246} ACPI_OBJECT_PACKAGE; 247 248 249/****************************************************************************** 250 * 251 * Complex data types 252 * 253 *****************************************************************************/ 254 255typedef struct AcpiObjectEvent 256{ 257 ACPI_OBJECT_COMMON_HEADER 258 void *Semaphore; 259 260} ACPI_OBJECT_EVENT; 261 262 263#define INFINITE_CONCURRENCY 0xFF 264 265typedef struct AcpiObjectMethod 266{ 267 ACPI_OBJECT_COMMON_HEADER 268 UINT8 MethodFlags; 269 UINT8 ParamCount; 270 271 UINT32 AmlLength; 272 273 void *Semaphore; 274 UINT8 *AmlStart; 275 276 UINT8 Concurrency; 277 UINT8 ThreadCount; 278 ACPI_OWNER_ID OwningId; 279 280} ACPI_OBJECT_METHOD; 281 282 283typedef struct AcpiObjectMutex 284{ 285 ACPI_OBJECT_COMMON_HEADER 286 UINT16 SyncLevel; 287 UINT16 AcquisitionDepth; 288 289 struct acpi_thread_state *OwnerThread; 290 void *Semaphore; 291 union acpi_operand_obj *Prev; /* Link for list of acquired mutexes */ 292 union acpi_operand_obj *Next; /* Link for list of acquired mutexes */ 293 294} ACPI_OBJECT_MUTEX; 295 296 297typedef struct AcpiObjectRegion 298{ 299 ACPI_OBJECT_COMMON_HEADER 300 301 UINT8 SpaceId; 302 303 union acpi_operand_obj *AddrHandler; /* Handler for system notifies */ 304 ACPI_NAMESPACE_NODE *Node; /* containing object */ 305 union acpi_operand_obj *Next; 306 UINT32 Length; 307 ACPI_PHYSICAL_ADDRESS Address; 308 309} ACPI_OBJECT_REGION; 310 311 312/****************************************************************************** 313 * 314 * Objects that can be notified. All share a common NotifyInfo area. 315 * 316 *****************************************************************************/ 317 318typedef struct AcpiObjectNotifyCommon /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */ 319{ 320 ACPI_OBJECT_COMMON_HEADER 321 ACPI_COMMON_NOTIFY_INFO 322 323} ACPI_OBJECT_NOTIFY_COMMON; 324 325 326typedef struct AcpiObjectDevice 327{ 328 ACPI_OBJECT_COMMON_HEADER 329 ACPI_COMMON_NOTIFY_INFO 330 331} ACPI_OBJECT_DEVICE; 332 333 334typedef struct AcpiObjectPowerResource 335{ 336 ACPI_OBJECT_COMMON_HEADER 337 ACPI_COMMON_NOTIFY_INFO 338 339 UINT32 SystemLevel; 340 UINT32 ResourceOrder; 341 342} ACPI_OBJECT_POWER_RESOURCE; 343 344 345typedef struct AcpiObjectProcessor 346{ 347 ACPI_OBJECT_COMMON_HEADER 348 ACPI_COMMON_NOTIFY_INFO 349 350 UINT32 ProcId; 351 UINT32 Length; 352 ACPI_IO_ADDRESS Address; 353 354} ACPI_OBJECT_PROCESSOR; 355 356 357typedef struct AcpiObjectThermalZone 358{ 359 ACPI_OBJECT_COMMON_HEADER 360 ACPI_COMMON_NOTIFY_INFO 361 362 363} ACPI_OBJECT_THERMAL_ZONE; 364 365 366/****************************************************************************** 367 * 368 * Fields. All share a common header/info field. 369 * 370 *****************************************************************************/ 371 372typedef struct AcpiObjectFieldCommon /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */ 373{ 374 ACPI_OBJECT_COMMON_HEADER 375 ACPI_COMMON_FIELD_INFO 376 union acpi_operand_obj *RegionObj; /* Containing Operation Region object */ 377 /* (REGION/BANK fields only) */ 378} ACPI_OBJECT_FIELD_COMMON; 379 380 381typedef struct AcpiObjectRegionField 382{ 383 ACPI_OBJECT_COMMON_HEADER 384 ACPI_COMMON_FIELD_INFO 385 union acpi_operand_obj *RegionObj; /* Containing OpRegion object */ 386 387} ACPI_OBJECT_REGION_FIELD; 388 389 390typedef struct AcpiObjectBankField 391{ 392 ACPI_OBJECT_COMMON_HEADER 393 ACPI_COMMON_FIELD_INFO 394 395 union acpi_operand_obj *RegionObj; /* Containing OpRegion object */ 396 union acpi_operand_obj *BankObj; /* BankSelect Register object */ 397 398} ACPI_OBJECT_BANK_FIELD; 399 400 401typedef struct AcpiObjectIndexField 402{ 403 ACPI_OBJECT_COMMON_HEADER 404 ACPI_COMMON_FIELD_INFO 405 406 /* 407 * No "RegionObj" pointer needed since the Index and Data registers 408 * are each field definitions unto themselves. 409 */ 410 union acpi_operand_obj *IndexObj; /* Index register */ 411 union acpi_operand_obj *DataObj; /* Data register */ 412 413 414} ACPI_OBJECT_INDEX_FIELD; 415 416 417/* The BufferField is different in that it is part of a Buffer, not an OpRegion */ 418 419typedef struct AcpiObjectBufferField 420{ 421 ACPI_OBJECT_COMMON_HEADER 422 ACPI_COMMON_FIELD_INFO 423 424 union acpi_operand_obj *BufferObj; /* Containing Buffer object */ 425 426} ACPI_OBJECT_BUFFER_FIELD; 427 428 429/****************************************************************************** 430 * 431 * Objects for handlers 432 * 433 *****************************************************************************/ 434 435typedef struct AcpiObjectNotifyHandler 436{ 437 ACPI_OBJECT_COMMON_HEADER 438 439 ACPI_NAMESPACE_NODE *Node; /* Parent device */ 440 ACPI_NOTIFY_HANDLER Handler; 441 void *Context; 442 443} ACPI_OBJECT_NOTIFY_HANDLER; 444 445 446/* Flags for address handler */ 447 448#define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x1 449 450 451typedef struct AcpiObjectAddrHandler 452{ 453 ACPI_OBJECT_COMMON_HEADER 454 455 UINT8 SpaceId; 456 UINT16 Hflags; 457 ACPI_ADR_SPACE_HANDLER Handler; 458 459 ACPI_NAMESPACE_NODE *Node; /* Parent device */ 460 void *Context; 461 ACPI_ADR_SPACE_SETUP Setup; 462 union acpi_operand_obj *RegionList; /* regions using this handler */ 463 union acpi_operand_obj *Next; 464 465} ACPI_OBJECT_ADDR_HANDLER; 466 467 468/****************************************************************************** 469 * 470 * Special internal objects 471 * 472 *****************************************************************************/ 473 474/* 475 * The Reference object type is used for these opcodes: 476 * Arg[0-6], Local[0-7], IndexOp, NameOp, ZeroOp, OneOp, OnesOp, DebugOp 477 */ 478typedef struct AcpiObjectReference 479{ 480 ACPI_OBJECT_COMMON_HEADER 481 482 UINT8 TargetType; /* Used for IndexOp */ 483 UINT16 Opcode; 484 UINT32 Offset; /* Used for ArgOp, LocalOp, and IndexOp */ 485 486 void *Object; /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */ 487 ACPI_NAMESPACE_NODE *Node; 488 union acpi_operand_obj **Where; 489 490} ACPI_OBJECT_REFERENCE; 491 492 493/* 494 * Extra object is used as additional storage for types that 495 * have AML code in their declarations (TermArgs) that must be 496 * evaluated at run time. 497 * 498 * Currently: Region and FieldUnit types 499 */ 500typedef struct AcpiObjectExtra 501{ 502 ACPI_OBJECT_COMMON_HEADER 503 UINT8 ByteFill1; 504 UINT16 WordFill1; 505 UINT32 AmlLength; 506 UINT8 *AmlStart; 507 ACPI_NAMESPACE_NODE *Method_REG; /* _REG method for this region (if any) */ 508 void *RegionContext; /* Region-specific data */ 509 510} ACPI_OBJECT_EXTRA; 511 512 513/* Additional data that can be attached to namespace nodes */ 514 515typedef struct AcpiObjectData 516{ 517 ACPI_OBJECT_COMMON_HEADER 518 ACPI_OBJECT_HANDLER Handler; 519 void *Pointer; 520 521} ACPI_OBJECT_DATA; 522 523 524/* Structure used when objects are cached for reuse */ 525 526typedef struct AcpiObjectCacheList 527{ 528 ACPI_OBJECT_COMMON_HEADER 529 union acpi_operand_obj *Next; /* Link for object cache and internal lists*/ 530 531} ACPI_OBJECT_CACHE_LIST; 532 533 534/****************************************************************************** 535 * 536 * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above 537 * 538 *****************************************************************************/ 539 540typedef union acpi_operand_obj 541{ 542 ACPI_OBJECT_COMMON Common; 543 544 ACPI_OBJECT_INTEGER Integer; 545 ACPI_OBJECT_STRING String; 546 ACPI_OBJECT_BUFFER Buffer; 547 ACPI_OBJECT_PACKAGE Package; 548 549 ACPI_OBJECT_EVENT Event; 550 ACPI_OBJECT_METHOD Method; 551 ACPI_OBJECT_MUTEX Mutex; 552 ACPI_OBJECT_REGION Region; 553 554 ACPI_OBJECT_NOTIFY_COMMON CommonNotify; 555 ACPI_OBJECT_DEVICE Device; 556 ACPI_OBJECT_POWER_RESOURCE PowerResource; 557 ACPI_OBJECT_PROCESSOR Processor; 558 ACPI_OBJECT_THERMAL_ZONE ThermalZone; 559 560 ACPI_OBJECT_FIELD_COMMON CommonField; 561 ACPI_OBJECT_REGION_FIELD Field; 562 ACPI_OBJECT_BUFFER_FIELD BufferField; 563 ACPI_OBJECT_BANK_FIELD BankField; 564 ACPI_OBJECT_INDEX_FIELD IndexField; 565 566 ACPI_OBJECT_NOTIFY_HANDLER NotifyHandler; 567 ACPI_OBJECT_ADDR_HANDLER AddrHandler; 568 569 ACPI_OBJECT_REFERENCE Reference; 570 ACPI_OBJECT_EXTRA Extra; 571 ACPI_OBJECT_DATA Data; 572 ACPI_OBJECT_CACHE_LIST Cache; 573 574} ACPI_OPERAND_OBJECT; 575 576 577/****************************************************************************** 578 * 579 * ACPI_DESCRIPTOR - objects that share a common descriptor identifier 580 * 581 *****************************************************************************/ 582 583 584/* Object descriptor types */ 585 586#define ACPI_DESC_TYPE_CACHED 0x11 /* Used only when object is cached */ 587#define ACPI_DESC_TYPE_STATE 0x20 588#define ACPI_DESC_TYPE_STATE_UPDATE 0x21 589#define ACPI_DESC_TYPE_STATE_PACKAGE 0x22 590#define ACPI_DESC_TYPE_STATE_CONTROL 0x23 591#define ACPI_DESC_TYPE_STATE_RPSCOPE 0x24 592#define ACPI_DESC_TYPE_STATE_PSCOPE 0x25 593#define ACPI_DESC_TYPE_STATE_WSCOPE 0x26 594#define ACPI_DESC_TYPE_STATE_RESULT 0x27 595#define ACPI_DESC_TYPE_STATE_NOTIFY 0x28 596#define ACPI_DESC_TYPE_STATE_THREAD 0x29 597#define ACPI_DESC_TYPE_WALK 0x44 598#define ACPI_DESC_TYPE_PARSER 0x66 599#define ACPI_DESC_TYPE_OPERAND 0x88 600#define ACPI_DESC_TYPE_NAMED 0xAA 601 602 603typedef union acpi_desc 604{ 605 UINT8 DescriptorId; /* To differentiate various internal objs */\ 606 ACPI_OPERAND_OBJECT Object; 607 ACPI_NAMESPACE_NODE Node; 608 ACPI_PARSE_OBJECT Op; 609 610} ACPI_DESCRIPTOR; 611 612 613#endif /* _ACOBJECT_H */ 614