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