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