acobject.h revision 1.1.1.17
1 /****************************************************************************** 2 * 3 * Name: acobject.h - Definition of ACPI_OPERAND_OBJECT (Internal object only) 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2022, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #ifndef _ACOBJECT_H 45 #define _ACOBJECT_H 46 47 /* acpisrc:StructDefs -- for acpisrc conversion */ 48 49 50 /* 51 * The ACPI_OPERAND_OBJECT is used to pass AML operands from the dispatcher 52 * to the interpreter, and to keep track of the various handlers such as 53 * address space handlers and notify handlers. The object is a constant 54 * size in order to allow it to be cached and reused. 55 * 56 * Note: The object is optimized to be aligned and will not work if it is 57 * byte-packed. 58 */ 59 #if ACPI_MACHINE_WIDTH == 64 60 #pragma pack(8) 61 #else 62 #pragma pack(4) 63 #endif 64 65 /******************************************************************************* 66 * 67 * Common Descriptors 68 * 69 ******************************************************************************/ 70 71 /* 72 * Common area for all objects. 73 * 74 * DescriptorType is used to differentiate between internal descriptors, and 75 * must be in the same place across all descriptors 76 * 77 * Note: The DescriptorType and Type fields must appear in the identical 78 * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT 79 * structures. 80 */ 81 #define ACPI_OBJECT_COMMON_HEADER \ 82 union acpi_operand_object *NextObject; /* Objects linked to parent NS node */\ 83 UINT8 DescriptorType; /* To differentiate various internal objs */\ 84 UINT8 Type; /* ACPI_OBJECT_TYPE */\ 85 UINT16 ReferenceCount; /* For object deletion management */\ 86 UINT8 Flags; 87 /* 88 * Note: There are 3 bytes available here before the 89 * next natural alignment boundary (for both 32/64 cases) 90 */ 91 92 /* Values for Flag byte above */ 93 94 #define AOPOBJ_AML_CONSTANT 0x01 /* Integer is an AML constant */ 95 #define AOPOBJ_STATIC_POINTER 0x02 /* Data is part of an ACPI table, don't delete */ 96 #define AOPOBJ_DATA_VALID 0x04 /* Object is initialized and data is valid */ 97 #define AOPOBJ_OBJECT_INITIALIZED 0x08 /* Region is initialized */ 98 #define AOPOBJ_REG_CONNECTED 0x10 /* _REG was run */ 99 #define AOPOBJ_SETUP_COMPLETE 0x20 /* Region setup is complete */ 100 #define AOPOBJ_INVALID 0x40 /* Host OS won't allow a Region address */ 101 102 103 /****************************************************************************** 104 * 105 * Basic data types 106 * 107 *****************************************************************************/ 108 109 typedef struct acpi_object_common 110 { 111 ACPI_OBJECT_COMMON_HEADER 112 113 } ACPI_OBJECT_COMMON; 114 115 116 typedef struct acpi_object_integer 117 { 118 ACPI_OBJECT_COMMON_HEADER 119 UINT8 Fill[3]; /* Prevent warning on some compilers */ 120 UINT64 Value; 121 122 } ACPI_OBJECT_INTEGER; 123 124 125 /* 126 * Note: The String and Buffer object must be identical through the 127 * pointer and length elements. There is code that depends on this. 128 * 129 * Fields common to both Strings and Buffers 130 */ 131 #define ACPI_COMMON_BUFFER_INFO(_Type) \ 132 _Type *Pointer; \ 133 UINT32 Length; 134 135 136 /* Null terminated, ASCII characters only */ 137 138 typedef struct acpi_object_string 139 { 140 ACPI_OBJECT_COMMON_HEADER 141 ACPI_COMMON_BUFFER_INFO (char) /* String in AML stream or allocated string */ 142 143 } ACPI_OBJECT_STRING; 144 145 146 typedef struct acpi_object_buffer 147 { 148 ACPI_OBJECT_COMMON_HEADER 149 ACPI_COMMON_BUFFER_INFO (UINT8) /* Buffer in AML stream or allocated buffer */ 150 UINT32 AmlLength; 151 UINT8 *AmlStart; 152 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 153 154 } ACPI_OBJECT_BUFFER; 155 156 157 typedef struct acpi_object_package 158 { 159 ACPI_OBJECT_COMMON_HEADER 160 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */ 161 union acpi_operand_object **Elements; /* Array of pointers to AcpiObjects */ 162 UINT8 *AmlStart; 163 UINT32 AmlLength; 164 UINT32 Count; /* # of elements in package */ 165 166 } ACPI_OBJECT_PACKAGE; 167 168 169 /****************************************************************************** 170 * 171 * Complex data types 172 * 173 *****************************************************************************/ 174 175 typedef struct acpi_object_event 176 { 177 ACPI_OBJECT_COMMON_HEADER 178 ACPI_SEMAPHORE OsSemaphore; /* Actual OS synchronization object */ 179 180 } ACPI_OBJECT_EVENT; 181 182 183 typedef struct acpi_object_mutex 184 { 185 ACPI_OBJECT_COMMON_HEADER 186 UINT8 SyncLevel; /* 0-15, specified in Mutex() call */ 187 UINT16 AcquisitionDepth; /* Allow multiple Acquires, same thread */ 188 ACPI_MUTEX OsMutex; /* Actual OS synchronization object */ 189 ACPI_THREAD_ID ThreadId; /* Current owner of the mutex */ 190 struct acpi_thread_state *OwnerThread; /* Current owner of the mutex */ 191 union acpi_operand_object *Prev; /* Link for list of acquired mutexes */ 192 union acpi_operand_object *Next; /* Link for list of acquired mutexes */ 193 ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */ 194 UINT8 OriginalSyncLevel; /* Owner's original sync level (0-15) */ 195 196 } ACPI_OBJECT_MUTEX; 197 198 199 typedef struct acpi_object_region 200 { 201 ACPI_OBJECT_COMMON_HEADER 202 UINT8 SpaceId; 203 ACPI_NAMESPACE_NODE *Node; /* Containing namespace node */ 204 union acpi_operand_object *Handler; /* Handler for region access */ 205 union acpi_operand_object *Next; 206 ACPI_PHYSICAL_ADDRESS Address; 207 UINT32 Length; 208 void *Pointer; /* Only for data table regions */ 209 210 } ACPI_OBJECT_REGION; 211 212 213 typedef struct acpi_object_method 214 { 215 ACPI_OBJECT_COMMON_HEADER 216 UINT8 InfoFlags; 217 UINT8 ParamCount; 218 UINT8 SyncLevel; 219 union acpi_operand_object *Mutex; 220 union acpi_operand_object *Node; 221 UINT8 *AmlStart; 222 union 223 { 224 ACPI_INTERNAL_METHOD Implementation; 225 union acpi_operand_object *Handler; 226 } Dispatch; 227 228 UINT32 AmlLength; 229 ACPI_OWNER_ID OwnerId; 230 UINT8 ThreadCount; 231 232 } ACPI_OBJECT_METHOD; 233 234 /* Flags for InfoFlags field above */ 235 236 #define ACPI_METHOD_MODULE_LEVEL 0x01 /* Method is actually module-level code */ 237 #define ACPI_METHOD_INTERNAL_ONLY 0x02 /* Method is implemented internally (_OSI) */ 238 #define ACPI_METHOD_SERIALIZED 0x04 /* Method is serialized */ 239 #define ACPI_METHOD_SERIALIZED_PENDING 0x08 /* Method is to be marked serialized */ 240 #define ACPI_METHOD_IGNORE_SYNC_LEVEL 0x10 /* Method was auto-serialized at table load time */ 241 #define ACPI_METHOD_MODIFIED_NAMESPACE 0x20 /* Method modified the namespace */ 242 243 244 /****************************************************************************** 245 * 246 * Objects that can be notified. All share a common NotifyInfo area. 247 * 248 *****************************************************************************/ 249 250 /* 251 * Common fields for objects that support ASL notifications 252 */ 253 #define ACPI_COMMON_NOTIFY_INFO \ 254 union acpi_operand_object *NotifyList[2]; /* Handlers for system/device notifies */\ 255 union acpi_operand_object *Handler; /* Handler for Address space */ 256 257 /* COMMON NOTIFY for POWER, PROCESSOR, DEVICE, and THERMAL */ 258 259 typedef struct acpi_object_notify_common 260 { 261 ACPI_OBJECT_COMMON_HEADER 262 ACPI_COMMON_NOTIFY_INFO 263 264 } ACPI_OBJECT_NOTIFY_COMMON; 265 266 267 typedef struct acpi_object_device 268 { 269 ACPI_OBJECT_COMMON_HEADER 270 ACPI_COMMON_NOTIFY_INFO 271 ACPI_GPE_BLOCK_INFO *GpeBlock; 272 273 } ACPI_OBJECT_DEVICE; 274 275 276 typedef struct acpi_object_power_resource 277 { 278 ACPI_OBJECT_COMMON_HEADER 279 ACPI_COMMON_NOTIFY_INFO 280 UINT32 SystemLevel; 281 UINT32 ResourceOrder; 282 283 } ACPI_OBJECT_POWER_RESOURCE; 284 285 286 typedef struct acpi_object_processor 287 { 288 ACPI_OBJECT_COMMON_HEADER 289 290 /* The next two fields take advantage of the 3-byte space before NOTIFY_INFO */ 291 292 UINT8 ProcId; 293 UINT8 Length; 294 ACPI_COMMON_NOTIFY_INFO 295 ACPI_IO_ADDRESS Address; 296 297 } ACPI_OBJECT_PROCESSOR; 298 299 300 typedef struct acpi_object_thermal_zone 301 { 302 ACPI_OBJECT_COMMON_HEADER 303 ACPI_COMMON_NOTIFY_INFO 304 305 } ACPI_OBJECT_THERMAL_ZONE; 306 307 308 /****************************************************************************** 309 * 310 * Fields. All share a common header/info field. 311 * 312 *****************************************************************************/ 313 314 /* 315 * Common bitfield for the field objects 316 * "Field Datum" -- a datum from the actual field object 317 * "Buffer Datum" -- a datum from a user buffer, read from or to be written to the field 318 */ 319 #define ACPI_COMMON_FIELD_INFO \ 320 UINT8 FieldFlags; /* Access, update, and lock bits */\ 321 UINT8 Attribute; /* From AccessAs keyword */\ 322 UINT8 AccessByteWidth; /* Read/Write size in bytes */\ 323 ACPI_NAMESPACE_NODE *Node; /* Link back to parent node */\ 324 UINT32 BitLength; /* Length of field in bits */\ 325 UINT32 BaseByteOffset; /* Byte offset within containing object */\ 326 UINT32 Value; /* Value to store into the Bank or Index register */\ 327 UINT8 StartFieldBitOffset;/* Bit offset within first field datum (0-63) */\ 328 UINT8 AccessLength; /* For serial regions/fields */ 329 330 /* COMMON FIELD (for BUFFER, REGION, BANK, and INDEX fields) */ 331 332 typedef struct acpi_object_field_common 333 { 334 ACPI_OBJECT_COMMON_HEADER 335 ACPI_COMMON_FIELD_INFO 336 union acpi_operand_object *RegionObj; /* Parent Operation Region object (REGION/BANK fields only) */ 337 338 } ACPI_OBJECT_FIELD_COMMON; 339 340 341 typedef struct acpi_object_region_field 342 { 343 ACPI_OBJECT_COMMON_HEADER 344 ACPI_COMMON_FIELD_INFO 345 UINT16 ResourceLength; 346 union acpi_operand_object *RegionObj; /* Containing OpRegion object */ 347 UINT8 *ResourceBuffer; /* ResourceTemplate for serial regions/fields */ 348 UINT16 PinNumberIndex; /* Index relative to previous Connection/Template */ 349 UINT8 *InternalPccBuffer; /* Internal buffer for fields associated with PCC */ 350 351 } ACPI_OBJECT_REGION_FIELD; 352 353 354 typedef struct acpi_object_bank_field 355 { 356 ACPI_OBJECT_COMMON_HEADER 357 ACPI_COMMON_FIELD_INFO 358 union acpi_operand_object *RegionObj; /* Containing OpRegion object */ 359 union acpi_operand_object *BankObj; /* BankSelect Register object */ 360 361 } ACPI_OBJECT_BANK_FIELD; 362 363 364 typedef struct acpi_object_index_field 365 { 366 ACPI_OBJECT_COMMON_HEADER 367 ACPI_COMMON_FIELD_INFO 368 369 /* 370 * No "RegionObj" pointer needed since the Index and Data registers 371 * are each field definitions unto themselves. 372 */ 373 union acpi_operand_object *IndexObj; /* Index register */ 374 union acpi_operand_object *DataObj; /* Data register */ 375 376 } ACPI_OBJECT_INDEX_FIELD; 377 378 379 /* The BufferField is different in that it is part of a Buffer, not an OpRegion */ 380 381 typedef struct acpi_object_buffer_field 382 { 383 ACPI_OBJECT_COMMON_HEADER 384 ACPI_COMMON_FIELD_INFO 385 BOOLEAN IsCreateField; /* Special case for objects created by CreateField() */ 386 union acpi_operand_object *BufferObj; /* Containing Buffer object */ 387 388 } ACPI_OBJECT_BUFFER_FIELD; 389 390 391 /****************************************************************************** 392 * 393 * Objects for handlers 394 * 395 *****************************************************************************/ 396 397 typedef struct acpi_object_notify_handler 398 { 399 ACPI_OBJECT_COMMON_HEADER 400 ACPI_NAMESPACE_NODE *Node; /* Parent device */ 401 UINT32 HandlerType; /* Type: Device/System/Both */ 402 ACPI_NOTIFY_HANDLER Handler; /* Handler address */ 403 void *Context; 404 union acpi_operand_object *Next[2]; /* Device and System handler lists */ 405 406 } ACPI_OBJECT_NOTIFY_HANDLER; 407 408 409 typedef struct acpi_object_addr_handler 410 { 411 ACPI_OBJECT_COMMON_HEADER 412 UINT8 SpaceId; 413 UINT8 HandlerFlags; 414 ACPI_ADR_SPACE_HANDLER Handler; 415 ACPI_NAMESPACE_NODE *Node; /* Parent device */ 416 void *Context; 417 ACPI_MUTEX ContextMutex; 418 ACPI_ADR_SPACE_SETUP Setup; 419 union acpi_operand_object *RegionList; /* Regions using this handler */ 420 union acpi_operand_object *Next; 421 422 } ACPI_OBJECT_ADDR_HANDLER; 423 424 /* Flags for address handler (HandlerFlags) */ 425 426 #define ACPI_ADDR_HANDLER_DEFAULT_INSTALLED 0x01 427 428 429 /****************************************************************************** 430 * 431 * Special internal objects 432 * 433 *****************************************************************************/ 434 435 /* 436 * The Reference object is used for these opcodes: 437 * Arg[0-6], Local[0-7], IndexOp, NameOp, RefOfOp, LoadOp, LoadTableOp, DebugOp 438 * The Reference.Class differentiates these types. 439 */ 440 typedef struct acpi_object_reference 441 { 442 ACPI_OBJECT_COMMON_HEADER 443 UINT8 Class; /* Reference Class */ 444 UINT8 TargetType; /* Used for Index Op */ 445 UINT8 Resolved; /* Reference has been resolved to a value */ 446 void *Object; /* NameOp=>HANDLE to obj, IndexOp=>ACPI_OPERAND_OBJECT */ 447 ACPI_NAMESPACE_NODE *Node; /* RefOf or Namepath */ 448 union acpi_operand_object **Where; /* Target of Index */ 449 UINT8 *IndexPointer; /* Used for Buffers and Strings */ 450 UINT8 *Aml; /* Used for deferred resolution of the ref */ 451 UINT32 Value; /* Used for Local/Arg/Index/DdbHandle */ 452 453 } ACPI_OBJECT_REFERENCE; 454 455 /* Values for Reference.Class above */ 456 457 typedef enum 458 { 459 ACPI_REFCLASS_LOCAL = 0, /* Method local */ 460 ACPI_REFCLASS_ARG = 1, /* Method argument */ 461 ACPI_REFCLASS_REFOF = 2, /* Result of RefOf() TBD: Split to Ref/Node and Ref/OperandObj? */ 462 ACPI_REFCLASS_INDEX = 3, /* Result of Index() */ 463 ACPI_REFCLASS_TABLE = 4, /* DdbHandle - Load(), LoadTable() */ 464 ACPI_REFCLASS_NAME = 5, /* Reference to a named object */ 465 ACPI_REFCLASS_DEBUG = 6, /* Debug object */ 466 467 ACPI_REFCLASS_MAX = 6 468 469 } ACPI_REFERENCE_CLASSES; 470 471 /* 472 * Extra object is used as additional storage for types that 473 * have AML code in their declarations (TermArgs) that must be 474 * evaluated at run time. 475 * 476 * Currently: Region and FieldUnit types 477 */ 478 typedef struct acpi_object_extra 479 { 480 ACPI_OBJECT_COMMON_HEADER 481 ACPI_NAMESPACE_NODE *Method_REG; /* _REG method for this region (if any) */ 482 ACPI_NAMESPACE_NODE *ScopeNode; 483 void *RegionContext; /* Region-specific data */ 484 UINT8 *AmlStart; 485 UINT32 AmlLength; 486 487 } ACPI_OBJECT_EXTRA; 488 489 490 /* Additional data that can be attached to namespace nodes */ 491 492 typedef struct acpi_object_data 493 { 494 ACPI_OBJECT_COMMON_HEADER 495 ACPI_OBJECT_HANDLER Handler; 496 void *Pointer; 497 498 } ACPI_OBJECT_DATA; 499 500 501 /* Structure used when objects are cached for reuse */ 502 503 typedef struct acpi_object_cache_list 504 { 505 ACPI_OBJECT_COMMON_HEADER 506 union acpi_operand_object *Next; /* Link for object cache and internal lists*/ 507 508 } ACPI_OBJECT_CACHE_LIST; 509 510 511 /****************************************************************************** 512 * 513 * ACPI_OPERAND_OBJECT Descriptor - a giant union of all of the above 514 * 515 *****************************************************************************/ 516 517 typedef union acpi_operand_object 518 { 519 ACPI_OBJECT_COMMON Common; 520 ACPI_OBJECT_INTEGER Integer; 521 ACPI_OBJECT_STRING String; 522 ACPI_OBJECT_BUFFER Buffer; 523 ACPI_OBJECT_PACKAGE Package; 524 ACPI_OBJECT_EVENT Event; 525 ACPI_OBJECT_METHOD Method; 526 ACPI_OBJECT_MUTEX Mutex; 527 ACPI_OBJECT_REGION Region; 528 ACPI_OBJECT_NOTIFY_COMMON CommonNotify; 529 ACPI_OBJECT_DEVICE Device; 530 ACPI_OBJECT_POWER_RESOURCE PowerResource; 531 ACPI_OBJECT_PROCESSOR Processor; 532 ACPI_OBJECT_THERMAL_ZONE ThermalZone; 533 ACPI_OBJECT_FIELD_COMMON CommonField; 534 ACPI_OBJECT_REGION_FIELD Field; 535 ACPI_OBJECT_BUFFER_FIELD BufferField; 536 ACPI_OBJECT_BANK_FIELD BankField; 537 ACPI_OBJECT_INDEX_FIELD IndexField; 538 ACPI_OBJECT_NOTIFY_HANDLER Notify; 539 ACPI_OBJECT_ADDR_HANDLER AddressSpace; 540 ACPI_OBJECT_REFERENCE Reference; 541 ACPI_OBJECT_EXTRA Extra; 542 ACPI_OBJECT_DATA Data; 543 ACPI_OBJECT_CACHE_LIST Cache; 544 545 /* 546 * Add namespace node to union in order to simplify code that accepts both 547 * ACPI_OPERAND_OBJECTs and ACPI_NAMESPACE_NODEs. The structures share 548 * a common DescriptorType field in order to differentiate them. 549 */ 550 ACPI_NAMESPACE_NODE Node; 551 552 } ACPI_OPERAND_OBJECT; 553 554 555 /****************************************************************************** 556 * 557 * ACPI_DESCRIPTOR - objects that share a common descriptor identifier 558 * 559 *****************************************************************************/ 560 561 /* Object descriptor types */ 562 563 #define ACPI_DESC_TYPE_CACHED 0x01 /* Used only when object is cached */ 564 #define ACPI_DESC_TYPE_STATE 0x02 565 #define ACPI_DESC_TYPE_STATE_UPDATE 0x03 566 #define ACPI_DESC_TYPE_STATE_PACKAGE 0x04 567 #define ACPI_DESC_TYPE_STATE_CONTROL 0x05 568 #define ACPI_DESC_TYPE_STATE_RPSCOPE 0x06 569 #define ACPI_DESC_TYPE_STATE_PSCOPE 0x07 570 #define ACPI_DESC_TYPE_STATE_WSCOPE 0x08 571 #define ACPI_DESC_TYPE_STATE_RESULT 0x09 572 #define ACPI_DESC_TYPE_STATE_NOTIFY 0x0A 573 #define ACPI_DESC_TYPE_STATE_THREAD 0x0B 574 #define ACPI_DESC_TYPE_WALK 0x0C 575 #define ACPI_DESC_TYPE_PARSER 0x0D 576 #define ACPI_DESC_TYPE_OPERAND 0x0E 577 #define ACPI_DESC_TYPE_NAMED 0x0F 578 #define ACPI_DESC_TYPE_MAX 0x0F 579 580 581 typedef struct acpi_common_descriptor 582 { 583 void *CommonPointer; 584 UINT8 DescriptorType; /* To differentiate various internal objs */ 585 586 } ACPI_COMMON_DESCRIPTOR; 587 588 typedef union acpi_descriptor 589 { 590 ACPI_COMMON_DESCRIPTOR Common; 591 ACPI_OPERAND_OBJECT Object; 592 ACPI_NAMESPACE_NODE Node; 593 ACPI_PARSE_OBJECT Op; 594 595 } ACPI_DESCRIPTOR; 596 597 #pragma pack() 598 599 #endif /* _ACOBJECT_H */ 600
Indexes created Sat Oct 11 16:09:52 GMT 2025