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