acobject.h revision 87031
1 2/****************************************************************************** 3 * 4 * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT (Internal object only) 5 * $Revision: 101 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 them to be cached and reused. 127 * 128 * All variants of the ACPI_OPERAND_OBJECT are defined with the same 129 * sequence of field types, with fields that are not used in a particular 130 * variant being named "Reserved". This is not strictly necessary, but 131 * may in some circumstances simplify understanding if these structures 132 * need to be displayed in a debugger having limited (or no) support for 133 * union types. It also simplifies some debug code in DumpTable() which 134 * dumps multi-level values: fetching Buffer.Pointer suffices to pick up 135 * the value or next level for any of several types. 136 */ 137 138/****************************************************************************** 139 * 140 * Common Descriptors 141 * 142 *****************************************************************************/ 143 144/* 145 * Common area for all objects. 146 * 147 * DataType is used to differentiate between internal descriptors, and MUST 148 * be the first byte in this structure. 149 */ 150 151 152#define ACPI_OBJECT_COMMON_HEADER /* SIZE/ALIGNMENT: 32 bits, one ptr plus trailing 8-bit flag */\ 153 UINT8 DataType; /* To differentiate various internal objs */\ 154 UINT8 Type; /* ACPI_OBJECT_TYPE */\ 155 UINT16 ReferenceCount; /* For object deletion management */\ 156 union acpi_operand_obj *NextObject; /* Objects linked to parent NS node */\ 157 UINT8 Flags; \ 158 159/* Defines for flag byte above */ 160 161#define AOPOBJ_STATIC_ALLOCATION 0x01 162#define AOPOBJ_STATIC_POINTER 0x02 163#define AOPOBJ_DATA_VALID 0x04 164#define AOPOBJ_OBJECT_INITIALIZED 0x08 165#define AOPOBJ_SETUP_COMPLETE 0x10 166#define AOPOBJ_SINGLE_DATUM 0x20 167 168 169/* 170 * Common bitfield for the field objects 171 * "Field Datum" -- a datum from the actual field object 172 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field 173 */ 174#define ACPI_COMMON_FIELD_INFO /* SIZE/ALIGNMENT: 24 bits + three 32-bit values */\ 175 UINT8 FieldFlags; /* Access, update, and lock bits */\ 176 UINT16 BitLength; /* Length of field in bits */\ 177 UINT32 BaseByteOffset; /* Byte offset within containing object */\ 178 UINT8 AccessBitWidth; /* Read/Write size in bits (from ASL AccessType)*/\ 179 UINT8 AccessByteWidth; /* Read/Write size in bytes */\ 180 UINT8 Attribute ; /* From AccessAs keyword */\ 181 UINT8 StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\ 182 UINT8 DatumValidBits; /* Valid bit in first "Field datum" */\ 183 UINT8 EndFieldValidBits; /* Valid bits in the last "field datum" */\ 184 UINT8 EndBufferValidBits; /* Valid bits in the last "buffer datum" */\ 185 UINT8 Reserved; /* Reserved for future use */\ 186 UINT32 Value; /* Value to store into the Bank or Index register */\ 187 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 188 189 190/* 191 * Fields common to both Strings and Buffers 192 */ 193#define ACPI_COMMON_BUFFER_INFO \ 194 UINT32 Length; 195 196 197/****************************************************************************** 198 * 199 * Individual Object Descriptors 200 * 201 *****************************************************************************/ 202 203 204typedef struct /* COMMON */ 205{ 206 ACPI_OBJECT_COMMON_HEADER 207 208} ACPI_OBJECT_COMMON; 209 210 211typedef struct /* CACHE_LIST */ 212{ 213 ACPI_OBJECT_COMMON_HEADER 214 union acpi_operand_obj *Next; /* Link for object cache and internal lists*/ 215 216} ACPI_OBJECT_CACHE_LIST; 217 218 219typedef struct /* NUMBER - has value */ 220{ 221 ACPI_OBJECT_COMMON_HEADER 222 223 ACPI_INTEGER Value; 224 225} ACPI_OBJECT_INTEGER; 226 227 228typedef struct /* STRING - has length and pointer - Null terminated, ASCII characters only */ 229{ 230 ACPI_OBJECT_COMMON_HEADER 231 ACPI_COMMON_BUFFER_INFO 232 NATIVE_CHAR *Pointer; /* String value in AML stream or in allocated space */ 233 234} ACPI_OBJECT_STRING; 235 236 237typedef struct /* BUFFER - has length and pointer - not null terminated */ 238{ 239 ACPI_OBJECT_COMMON_HEADER 240 ACPI_COMMON_BUFFER_INFO 241 UINT8 *Pointer; /* Buffer value in AML stream or in allocated space */ 242 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 243 244} ACPI_OBJECT_BUFFER; 245 246 247typedef struct /* PACKAGE - has count, elements, next element */ 248{ 249 ACPI_OBJECT_COMMON_HEADER 250 251 UINT32 Count; /* # of elements in package */ 252 union acpi_operand_obj **Elements; /* Array of pointers to AcpiObjects */ 253 union acpi_operand_obj **NextElement; /* used only while initializing */ 254 255} ACPI_OBJECT_PACKAGE; 256 257 258typedef struct /* DEVICE - has handle and notification handler/context */ 259{ 260 ACPI_OBJECT_COMMON_HEADER 261 262 union acpi_operand_obj *SysHandler; /* Handler for system notifies */ 263 union acpi_operand_obj *DrvHandler; /* Handler for driver notifies */ 264 union acpi_operand_obj *AddrHandler; /* Handler for Address space */ 265 266} ACPI_OBJECT_DEVICE; 267 268 269typedef struct /* EVENT */ 270{ 271 ACPI_OBJECT_COMMON_HEADER 272 void *Semaphore; 273 274} ACPI_OBJECT_EVENT; 275 276 277#define INFINITE_CONCURRENCY 0xFF 278 279typedef struct /* METHOD */ 280{ 281 ACPI_OBJECT_COMMON_HEADER 282 UINT8 MethodFlags; 283 UINT8 ParamCount; 284 285 UINT32 AmlLength; 286 287 void *Semaphore; 288 UINT8 *AmlStart; 289 290 UINT8 Concurrency; 291 UINT8 ThreadCount; 292 ACPI_OWNER_ID OwningId; 293 294} ACPI_OBJECT_METHOD; 295 296 297typedef struct acpi_obj_mutex /* MUTEX */ 298{ 299 ACPI_OBJECT_COMMON_HEADER 300 UINT16 SyncLevel; 301 UINT16 AcquisitionDepth; 302 303 struct acpi_thread_state *OwnerThread; 304 void *Semaphore; 305 union acpi_operand_obj *Prev; /* Link for list of acquired mutexes */ 306 union acpi_operand_obj *Next; /* Link for list of acquired mutexes */ 307 308} ACPI_OBJECT_MUTEX; 309 310 311typedef struct /* REGION */ 312{ 313 ACPI_OBJECT_COMMON_HEADER 314 315 UINT8 SpaceId; 316 UINT32 Length; 317 ACPI_PHYSICAL_ADDRESS Address; 318 319 union acpi_operand_obj *AddrHandler; /* Handler for system notifies */ 320 ACPI_NAMESPACE_NODE *Node; /* containing object */ 321 union acpi_operand_obj *Next; 322 323} ACPI_OBJECT_REGION; 324 325 326typedef struct /* POWER RESOURCE - has Handle and notification handler/context*/ 327{ 328 ACPI_OBJECT_COMMON_HEADER 329 330 UINT32 SystemLevel; 331 UINT32 ResourceOrder; 332 333 union acpi_operand_obj *SysHandler; /* Handler for system notifies */ 334 union acpi_operand_obj *DrvHandler; /* Handler for driver notifies */ 335 336} ACPI_OBJECT_POWER_RESOURCE; 337 338 339typedef struct /* PROCESSOR - has Handle and notification handler/context*/ 340{ 341 ACPI_OBJECT_COMMON_HEADER 342 343 UINT32 ProcId; 344 UINT32 Length; 345 ACPI_IO_ADDRESS Address; 346 347 union acpi_operand_obj *SysHandler; /* Handler for system notifies */ 348 union acpi_operand_obj *DrvHandler; /* Handler for driver notifies */ 349 union acpi_operand_obj *AddrHandler; /* Handler for Address space */ 350 351} ACPI_OBJECT_PROCESSOR; 352 353 354typedef struct /* THERMAL ZONE - has Handle and Handler/Context */ 355{ 356 ACPI_OBJECT_COMMON_HEADER 357 358 union acpi_operand_obj *SysHandler; /* Handler for system notifies */ 359 union acpi_operand_obj *DrvHandler; /* Handler for driver notifies */ 360 union acpi_operand_obj *AddrHandler; /* Handler for Address space */ 361 362} ACPI_OBJECT_THERMAL_ZONE; 363 364 365/* 366 * Fields. All share a common header/info field. 367 */ 368 369typedef struct /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */ 370{ 371 ACPI_OBJECT_COMMON_HEADER 372 ACPI_COMMON_FIELD_INFO 373 union acpi_operand_obj *RegionObj; /* Containing Operation Region object */ 374 /* (REGION/BANK fields only) */ 375} ACPI_OBJECT_FIELD_COMMON; 376 377 378typedef struct /* REGION FIELD */ 379{ 380 ACPI_OBJECT_COMMON_HEADER 381 ACPI_COMMON_FIELD_INFO 382 union acpi_operand_obj *RegionObj; /* Containing OpRegion object */ 383 384} ACPI_OBJECT_REGION_FIELD; 385 386 387typedef struct /* BANK FIELD */ 388{ 389 ACPI_OBJECT_COMMON_HEADER 390 ACPI_COMMON_FIELD_INFO 391 392 union acpi_operand_obj *RegionObj; /* Containing OpRegion object */ 393 union acpi_operand_obj *BankObj; /* BankSelect Register object */ 394 395} ACPI_OBJECT_BANK_FIELD; 396 397 398typedef struct /* INDEX FIELD */ 399{ 400 ACPI_OBJECT_COMMON_HEADER 401 ACPI_COMMON_FIELD_INFO 402 403 /* 404 * No "RegionObj" pointer needed since the Index and Data registers 405 * are each field definitions unto themselves. 406 */ 407 union acpi_operand_obj *IndexObj; /* Index register */ 408 union acpi_operand_obj *DataObj; /* Data register */ 409 410 411} ACPI_OBJECT_INDEX_FIELD; 412 413 414/* The BufferField is different in that it is part of a Buffer, not an OpRegion */ 415 416typedef struct /* BUFFER FIELD */ 417{ 418 ACPI_OBJECT_COMMON_HEADER 419 ACPI_COMMON_FIELD_INFO 420 421 union acpi_operand_obj *BufferObj; /* Containing Buffer object */ 422 423} ACPI_OBJECT_BUFFER_FIELD; 424 425 426/* 427 * Handlers 428 */ 429 430typedef struct /* NOTIFY HANDLER */ 431{ 432 ACPI_OBJECT_COMMON_HEADER 433 434 ACPI_NAMESPACE_NODE *Node; /* Parent device */ 435 ACPI_NOTIFY_HANDLER Handler; 436 void *Context; 437 438} ACPI_OBJECT_NOTIFY_HANDLER; 439 440 441/* Flags for address handler */ 442 443#define ADDR_HANDLER_DEFAULT_INSTALLED 0x1 444 445 446typedef struct /* ADDRESS HANDLER */ 447{ 448 ACPI_OBJECT_COMMON_HEADER 449 450 UINT8 SpaceId; 451 UINT16 Hflags; 452 ACPI_ADR_SPACE_HANDLER Handler; 453 454 ACPI_NAMESPACE_NODE *Node; /* Parent device */ 455 void *Context; 456 ACPI_ADR_SPACE_SETUP Setup; 457 union acpi_operand_obj *RegionList; /* regions using this handler */ 458 union acpi_operand_obj *Next; 459 460} ACPI_OBJECT_ADDR_HANDLER; 461 462 463/* 464 * The Reference object type is used for these opcodes: 465 * Arg[0-6], Local[0-7], IndexOp, NameOp, ZeroOp, OneOp, OnesOp, DebugOp 466 */ 467 468typedef struct /* Reference - Local object type */ 469{ 470 ACPI_OBJECT_COMMON_HEADER 471 472 UINT8 TargetType; /* Used for IndexOp */ 473 UINT16 Opcode; 474 UINT32 Offset; /* Used for ArgOp, LocalOp, and IndexOp */ 475 476 void *Object; /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */ 477 ACPI_NAMESPACE_NODE *Node; 478 union acpi_operand_obj **Where; 479 480} ACPI_OBJECT_REFERENCE; 481 482 483/* 484 * Extra object is used as additional storage for types that 485 * have AML code in their declarations (TermArgs) that must be 486 * evaluated at run time. 487 * 488 * Currently: Region and FieldUnit types 489 */ 490 491typedef struct /* EXTRA */ 492{ 493 ACPI_OBJECT_COMMON_HEADER 494 UINT8 ByteFill1; 495 UINT16 WordFill1; 496 UINT32 AmlLength; 497 UINT8 *AmlStart; 498 ACPI_NAMESPACE_NODE *Method_REG; /* _REG method for this region (if any) */ 499 void *RegionContext; /* Region-specific data */ 500 501} ACPI_OBJECT_EXTRA; 502 503 504typedef struct /* DATA */ 505{ 506 ACPI_OBJECT_COMMON_HEADER 507 ACPI_OBJECT_HANDLER Handler; 508 void *Pointer; 509 510} ACPI_OBJECT_DATA; 511 512 513/****************************************************************************** 514 * 515 * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above 516 * 517 *****************************************************************************/ 518 519typedef union acpi_operand_obj 520{ 521 ACPI_OBJECT_COMMON Common; 522 ACPI_OBJECT_CACHE_LIST Cache; 523 ACPI_OBJECT_INTEGER Integer; 524 ACPI_OBJECT_STRING String; 525 ACPI_OBJECT_BUFFER Buffer; 526 ACPI_OBJECT_PACKAGE Package; 527 ACPI_OBJECT_BUFFER_FIELD BufferField; 528 ACPI_OBJECT_DEVICE Device; 529 ACPI_OBJECT_EVENT Event; 530 ACPI_OBJECT_METHOD Method; 531 ACPI_OBJECT_MUTEX Mutex; 532 ACPI_OBJECT_REGION Region; 533 ACPI_OBJECT_POWER_RESOURCE PowerResource; 534 ACPI_OBJECT_PROCESSOR Processor; 535 ACPI_OBJECT_THERMAL_ZONE ThermalZone; 536 ACPI_OBJECT_FIELD_COMMON CommonField; 537 ACPI_OBJECT_REGION_FIELD Field; 538 ACPI_OBJECT_BANK_FIELD BankField; 539 ACPI_OBJECT_INDEX_FIELD IndexField; 540 ACPI_OBJECT_REFERENCE Reference; 541 ACPI_OBJECT_NOTIFY_HANDLER NotifyHandler; 542 ACPI_OBJECT_ADDR_HANDLER AddrHandler; 543 ACPI_OBJECT_EXTRA Extra; 544 ACPI_OBJECT_DATA Data; 545 546} ACPI_OPERAND_OBJECT; 547 548#endif /* _ACOBJECT_H */ 549