1 2 /****************************************************************************** 3 * 4 * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT (Internal object only) 5 * $Revision: 1.139 $ 6 * 7 *****************************************************************************/ 8 9 /****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2006, 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 /* acpisrc:StructDefs -- for acpisrc conversion */ 122 123 124 /* 125 * The ACPI_OPERAND_OBJECT is used to pass AML operands from the dispatcher 126 * to the interpreter, and to keep track of the various handlers such as 127 * address space handlers and notify handlers. The object is a constant 128 * size in order to allow it to be cached and reused. 129 */ 130 131 /******************************************************************************* 132 * 133 * Common Descriptors 134 * 135 ******************************************************************************/ 136 137 /* 138 * Common area for all objects. 139 * 140 * DescriptorType is used to differentiate between internal descriptors, and 141 * must be in the same place across all descriptors 142 * 143 * Note: The DescriptorType and Type fields must appear in the identical 144 * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT 145 * structures. 146 */ 147 #define ACPI_OBJECT_COMMON_HEADER \ 148 union acpi_operand_object *NextObject; /* Objects linked to parent NS node */\ 149 UINT8 DescriptorType; /* To differentiate various internal objs */\ 150 UINT8 Type; /* ACPI_OBJECT_TYPE */\ 151 UINT16 ReferenceCount; /* For object deletion management */\ 152 UINT8 Flags; 153 /* 154 * Note: There are 3 bytes available here before the 155 * next natural alignment boundary (for both 32/64 cases) 156 */ 157 158 /* Values for Flag byte above */ 159 160 #define AOPOBJ_AML_CONSTANT 0x01 161 #define AOPOBJ_STATIC_POINTER 0x02 162 #define AOPOBJ_DATA_VALID 0x04 163 #define AOPOBJ_OBJECT_INITIALIZED 0x08 164 #define AOPOBJ_SETUP_COMPLETE 0x10 165 #define AOPOBJ_SINGLE_DATUM 0x20 166 #define AOPOBJ_INVALID 0x40 /* Used if host OS won't allow an OpRegion address */ 167 168 169 /****************************************************************************** 170 * 171 * Basic data types 172 * 173 *****************************************************************************/ 174 175 typedef struct acpi_object_common 176 { 177 ACPI_OBJECT_COMMON_HEADER 178 179 } ACPI_OBJECT_COMMON; 180 181 182 typedef struct acpi_object_integer 183 { 184 ACPI_OBJECT_COMMON_HEADER 185 ACPI_INTEGER Value; 186 187 } ACPI_OBJECT_INTEGER; 188 189 190 /* 191 * Note: The String and Buffer object must be identical through the Pointer 192 * and length elements. There is code that depends on this. 193 * 194 * Fields common to both Strings and Buffers 195 */ 196 #define ACPI_COMMON_BUFFER_INFO(_Type) \ 197 _Type *Pointer; \ 198 UINT32 Length; 199 200 201 typedef struct acpi_object_string /* Null terminated, ASCII characters only */ 202 { 203 ACPI_OBJECT_COMMON_HEADER 204 ACPI_COMMON_BUFFER_INFO (char) /* String in AML stream or allocated string */ 205 206 } ACPI_OBJECT_STRING; 207 208 209 typedef struct acpi_object_buffer 210 { 211 ACPI_OBJECT_COMMON_HEADER 212 ACPI_COMMON_BUFFER_INFO (UINT8) /* Buffer in AML stream or allocated buffer */ 213 UINT32 AmlLength; 214 UINT8 *AmlStart; 215 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 216 217 } ACPI_OBJECT_BUFFER; 218 219 220 typedef struct acpi_object_package 221 { 222 ACPI_OBJECT_COMMON_HEADER 223 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 224 union acpi_operand_object **Elements; /* Array of pointers to AcpiObjects */ 225 UINT8 *AmlStart; 226 UINT32 AmlLength; 227 UINT32 Count; /* # of elements in package */ 228 229 } ACPI_OBJECT_PACKAGE; 230 231 232 /****************************************************************************** 233 * 234 * Complex data types 235 * 236 *****************************************************************************/ 237 238 typedef struct acpi_object_event 239 { 240 ACPI_OBJECT_COMMON_HEADER 241 ACPI_SEMAPHORE OsSemaphore; /* Actual OS synchronization object */ 242 243 } ACPI_OBJECT_EVENT; 244 245 246 typedef struct acpi_object_mutex 247 { 248 ACPI_OBJECT_COMMON_HEADER 249 UINT8 SyncLevel; /* 0-15, specified in Mutex() call */ 250 UINT16 AcquisitionDepth; /* Allow multiple Acquires, same thread */ 251 struct acpi_thread_state *OwnerThread; /* Current owner of the mutex */ 252 ACPI_MUTEX OsMutex; /* Actual OS synchronization object */ 253 union acpi_operand_object *Prev; /* Link for list of acquired mutexes */ 254 union acpi_operand_object *Next; /* Link for list of acquired mutexes */ 255 ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */ 256 UINT8 OriginalSyncLevel; /* Owner's original sync level (0-15) */ 257 258 } ACPI_OBJECT_MUTEX; 259 260 261 typedef struct acpi_object_region 262 { 263 ACPI_OBJECT_COMMON_HEADER 264 UINT8 SpaceId; 265 ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */ 266 union acpi_operand_object *Handler; /* Handler for region access */ 267 union acpi_operand_object *Next; 268 ACPI_PHYSICAL_ADDRESS Address; 269 UINT32 Length; 270 271 } ACPI_OBJECT_REGION; 272 273 274 typedef struct acpi_object_method 275 { 276 ACPI_OBJECT_COMMON_HEADER 277 UINT8 MethodFlags; 278 UINT8 ParamCount; 279 UINT8 SyncLevel; 280 union acpi_operand_object *Mutex; 281 UINT8 *AmlStart; 282 ACPI_INTERNAL_METHOD Implementation; 283 UINT32 AmlLength; 284 UINT8 ThreadCount; 285 ACPI_OWNER_ID OwnerId; 286 287 } ACPI_OBJECT_METHOD; 288 289 290 /****************************************************************************** 291 * 292 * Objects that can be notified. All share a common NotifyInfo area. 293 * 294 *****************************************************************************/ 295 296 /* 297 * Common fields for objects that support ASL notifications 298 */ 299 #define ACPI_COMMON_NOTIFY_INFO \ 300 union acpi_operand_object *SystemNotify; /* Handler for system notifies */\ 301 union acpi_operand_object *DeviceNotify; /* Handler for driver notifies */\ 302 union acpi_operand_object *Handler; /* Handler for Address space */ 303 304 305 typedef struct acpi_object_notify_common /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */ 306 { 307 ACPI_OBJECT_COMMON_HEADER 308 ACPI_COMMON_NOTIFY_INFO 309 310 } ACPI_OBJECT_NOTIFY_COMMON; 311 312 313 typedef struct acpi_object_device 314 { 315 ACPI_OBJECT_COMMON_HEADER 316 ACPI_COMMON_NOTIFY_INFO 317 ACPI_GPE_BLOCK_INFO *GpeBlock; 318 319 } ACPI_OBJECT_DEVICE; 320 321 322 typedef struct acpi_object_power_resource 323 { 324 ACPI_OBJECT_COMMON_HEADER 325 ACPI_COMMON_NOTIFY_INFO 326 UINT32 SystemLevel; 327 UINT32 ResourceOrder; 328 329 } ACPI_OBJECT_POWER_RESOURCE; 330 331 332 typedef struct acpi_object_processor 333 { 334 ACPI_OBJECT_COMMON_HEADER 335 UINT8 ProcId; 336 UINT8 Length; 337 ACPI_COMMON_NOTIFY_INFO 338 ACPI_IO_ADDRESS Address; 339 340 } ACPI_OBJECT_PROCESSOR; 341 342 343 typedef struct acpi_object_thermal_zone 344 { 345 ACPI_OBJECT_COMMON_HEADER 346 ACPI_COMMON_NOTIFY_INFO 347 348 } ACPI_OBJECT_THERMAL_ZONE; 349 350 351 /****************************************************************************** 352 * 353 * Fields. All share a common header/info field. 354 * 355 *****************************************************************************/ 356 357 /* 358 * Common bitfield for the field objects 359 * "Field Datum" -- a datum from the actual field object 360 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field 361 */ 362 #define ACPI_COMMON_FIELD_INFO \ 363 UINT8 FieldFlags; /* Access, update, and lock bits */\ 364 UINT8 Attribute; /* From AccessAs keyword */\ 365 UINT8 AccessByteWidth; /* Read/Write size in bytes */\ 366 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */\ 367 UINT32 BitLength; /* Length of field in bits */\ 368 UINT32 BaseByteOffset; /* Byte offset within containing object */\ 369 UINT32 Value; /* Value to store into the Bank or Index register */\ 370 UINT8 StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\ 371 UINT8 AccessBitWidth; /* Read/Write size in bits (8-64) */ 372 373 374 typedef struct acpi_object_field_common /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */ 375 { 376 ACPI_OBJECT_COMMON_HEADER 377 ACPI_COMMON_FIELD_INFO 378 union acpi_operand_object *RegionObj; /* Parent Operation Region object (REGION/BANK fields only) */ 379 380 } ACPI_OBJECT_FIELD_COMMON; 381 382 383 typedef struct acpi_object_region_field 384 { 385 ACPI_OBJECT_COMMON_HEADER 386 ACPI_COMMON_FIELD_INFO 387 union acpi_operand_object *RegionObj; /* Containing OpRegion object */ 388 389 } ACPI_OBJECT_REGION_FIELD; 390 391 392 typedef struct acpi_object_bank_field 393 { 394 ACPI_OBJECT_COMMON_HEADER 395 ACPI_COMMON_FIELD_INFO 396 union acpi_operand_object *RegionObj; /* Containing OpRegion object */ 397 union acpi_operand_object *BankObj; /* BankSelect Register object */ 398 399 } ACPI_OBJECT_BANK_FIELD; 400 401 402 typedef struct acpi_object_index_field 403 { 404 ACPI_OBJECT_COMMON_HEADER 405 ACPI_COMMON_FIELD_INFO 406 407 /* 408 * No "RegionObj" pointer needed since the Index and Data registers 409 * are each field definitions unto themselves. 410 */ 411 union acpi_operand_object *IndexObj; /* Index register */ 412 union acpi_operand_object *DataObj; /* Data register */ 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 419 typedef struct acpi_object_buffer_field 420 { 421 ACPI_OBJECT_COMMON_HEADER 422 ACPI_COMMON_FIELD_INFO 423 union acpi_operand_object *BufferObj; /* Containing Buffer object */ 424 425 } ACPI_OBJECT_BUFFER_FIELD; 426 427 428 /****************************************************************************** 429 * 430 * Objects for handlers 431 * 432 *****************************************************************************/ 433 434 typedef struct acpi_object_notify_handler 435 { 436 ACPI_OBJECT_COMMON_HEADER 437 ACPI_NAMESPACE_NODE *Node; /* Parent device */ 438 ACPI_NOTIFY_HANDLER Handler; 439 void *Context; 440 441 } ACPI_OBJECT_NOTIFY_HANDLER; 442 443 444 typedef struct acpi_object_addr_handler 445 { 446 ACPI_OBJECT_COMMON_HEADER 447 UINT8 SpaceId; 448 UINT8 HandlerFlags; 449 ACPI_ADR_SPACE_HANDLER Handler; 450 ACPI_NAMESPACE_NODE *Node; /* Parent device */ 451 void *Context; 452 ACPI_ADR_SPACE_SETUP Setup; 453 union acpi_operand_object *RegionList; /* regions using this handler */ 454 union acpi_operand_object *Next; 455 456 } ACPI_OBJECT_ADDR_HANDLER; 457 458 /* Flags for address handler (HandlerFlags) */ 459 460 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01 461 462 463 /****************************************************************************** 464 * 465 * Special internal objects 466 * 467 *****************************************************************************/ 468 469 /* 470 * The Reference object type is used for these opcodes: 471 * Arg[0-6], Local[0-7], IndexOp, NameOp, ZeroOp, OneOp, OnesOp, DebugOp 472 */ 473 typedef struct acpi_object_reference 474 { 475 ACPI_OBJECT_COMMON_HEADER 476 UINT8 TargetType; /* Used for IndexOp */ 477 UINT16 Opcode; 478 void *Object; /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */ 479 ACPI_NAMESPACE_NODE *Node; 480 union acpi_operand_object **Where; 481 UINT32 Offset; /* Used for ArgOp, LocalOp, and IndexOp */ 482 483 } ACPI_OBJECT_REFERENCE; 484 485 486 /* 487 * Extra object is used as additional storage for types that 488 * have AML code in their declarations (TermArgs) that must be 489 * evaluated at run time. 490 * 491 * Currently: Region and FieldUnit types 492 */ 493 typedef struct acpi_object_extra 494 { 495 ACPI_OBJECT_COMMON_HEADER 496 ACPI_NAMESPACE_NODE *Method_REG; /* _REG method for this region (if any) */ 497 void *RegionContext; /* Region-specific data */ 498 UINT8 *AmlStart; 499 UINT32 AmlLength; 500 501 } ACPI_OBJECT_EXTRA; 502 503 504 /* Additional data that can be attached to namespace nodes */ 505 506 typedef struct acpi_object_data 507 { 508 ACPI_OBJECT_COMMON_HEADER 509 ACPI_OBJECT_HANDLER Handler; 510 void *Pointer; 511 512 } ACPI_OBJECT_DATA; 513 514 515 /* Structure used when objects are cached for reuse */ 516 517 typedef struct acpi_object_cache_list 518 { 519 ACPI_OBJECT_COMMON_HEADER 520 union acpi_operand_object *Next; /* Link for object cache and internal lists*/ 521 522 } ACPI_OBJECT_CACHE_LIST; 523 524 525 /****************************************************************************** 526 * 527 * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above 528 * 529 *****************************************************************************/ 530 531 typedef union acpi_operand_object 532 { 533 ACPI_OBJECT_COMMON Common; 534 ACPI_OBJECT_INTEGER Integer; 535 ACPI_OBJECT_STRING String; 536 ACPI_OBJECT_BUFFER Buffer; 537 ACPI_OBJECT_PACKAGE Package; 538 ACPI_OBJECT_EVENT Event; 539 ACPI_OBJECT_METHOD Method; 540 ACPI_OBJECT_MUTEX Mutex; 541 ACPI_OBJECT_REGION Region; 542 ACPI_OBJECT_NOTIFY_COMMON CommonNotify; 543 ACPI_OBJECT_DEVICE Device; 544 ACPI_OBJECT_POWER_RESOURCE PowerResource; 545 ACPI_OBJECT_PROCESSOR Processor; 546 ACPI_OBJECT_THERMAL_ZONE ThermalZone; 547 ACPI_OBJECT_FIELD_COMMON CommonField; 548 ACPI_OBJECT_REGION_FIELD Field; 549 ACPI_OBJECT_BUFFER_FIELD BufferField; 550 ACPI_OBJECT_BANK_FIELD BankField; 551 ACPI_OBJECT_INDEX_FIELD IndexField; 552 ACPI_OBJECT_NOTIFY_HANDLER Notify; 553 ACPI_OBJECT_ADDR_HANDLER AddressSpace; 554 ACPI_OBJECT_REFERENCE Reference; 555 ACPI_OBJECT_EXTRA Extra; 556 ACPI_OBJECT_DATA Data; 557 ACPI_OBJECT_CACHE_LIST Cache; 558 559 } ACPI_OPERAND_OBJECT; 560 561 562 /****************************************************************************** 563 * 564 * ACPI_DESCRIPTOR - objects that share a common descriptor identifier 565 * 566 *****************************************************************************/ 567 568 /* Object descriptor types */ 569 570 #define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */ 571 #define ACPI_DESC_TYPE_STATE 0x02 572 #define ACPI_DESC_TYPE_STATE_UPDATE 0x03 573 #define ACPI_DESC_TYPE_STATE_PACKAGE 0x04 574 #define ACPI_DESC_TYPE_STATE_CONTROL 0x05 575 #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06 576 #define ACPI_DESC_TYPE_STATE_PSCOPE 0x07 577 #define ACPI_DESC_TYPE_STATE_WSCOPE 0x08 578 #define ACPI_DESC_TYPE_STATE_RESULT 0x09 579 #define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A 580 #define ACPI_DESC_TYPE_STATE_THREAD 0x0B 581 #define ACPI_DESC_TYPE_WALK 0x0C 582 #define ACPI_DESC_TYPE_PARSER 0x0D 583 #define ACPI_DESC_TYPE_OPERAND 0x0E 584 #define ACPI_DESC_TYPE_NAMED 0x0F 585 #define ACPI_DESC_TYPE_MAX 0x0F 586 587 588 typedef struct acpi_common_descriptor 589 { 590 void *CommonPointer; 591 UINT8 DescriptorType; /* To differentiate various internal objs */ 592 593 } ACPI_COMMON_DESCRIPTOR; 594 595 typedef union acpi_descriptor 596 { 597 ACPI_COMMON_DESCRIPTOR Common; 598 ACPI_OPERAND_OBJECT Object; 599 ACPI_NAMESPACE_NODE Node; 600 ACPI_PARSE_OBJECT Op; 601 602 } ACPI_DESCRIPTOR; 603 604 605 #endif /* _ACOBJECT_H */ 606