acobject.h revision 85756
1 2/****************************************************************************** 3 * 4 * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT (Internal object only) 5 * $Revision: 93 $ 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 198 199 200/****************************************************************************** 201 * 202 * Individual Object Descriptors 203 * 204 *****************************************************************************/ 205 206 207typedef struct /* COMMON */ 208{ 209 ACPI_OBJECT_COMMON_HEADER 210 211} ACPI_OBJECT_COMMON; 212 213 214typedef struct /* CACHE_LIST */ 215{ 216 ACPI_OBJECT_COMMON_HEADER 217 union acpi_operand_obj *Next; /* Link for object cache and internal lists*/ 218 219} ACPI_OBJECT_CACHE_LIST; 220 221 222typedef struct /* NUMBER - has value */ 223{ 224 ACPI_OBJECT_COMMON_HEADER 225 226 ACPI_INTEGER Value; 227 228} ACPI_OBJECT_INTEGER; 229 230 231typedef struct /* STRING - has length and pointer - Null terminated, ASCII characters only */ 232{ 233 ACPI_OBJECT_COMMON_HEADER 234 ACPI_COMMON_BUFFER_INFO 235 NATIVE_CHAR *Pointer; /* String value in AML stream or in allocated space */ 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 UINT8 *Pointer; /* Buffer value in AML stream or in allocated space */ 245 246} ACPI_OBJECT_BUFFER; 247 248 249typedef struct /* PACKAGE - has count, elements, next element */ 250{ 251 ACPI_OBJECT_COMMON_HEADER 252 253 UINT32 Count; /* # of elements in package */ 254 union acpi_operand_obj **Elements; /* Array of pointers to AcpiObjects */ 255 union acpi_operand_obj **NextElement; /* used only while initializing */ 256 257} ACPI_OBJECT_PACKAGE; 258 259 260typedef struct /* DEVICE - has handle and notification handler/context */ 261{ 262 ACPI_OBJECT_COMMON_HEADER 263 264 union acpi_operand_obj *SysHandler; /* Handler for system notifies */ 265 union acpi_operand_obj *DrvHandler; /* Handler for driver notifies */ 266 union acpi_operand_obj *AddrHandler; /* Handler for Address space */ 267 268} ACPI_OBJECT_DEVICE; 269 270 271typedef struct /* EVENT */ 272{ 273 ACPI_OBJECT_COMMON_HEADER 274 void *Semaphore; 275 276} ACPI_OBJECT_EVENT; 277 278 279#define INFINITE_CONCURRENCY 0xFF 280 281typedef struct /* METHOD */ 282{ 283 ACPI_OBJECT_COMMON_HEADER 284 UINT8 MethodFlags; 285 UINT8 ParamCount; 286 287 UINT32 AmlLength; 288 289 void *Semaphore; 290 UINT8 *AmlStart; 291 292 UINT8 Concurrency; 293 UINT8 ThreadCount; 294 ACPI_OWNER_ID OwningId; 295 296} ACPI_OBJECT_METHOD; 297 298 299typedef struct acpi_obj_mutex /* MUTEX */ 300{ 301 ACPI_OBJECT_COMMON_HEADER 302 UINT16 SyncLevel; 303 UINT16 AcquisitionDepth; 304 305 void *Semaphore; 306 void *Owner; 307 union acpi_operand_obj *Prev; /* Link for list of acquired mutexes */ 308 union acpi_operand_obj *Next; /* Link for list of acquired mutexes */ 309 310} ACPI_OBJECT_MUTEX; 311 312 313typedef struct /* REGION */ 314{ 315 ACPI_OBJECT_COMMON_HEADER 316 317 UINT8 SpaceId; 318 UINT32 Length; 319 ACPI_PHYSICAL_ADDRESS Address; 320 union acpi_operand_obj *Extra; /* Pointer to executable AML (in region definition) */ 321 322 union acpi_operand_obj *AddrHandler; /* Handler for system notifies */ 323 ACPI_NAMESPACE_NODE *Node; /* containing object */ 324 union acpi_operand_obj *Next; 325 326} ACPI_OBJECT_REGION; 327 328 329typedef struct /* POWER RESOURCE - has Handle and notification handler/context*/ 330{ 331 ACPI_OBJECT_COMMON_HEADER 332 333 UINT32 SystemLevel; 334 UINT32 ResourceOrder; 335 336 union acpi_operand_obj *SysHandler; /* Handler for system notifies */ 337 union acpi_operand_obj *DrvHandler; /* Handler for driver notifies */ 338 339} ACPI_OBJECT_POWER_RESOURCE; 340 341 342typedef struct /* PROCESSOR - has Handle and notification handler/context*/ 343{ 344 ACPI_OBJECT_COMMON_HEADER 345 346 UINT32 ProcId; 347 UINT32 Length; 348 ACPI_IO_ADDRESS Address; 349 350 union acpi_operand_obj *SysHandler; /* Handler for system notifies */ 351 union acpi_operand_obj *DrvHandler; /* Handler for driver notifies */ 352 union acpi_operand_obj *AddrHandler; /* Handler for Address space */ 353 354} ACPI_OBJECT_PROCESSOR; 355 356 357typedef struct /* THERMAL ZONE - has Handle and Handler/Context */ 358{ 359 ACPI_OBJECT_COMMON_HEADER 360 361 union acpi_operand_obj *SysHandler; /* Handler for system notifies */ 362 union acpi_operand_obj *DrvHandler; /* Handler for driver notifies */ 363 union acpi_operand_obj *AddrHandler; /* Handler for Address space */ 364 365} ACPI_OBJECT_THERMAL_ZONE; 366 367 368/* 369 * Fields. All share a common header/info field. 370 */ 371 372typedef struct /* 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 /* REGION FIELD */ 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 /* BANK FIELD */ 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 *BankRegisterObj; /* BankSelect Register object */ 397 398} ACPI_OBJECT_BANK_FIELD; 399 400 401typedef struct /* INDEX FIELD */ 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 /* BUFFER FIELD */ 420{ 421 ACPI_OBJECT_COMMON_HEADER 422 ACPI_COMMON_FIELD_INFO 423 424 union acpi_operand_obj *Extra; /* Pointer to executable AML (in field definition) */ 425 ACPI_NAMESPACE_NODE *Node; /* Parent (containing) object node */ 426 union acpi_operand_obj *BufferObj; /* Containing Buffer object */ 427 428} ACPI_OBJECT_BUFFER_FIELD; 429 430 431/* 432 * Handlers 433 */ 434 435typedef struct /* NOTIFY HANDLER */ 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 ADDR_HANDLER_DEFAULT_INSTALLED 0x1 449 450 451typedef struct /* ADDRESS HANDLER */ 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 * The Reference object type is used for these opcodes: 470 * Arg[0-6], Local[0-7], IndexOp, NameOp, ZeroOp, OneOp, OnesOp, DebugOp 471 */ 472 473typedef struct /* Reference - Local object type */ 474{ 475 ACPI_OBJECT_COMMON_HEADER 476 477 UINT8 TargetType; /* Used for IndexOp */ 478 UINT16 Opcode; 479 UINT32 Offset; /* Used for ArgOp, LocalOp, and IndexOp */ 480 481 void *Object; /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */ 482 ACPI_NAMESPACE_NODE *Node; 483 union acpi_operand_obj **Where; 484 485} ACPI_OBJECT_REFERENCE; 486 487 488/* 489 * Extra object is used as additional storage for types that 490 * have AML code in their declarations (TermArgs) that must be 491 * evaluated at run time. 492 * 493 * Currently: Region and FieldUnit types 494 */ 495 496typedef struct /* EXTRA */ 497{ 498 ACPI_OBJECT_COMMON_HEADER 499 UINT8 ByteFill1; 500 UINT16 WordFill1; 501 UINT32 AmlLength; 502 UINT8 *AmlStart; 503 ACPI_NAMESPACE_NODE *Method_REG; /* _REG method for this region (if any) */ 504 void *RegionContext; /* Region-specific data */ 505 506} ACPI_OBJECT_EXTRA; 507 508 509/****************************************************************************** 510 * 511 * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above 512 * 513 *****************************************************************************/ 514 515typedef union acpi_operand_obj 516{ 517 ACPI_OBJECT_COMMON Common; 518 ACPI_OBJECT_CACHE_LIST Cache; 519 ACPI_OBJECT_INTEGER Integer; 520 ACPI_OBJECT_STRING String; 521 ACPI_OBJECT_BUFFER Buffer; 522 ACPI_OBJECT_PACKAGE Package; 523 ACPI_OBJECT_BUFFER_FIELD BufferField; 524 ACPI_OBJECT_DEVICE Device; 525 ACPI_OBJECT_EVENT Event; 526 ACPI_OBJECT_METHOD Method; 527 ACPI_OBJECT_MUTEX Mutex; 528 ACPI_OBJECT_REGION Region; 529 ACPI_OBJECT_POWER_RESOURCE PowerResource; 530 ACPI_OBJECT_PROCESSOR Processor; 531 ACPI_OBJECT_THERMAL_ZONE ThermalZone; 532 ACPI_OBJECT_FIELD_COMMON CommonField; 533 ACPI_OBJECT_REGION_FIELD Field; 534 ACPI_OBJECT_BANK_FIELD BankField; 535 ACPI_OBJECT_INDEX_FIELD IndexField; 536 ACPI_OBJECT_REFERENCE Reference; 537 ACPI_OBJECT_NOTIFY_HANDLER NotifyHandler; 538 ACPI_OBJECT_ADDR_HANDLER AddrHandler; 539 ACPI_OBJECT_EXTRA Extra; 540 541} ACPI_OPERAND_OBJECT; 542 543#endif /* _ACOBJECT_H */ 544