1 /****************************************************************************** 2 * 3 * Name: aclocal.h - Internal data types used across the ACPI subsystem 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2023, 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 __ACLOCAL_H__ 45 #define __ACLOCAL_H__ 46 47 48 /* acpisrc:StructDefs -- for acpisrc conversion */ 49 50 #define ACPI_SERIALIZED 0xFF 51 52 typedef UINT32 ACPI_MUTEX_HANDLE; 53 #define ACPI_GLOBAL_LOCK (ACPI_SEMAPHORE) (-1) 54 55 /* Total number of aml opcodes defined */ 56 57 #define AML_NUM_OPCODES 0x83 58 59 60 /* Forward declarations */ 61 62 struct acpi_walk_state; 63 struct acpi_obj_mutex; 64 union acpi_parse_object; 65 66 67 /***************************************************************************** 68 * 69 * Mutex typedefs and structs 70 * 71 ****************************************************************************/ 72 73 74 /* 75 * Predefined handles for the mutex objects used within the subsystem 76 * All mutex objects are automatically created by AcpiUtMutexInitialize. 77 * 78 * The acquire/release ordering protocol is implied via this list. Mutexes 79 * with a lower value must be acquired before mutexes with a higher value. 80 * 81 * NOTE: any changes here must be reflected in the AcpiGbl_MutexNames 82 * table below also! 83 */ 84 #define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */ 85 #define ACPI_MTX_NAMESPACE 1 /* ACPI Namespace */ 86 #define ACPI_MTX_TABLES 2 /* Data for ACPI tables */ 87 #define ACPI_MTX_EVENTS 3 /* Data for ACPI events */ 88 #define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */ 89 #define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */ 90 91 #define ACPI_MAX_MUTEX 5 92 #define ACPI_NUM_MUTEX (ACPI_MAX_MUTEX+1) 93 94 95 /* Lock structure for reader/writer interfaces */ 96 97 typedef struct acpi_rw_lock 98 { 99 ACPI_MUTEX WriterMutex; 100 ACPI_MUTEX ReaderMutex; 101 UINT32 NumReaders; 102 103 } ACPI_RW_LOCK; 104 105 106 /* 107 * Predefined handles for spinlocks used within the subsystem. 108 * These spinlocks are created by AcpiUtMutexInitialize 109 */ 110 #define ACPI_LOCK_GPES 0 111 #define ACPI_LOCK_HARDWARE 1 112 113 #define ACPI_MAX_LOCK 1 114 #define ACPI_NUM_LOCK (ACPI_MAX_LOCK+1) 115 116 117 /* This Thread ID means that the mutex is not in use (unlocked) */ 118 119 #define ACPI_MUTEX_NOT_ACQUIRED ((ACPI_THREAD_ID) -1) 120 121 /* This Thread ID means an invalid thread ID */ 122 123 #ifdef ACPI_OS_INVALID_THREAD_ID 124 #define ACPI_INVALID_THREAD_ID ACPI_OS_INVALID_THREAD_ID 125 #else 126 #define ACPI_INVALID_THREAD_ID ((ACPI_THREAD_ID) 0xFFFFFFFF) 127 #endif 128 129 /* Table for the global mutexes */ 130 131 typedef struct acpi_mutex_info 132 { 133 ACPI_MUTEX Mutex; 134 UINT32 UseCount; 135 ACPI_THREAD_ID ThreadId; 136 137 } ACPI_MUTEX_INFO; 138 139 140 /* Lock flag parameter for various interfaces */ 141 142 #define ACPI_MTX_DO_NOT_LOCK 0 143 #define ACPI_MTX_LOCK 1 144 145 146 /* Field access granularities */ 147 148 #define ACPI_FIELD_BYTE_GRANULARITY 1 149 #define ACPI_FIELD_WORD_GRANULARITY 2 150 #define ACPI_FIELD_DWORD_GRANULARITY 4 151 #define ACPI_FIELD_QWORD_GRANULARITY 8 152 153 154 #define ACPI_ENTRY_NOT_FOUND NULL 155 156 157 /***************************************************************************** 158 * 159 * Namespace typedefs and structs 160 * 161 ****************************************************************************/ 162 163 /* Operational modes of the AML interpreter/scanner */ 164 165 typedef enum 166 { 167 ACPI_IMODE_LOAD_PASS1 = 0x01, 168 ACPI_IMODE_LOAD_PASS2 = 0x02, 169 ACPI_IMODE_EXECUTE = 0x03 170 171 } ACPI_INTERPRETER_MODE; 172 173 174 /* 175 * The Namespace Node describes a named object that appears in the AML. 176 * DescriptorType is used to differentiate between internal descriptors. 177 * 178 * The node is optimized for both 32-bit and 64-bit platforms: 179 * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case. 180 * 181 * Note: The DescriptorType and Type fields must appear in the identical 182 * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT 183 * structures. 184 */ 185 typedef struct acpi_namespace_node 186 { 187 union acpi_operand_object *Object; /* Interpreter object */ 188 UINT8 DescriptorType; /* Differentiate object descriptor types */ 189 UINT8 Type; /* ACPI Type associated with this name */ 190 UINT16 Flags; /* Miscellaneous flags */ 191 ACPI_NAME_UNION Name; /* ACPI Name, always 4 chars per ACPI spec */ 192 struct acpi_namespace_node *Parent; /* Parent node */ 193 struct acpi_namespace_node *Child; /* First child */ 194 struct acpi_namespace_node *Peer; /* First peer */ 195 ACPI_OWNER_ID OwnerId; /* Node creator */ 196 197 /* 198 * The following fields are used by the ASL compiler and disassembler only 199 */ 200 #ifdef ACPI_LARGE_NAMESPACE_NODE 201 union acpi_parse_object *Op; 202 void *MethodLocals; 203 void *MethodArgs; 204 UINT32 Value; 205 UINT32 Length; 206 UINT8 ArgCount; 207 208 #endif 209 210 } ACPI_NAMESPACE_NODE; 211 212 213 /* Namespace Node flags */ 214 215 #define ANOBJ_RESERVED 0x01 /* Available for use */ 216 #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */ 217 #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */ 218 #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */ 219 #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */ 220 #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */ 221 #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (InstallMethod) */ 222 #define ANOBJ_NODE_EARLY_INIT 0x80 /* AcpiExec only: Node was create via init file (-fi) */ 223 224 #define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */ 225 #define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */ 226 #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */ 227 #define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */ 228 229 230 /* Internal ACPI table management - master table list */ 231 232 typedef struct acpi_table_list 233 { 234 ACPI_TABLE_DESC *Tables; /* Table descriptor array */ 235 UINT32 CurrentTableCount; /* Tables currently in the array */ 236 UINT32 MaxTableCount; /* Max tables array will hold */ 237 UINT8 Flags; 238 239 } ACPI_TABLE_LIST; 240 241 /* Flags for above */ 242 243 #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */ 244 #define ACPI_ROOT_ORIGIN_ALLOCATED (1) 245 #define ACPI_ROOT_ALLOW_RESIZE (2) 246 247 248 /* List to manage incoming ACPI tables */ 249 250 typedef struct acpi_new_table_desc 251 { 252 ACPI_TABLE_HEADER *Table; 253 struct acpi_new_table_desc *Next; 254 255 } ACPI_NEW_TABLE_DESC; 256 257 258 /* Predefined table indexes */ 259 260 #define ACPI_INVALID_TABLE_INDEX (0xFFFFFFFF) 261 262 263 typedef struct acpi_find_context 264 { 265 char *SearchFor; 266 ACPI_HANDLE *List; 267 UINT32 *Count; 268 269 } ACPI_FIND_CONTEXT; 270 271 272 typedef struct acpi_ns_search_data 273 { 274 ACPI_NAMESPACE_NODE *Node; 275 276 } ACPI_NS_SEARCH_DATA; 277 278 279 /* Object types used during package copies */ 280 281 #define ACPI_COPY_TYPE_SIMPLE 0 282 #define ACPI_COPY_TYPE_PACKAGE 1 283 284 285 /* Info structure used to convert external<->internal namestrings */ 286 287 typedef struct acpi_namestring_info 288 { 289 const char *ExternalName; 290 const char *NextExternalChar; 291 char *InternalName; 292 UINT32 Length; 293 UINT32 NumSegments; 294 UINT32 NumCarats; 295 BOOLEAN FullyQualified; 296 297 } ACPI_NAMESTRING_INFO; 298 299 300 /* Field creation info */ 301 302 typedef struct acpi_create_field_info 303 { 304 ACPI_NAMESPACE_NODE *RegionNode; 305 ACPI_NAMESPACE_NODE *FieldNode; 306 ACPI_NAMESPACE_NODE *RegisterNode; 307 ACPI_NAMESPACE_NODE *DataRegisterNode; 308 ACPI_NAMESPACE_NODE *ConnectionNode; 309 UINT8 *ResourceBuffer; 310 UINT32 BankValue; 311 UINT32 FieldBitPosition; 312 UINT32 FieldBitLength; 313 UINT16 ResourceLength; 314 UINT16 PinNumberIndex; 315 UINT8 FieldFlags; 316 UINT8 Attribute; 317 UINT8 FieldType; 318 UINT8 AccessLength; 319 320 } ACPI_CREATE_FIELD_INFO; 321 322 323 typedef 324 ACPI_STATUS (*ACPI_INTERNAL_METHOD) ( 325 struct acpi_walk_state *WalkState); 326 327 328 /* 329 * Bitmapped ACPI types. Used internally only 330 */ 331 #define ACPI_BTYPE_ANY 0x00000000 332 #define ACPI_BTYPE_INTEGER 0x00000001 333 #define ACPI_BTYPE_STRING 0x00000002 334 #define ACPI_BTYPE_BUFFER 0x00000004 335 #define ACPI_BTYPE_PACKAGE 0x00000008 336 #define ACPI_BTYPE_FIELD_UNIT 0x00000010 337 #define ACPI_BTYPE_DEVICE 0x00000020 338 #define ACPI_BTYPE_EVENT 0x00000040 339 #define ACPI_BTYPE_METHOD 0x00000080 340 #define ACPI_BTYPE_MUTEX 0x00000100 341 #define ACPI_BTYPE_REGION 0x00000200 342 #define ACPI_BTYPE_POWER 0x00000400 343 #define ACPI_BTYPE_PROCESSOR 0x00000800 344 #define ACPI_BTYPE_THERMAL 0x00001000 345 #define ACPI_BTYPE_BUFFER_FIELD 0x00002000 346 #define ACPI_BTYPE_DDB_HANDLE 0x00004000 347 #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000 348 #define ACPI_BTYPE_REFERENCE_OBJECT 0x00010000 /* From Index(), RefOf(), etc (Type6Opcodes) */ 349 #define ACPI_BTYPE_RESOURCE 0x00020000 350 #define ACPI_BTYPE_NAMED_REFERENCE 0x00040000 /* Generic unresolved Name or Namepath */ 351 352 #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER) 353 354 #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE) 355 356 /* Used by Copy, DeRefOf, Store, Printf, Fprintf */ 357 358 #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE_OBJECT | ACPI_BTYPE_DDB_HANDLE) 359 #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR) 360 #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */ 361 #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF 362 363 #pragma pack(1) 364 365 /* 366 * Information structure for ACPI predefined names. 367 * Each entry in the table contains the following items: 368 * 369 * Name - The ACPI reserved name 370 * ParamCount - Number of arguments to the method 371 * ExpectedReturnBtypes - Allowed type(s) for the return value 372 */ 373 typedef struct acpi_name_info 374 { 375 char Name[ACPI_NAMESEG_SIZE]; 376 UINT16 ArgumentList; 377 UINT8 ExpectedBtypes; 378 379 } ACPI_NAME_INFO; 380 381 /* 382 * Secondary information structures for ACPI predefined objects that return 383 * package objects. This structure appears as the next entry in the table 384 * after the NAME_INFO structure above. 385 * 386 * The reason for this is to minimize the size of the predefined name table. 387 */ 388 389 /* 390 * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2, 391 * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT, 392 * ACPI_PTYPE2_FIX_VAR 393 */ 394 typedef struct acpi_package_info 395 { 396 UINT8 Type; 397 UINT8 ObjectType1; 398 UINT8 Count1; 399 UINT8 ObjectType2; 400 UINT8 Count2; 401 UINT16 Reserved; 402 403 } ACPI_PACKAGE_INFO; 404 405 /* Used for ACPI_PTYPE2_FIXED */ 406 407 typedef struct acpi_package_info2 408 { 409 UINT8 Type; 410 UINT8 Count; 411 UINT8 ObjectType[4]; 412 UINT8 Reserved; 413 414 } ACPI_PACKAGE_INFO2; 415 416 /* Used for ACPI_PTYPE1_OPTION */ 417 418 typedef struct acpi_package_info3 419 { 420 UINT8 Type; 421 UINT8 Count; 422 UINT8 ObjectType[2]; 423 UINT8 TailObjectType; 424 UINT16 Reserved; 425 426 } ACPI_PACKAGE_INFO3; 427 428 typedef struct acpi_package_info4 429 { 430 UINT8 Type; 431 UINT8 ObjectType1; 432 UINT8 Count1; 433 UINT8 SubObjectTypes; 434 UINT8 PkgCount; 435 UINT16 Reserved; 436 437 } ACPI_PACKAGE_INFO4; 438 439 typedef union acpi_predefined_info 440 { 441 ACPI_NAME_INFO Info; 442 ACPI_PACKAGE_INFO RetInfo; 443 ACPI_PACKAGE_INFO2 RetInfo2; 444 ACPI_PACKAGE_INFO3 RetInfo3; 445 ACPI_PACKAGE_INFO4 RetInfo4; 446 447 } ACPI_PREDEFINED_INFO; 448 449 /* Reset to default packing */ 450 451 #pragma pack() 452 453 454 /* Return object auto-repair info */ 455 456 typedef ACPI_STATUS (*ACPI_OBJECT_CONVERTER) ( 457 struct acpi_namespace_node *Scope, 458 union acpi_operand_object *OriginalObject, 459 union acpi_operand_object **ConvertedObject); 460 461 typedef struct acpi_simple_repair_info 462 { 463 char Name[ACPI_NAMESEG_SIZE]; 464 UINT32 UnexpectedBtypes; 465 UINT32 PackageIndex; 466 ACPI_OBJECT_CONVERTER ObjectConverter; 467 468 } ACPI_SIMPLE_REPAIR_INFO; 469 470 471 /* 472 * Bitmapped return value types 473 * Note: the actual data types must be contiguous, a loop in nspredef.c 474 * depends on this. 475 */ 476 #define ACPI_RTYPE_ANY 0x00 477 #define ACPI_RTYPE_NONE 0x01 478 #define ACPI_RTYPE_INTEGER 0x02 479 #define ACPI_RTYPE_STRING 0x04 480 #define ACPI_RTYPE_BUFFER 0x08 481 #define ACPI_RTYPE_PACKAGE 0x10 482 #define ACPI_RTYPE_REFERENCE 0x20 483 #define ACPI_RTYPE_ALL 0x3F 484 485 #define ACPI_NUM_RTYPES 5 /* Number of actual object types */ 486 487 488 /* Info for running the _REG methods */ 489 490 typedef struct acpi_reg_walk_info 491 { 492 UINT32 Function; 493 UINT32 RegRunCount; 494 ACPI_ADR_SPACE_TYPE SpaceId; 495 496 } ACPI_REG_WALK_INFO; 497 498 499 /***************************************************************************** 500 * 501 * Event typedefs and structs 502 * 503 ****************************************************************************/ 504 505 /* Dispatch info for each host-installed SCI handler */ 506 507 typedef struct acpi_sci_handler_info 508 { 509 struct acpi_sci_handler_info *Next; 510 ACPI_SCI_HANDLER Address; /* Address of handler */ 511 void *Context; /* Context to be passed to handler */ 512 513 } ACPI_SCI_HANDLER_INFO; 514 515 /* Dispatch info for each GPE -- either a method or handler, cannot be both */ 516 517 typedef struct acpi_gpe_handler_info 518 { 519 ACPI_GPE_HANDLER Address; /* Address of handler, if any */ 520 void *Context; /* Context to be passed to handler */ 521 ACPI_NAMESPACE_NODE *MethodNode; /* Method node for this GPE level (saved) */ 522 UINT8 OriginalFlags; /* Original (pre-handler) GPE info */ 523 BOOLEAN OriginallyEnabled; /* True if GPE was originally enabled */ 524 525 } ACPI_GPE_HANDLER_INFO; 526 527 /* Notify info for implicit notify, multiple device objects */ 528 529 typedef struct acpi_gpe_notify_info 530 { 531 ACPI_NAMESPACE_NODE *DeviceNode; /* Device to be notified */ 532 struct acpi_gpe_notify_info *Next; 533 534 } ACPI_GPE_NOTIFY_INFO; 535 536 /* 537 * GPE dispatch info. At any time, the GPE can have at most one type 538 * of dispatch - Method, Handler, or Implicit Notify. 539 */ 540 typedef union acpi_gpe_dispatch_info 541 { 542 ACPI_NAMESPACE_NODE *MethodNode; /* Method node for this GPE level */ 543 ACPI_GPE_HANDLER_INFO *Handler; /* Installed GPE handler */ 544 ACPI_GPE_NOTIFY_INFO *NotifyList; /* List of _PRW devices for implicit notifies */ 545 546 } ACPI_GPE_DISPATCH_INFO; 547 548 /* 549 * Information about a GPE, one per each GPE in an array. 550 * NOTE: Important to keep this struct as small as possible. 551 */ 552 typedef struct acpi_gpe_event_info 553 { 554 union acpi_gpe_dispatch_info Dispatch; /* Either Method, Handler, or NotifyList */ 555 struct acpi_gpe_register_info *RegisterInfo; /* Backpointer to register info */ 556 UINT8 Flags; /* Misc info about this GPE */ 557 UINT8 GpeNumber; /* This GPE */ 558 UINT8 RuntimeCount; /* References to a run GPE */ 559 BOOLEAN DisableForDispatch; /* Masked during dispatching */ 560 561 } ACPI_GPE_EVENT_INFO; 562 563 /* Information about a GPE register pair, one per each status/enable pair in an array */ 564 565 typedef struct acpi_gpe_register_info 566 { 567 ACPI_GENERIC_ADDRESS StatusAddress; /* Address of status reg */ 568 ACPI_GENERIC_ADDRESS EnableAddress; /* Address of enable reg */ 569 UINT16 BaseGpeNumber; /* Base GPE number for this register */ 570 UINT8 EnableForWake; /* GPEs to keep enabled when sleeping */ 571 UINT8 EnableForRun; /* GPEs to keep enabled when running */ 572 UINT8 MaskForRun; /* GPEs to keep masked when running */ 573 UINT8 EnableMask; /* Current mask of enabled GPEs */ 574 575 } ACPI_GPE_REGISTER_INFO; 576 577 /* 578 * Information about a GPE register block, one per each installed block -- 579 * GPE0, GPE1, and one per each installed GPE Block Device. 580 */ 581 typedef struct acpi_gpe_block_info 582 { 583 ACPI_NAMESPACE_NODE *Node; 584 struct acpi_gpe_block_info *Previous; 585 struct acpi_gpe_block_info *Next; 586 struct acpi_gpe_xrupt_info *XruptBlock; /* Backpointer to interrupt block */ 587 ACPI_GPE_REGISTER_INFO *RegisterInfo; /* One per GPE register pair */ 588 ACPI_GPE_EVENT_INFO *EventInfo; /* One for each GPE */ 589 UINT64 Address; /* Base address of the block */ 590 UINT32 RegisterCount; /* Number of register pairs in block */ 591 UINT16 GpeCount; /* Number of individual GPEs in block */ 592 UINT16 BlockBaseNumber;/* Base GPE number for this block */ 593 UINT8 SpaceId; 594 BOOLEAN Initialized; /* TRUE if this block is initialized */ 595 596 } ACPI_GPE_BLOCK_INFO; 597 598 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */ 599 600 typedef struct acpi_gpe_xrupt_info 601 { 602 struct acpi_gpe_xrupt_info *Previous; 603 struct acpi_gpe_xrupt_info *Next; 604 ACPI_GPE_BLOCK_INFO *GpeBlockListHead; /* List of GPE blocks for this xrupt */ 605 UINT32 InterruptNumber; /* System interrupt number */ 606 607 } ACPI_GPE_XRUPT_INFO; 608 609 typedef struct acpi_gpe_walk_info 610 { 611 ACPI_NAMESPACE_NODE *GpeDevice; 612 ACPI_GPE_BLOCK_INFO *GpeBlock; 613 UINT16 Count; 614 ACPI_OWNER_ID OwnerId; 615 BOOLEAN ExecuteByOwnerId; 616 617 } ACPI_GPE_WALK_INFO; 618 619 typedef struct acpi_gpe_device_info 620 { 621 UINT32 Index; 622 UINT32 NextBlockBaseIndex; 623 ACPI_STATUS Status; 624 ACPI_NAMESPACE_NODE *GpeDevice; 625 626 } ACPI_GPE_DEVICE_INFO; 627 628 typedef ACPI_STATUS (*ACPI_GPE_CALLBACK) ( 629 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 630 ACPI_GPE_BLOCK_INFO *GpeBlock, 631 void *Context); 632 633 634 /* Information about each particular fixed event */ 635 636 typedef struct acpi_fixed_event_handler 637 { 638 ACPI_EVENT_HANDLER Handler; /* Address of handler. */ 639 void *Context; /* Context to be passed to handler */ 640 641 } ACPI_FIXED_EVENT_HANDLER; 642 643 typedef struct acpi_fixed_event_info 644 { 645 UINT8 StatusRegisterId; 646 UINT8 EnableRegisterId; 647 UINT16 StatusBitMask; 648 UINT16 EnableBitMask; 649 650 } ACPI_FIXED_EVENT_INFO; 651 652 /* Information used during field processing */ 653 654 typedef struct acpi_field_info 655 { 656 UINT8 SkipField; 657 UINT8 FieldFlag; 658 UINT32 PkgLength; 659 660 } ACPI_FIELD_INFO; 661 662 /* Information about the interrupt ID and _EVT of a GED device */ 663 664 typedef struct acpi_ged_handler_info 665 { 666 struct acpi_ged_handler_info *Next; 667 UINT32 IntId; /* The interrupt ID that triggers the execution of the EvtMethod. */ 668 ACPI_NAMESPACE_NODE *EvtMethod; /* The _EVT method to be executed when an interrupt with ID = IntID is received */ 669 670 } ACPI_GED_HANDLER_INFO; 671 672 /***************************************************************************** 673 * 674 * Generic "state" object for stacks 675 * 676 ****************************************************************************/ 677 678 #define ACPI_CONTROL_NORMAL 0xC0 679 #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1 680 #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2 681 #define ACPI_CONTROL_PREDICATE_FALSE 0xC3 682 #define ACPI_CONTROL_PREDICATE_TRUE 0xC4 683 684 685 #define ACPI_STATE_COMMON \ 686 void *Next; \ 687 UINT8 DescriptorType; /* To differentiate various internal objs */\ 688 UINT8 Flags; \ 689 UINT16 Value; \ 690 UINT16 State 691 692 /* There are 2 bytes available here until the next natural alignment boundary */ 693 694 typedef struct acpi_common_state 695 { 696 ACPI_STATE_COMMON; 697 } ACPI_COMMON_STATE; 698 699 700 /* 701 * Update state - used to traverse complex objects such as packages 702 */ 703 typedef struct acpi_update_state 704 { 705 ACPI_STATE_COMMON; 706 union acpi_operand_object *Object; 707 708 } ACPI_UPDATE_STATE; 709 710 711 /* 712 * Pkg state - used to traverse nested package structures 713 */ 714 typedef struct acpi_pkg_state 715 { 716 ACPI_STATE_COMMON; 717 UINT32 Index; 718 union acpi_operand_object *SourceObject; 719 union acpi_operand_object *DestObject; 720 struct acpi_walk_state *WalkState; 721 void *ThisTargetObj; 722 UINT32 NumPackages; 723 724 } ACPI_PKG_STATE; 725 726 727 /* 728 * Control state - one per if/else and while constructs. 729 * Allows nesting of these constructs 730 */ 731 typedef struct acpi_control_state 732 { 733 ACPI_STATE_COMMON; 734 UINT16 Opcode; 735 union acpi_parse_object *PredicateOp; 736 UINT8 *AmlPredicateStart; /* Start of if/while predicate */ 737 UINT8 *PackageEnd; /* End of if/while block */ 738 UINT64 LoopTimeout; /* While() loop timeout */ 739 740 } ACPI_CONTROL_STATE; 741 742 743 /* 744 * Scope state - current scope during namespace lookups 745 */ 746 typedef struct acpi_scope_state 747 { 748 ACPI_STATE_COMMON; 749 ACPI_NAMESPACE_NODE *Node; 750 751 } ACPI_SCOPE_STATE; 752 753 754 typedef struct acpi_pscope_state 755 { 756 ACPI_STATE_COMMON; 757 UINT32 ArgCount; /* Number of fixed arguments */ 758 union acpi_parse_object *Op; /* Current op being parsed */ 759 UINT8 *ArgEnd; /* Current argument end */ 760 UINT8 *PkgEnd; /* Current package end */ 761 UINT32 ArgList; /* Next argument to parse */ 762 763 } ACPI_PSCOPE_STATE; 764 765 766 /* 767 * Thread state - one per thread across multiple walk states. Multiple walk 768 * states are created when there are nested control methods executing. 769 */ 770 typedef struct acpi_thread_state 771 { 772 ACPI_STATE_COMMON; 773 UINT8 CurrentSyncLevel; /* Mutex Sync (nested acquire) level */ 774 struct acpi_walk_state *WalkStateList; /* Head of list of WalkStates for this thread */ 775 union acpi_operand_object *AcquiredMutexList; /* List of all currently acquired mutexes */ 776 ACPI_THREAD_ID ThreadId; /* Running thread ID */ 777 778 } ACPI_THREAD_STATE; 779 780 781 /* 782 * Result values - used to accumulate the results of nested 783 * AML arguments 784 */ 785 typedef struct acpi_result_values 786 { 787 ACPI_STATE_COMMON; 788 union acpi_operand_object *ObjDesc [ACPI_RESULTS_FRAME_OBJ_NUM]; 789 790 } ACPI_RESULT_VALUES; 791 792 793 typedef 794 ACPI_STATUS (*ACPI_PARSE_DOWNWARDS) ( 795 struct acpi_walk_state *WalkState, 796 union acpi_parse_object **OutOp); 797 798 typedef 799 ACPI_STATUS (*ACPI_PARSE_UPWARDS) ( 800 struct acpi_walk_state *WalkState); 801 802 803 /* Global handlers for AML Notifies */ 804 805 typedef struct acpi_global_notify_handler 806 { 807 ACPI_NOTIFY_HANDLER Handler; 808 void *Context; 809 810 } ACPI_GLOBAL_NOTIFY_HANDLER; 811 812 /* 813 * Notify info - used to pass info to the deferred notify 814 * handler/dispatcher. 815 */ 816 typedef struct acpi_notify_info 817 { 818 ACPI_STATE_COMMON; 819 UINT8 HandlerListId; 820 ACPI_NAMESPACE_NODE *Node; 821 union acpi_operand_object *HandlerListHead; 822 ACPI_GLOBAL_NOTIFY_HANDLER *Global; 823 824 } ACPI_NOTIFY_INFO; 825 826 827 /* Generic state is union of structs above */ 828 829 typedef union acpi_generic_state 830 { 831 ACPI_COMMON_STATE Common; 832 ACPI_CONTROL_STATE Control; 833 ACPI_UPDATE_STATE Update; 834 ACPI_SCOPE_STATE Scope; 835 ACPI_PSCOPE_STATE ParseScope; 836 ACPI_PKG_STATE Pkg; 837 ACPI_THREAD_STATE Thread; 838 ACPI_RESULT_VALUES Results; 839 ACPI_NOTIFY_INFO Notify; 840 841 } ACPI_GENERIC_STATE; 842 843 844 /***************************************************************************** 845 * 846 * Interpreter typedefs and structs 847 * 848 ****************************************************************************/ 849 850 typedef 851 ACPI_STATUS (*ACPI_EXECUTE_OP) ( 852 struct acpi_walk_state *WalkState); 853 854 /* Address Range info block */ 855 856 typedef struct acpi_address_range 857 { 858 struct acpi_address_range *Next; 859 ACPI_NAMESPACE_NODE *RegionNode; 860 ACPI_PHYSICAL_ADDRESS StartAddress; 861 ACPI_PHYSICAL_ADDRESS EndAddress; 862 863 } ACPI_ADDRESS_RANGE; 864 865 866 /***************************************************************************** 867 * 868 * Parser typedefs and structs 869 * 870 ****************************************************************************/ 871 872 /* 873 * AML opcode, name, and argument layout 874 */ 875 typedef struct acpi_opcode_info 876 { 877 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT) 878 const char *Name; /* Opcode name (disassembler/debug only) */ 879 #endif 880 UINT32 ParseArgs; /* Grammar/Parse time arguments */ 881 UINT32 RuntimeArgs; /* Interpret time arguments */ 882 UINT16 Flags; /* Misc flags */ 883 UINT8 ObjectType; /* Corresponding internal object type */ 884 UINT8 Class; /* Opcode class */ 885 UINT8 Type; /* Opcode type */ 886 887 } ACPI_OPCODE_INFO; 888 889 /* Structure for Resource Tag information */ 890 891 typedef struct acpi_tag_info 892 { 893 UINT32 BitOffset; 894 UINT32 BitLength; 895 896 } ACPI_TAG_INFO; 897 898 /* Value associated with the parse object */ 899 900 typedef union acpi_parse_value 901 { 902 UINT64 Integer; /* Integer constant (Up to 64 bits) */ 903 UINT32 Size; /* bytelist or field size */ 904 char *String; /* NULL terminated string */ 905 UINT8 *Buffer; /* buffer or string */ 906 char *Name; /* NULL terminated string */ 907 union acpi_parse_object *Arg; /* arguments and contained ops */ 908 ACPI_TAG_INFO Tag; /* Resource descriptor tag info */ 909 910 } ACPI_PARSE_VALUE; 911 912 913 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT) 914 #define ACPI_DISASM_ONLY_MEMBERS(a) a; 915 #else 916 #define ACPI_DISASM_ONLY_MEMBERS(a) 917 #endif 918 919 #if defined(ACPI_ASL_COMPILER) 920 #define ACPI_CONVERTER_ONLY_MEMBERS(a) a; 921 #else 922 #define ACPI_CONVERTER_ONLY_MEMBERS(a) 923 #endif 924 925 #define ACPI_PARSE_COMMON \ 926 union acpi_parse_object *Parent; /* Parent op */\ 927 UINT8 DescriptorType; /* To differentiate various internal objs */\ 928 UINT8 Flags; /* Type of Op */\ 929 UINT16 AmlOpcode; /* AML opcode */\ 930 UINT8 *Aml; /* Address of declaration in AML */\ 931 union acpi_parse_object *Next; /* Next op */\ 932 ACPI_NAMESPACE_NODE *Node; /* For use by interpreter */\ 933 ACPI_PARSE_VALUE Value; /* Value or args associated with the opcode */\ 934 UINT8 ArgListLength; /* Number of elements in the arg list */\ 935 ACPI_DISASM_ONLY_MEMBERS (\ 936 UINT16 DisasmFlags; /* Used during AML disassembly */\ 937 UINT8 DisasmOpcode; /* Subtype used for disassembly */\ 938 const char *OperatorSymbol; /* Used for C-style operator name strings */\ 939 char AmlOpName[16]) /* Op name (debug only) */\ 940 ACPI_CONVERTER_ONLY_MEMBERS (\ 941 char *InlineComment; /* Inline comment */\ 942 char *EndNodeComment; /* End of node comment */\ 943 char *NameComment; /* Comment associated with the first parameter of the name node */\ 944 char *CloseBraceComment; /* Comments that come after } on the same as } */\ 945 ACPI_COMMENT_NODE *CommentList; /* comments that appears before this node */\ 946 ACPI_COMMENT_NODE *EndBlkComment; /* comments that at the end of a block but before ) or } */\ 947 char *CvFilename; /* Filename associated with this node. Used for ASL/ASL+ converter */\ 948 char *CvParentFilename) /* Parent filename associated with this node. Used for ASL/ASL+ converter */ 949 950 951 /* categories of comments */ 952 953 typedef enum 954 { 955 STANDARD_COMMENT = 1, 956 INLINE_COMMENT, 957 ENDNODE_COMMENT, 958 OPENBRACE_COMMENT, 959 CLOSE_BRACE_COMMENT, 960 STD_DEFBLK_COMMENT, 961 END_DEFBLK_COMMENT, 962 FILENAME_COMMENT, 963 PARENTFILENAME_COMMENT, 964 ENDBLK_COMMENT, 965 INCLUDE_COMMENT 966 967 } ASL_COMMENT_TYPES; 968 969 970 /* Internal opcodes for DisasmOpcode field above */ 971 972 #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */ 973 #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */ 974 #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */ 975 #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */ 976 #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */ 977 #define ACPI_DASM_UUID 0x05 /* Buffer is a UUID/GUID */ 978 #define ACPI_DASM_EISAID 0x06 /* Integer is an EISAID */ 979 #define ACPI_DASM_MATCHOP 0x07 /* Parent opcode is a Match() operator */ 980 #define ACPI_DASM_LNOT_PREFIX 0x08 /* Start of a LNotEqual (etc.) pair of opcodes */ 981 #define ACPI_DASM_LNOT_SUFFIX 0x09 /* End of a LNotEqual (etc.) pair of opcodes */ 982 #define ACPI_DASM_HID_STRING 0x0A /* String is a _HID or _CID */ 983 #define ACPI_DASM_IGNORE_SINGLE 0x0B /* Ignore the opcode but not it's children */ 984 #define ACPI_DASM_SWITCH 0x0C /* While is a Switch */ 985 #define ACPI_DASM_SWITCH_PREDICATE 0x0D /* Object is a predicate for a Switch or Case block */ 986 #define ACPI_DASM_CASE 0x0E /* If/Else is a Case in a Switch/Case block */ 987 #define ACPI_DASM_DEFAULT 0x0F /* Else is a Default in a Switch/Case block */ 988 989 990 /* 991 * List struct used in the -ca option 992 */ 993 typedef struct acpi_comment_node 994 { 995 char *Comment; 996 struct acpi_comment_node *Next; 997 998 } ACPI_COMMENT_NODE; 999 1000 1001 typedef struct acpi_comment_addr_node 1002 { 1003 UINT8 *Addr; 1004 struct acpi_comment_addr_node *Next; 1005 } ACPI_COMMENT_ADDR_NODE; 1006 1007 /* 1008 * File node - used for "Include" operator file stack and 1009 * dependency tree for the -ca option 1010 */ 1011 typedef struct acpi_file_node 1012 { 1013 void *File; 1014 char *Filename; 1015 char *FileStart; /* Points to AML and indicates when the AML for this particular file starts. */ 1016 char *FileEnd; /* Points to AML and indicates when the AML for this particular file ends. */ 1017 struct acpi_file_node *Next; 1018 struct acpi_file_node *Parent; 1019 BOOLEAN IncludeWritten; 1020 ACPI_COMMENT_NODE *IncludeComment; 1021 1022 } ACPI_FILE_NODE; 1023 1024 1025 /* 1026 * Generic operation (for example: If, While, Store) 1027 */ 1028 typedef struct acpi_parse_obj_common 1029 { 1030 ACPI_PARSE_COMMON 1031 } ACPI_PARSE_OBJ_COMMON; 1032 1033 1034 /* 1035 * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and OpRegions), 1036 * and bytelists. 1037 */ 1038 typedef struct acpi_parse_obj_named 1039 { 1040 ACPI_PARSE_COMMON 1041 char *Path; 1042 UINT8 *Data; /* AML body or bytelist data */ 1043 UINT32 Length; /* AML length */ 1044 UINT32 Name; /* 4-byte name or zero if no name */ 1045 1046 } ACPI_PARSE_OBJ_NAMED; 1047 1048 1049 /* This version is used by the iASL compiler only */ 1050 1051 #define ACPI_MAX_PARSEOP_NAME 20 1052 1053 typedef struct acpi_parse_obj_asl 1054 { 1055 ACPI_PARSE_COMMON 1056 union acpi_parse_object *Child; 1057 union acpi_parse_object *ParentMethod; 1058 char *Filename; 1059 BOOLEAN FileChanged; 1060 char *ParentFilename; 1061 char *ExternalName; 1062 char *Namepath; 1063 char NameSeg[4]; 1064 UINT32 ExtraValue; 1065 UINT32 Column; 1066 UINT32 LineNumber; 1067 UINT32 LogicalLineNumber; 1068 UINT32 LogicalByteOffset; 1069 UINT32 EndLine; 1070 UINT32 EndLogicalLine; 1071 UINT32 AcpiBtype; 1072 UINT32 AmlLength; 1073 UINT32 AmlSubtreeLength; 1074 UINT32 FinalAmlLength; 1075 UINT32 FinalAmlOffset; 1076 UINT32 CompileFlags; 1077 UINT16 ParseOpcode; 1078 UINT8 AmlOpcodeLength; 1079 UINT8 AmlPkgLenBytes; 1080 UINT8 Extra; 1081 char ParseOpName[ACPI_MAX_PARSEOP_NAME]; 1082 1083 } ACPI_PARSE_OBJ_ASL; 1084 1085 typedef union acpi_parse_object 1086 { 1087 ACPI_PARSE_OBJ_COMMON Common; 1088 ACPI_PARSE_OBJ_NAMED Named; 1089 ACPI_PARSE_OBJ_ASL Asl; 1090 1091 } ACPI_PARSE_OBJECT; 1092 1093 typedef struct asl_comment_state 1094 { 1095 UINT8 CommentType; 1096 UINT32 SpacesBefore; 1097 ACPI_PARSE_OBJECT *LatestParseOp; 1098 ACPI_PARSE_OBJECT *ParsingParenBraceNode; 1099 BOOLEAN CaptureComments; 1100 1101 } ASL_COMMENT_STATE; 1102 1103 1104 /* 1105 * Parse state - one state per parser invocation and each control 1106 * method. 1107 */ 1108 typedef struct acpi_parse_state 1109 { 1110 UINT8 *AmlStart; /* First AML byte */ 1111 UINT8 *Aml; /* Next AML byte */ 1112 UINT8 *AmlEnd; /* (last + 1) AML byte */ 1113 UINT8 *PkgStart; /* Current package begin */ 1114 UINT8 *PkgEnd; /* Current package end */ 1115 union acpi_parse_object *StartOp; /* Root of parse tree */ 1116 struct acpi_namespace_node *StartNode; 1117 union acpi_generic_state *Scope; /* Current scope */ 1118 union acpi_parse_object *StartScope; 1119 UINT32 AmlSize; 1120 1121 } ACPI_PARSE_STATE; 1122 1123 1124 /* Parse object flags */ 1125 1126 #define ACPI_PARSEOP_GENERIC 0x01 1127 #define ACPI_PARSEOP_NAMED_OBJECT 0x02 1128 #define ACPI_PARSEOP_DEFERRED 0x04 1129 #define ACPI_PARSEOP_BYTELIST 0x08 1130 #define ACPI_PARSEOP_IN_STACK 0x10 1131 #define ACPI_PARSEOP_TARGET 0x20 1132 #define ACPI_PARSEOP_IN_CACHE 0x80 1133 1134 /* Parse object DisasmFlags */ 1135 1136 #define ACPI_PARSEOP_IGNORE 0x0001 1137 #define ACPI_PARSEOP_PARAMETER_LIST 0x0002 1138 #define ACPI_PARSEOP_EMPTY_TERMLIST 0x0004 1139 #define ACPI_PARSEOP_PREDEFINED_CHECKED 0x0008 1140 #define ACPI_PARSEOP_CLOSING_PAREN 0x0010 1141 #define ACPI_PARSEOP_COMPOUND_ASSIGNMENT 0x0020 1142 #define ACPI_PARSEOP_ASSIGNMENT 0x0040 1143 #define ACPI_PARSEOP_ELSEIF 0x0080 1144 #define ACPI_PARSEOP_LEGACY_ASL_ONLY 0x0100 1145 1146 1147 /***************************************************************************** 1148 * 1149 * Hardware (ACPI registers) and PNP 1150 * 1151 ****************************************************************************/ 1152 1153 typedef struct acpi_bit_register_info 1154 { 1155 UINT8 ParentRegister; 1156 UINT8 BitPosition; 1157 UINT16 AccessBitMask; 1158 1159 } ACPI_BIT_REGISTER_INFO; 1160 1161 1162 /* 1163 * Some ACPI registers have bits that must be ignored -- meaning that they 1164 * must be preserved. 1165 */ 1166 #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */ 1167 1168 /* Write-only bits must be zeroed by software */ 1169 1170 #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */ 1171 1172 /* For control registers, both ignored and reserved bits must be preserved */ 1173 1174 /* 1175 * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the 1176 * ACPI specification to be a "preserved" bit - "OSPM always preserves this 1177 * bit position", section 4.7.3.2.1. However, on some machines the OS must 1178 * write a one to this bit after resume for the machine to work properly. 1179 * To enable this, we no longer attempt to preserve this bit. No machines 1180 * are known to fail if the bit is not preserved. (May 2009) 1181 */ 1182 #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */ 1183 #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */ 1184 #define ACPI_PM1_CONTROL_PRESERVED_BITS \ 1185 (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS) 1186 1187 #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */ 1188 1189 /* 1190 * Register IDs 1191 * These are the full ACPI registers 1192 */ 1193 #define ACPI_REGISTER_PM1_STATUS 0x01 1194 #define ACPI_REGISTER_PM1_ENABLE 0x02 1195 #define ACPI_REGISTER_PM1_CONTROL 0x03 1196 #define ACPI_REGISTER_PM2_CONTROL 0x04 1197 #define ACPI_REGISTER_PM_TIMER 0x05 1198 #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06 1199 #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07 1200 1201 1202 /* Masks used to access the BitRegisters */ 1203 1204 #define ACPI_BITMASK_TIMER_STATUS 0x0001 1205 #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010 1206 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020 1207 #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100 1208 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200 1209 #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400 1210 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */ 1211 #define ACPI_BITMASK_WAKE_STATUS 0x8000 1212 1213 #define ACPI_BITMASK_ALL_FIXED_STATUS (\ 1214 ACPI_BITMASK_TIMER_STATUS | \ 1215 ACPI_BITMASK_BUS_MASTER_STATUS | \ 1216 ACPI_BITMASK_GLOBAL_LOCK_STATUS | \ 1217 ACPI_BITMASK_POWER_BUTTON_STATUS | \ 1218 ACPI_BITMASK_SLEEP_BUTTON_STATUS | \ 1219 ACPI_BITMASK_RT_CLOCK_STATUS | \ 1220 ACPI_BITMASK_PCIEXP_WAKE_STATUS | \ 1221 ACPI_BITMASK_WAKE_STATUS) 1222 1223 #define ACPI_BITMASK_TIMER_ENABLE 0x0001 1224 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020 1225 #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100 1226 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200 1227 #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400 1228 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */ 1229 1230 #define ACPI_BITMASK_SCI_ENABLE 0x0001 1231 #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002 1232 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004 1233 #define ACPI_BITMASK_SLEEP_TYPE 0x1C00 1234 #define ACPI_BITMASK_SLEEP_ENABLE 0x2000 1235 1236 #define ACPI_BITMASK_ARB_DISABLE 0x0001 1237 1238 1239 /* Raw bit position of each BitRegister */ 1240 1241 #define ACPI_BITPOSITION_TIMER_STATUS 0x00 1242 #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04 1243 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05 1244 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08 1245 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09 1246 #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A 1247 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */ 1248 #define ACPI_BITPOSITION_WAKE_STATUS 0x0F 1249 1250 #define ACPI_BITPOSITION_TIMER_ENABLE 0x00 1251 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05 1252 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08 1253 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09 1254 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A 1255 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */ 1256 1257 #define ACPI_BITPOSITION_SCI_ENABLE 0x00 1258 #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01 1259 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02 1260 #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A 1261 #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D 1262 1263 #define ACPI_BITPOSITION_ARB_DISABLE 0x00 1264 1265 1266 /* Structs and definitions for _OSI support and I/O port validation */ 1267 1268 #define ACPI_ALWAYS_ILLEGAL 0x00 1269 1270 typedef struct acpi_interface_info 1271 { 1272 const char *Name; 1273 struct acpi_interface_info *Next; 1274 UINT8 Flags; 1275 UINT8 Value; 1276 1277 } ACPI_INTERFACE_INFO; 1278 1279 #define ACPI_OSI_INVALID 0x01 1280 #define ACPI_OSI_DYNAMIC 0x02 1281 #define ACPI_OSI_FEATURE 0x04 1282 #define ACPI_OSI_DEFAULT_INVALID 0x08 1283 #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID) 1284 1285 typedef struct acpi_port_info 1286 { 1287 const char *Name; 1288 UINT16 Start; 1289 UINT16 End; 1290 UINT8 OsiDependency; 1291 1292 } ACPI_PORT_INFO; 1293 1294 1295 /***************************************************************************** 1296 * 1297 * Resource descriptors 1298 * 1299 ****************************************************************************/ 1300 1301 /* ResourceType values */ 1302 1303 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0 1304 #define ACPI_ADDRESS_TYPE_IO_RANGE 1 1305 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2 1306 1307 #define ACPI_ADDRESS_TYPE_PCC_NUMBER 0xA 1308 1309 /* Resource descriptor types and masks */ 1310 1311 #define ACPI_RESOURCE_NAME_LARGE 0x80 1312 #define ACPI_RESOURCE_NAME_SMALL 0x00 1313 1314 #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */ 1315 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */ 1316 #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */ 1317 1318 1319 /* 1320 * Small resource descriptor "names" as defined by the ACPI specification. 1321 * Note: Bits 2:0 are used for the descriptor length 1322 */ 1323 #define ACPI_RESOURCE_NAME_IRQ 0x20 1324 #define ACPI_RESOURCE_NAME_DMA 0x28 1325 #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30 1326 #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38 1327 #define ACPI_RESOURCE_NAME_IO 0x40 1328 #define ACPI_RESOURCE_NAME_FIXED_IO 0x48 1329 #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50 1330 #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58 1331 #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60 1332 #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68 1333 #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70 1334 #define ACPI_RESOURCE_NAME_END_TAG 0x78 1335 1336 /* 1337 * Large resource descriptor "names" as defined by the ACPI specification. 1338 * Note: includes the Large Descriptor bit in bit[7] 1339 */ 1340 #define ACPI_RESOURCE_NAME_MEMORY24 0x81 1341 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82 1342 #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83 1343 #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84 1344 #define ACPI_RESOURCE_NAME_MEMORY32 0x85 1345 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86 1346 #define ACPI_RESOURCE_NAME_ADDRESS32 0x87 1347 #define ACPI_RESOURCE_NAME_ADDRESS16 0x88 1348 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89 1349 #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A 1350 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B 1351 #define ACPI_RESOURCE_NAME_GPIO 0x8C 1352 #define ACPI_RESOURCE_NAME_PIN_FUNCTION 0x8D 1353 #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E 1354 #define ACPI_RESOURCE_NAME_PIN_CONFIG 0x8F 1355 #define ACPI_RESOURCE_NAME_PIN_GROUP 0x90 1356 #define ACPI_RESOURCE_NAME_PIN_GROUP_FUNCTION 0x91 1357 #define ACPI_RESOURCE_NAME_PIN_GROUP_CONFIG 0x92 1358 #define ACPI_RESOURCE_NAME_CLOCK_INPUT 0x93 1359 #define ACPI_RESOURCE_NAME_LARGE_MAX 0x94 1360 1361 1362 /***************************************************************************** 1363 * 1364 * Miscellaneous 1365 * 1366 ****************************************************************************/ 1367 1368 #define ACPI_ASCII_ZERO 0x30 1369 1370 1371 /***************************************************************************** 1372 * 1373 * Disassembler 1374 * 1375 ****************************************************************************/ 1376 1377 typedef struct acpi_external_list 1378 { 1379 char *Path; 1380 char *InternalPath; 1381 struct acpi_external_list *Next; 1382 UINT32 Value; 1383 UINT16 Length; 1384 UINT16 Flags; 1385 UINT8 Type; 1386 1387 } ACPI_EXTERNAL_LIST; 1388 1389 /* Values for Flags field above */ 1390 1391 #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */ 1392 #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */ 1393 #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */ 1394 #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */ 1395 #define ACPI_EXT_ORIGIN_FROM_OPCODE 0x10 /* External came from a External() opcode */ 1396 #define ACPI_EXT_CONFLICTING_DECLARATION 0x20 /* External has a conflicting declaration within AML */ 1397 1398 1399 typedef struct acpi_external_file 1400 { 1401 char *Path; 1402 struct acpi_external_file *Next; 1403 1404 } ACPI_EXTERNAL_FILE; 1405 1406 1407 typedef struct acpi_parse_object_list 1408 { 1409 ACPI_PARSE_OBJECT *Op; 1410 struct acpi_parse_object_list *Next; 1411 1412 } ACPI_PARSE_OBJECT_LIST; 1413 1414 /***************************************************************************** 1415 * 1416 * Debugger 1417 * 1418 ****************************************************************************/ 1419 1420 typedef struct acpi_db_method_info 1421 { 1422 ACPI_HANDLE Method; 1423 ACPI_HANDLE MainThreadGate; 1424 ACPI_HANDLE ThreadCompleteGate; 1425 ACPI_HANDLE InfoGate; 1426 ACPI_THREAD_ID *Threads; 1427 UINT32 NumThreads; 1428 UINT32 NumCreated; 1429 UINT32 NumCompleted; 1430 1431 char *Name; 1432 UINT32 Flags; 1433 UINT32 NumLoops; 1434 char Pathname[ACPI_DB_LINE_BUFFER_SIZE]; 1435 char **Args; 1436 ACPI_OBJECT_TYPE *Types; 1437 1438 /* 1439 * Arguments to be passed to method for the commands Threads and 1440 * Background. Note, ACPI specifies a maximum of 7 arguments (0 - 6). 1441 * 1442 * For the Threads command, the Number of threads, ID of current 1443 * thread and Index of current thread inside all them created. 1444 */ 1445 char InitArgs; 1446 #ifdef ACPI_DEBUGGER 1447 ACPI_OBJECT_TYPE ArgTypes[ACPI_METHOD_NUM_ARGS]; 1448 #endif 1449 char *Arguments[ACPI_METHOD_NUM_ARGS]; 1450 char NumThreadsStr[11]; 1451 char IdOfThreadStr[11]; 1452 char IndexOfThreadStr[11]; 1453 1454 } ACPI_DB_METHOD_INFO; 1455 1456 typedef struct acpi_integrity_info 1457 { 1458 UINT32 Nodes; 1459 UINT32 Objects; 1460 1461 } ACPI_INTEGRITY_INFO; 1462 1463 1464 #define ACPI_DB_DISABLE_OUTPUT 0x00 1465 #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01 1466 #define ACPI_DB_CONSOLE_OUTPUT 0x02 1467 #define ACPI_DB_DUPLICATE_OUTPUT 0x03 1468 1469 1470 typedef struct acpi_object_info 1471 { 1472 UINT32 Types[ACPI_TOTAL_TYPES]; 1473 1474 } ACPI_OBJECT_INFO; 1475 1476 1477 /***************************************************************************** 1478 * 1479 * Debug 1480 * 1481 ****************************************************************************/ 1482 1483 /* Entry for a memory allocation (debug only) */ 1484 1485 #define ACPI_MEM_MALLOC 0 1486 #define ACPI_MEM_CALLOC 1 1487 #define ACPI_MAX_MODULE_NAME 16 1488 1489 #define ACPI_COMMON_DEBUG_MEM_HEADER \ 1490 struct acpi_debug_mem_block *Previous; \ 1491 struct acpi_debug_mem_block *Next; \ 1492 UINT32 Size; \ 1493 UINT32 Component; \ 1494 UINT32 Line; \ 1495 char Module[ACPI_MAX_MODULE_NAME]; \ 1496 UINT8 AllocType; 1497 1498 typedef struct acpi_debug_mem_header 1499 { 1500 ACPI_COMMON_DEBUG_MEM_HEADER 1501 1502 } ACPI_DEBUG_MEM_HEADER; 1503 1504 typedef struct acpi_debug_mem_block 1505 { 1506 ACPI_COMMON_DEBUG_MEM_HEADER 1507 UINT64 UserSpace; 1508 1509 } ACPI_DEBUG_MEM_BLOCK; 1510 1511 1512 #define ACPI_MEM_LIST_GLOBAL 0 1513 #define ACPI_MEM_LIST_NSNODE 1 1514 #define ACPI_MEM_LIST_MAX 1 1515 #define ACPI_NUM_MEM_LISTS 2 1516 1517 1518 /***************************************************************************** 1519 * 1520 * Info/help support 1521 * 1522 ****************************************************************************/ 1523 1524 typedef struct ah_predefined_name 1525 { 1526 char *Name; 1527 char *Description; 1528 #ifndef ACPI_ASL_COMPILER 1529 char *Action; 1530 #endif 1531 1532 } AH_PREDEFINED_NAME; 1533 1534 typedef struct ah_device_id 1535 { 1536 const char *Name; 1537 const char *Description; 1538 1539 } AH_DEVICE_ID; 1540 1541 typedef struct ah_uuid 1542 { 1543 const char *Description; 1544 const char *String; 1545 1546 } AH_UUID; 1547 1548 typedef struct ah_table 1549 { 1550 char *Signature; 1551 char *Description; 1552 1553 } AH_TABLE; 1554 1555 #endif /* __ACLOCAL_H__ */ 1556