sys/contrib/dev/acpica/include/aclocal.h

   1 /******************************************************************************
   2  *
   3  * Name: aclocal.h - Internal data types used across the ACPI subsystem
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights.  You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code.  No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision.  In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change.  Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee.  Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution.  In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government.  In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #ifndef __ACLOCAL_H__
 117 #define __ACLOCAL_H__
 118
 119
 120 /* acpisrc:StructDefs -- for acpisrc conversion */
 121
 122 #define ACPI_SERIALIZED                 0xFF
 123
 124 typedef UINT32                          ACPI_MUTEX_HANDLE;
 125 #define ACPI_GLOBAL_LOCK                (ACPI_SEMAPHORE) (-1)
 126
 127 /* Total number of aml opcodes defined */
 128
 129 #define AML_NUM_OPCODES                 0x7F
 130
 131
 132 /* Forward declarations */
 133
 134 struct acpi_walk_state;
 135 struct acpi_obj_mutex;
 136 union acpi_parse_object;
 137
 138
 139 /*****************************************************************************
 140  *
 141  * Mutex typedefs and structs
 142  *
 143  ****************************************************************************/
 144
 145
 146 /*
 147  * Predefined handles for the mutex objects used within the subsystem
 148  * All mutex objects are automatically created by AcpiUtMutexInitialize.
 149  *
 150  * The acquire/release ordering protocol is implied via this list. Mutexes
 151  * with a lower value must be acquired before mutexes with a higher value.
 152  *
 153  * NOTE: any changes here must be reflected in the AcpiGbl_MutexNames
 154  * table below also!
 155  */
 156 #define ACPI_MTX_INTERPRETER            0   /* AML Interpreter, main lock */
 157 #define ACPI_MTX_NAMESPACE              1   /* ACPI Namespace */
 158 #define ACPI_MTX_TABLES                 2   /* Data for ACPI tables */
 159 #define ACPI_MTX_EVENTS                 3   /* Data for ACPI events */
 160 #define ACPI_MTX_CACHES                 4   /* Internal caches, general purposes */
 161 #define ACPI_MTX_MEMORY                 5   /* Debug memory tracking lists */
 162 #define ACPI_MTX_DEBUG_CMD_COMPLETE     6   /* AML debugger */
 163 #define ACPI_MTX_DEBUG_CMD_READY        7   /* AML debugger */
 164
 165 #define ACPI_MAX_MUTEX                  7
 166 #define ACPI_NUM_MUTEX                  ACPI_MAX_MUTEX+1
 167
 168 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
 169 #ifdef DEFINE_ACPI_GLOBALS
 170
 171 /* Debug names for the mutexes above */
 172
 173 static char                 *AcpiGbl_MutexNames[ACPI_NUM_MUTEX] =
 174 {
 175     "ACPI_MTX_Interpreter",
 176     "ACPI_MTX_Namespace",
 177     "ACPI_MTX_Tables",
 178     "ACPI_MTX_Events",
 179     "ACPI_MTX_Caches",
 180     "ACPI_MTX_Memory",
 181     "ACPI_MTX_CommandComplete",
 182     "ACPI_MTX_CommandReady"
 183 };
 184
 185 #endif
 186 #endif
 187
 188 /* Lock structure for reader/writer interfaces */
 189
 190 typedef struct acpi_rw_lock
 191 {
 192     ACPI_MUTEX              WriterMutex;
 193     ACPI_MUTEX              ReaderMutex;
 194     UINT32                  NumReaders;
 195
 196 } ACPI_RW_LOCK;
 197
 198
 199 /*
 200  * Predefined handles for spinlocks used within the subsystem.
 201  * These spinlocks are created by AcpiUtMutexInitialize
 202  */
 203 #define ACPI_LOCK_GPES                  0
 204 #define ACPI_LOCK_HARDWARE              1
 205
 206 #define ACPI_MAX_LOCK                   1
 207 #define ACPI_NUM_LOCK                   ACPI_MAX_LOCK+1
 208
 209
 210 /* This Thread ID means that the mutex is not in use (unlocked) */
 211
 212 #define ACPI_MUTEX_NOT_ACQUIRED         (ACPI_THREAD_ID) -1
 213
 214 /* Table for the global mutexes */
 215
 216 typedef struct acpi_mutex_info
 217 {
 218     ACPI_MUTEX                      Mutex;
 219     UINT32                          UseCount;
 220     ACPI_THREAD_ID                  ThreadId;
 221
 222 } ACPI_MUTEX_INFO;
 223
 224
 225 /* Lock flag parameter for various interfaces */
 226
 227 #define ACPI_MTX_DO_NOT_LOCK            0
 228 #define ACPI_MTX_LOCK                   1
 229
 230
 231 /* Field access granularities */
 232
 233 #define ACPI_FIELD_BYTE_GRANULARITY     1
 234 #define ACPI_FIELD_WORD_GRANULARITY     2
 235 #define ACPI_FIELD_DWORD_GRANULARITY    4
 236 #define ACPI_FIELD_QWORD_GRANULARITY    8
 237
 238
 239 #define ACPI_ENTRY_NOT_FOUND            NULL
 240
 241
 242 /*****************************************************************************
 243  *
 244  * Namespace typedefs and structs
 245  *
 246  ****************************************************************************/
 247
 248 /* Operational modes of the AML interpreter/scanner */
 249
 250 typedef enum
 251 {
 252     ACPI_IMODE_LOAD_PASS1           = 0x01,
 253     ACPI_IMODE_LOAD_PASS2           = 0x02,
 254     ACPI_IMODE_EXECUTE              = 0x03
 255
 256 } ACPI_INTERPRETER_MODE;
 257
 258
 259 /*
 260  * The Namespace Node describes a named object that appears in the AML.
 261  * DescriptorType is used to differentiate between internal descriptors.
 262  *
 263  * The node is optimized for both 32-bit and 64-bit platforms:
 264  * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case.
 265  *
 266  * Note: The DescriptorType and Type fields must appear in the identical
 267  * position in both the ACPI_NAMESPACE_NODE and ACPI_OPERAND_OBJECT
 268  * structures.
 269  */
 270 typedef struct acpi_namespace_node
 271 {
 272     union acpi_operand_object       *Object;        /* Interpreter object */
 273     UINT8                           DescriptorType; /* Differentiate object descriptor types */
 274     UINT8                           Type;           /* ACPI Type associated with this name */
 275     UINT8                           Flags;          /* Miscellaneous flags */
 276     ACPI_OWNER_ID                   OwnerId;        /* Node creator */
 277     ACPI_NAME_UNION                 Name;           /* ACPI Name, always 4 chars per ACPI spec */
 278     struct acpi_namespace_node      *Child;         /* First child */
 279     struct acpi_namespace_node      *Peer;          /* Peer. Parent if ANOBJ_END_OF_PEER_LIST set */
 280
 281     /*
 282      * The following fields are used by the ASL compiler and disassembler only
 283      */
 284 #ifdef ACPI_LARGE_NAMESPACE_NODE
 285     union acpi_parse_object         *Op;
 286     UINT32                          Value;
 287     UINT32                          Length;
 288 #endif
 289
 290 } ACPI_NAMESPACE_NODE;
 291
 292
 293 /* Namespace Node flags */
 294
 295 #define ANOBJ_END_OF_PEER_LIST          0x01    /* End-of-list, Peer field points to parent */
 296 #define ANOBJ_TEMPORARY                 0x02    /* Node is create by a method and is temporary */
 297 #define ANOBJ_METHOD_ARG                0x04    /* Node is a method argument */
 298 #define ANOBJ_METHOD_LOCAL              0x08    /* Node is a method local */
 299 #define ANOBJ_SUBTREE_HAS_INI           0x10    /* Used to optimize device initialization */
 300 #define ANOBJ_EVALUATED                 0x20    /* Set on first evaluation of node */
 301 #define ANOBJ_ALLOCATED_BUFFER          0x40    /* Method AML buffer is dynamic (InstallMethod) */
 302
 303 #define ANOBJ_IS_EXTERNAL               0x08    /* iASL only: This object created via External() */
 304 #define ANOBJ_METHOD_NO_RETVAL          0x10    /* iASL only: Method has no return value */
 305 #define ANOBJ_METHOD_SOME_NO_RETVAL     0x20    /* iASL only: Method has at least one return value */
 306 #define ANOBJ_IS_BIT_OFFSET             0x40    /* iASL only: Reference is a bit offset */
 307 #define ANOBJ_IS_REFERENCED             0x80    /* iASL only: Object was referenced */
 308
 309
 310 /* One internal RSDT for table management */
 311
 312 typedef struct acpi_internal_rsdt
 313 {
 314     ACPI_TABLE_DESC                 *Tables;
 315     UINT32                          Count;
 316     UINT32                          Size;
 317     UINT8                           Flags;
 318
 319 } ACPI_INTERNAL_RSDT;
 320
 321 /* Flags for above */
 322
 323 #define ACPI_ROOT_ORIGIN_UNKNOWN        (0)     /* ~ORIGIN_ALLOCATED */
 324 #define ACPI_ROOT_ORIGIN_ALLOCATED      (1)
 325 #define ACPI_ROOT_ALLOW_RESIZE          (2)
 326
 327
 328 /* Predefined (fixed) table indexes */
 329
 330 #define ACPI_TABLE_INDEX_DSDT           (0)
 331 #define ACPI_TABLE_INDEX_FACS           (1)
 332
 333
 334 typedef struct acpi_find_context
 335 {
 336     char                            *SearchFor;
 337     ACPI_HANDLE                     *List;
 338     UINT32                          *Count;
 339
 340 } ACPI_FIND_CONTEXT;
 341
 342
 343 typedef struct acpi_ns_search_data
 344 {
 345     ACPI_NAMESPACE_NODE             *Node;
 346
 347 } ACPI_NS_SEARCH_DATA;
 348
 349
 350 /* Object types used during package copies */
 351
 352 #define ACPI_COPY_TYPE_SIMPLE           0
 353 #define ACPI_COPY_TYPE_PACKAGE          1
 354
 355
 356 /* Info structure used to convert external<->internal namestrings */
 357
 358 typedef struct acpi_namestring_info
 359 {
 360     const char                      *ExternalName;
 361     const char                      *NextExternalChar;
 362     char                            *InternalName;
 363     UINT32                          Length;
 364     UINT32                          NumSegments;
 365     UINT32                          NumCarats;
 366     BOOLEAN                         FullyQualified;
 367
 368 } ACPI_NAMESTRING_INFO;
 369
 370
 371 /* Field creation info */
 372
 373 typedef struct acpi_create_field_info
 374 {
 375     ACPI_NAMESPACE_NODE             *RegionNode;
 376     ACPI_NAMESPACE_NODE             *FieldNode;
 377     ACPI_NAMESPACE_NODE             *RegisterNode;
 378     ACPI_NAMESPACE_NODE             *DataRegisterNode;
 379     UINT32                          BankValue;
 380     UINT32                          FieldBitPosition;
 381     UINT32                          FieldBitLength;
 382     UINT8                           FieldFlags;
 383     UINT8                           Attribute;
 384     UINT8                           FieldType;
 385
 386 } ACPI_CREATE_FIELD_INFO;
 387
 388
 389 typedef
 390 ACPI_STATUS (*ACPI_INTERNAL_METHOD) (
 391     struct acpi_walk_state          *WalkState);
 392
 393
 394 /*
 395  * Bitmapped ACPI types.  Used internally only
 396  */
 397 #define ACPI_BTYPE_ANY                  0x00000000
 398 #define ACPI_BTYPE_INTEGER              0x00000001
 399 #define ACPI_BTYPE_STRING               0x00000002
 400 #define ACPI_BTYPE_BUFFER               0x00000004
 401 #define ACPI_BTYPE_PACKAGE              0x00000008
 402 #define ACPI_BTYPE_FIELD_UNIT           0x00000010
 403 #define ACPI_BTYPE_DEVICE               0x00000020
 404 #define ACPI_BTYPE_EVENT                0x00000040
 405 #define ACPI_BTYPE_METHOD               0x00000080
 406 #define ACPI_BTYPE_MUTEX                0x00000100
 407 #define ACPI_BTYPE_REGION               0x00000200
 408 #define ACPI_BTYPE_POWER                0x00000400
 409 #define ACPI_BTYPE_PROCESSOR            0x00000800
 410 #define ACPI_BTYPE_THERMAL              0x00001000
 411 #define ACPI_BTYPE_BUFFER_FIELD         0x00002000
 412 #define ACPI_BTYPE_DDB_HANDLE           0x00004000
 413 #define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
 414 #define ACPI_BTYPE_REFERENCE            0x00010000
 415 #define ACPI_BTYPE_RESOURCE             0x00020000
 416
 417 #define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
 418
 419 #define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
 420 #define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
 421 #define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
 422 #define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF  /* ARG or LOCAL */
 423 #define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
 424
 425
 426 /*
 427  * Information structure for ACPI predefined names.
 428  * Each entry in the table contains the following items:
 429  *
 430  * Name                 - The ACPI reserved name
 431  * ParamCount           - Number of arguments to the method
 432  * ExpectedReturnBtypes - Allowed type(s) for the return value
 433  */
 434 typedef struct acpi_name_info
 435 {
 436     char                        Name[ACPI_NAME_SIZE];
 437     UINT8                       ParamCount;
 438     UINT8                       ExpectedBtypes;
 439
 440 } ACPI_NAME_INFO;
 441
 442 /*
 443  * Secondary information structures for ACPI predefined objects that return
 444  * package objects. This structure appears as the next entry in the table
 445  * after the NAME_INFO structure above.
 446  *
 447  * The reason for this is to minimize the size of the predefined name table.
 448  */
 449
 450 /*
 451  * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2,
 452  * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT
 453  */
 454 typedef struct acpi_package_info
 455 {
 456     UINT8                       Type;
 457     UINT8                       ObjectType1;
 458     UINT8                       Count1;
 459     UINT8                       ObjectType2;
 460     UINT8                       Count2;
 461     UINT8                       Reserved;
 462
 463 } ACPI_PACKAGE_INFO;
 464
 465 /* Used for ACPI_PTYPE2_FIXED */
 466
 467 typedef struct acpi_package_info2
 468 {
 469     UINT8                       Type;
 470     UINT8                       Count;
 471     UINT8                       ObjectType[4];
 472
 473 } ACPI_PACKAGE_INFO2;
 474
 475 /* Used for ACPI_PTYPE1_OPTION */
 476
 477 typedef struct acpi_package_info3
 478 {
 479     UINT8                       Type;
 480     UINT8                       Count;
 481     UINT8                       ObjectType[2];
 482     UINT8                       TailObjectType;
 483     UINT8                       Reserved;
 484
 485 } ACPI_PACKAGE_INFO3;
 486
 487 typedef union acpi_predefined_info
 488 {
 489     ACPI_NAME_INFO              Info;
 490     ACPI_PACKAGE_INFO           RetInfo;
 491     ACPI_PACKAGE_INFO2          RetInfo2;
 492     ACPI_PACKAGE_INFO3          RetInfo3;
 493
 494 } ACPI_PREDEFINED_INFO;
 495
 496
 497 /* Data block used during object validation */
 498
 499 typedef struct acpi_predefined_data
 500 {
 501     char                        *Pathname;
 502     const ACPI_PREDEFINED_INFO  *Predefined;
 503     union acpi_operand_object   *ParentPackage;
 504     UINT32                      Flags;
 505     UINT8                       NodeFlags;
 506
 507 } ACPI_PREDEFINED_DATA;
 508
 509 /* Defines for Flags field above */
 510
 511 #define ACPI_OBJECT_REPAIRED    1
 512
 513
 514 /*
 515  * Bitmapped return value types
 516  * Note: the actual data types must be contiguous, a loop in nspredef.c
 517  * depends on this.
 518  */
 519 #define ACPI_RTYPE_ANY                  0x00
 520 #define ACPI_RTYPE_NONE                 0x01
 521 #define ACPI_RTYPE_INTEGER              0x02
 522 #define ACPI_RTYPE_STRING               0x04
 523 #define ACPI_RTYPE_BUFFER               0x08
 524 #define ACPI_RTYPE_PACKAGE              0x10
 525 #define ACPI_RTYPE_REFERENCE            0x20
 526 #define ACPI_RTYPE_ALL                  0x3F
 527
 528 #define ACPI_NUM_RTYPES                 5   /* Number of actual object types */
 529
 530
 531 /*****************************************************************************
 532  *
 533  * Event typedefs and structs
 534  *
 535  ****************************************************************************/
 536
 537 /* Dispatch info for each GPE -- either a method or handler, cannot be both */
 538
 539 typedef struct acpi_handler_info
 540 {
 541     ACPI_EVENT_HANDLER              Address;        /* Address of handler, if any */
 542     void                            *Context;       /* Context to be passed to handler */
 543     ACPI_NAMESPACE_NODE             *MethodNode;    /* Method node for this GPE level (saved) */
 544
 545 } ACPI_HANDLER_INFO;
 546
 547 typedef union acpi_gpe_dispatch_info
 548 {
 549     ACPI_NAMESPACE_NODE             *MethodNode;    /* Method node for this GPE level */
 550     struct acpi_handler_info        *Handler;
 551
 552 } ACPI_GPE_DISPATCH_INFO;
 553
 554 /*
 555  * Information about a GPE, one per each GPE in an array.
 556  * NOTE: Important to keep this struct as small as possible.
 557  */
 558 typedef struct acpi_gpe_event_info
 559 {
 560     union acpi_gpe_dispatch_info    Dispatch;       /* Either Method or Handler */
 561     struct acpi_gpe_register_info   *RegisterInfo;  /* Backpointer to register info */
 562     UINT8                           Flags;          /* Misc info about this GPE */
 563     UINT8                           GpeNumber;      /* This GPE */
 564     UINT8                           RuntimeCount;   /* References to a run GPE */
 565     UINT8                           WakeupCount;    /* References to a wake GPE */
 566
 567 } ACPI_GPE_EVENT_INFO;
 568
 569 /* Information about a GPE register pair, one per each status/enable pair in an array */
 570
 571 typedef struct acpi_gpe_register_info
 572 {
 573     ACPI_GENERIC_ADDRESS            StatusAddress;  /* Address of status reg */
 574     ACPI_GENERIC_ADDRESS            EnableAddress;  /* Address of enable reg */
 575     UINT8                           EnableForWake;  /* GPEs to keep enabled when sleeping */
 576     UINT8                           EnableForRun;   /* GPEs to keep enabled when running */
 577     UINT8                           BaseGpeNumber;  /* Base GPE number for this register */
 578
 579 } ACPI_GPE_REGISTER_INFO;
 580
 581 /*
 582  * Information about a GPE register block, one per each installed block --
 583  * GPE0, GPE1, and one per each installed GPE Block Device.
 584  */
 585 typedef struct acpi_gpe_block_info
 586 {
 587     ACPI_NAMESPACE_NODE             *Node;
 588     struct acpi_gpe_block_info      *Previous;
 589     struct acpi_gpe_block_info      *Next;
 590     struct acpi_gpe_xrupt_info      *XruptBlock;    /* Backpointer to interrupt block */
 591     ACPI_GPE_REGISTER_INFO          *RegisterInfo;  /* One per GPE register pair */
 592     ACPI_GPE_EVENT_INFO             *EventInfo;     /* One for each GPE */
 593     ACPI_GENERIC_ADDRESS            BlockAddress;   /* Base address of the block */
 594     UINT32                          RegisterCount;  /* Number of register pairs in block */
 595     UINT16                          GpeCount;       /* Number of individual GPEs in block */
 596     UINT8                           BlockBaseNumber;/* Base GPE number for this block */
 597
 598 } ACPI_GPE_BLOCK_INFO;
 599
 600 /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */
 601
 602 typedef struct acpi_gpe_xrupt_info
 603 {
 604     struct acpi_gpe_xrupt_info      *Previous;
 605     struct acpi_gpe_xrupt_info      *Next;
 606     ACPI_GPE_BLOCK_INFO             *GpeBlockListHead;  /* List of GPE blocks for this xrupt */
 607     UINT32                          InterruptNumber;    /* System interrupt number */
 608
 609 } ACPI_GPE_XRUPT_INFO;
 610
 611 typedef struct acpi_gpe_walk_info
 612 {
 613     ACPI_NAMESPACE_NODE             *GpeDevice;
 614     ACPI_GPE_BLOCK_INFO             *GpeBlock;
 615
 616 } ACPI_GPE_WALK_INFO;
 617
 618 typedef struct acpi_gpe_device_info
 619 {
 620     UINT32                          Index;
 621     UINT32                          NextBlockBaseIndex;
 622     ACPI_STATUS                     Status;
 623     ACPI_NAMESPACE_NODE             *GpeDevice;
 624
 625 } ACPI_GPE_DEVICE_INFO;
 626
 627 typedef ACPI_STATUS (*ACPI_GPE_CALLBACK) (
 628     ACPI_GPE_XRUPT_INFO             *GpeXruptInfo,
 629     ACPI_GPE_BLOCK_INFO             *GpeBlock,
 630     void                            *Context);
 631
 632
 633 /* Information about each particular fixed event */
 634
 635 typedef struct acpi_fixed_event_handler
 636 {
 637     ACPI_EVENT_HANDLER              Handler;        /* Address of handler. */
 638     void                            *Context;       /* Context to be passed to handler */
 639
 640 } ACPI_FIXED_EVENT_HANDLER;
 641
 642 typedef struct acpi_fixed_event_info
 643 {
 644     UINT8                           StatusRegisterId;
 645     UINT8                           EnableRegisterId;
 646     UINT16                          StatusBitMask;
 647     UINT16                          EnableBitMask;
 648
 649 } ACPI_FIXED_EVENT_INFO;
 650
 651 /* Information used during field processing */
 652
 653 typedef struct acpi_field_info
 654 {
 655     UINT8                           SkipField;
 656     UINT8                           FieldFlag;
 657     UINT32                          PkgLength;
 658
 659 } ACPI_FIELD_INFO;
 660
 661
 662 /*****************************************************************************
 663  *
 664  * Generic "state" object for stacks
 665  *
 666  ****************************************************************************/
 667
 668 #define ACPI_CONTROL_NORMAL                  0xC0
 669 #define ACPI_CONTROL_CONDITIONAL_EXECUTING   0xC1
 670 #define ACPI_CONTROL_PREDICATE_EXECUTING     0xC2
 671 #define ACPI_CONTROL_PREDICATE_FALSE         0xC3
 672 #define ACPI_CONTROL_PREDICATE_TRUE          0xC4
 673
 674
 675 #define ACPI_STATE_COMMON \
 676     void                            *Next; \
 677     UINT8                           DescriptorType; /* To differentiate various internal objs */\
 678     UINT8                           Flags; \
 679     UINT16                          Value; \
 680     UINT16                          State;
 681
 682     /* There are 2 bytes available here until the next natural alignment boundary */
 683
 684 typedef struct acpi_common_state
 685 {
 686     ACPI_STATE_COMMON
 687 } ACPI_COMMON_STATE;
 688
 689
 690 /*
 691  * Update state - used to traverse complex objects such as packages
 692  */
 693 typedef struct acpi_update_state
 694 {
 695     ACPI_STATE_COMMON
 696     union acpi_operand_object       *Object;
 697
 698 } ACPI_UPDATE_STATE;
 699
 700
 701 /*
 702  * Pkg state - used to traverse nested package structures
 703  */
 704 typedef struct acpi_pkg_state
 705 {
 706     ACPI_STATE_COMMON
 707     UINT16                          Index;
 708     union acpi_operand_object       *SourceObject;
 709     union acpi_operand_object       *DestObject;
 710     struct acpi_walk_state          *WalkState;
 711     void                            *ThisTargetObj;
 712     UINT32                          NumPackages;
 713
 714 } ACPI_PKG_STATE;
 715
 716
 717 /*
 718  * Control state - one per if/else and while constructs.
 719  * Allows nesting of these constructs
 720  */
 721 typedef struct acpi_control_state
 722 {
 723     ACPI_STATE_COMMON
 724     UINT16                          Opcode;
 725     union acpi_parse_object         *PredicateOp;
 726     UINT8                           *AmlPredicateStart;     /* Start of if/while predicate */
 727     UINT8                           *PackageEnd;            /* End of if/while block */
 728     UINT32                          LoopCount;              /* While() loop counter */
 729
 730 } ACPI_CONTROL_STATE;
 731
 732
 733 /*
 734  * Scope state - current scope during namespace lookups
 735  */
 736 typedef struct acpi_scope_state
 737 {
 738     ACPI_STATE_COMMON
 739     ACPI_NAMESPACE_NODE             *Node;
 740
 741 } ACPI_SCOPE_STATE;
 742
 743
 744 typedef struct acpi_pscope_state
 745 {
 746     ACPI_STATE_COMMON
 747     UINT32                          ArgCount;               /* Number of fixed arguments */
 748     union acpi_parse_object         *Op;                    /* Current op being parsed */
 749     UINT8                           *ArgEnd;                /* Current argument end */
 750     UINT8                           *PkgEnd;                /* Current package end */
 751     UINT32                          ArgList;                /* Next argument to parse */
 752
 753 } ACPI_PSCOPE_STATE;
 754
 755
 756 /*
 757  * Thread state - one per thread across multiple walk states.  Multiple walk
 758  * states are created when there are nested control methods executing.
 759  */
 760 typedef struct acpi_thread_state
 761 {
 762     ACPI_STATE_COMMON
 763     UINT8                           CurrentSyncLevel;       /* Mutex Sync (nested acquire) level */
 764     struct acpi_walk_state          *WalkStateList;         /* Head of list of WalkStates for this thread */
 765     union acpi_operand_object       *AcquiredMutexList;     /* List of all currently acquired mutexes */
 766     ACPI_THREAD_ID                  ThreadId;               /* Running thread ID */
 767
 768 } ACPI_THREAD_STATE;
 769
 770
 771 /*
 772  * Result values - used to accumulate the results of nested
 773  * AML arguments
 774  */
 775 typedef struct acpi_result_values
 776 {
 777     ACPI_STATE_COMMON
 778     union acpi_operand_object       *ObjDesc [ACPI_RESULTS_FRAME_OBJ_NUM];
 779
 780 } ACPI_RESULT_VALUES;
 781
 782
 783 typedef
 784 ACPI_STATUS (*ACPI_PARSE_DOWNWARDS) (
 785     struct acpi_walk_state          *WalkState,
 786     union acpi_parse_object         **OutOp);
 787
 788 typedef
 789 ACPI_STATUS (*ACPI_PARSE_UPWARDS) (
 790     struct acpi_walk_state          *WalkState);
 791
 792
 793 /*
 794  * Notify info - used to pass info to the deferred notify
 795  * handler/dispatcher.
 796  */
 797 typedef struct acpi_notify_info
 798 {
 799     ACPI_STATE_COMMON
 800     ACPI_NAMESPACE_NODE             *Node;
 801     union acpi_operand_object       *HandlerObj;
 802
 803 } ACPI_NOTIFY_INFO;
 804
 805
 806 /* Generic state is union of structs above */
 807
 808 typedef union acpi_generic_state
 809 {
 810     ACPI_COMMON_STATE               Common;
 811     ACPI_CONTROL_STATE              Control;
 812     ACPI_UPDATE_STATE               Update;
 813     ACPI_SCOPE_STATE                Scope;
 814     ACPI_PSCOPE_STATE               ParseScope;
 815     ACPI_PKG_STATE                  Pkg;
 816     ACPI_THREAD_STATE               Thread;
 817     ACPI_RESULT_VALUES              Results;
 818     ACPI_NOTIFY_INFO                Notify;
 819
 820 } ACPI_GENERIC_STATE;
 821
 822
 823 /*****************************************************************************
 824  *
 825  * Interpreter typedefs and structs
 826  *
 827  ****************************************************************************/
 828
 829 typedef
 830 ACPI_STATUS (*ACPI_EXECUTE_OP) (
 831     struct acpi_walk_state          *WalkState);
 832
 833
 834 /*****************************************************************************
 835  *
 836  * Parser typedefs and structs
 837  *
 838  ****************************************************************************/
 839
 840 /*
 841  * AML opcode, name, and argument layout
 842  */
 843 typedef struct acpi_opcode_info
 844 {
 845 #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT)
 846     char                            *Name;          /* Opcode name (disassembler/debug only) */
 847 #endif
 848     UINT32                          ParseArgs;      /* Grammar/Parse time arguments */
 849     UINT32                          RuntimeArgs;    /* Interpret time arguments */
 850     UINT16                          Flags;          /* Misc flags */
 851     UINT8                           ObjectType;     /* Corresponding internal object type */
 852     UINT8                           Class;          /* Opcode class */
 853     UINT8                           Type;           /* Opcode type */
 854
 855 } ACPI_OPCODE_INFO;
 856
 857 typedef union acpi_parse_value
 858 {
 859     UINT64                          Integer;        /* Integer constant (Up to 64 bits) */
 860     UINT32                          Size;           /* bytelist or field size */
 861     char                            *String;        /* NULL terminated string */
 862     UINT8                           *Buffer;        /* buffer or string */
 863     char                            *Name;          /* NULL terminated string */
 864     union acpi_parse_object         *Arg;           /* arguments and contained ops */
 865
 866 } ACPI_PARSE_VALUE;
 867
 868
 869 #ifdef ACPI_DISASSEMBLER
 870 #define ACPI_DISASM_ONLY_MEMBERS(a)     a;
 871 #else
 872 #define ACPI_DISASM_ONLY_MEMBERS(a)
 873 #endif
 874
 875 #define ACPI_PARSE_COMMON \
 876     union acpi_parse_object         *Parent;        /* Parent op */\
 877     UINT8                           DescriptorType; /* To differentiate various internal objs */\
 878     UINT8                           Flags;          /* Type of Op */\
 879     UINT16                          AmlOpcode;      /* AML opcode */\
 880     UINT32                          AmlOffset;      /* Offset of declaration in AML */\
 881     union acpi_parse_object         *Next;          /* Next op */\
 882     ACPI_NAMESPACE_NODE             *Node;          /* For use by interpreter */\
 883     ACPI_PARSE_VALUE                Value;          /* Value or args associated with the opcode */\
 884     UINT8                           ArgListLength;  /* Number of elements in the arg list */\
 885     ACPI_DISASM_ONLY_MEMBERS (\
 886     UINT8                           DisasmFlags;    /* Used during AML disassembly */\
 887     UINT8                           DisasmOpcode;   /* Subtype used for disassembly */\
 888     char                            AmlOpName[16])  /* Op name (debug only) */
 889
 890
 891 #define ACPI_DASM_BUFFER                0x00
 892 #define ACPI_DASM_RESOURCE              0x01
 893 #define ACPI_DASM_STRING                0x02
 894 #define ACPI_DASM_UNICODE               0x03
 895 #define ACPI_DASM_EISAID                0x04
 896 #define ACPI_DASM_MATCHOP               0x05
 897 #define ACPI_DASM_LNOT_PREFIX           0x06
 898 #define ACPI_DASM_LNOT_SUFFIX           0x07
 899 #define ACPI_DASM_IGNORE                0x08
 900
 901 /*
 902  * Generic operation (for example:  If, While, Store)
 903  */
 904 typedef struct acpi_parse_obj_common
 905 {
 906     ACPI_PARSE_COMMON
 907 } ACPI_PARSE_OBJ_COMMON;
 908
 909
 910 /*
 911  * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and OpRegions),
 912  * and bytelists.
 913  */
 914 typedef struct acpi_parse_obj_named
 915 {
 916     ACPI_PARSE_COMMON
 917     UINT8                           *Path;
 918     UINT8                           *Data;          /* AML body or bytelist data */
 919     UINT32                          Length;         /* AML length */
 920     UINT32                          Name;           /* 4-byte name or zero if no name */
 921
 922 } ACPI_PARSE_OBJ_NAMED;
 923
 924
 925 /* This version is used by the iASL compiler only */
 926
 927 #define ACPI_MAX_PARSEOP_NAME   20
 928
 929 typedef struct acpi_parse_obj_asl
 930 {
 931     ACPI_PARSE_COMMON
 932     union acpi_parse_object         *Child;
 933     union acpi_parse_object         *ParentMethod;
 934     char                            *Filename;
 935     char                            *ExternalName;
 936     char                            *Namepath;
 937     char                            NameSeg[4];
 938     UINT32                          ExtraValue;
 939     UINT32                          Column;
 940     UINT32                          LineNumber;
 941     UINT32                          LogicalLineNumber;
 942     UINT32                          LogicalByteOffset;
 943     UINT32                          EndLine;
 944     UINT32                          EndLogicalLine;
 945     UINT32                          AcpiBtype;
 946     UINT32                          AmlLength;
 947     UINT32                          AmlSubtreeLength;
 948     UINT32                          FinalAmlLength;
 949     UINT32                          FinalAmlOffset;
 950     UINT32                          CompileFlags;
 951     UINT16                          ParseOpcode;
 952     UINT8                           AmlOpcodeLength;
 953     UINT8                           AmlPkgLenBytes;
 954     UINT8                           Extra;
 955     char                            ParseOpName[ACPI_MAX_PARSEOP_NAME];
 956
 957 } ACPI_PARSE_OBJ_ASL;
 958
 959 typedef union acpi_parse_object
 960 {
 961     ACPI_PARSE_OBJ_COMMON           Common;
 962     ACPI_PARSE_OBJ_NAMED            Named;
 963     ACPI_PARSE_OBJ_ASL              Asl;
 964
 965 } ACPI_PARSE_OBJECT;
 966
 967
 968 /*
 969  * Parse state - one state per parser invocation and each control
 970  * method.
 971  */
 972 typedef struct acpi_parse_state
 973 {
 974     UINT8                           *AmlStart;      /* First AML byte */
 975     UINT8                           *Aml;           /* Next AML byte */
 976     UINT8                           *AmlEnd;        /* (last + 1) AML byte */
 977     UINT8                           *PkgStart;      /* Current package begin */
 978     UINT8                           *PkgEnd;        /* Current package end */
 979     union acpi_parse_object         *StartOp;       /* Root of parse tree */
 980     struct acpi_namespace_node      *StartNode;
 981     union acpi_generic_state        *Scope;         /* Current scope */
 982     union acpi_parse_object         *StartScope;
 983     UINT32                          AmlSize;
 984
 985 } ACPI_PARSE_STATE;
 986
 987
 988 /* Parse object flags */
 989
 990 #define ACPI_PARSEOP_GENERIC            0x01
 991 #define ACPI_PARSEOP_NAMED              0x02
 992 #define ACPI_PARSEOP_DEFERRED           0x04
 993 #define ACPI_PARSEOP_BYTELIST           0x08
 994 #define ACPI_PARSEOP_IN_STACK           0x10
 995 #define ACPI_PARSEOP_TARGET             0x20
 996 #define ACPI_PARSEOP_IN_CACHE           0x80
 997
 998 /* Parse object DisasmFlags */
 999
1000 #define ACPI_PARSEOP_IGNORE             0x01
1001 #define ACPI_PARSEOP_PARAMLIST          0x02
1002 #define ACPI_PARSEOP_EMPTY_TERMLIST     0x04
1003 #define ACPI_PARSEOP_SPECIAL            0x10
1004
1005
1006 /*****************************************************************************
1007  *
1008  * Hardware (ACPI registers) and PNP
1009  *
1010  ****************************************************************************/
1011
1012 typedef struct acpi_bit_register_info
1013 {
1014     UINT8                           ParentRegister;
1015     UINT8                           BitPosition;
1016     UINT16                          AccessBitMask;
1017
1018 } ACPI_BIT_REGISTER_INFO;
1019
1020
1021 /*
1022  * Some ACPI registers have bits that must be ignored -- meaning that they
1023  * must be preserved.
1024  */
1025 #define ACPI_PM1_STATUS_PRESERVED_BITS          0x0800  /* Bit 11 */
1026
1027 /* Write-only bits must be zeroed by software */
1028
1029 #define ACPI_PM1_CONTROL_WRITEONLY_BITS         0x2004  /* Bits 13, 2 */
1030
1031 /* For control registers, both ignored and reserved bits must be preserved */
1032
1033 /*
1034  * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the
1035  * ACPI specification to be a "preserved" bit - "OSPM always preserves this
1036  * bit position", section 4.7.3.2.1. However, on some machines the OS must
1037  * write a one to this bit after resume for the machine to work properly.
1038  * To enable this, we no longer attempt to preserve this bit. No machines
1039  * are known to fail if the bit is not preserved. (May 2009)
1040  */
1041 #define ACPI_PM1_CONTROL_IGNORED_BITS           0x0200  /* Bit 9 */
1042 #define ACPI_PM1_CONTROL_RESERVED_BITS          0xC1F8  /* Bits 14-15, 3-8 */
1043 #define ACPI_PM1_CONTROL_PRESERVED_BITS \
1044          (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS)
1045
1046 #define ACPI_PM2_CONTROL_PRESERVED_BITS         0xFFFFFFFE /* All except bit 0 */
1047
1048 /*
1049  * Register IDs
1050  * These are the full ACPI registers
1051  */
1052 #define ACPI_REGISTER_PM1_STATUS                0x01
1053 #define ACPI_REGISTER_PM1_ENABLE                0x02
1054 #define ACPI_REGISTER_PM1_CONTROL               0x03
1055 #define ACPI_REGISTER_PM2_CONTROL               0x04
1056 #define ACPI_REGISTER_PM_TIMER                  0x05
1057 #define ACPI_REGISTER_PROCESSOR_BLOCK           0x06
1058 #define ACPI_REGISTER_SMI_COMMAND_BLOCK         0x07
1059
1060
1061 /* Masks used to access the BitRegisters */
1062
1063 #define ACPI_BITMASK_TIMER_STATUS               0x0001
1064 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
1065 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
1066 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
1067 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
1068 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
1069 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000    /* ACPI 3.0 */
1070 #define ACPI_BITMASK_WAKE_STATUS                0x8000
1071
1072 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
1073     ACPI_BITMASK_TIMER_STATUS          | \
1074     ACPI_BITMASK_BUS_MASTER_STATUS     | \
1075     ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
1076     ACPI_BITMASK_POWER_BUTTON_STATUS   | \
1077     ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
1078     ACPI_BITMASK_RT_CLOCK_STATUS       | \
1079     ACPI_BITMASK_WAKE_STATUS)
1080
1081 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
1082 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
1083 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
1084 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
1085 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
1086 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000    /* ACPI 3.0 */
1087
1088 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
1089 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
1090 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
1091 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
1092 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
1093
1094 #define ACPI_BITMASK_ARB_DISABLE                0x0001
1095
1096
1097 /* Raw bit position of each BitRegister */
1098
1099 #define ACPI_BITPOSITION_TIMER_STATUS           0x00
1100 #define ACPI_BITPOSITION_BUS_MASTER_STATUS      0x04
1101 #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS     0x05
1102 #define ACPI_BITPOSITION_POWER_BUTTON_STATUS    0x08
1103 #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS    0x09
1104 #define ACPI_BITPOSITION_RT_CLOCK_STATUS        0x0A
1105 #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS     0x0E    /* ACPI 3.0 */
1106 #define ACPI_BITPOSITION_WAKE_STATUS            0x0F
1107
1108 #define ACPI_BITPOSITION_TIMER_ENABLE           0x00
1109 #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE     0x05
1110 #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE    0x08
1111 #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE    0x09
1112 #define ACPI_BITPOSITION_RT_CLOCK_ENABLE        0x0A
1113 #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE    0x0E    /* ACPI 3.0 */
1114
1115 #define ACPI_BITPOSITION_SCI_ENABLE             0x00
1116 #define ACPI_BITPOSITION_BUS_MASTER_RLD         0x01
1117 #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE    0x02
1118 #define ACPI_BITPOSITION_SLEEP_TYPE             0x0A
1119 #define ACPI_BITPOSITION_SLEEP_ENABLE           0x0D
1120
1121 #define ACPI_BITPOSITION_ARB_DISABLE            0x00
1122
1123
1124 /* Structs and definitions for _OSI support and I/O port validation */
1125
1126 #define ACPI_OSI_WIN_2000               0x01
1127 #define ACPI_OSI_WIN_XP                 0x02
1128 #define ACPI_OSI_WIN_XP_SP1             0x03
1129 #define ACPI_OSI_WINSRV_2003            0x04
1130 #define ACPI_OSI_WIN_XP_SP2             0x05
1131 #define ACPI_OSI_WINSRV_2003_SP1        0x06
1132 #define ACPI_OSI_WIN_VISTA              0x07
1133 #define ACPI_OSI_WINSRV_2008            0x08
1134 #define ACPI_OSI_WIN_VISTA_SP1          0x09
1135 #define ACPI_OSI_WIN_7                  0x0A
1136
1137 #define ACPI_ALWAYS_ILLEGAL             0x00
1138
1139 typedef struct acpi_interface_info
1140 {
1141     char                    *Name;
1142     UINT8                   Value;
1143
1144 } ACPI_INTERFACE_INFO;
1145
1146 typedef struct acpi_port_info
1147 {
1148     char                    *Name;
1149     UINT16                  Start;
1150     UINT16                  End;
1151     UINT8                   OsiDependency;
1152
1153 } ACPI_PORT_INFO;
1154
1155
1156 /*****************************************************************************
1157  *
1158  * Resource descriptors
1159  *
1160  ****************************************************************************/
1161
1162 /* ResourceType values */
1163
1164 #define ACPI_ADDRESS_TYPE_MEMORY_RANGE          0
1165 #define ACPI_ADDRESS_TYPE_IO_RANGE              1
1166 #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE      2
1167
1168 /* Resource descriptor types and masks */
1169
1170 #define ACPI_RESOURCE_NAME_LARGE                0x80
1171 #define ACPI_RESOURCE_NAME_SMALL                0x00
1172
1173 #define ACPI_RESOURCE_NAME_SMALL_MASK           0x78 /* Bits 6:3 contain the type */
1174 #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK    0x07 /* Bits 2:0 contain the length */
1175 #define ACPI_RESOURCE_NAME_LARGE_MASK           0x7F /* Bits 6:0 contain the type */
1176
1177
1178 /*
1179  * Small resource descriptor "names" as defined by the ACPI specification.
1180  * Note: Bits 2:0 are used for the descriptor length
1181  */
1182 #define ACPI_RESOURCE_NAME_IRQ                  0x20
1183 #define ACPI_RESOURCE_NAME_DMA                  0x28
1184 #define ACPI_RESOURCE_NAME_START_DEPENDENT      0x30
1185 #define ACPI_RESOURCE_NAME_END_DEPENDENT        0x38
1186 #define ACPI_RESOURCE_NAME_IO                   0x40
1187 #define ACPI_RESOURCE_NAME_FIXED_IO             0x48
1188 #define ACPI_RESOURCE_NAME_RESERVED_S1          0x50
1189 #define ACPI_RESOURCE_NAME_RESERVED_S2          0x58
1190 #define ACPI_RESOURCE_NAME_RESERVED_S3          0x60
1191 #define ACPI_RESOURCE_NAME_RESERVED_S4          0x68
1192 #define ACPI_RESOURCE_NAME_VENDOR_SMALL         0x70
1193 #define ACPI_RESOURCE_NAME_END_TAG              0x78
1194
1195 /*
1196  * Large resource descriptor "names" as defined by the ACPI specification.
1197  * Note: includes the Large Descriptor bit in bit[7]
1198  */
1199 #define ACPI_RESOURCE_NAME_MEMORY24             0x81
1200 #define ACPI_RESOURCE_NAME_GENERIC_REGISTER     0x82
1201 #define ACPI_RESOURCE_NAME_RESERVED_L1          0x83
1202 #define ACPI_RESOURCE_NAME_VENDOR_LARGE         0x84
1203 #define ACPI_RESOURCE_NAME_MEMORY32             0x85
1204 #define ACPI_RESOURCE_NAME_FIXED_MEMORY32       0x86
1205 #define ACPI_RESOURCE_NAME_ADDRESS32            0x87
1206 #define ACPI_RESOURCE_NAME_ADDRESS16            0x88
1207 #define ACPI_RESOURCE_NAME_EXTENDED_IRQ         0x89
1208 #define ACPI_RESOURCE_NAME_ADDRESS64            0x8A
1209 #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64   0x8B
1210 #define ACPI_RESOURCE_NAME_LARGE_MAX            0x8B
1211
1212
1213 /*****************************************************************************
1214  *
1215  * Miscellaneous
1216  *
1217  ****************************************************************************/
1218
1219 #define ACPI_ASCII_ZERO                 0x30
1220
1221
1222 /*****************************************************************************
1223  *
1224  * Disassembler
1225  *
1226  ****************************************************************************/
1227
1228 typedef struct acpi_external_list
1229 {
1230     char                        *Path;
1231     char                        *InternalPath;
1232     struct acpi_external_list   *Next;
1233     UINT32                      Value;
1234     UINT16                      Length;
1235     UINT8                       Type;
1236     UINT8                       Flags;
1237
1238 } ACPI_EXTERNAL_LIST;
1239
1240 /* Values for Flags field above */
1241
1242 #define ACPI_IPATH_ALLOCATED    0x01
1243
1244
1245 /*****************************************************************************
1246  *
1247  * Debugger
1248  *
1249  ****************************************************************************/
1250
1251 typedef struct acpi_db_method_info
1252 {
1253     ACPI_HANDLE                     MainThreadGate;
1254     ACPI_HANDLE                     ThreadCompleteGate;
1255     ACPI_HANDLE                     InfoGate;
1256     UINT32                          *Threads;
1257     UINT32                          NumThreads;
1258     UINT32                          NumCreated;
1259     UINT32                          NumCompleted;
1260
1261     char                            *Name;
1262     UINT32                          Flags;
1263     UINT32                          NumLoops;
1264     char                            Pathname[128];
1265     char                            **Args;
1266
1267     /*
1268      * Arguments to be passed to method for the command
1269      * Threads -
1270      *   the Number of threads, ID of current thread and
1271      *   Index of current thread inside all them created.
1272      */
1273     char                            InitArgs;
1274     char                            *Arguments[4];
1275     char                            NumThreadsStr[11];
1276     char                            IdOfThreadStr[11];
1277     char                            IndexOfThreadStr[11];
1278
1279 } ACPI_DB_METHOD_INFO;
1280
1281 typedef struct acpi_integrity_info
1282 {
1283     UINT32                          Nodes;
1284     UINT32                          Objects;
1285
1286 } ACPI_INTEGRITY_INFO;
1287
1288
1289 #define ACPI_DB_REDIRECTABLE_OUTPUT     0x01
1290 #define ACPI_DB_CONSOLE_OUTPUT          0x02
1291 #define ACPI_DB_DUPLICATE_OUTPUT        0x03
1292
1293
1294 /*****************************************************************************
1295  *
1296  * Debug
1297  *
1298  ****************************************************************************/
1299
1300 /* Entry for a memory allocation (debug only) */
1301
1302 #define ACPI_MEM_MALLOC                 0
1303 #define ACPI_MEM_CALLOC                 1
1304 #define ACPI_MAX_MODULE_NAME            16
1305
1306 #define ACPI_COMMON_DEBUG_MEM_HEADER \
1307     struct acpi_debug_mem_block     *Previous; \
1308     struct acpi_debug_mem_block     *Next; \
1309     UINT32                          Size; \
1310     UINT32                          Component; \
1311     UINT32                          Line; \
1312     char                            Module[ACPI_MAX_MODULE_NAME]; \
1313     UINT8                           AllocType;
1314
1315 typedef struct acpi_debug_mem_header
1316 {
1317     ACPI_COMMON_DEBUG_MEM_HEADER
1318
1319 } ACPI_DEBUG_MEM_HEADER;
1320
1321 typedef struct acpi_debug_mem_block
1322 {
1323     ACPI_COMMON_DEBUG_MEM_HEADER
1324     UINT64                          UserSpace;
1325
1326 } ACPI_DEBUG_MEM_BLOCK;
1327
1328
1329 #define ACPI_MEM_LIST_GLOBAL            0
1330 #define ACPI_MEM_LIST_NSNODE            1
1331 #define ACPI_MEM_LIST_MAX               1
1332 #define ACPI_NUM_MEM_LISTS              2
1333
1334
1335 #endif /* __ACLOCAL_H__ */