Home | History | Annotate | Line # | Download | only in include
acstruct.h revision 1.1.1.2.8.2
      1  1.1.1.2.8.2  jruoho /******************************************************************************
      2  1.1.1.2.8.2  jruoho  *
      3  1.1.1.2.8.2  jruoho  * Name: acstruct.h - Internal structs
      4  1.1.1.2.8.2  jruoho  *
      5  1.1.1.2.8.2  jruoho  *****************************************************************************/
      6  1.1.1.2.8.2  jruoho 
      7  1.1.1.2.8.2  jruoho /*
      8  1.1.1.2.8.2  jruoho  * Copyright (C) 2000 - 2011, Intel Corp.
      9  1.1.1.2.8.2  jruoho  * All rights reserved.
     10  1.1.1.2.8.2  jruoho  *
     11  1.1.1.2.8.2  jruoho  * Redistribution and use in source and binary forms, with or without
     12  1.1.1.2.8.2  jruoho  * modification, are permitted provided that the following conditions
     13  1.1.1.2.8.2  jruoho  * are met:
     14  1.1.1.2.8.2  jruoho  * 1. Redistributions of source code must retain the above copyright
     15  1.1.1.2.8.2  jruoho  *    notice, this list of conditions, and the following disclaimer,
     16  1.1.1.2.8.2  jruoho  *    without modification.
     17  1.1.1.2.8.2  jruoho  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18  1.1.1.2.8.2  jruoho  *    substantially similar to the "NO WARRANTY" disclaimer below
     19  1.1.1.2.8.2  jruoho  *    ("Disclaimer") and any redistribution must be conditioned upon
     20  1.1.1.2.8.2  jruoho  *    including a substantially similar Disclaimer requirement for further
     21  1.1.1.2.8.2  jruoho  *    binary redistribution.
     22  1.1.1.2.8.2  jruoho  * 3. Neither the names of the above-listed copyright holders nor the names
     23  1.1.1.2.8.2  jruoho  *    of any contributors may be used to endorse or promote products derived
     24  1.1.1.2.8.2  jruoho  *    from this software without specific prior written permission.
     25  1.1.1.2.8.2  jruoho  *
     26  1.1.1.2.8.2  jruoho  * Alternatively, this software may be distributed under the terms of the
     27  1.1.1.2.8.2  jruoho  * GNU General Public License ("GPL") version 2 as published by the Free
     28  1.1.1.2.8.2  jruoho  * Software Foundation.
     29  1.1.1.2.8.2  jruoho  *
     30  1.1.1.2.8.2  jruoho  * NO WARRANTY
     31  1.1.1.2.8.2  jruoho  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32  1.1.1.2.8.2  jruoho  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33  1.1.1.2.8.2  jruoho  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34  1.1.1.2.8.2  jruoho  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35  1.1.1.2.8.2  jruoho  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36  1.1.1.2.8.2  jruoho  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37  1.1.1.2.8.2  jruoho  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38  1.1.1.2.8.2  jruoho  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39  1.1.1.2.8.2  jruoho  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40  1.1.1.2.8.2  jruoho  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41  1.1.1.2.8.2  jruoho  * POSSIBILITY OF SUCH DAMAGES.
     42  1.1.1.2.8.2  jruoho  */
     43  1.1.1.2.8.2  jruoho 
     44  1.1.1.2.8.2  jruoho #ifndef __ACSTRUCT_H__
     45  1.1.1.2.8.2  jruoho #define __ACSTRUCT_H__
     46  1.1.1.2.8.2  jruoho 
     47  1.1.1.2.8.2  jruoho /* acpisrc:StructDefs -- for acpisrc conversion */
     48  1.1.1.2.8.2  jruoho 
     49  1.1.1.2.8.2  jruoho /*****************************************************************************
     50  1.1.1.2.8.2  jruoho  *
     51  1.1.1.2.8.2  jruoho  * Tree walking typedefs and structs
     52  1.1.1.2.8.2  jruoho  *
     53  1.1.1.2.8.2  jruoho  ****************************************************************************/
     54  1.1.1.2.8.2  jruoho 
     55  1.1.1.2.8.2  jruoho 
     56  1.1.1.2.8.2  jruoho /*
     57  1.1.1.2.8.2  jruoho  * Walk state - current state of a parse tree walk.  Used for both a leisurely
     58  1.1.1.2.8.2  jruoho  * stroll through the tree (for whatever reason), and for control method
     59  1.1.1.2.8.2  jruoho  * execution.
     60  1.1.1.2.8.2  jruoho  */
     61  1.1.1.2.8.2  jruoho #define ACPI_NEXT_OP_DOWNWARD       1
     62  1.1.1.2.8.2  jruoho #define ACPI_NEXT_OP_UPWARD         2
     63  1.1.1.2.8.2  jruoho 
     64  1.1.1.2.8.2  jruoho /*
     65  1.1.1.2.8.2  jruoho  * Groups of definitions for WalkType used for different implementations of
     66  1.1.1.2.8.2  jruoho  * walkers (never simultaneously) - flags for interpreter:
     67  1.1.1.2.8.2  jruoho  */
     68  1.1.1.2.8.2  jruoho #define ACPI_WALK_NON_METHOD        0
     69  1.1.1.2.8.2  jruoho #define ACPI_WALK_METHOD            0x01
     70  1.1.1.2.8.2  jruoho #define ACPI_WALK_METHOD_RESTART    0x02
     71  1.1.1.2.8.2  jruoho 
     72  1.1.1.2.8.2  jruoho /* Flags for iASL compiler only */
     73  1.1.1.2.8.2  jruoho 
     74  1.1.1.2.8.2  jruoho #define ACPI_WALK_CONST_REQUIRED    0x10
     75  1.1.1.2.8.2  jruoho #define ACPI_WALK_CONST_OPTIONAL    0x20
     76  1.1.1.2.8.2  jruoho 
     77  1.1.1.2.8.2  jruoho 
     78  1.1.1.2.8.2  jruoho typedef struct acpi_walk_state
     79  1.1.1.2.8.2  jruoho {
     80  1.1.1.2.8.2  jruoho     struct acpi_walk_state          *Next;              /* Next WalkState in list */
     81  1.1.1.2.8.2  jruoho     UINT8                           DescriptorType;     /* To differentiate various internal objs */
     82  1.1.1.2.8.2  jruoho     UINT8                           WalkType;
     83  1.1.1.2.8.2  jruoho     UINT16                          Opcode;             /* Current AML opcode */
     84  1.1.1.2.8.2  jruoho     UINT8                           NextOpInfo;         /* Info about NextOp */
     85  1.1.1.2.8.2  jruoho     UINT8                           NumOperands;        /* Stack pointer for Operands[] array */
     86  1.1.1.2.8.2  jruoho     UINT8                           OperandIndex;       /* Index into operand stack, to be used by AcpiDsObjStackPush */
     87  1.1.1.2.8.2  jruoho     ACPI_OWNER_ID                   OwnerId;            /* Owner of objects created during the walk */
     88  1.1.1.2.8.2  jruoho     BOOLEAN                         LastPredicate;      /* Result of last predicate */
     89  1.1.1.2.8.2  jruoho     UINT8                           CurrentResult;
     90  1.1.1.2.8.2  jruoho     UINT8                           ReturnUsed;
     91  1.1.1.2.8.2  jruoho     UINT8                           ScopeDepth;
     92  1.1.1.2.8.2  jruoho     UINT8                           PassNumber;         /* Parse pass during table load */
     93  1.1.1.2.8.2  jruoho     UINT8                           ResultSize;         /* Total elements for the result stack */
     94  1.1.1.2.8.2  jruoho     UINT8                           ResultCount;        /* Current number of occupied elements of result stack */
     95  1.1.1.2.8.2  jruoho     UINT32                          AmlOffset;
     96  1.1.1.2.8.2  jruoho     UINT32                          ArgTypes;
     97  1.1.1.2.8.2  jruoho     UINT32                          MethodBreakpoint;   /* For single stepping */
     98  1.1.1.2.8.2  jruoho     UINT32                          UserBreakpoint;     /* User AML breakpoint */
     99  1.1.1.2.8.2  jruoho     UINT32                          ParseFlags;
    100  1.1.1.2.8.2  jruoho 
    101  1.1.1.2.8.2  jruoho     ACPI_PARSE_STATE                ParserState;        /* Current state of parser */
    102  1.1.1.2.8.2  jruoho     UINT32                          PrevArgTypes;
    103  1.1.1.2.8.2  jruoho     UINT32                          ArgCount;           /* push for fixed or var args */
    104  1.1.1.2.8.2  jruoho 
    105  1.1.1.2.8.2  jruoho     struct acpi_namespace_node      Arguments[ACPI_METHOD_NUM_ARGS];        /* Control method arguments */
    106  1.1.1.2.8.2  jruoho     struct acpi_namespace_node      LocalVariables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */
    107  1.1.1.2.8.2  jruoho     union acpi_operand_object       *Operands[ACPI_OBJ_NUM_OPERANDS + 1];   /* Operands passed to the interpreter (+1 for NULL terminator) */
    108  1.1.1.2.8.2  jruoho     union acpi_operand_object       **Params;
    109  1.1.1.2.8.2  jruoho 
    110  1.1.1.2.8.2  jruoho     UINT8                           *AmlLastWhile;
    111  1.1.1.2.8.2  jruoho     union acpi_operand_object       **CallerReturnDesc;
    112  1.1.1.2.8.2  jruoho     ACPI_GENERIC_STATE              *ControlState;      /* List of control states (nested IFs) */
    113  1.1.1.2.8.2  jruoho     struct acpi_namespace_node      *DeferredNode;      /* Used when executing deferred opcodes */
    114  1.1.1.2.8.2  jruoho     union acpi_operand_object       *ImplicitReturnObj;
    115  1.1.1.2.8.2  jruoho     struct acpi_namespace_node      *MethodCallNode;    /* Called method Node*/
    116  1.1.1.2.8.2  jruoho     ACPI_PARSE_OBJECT               *MethodCallOp;      /* MethodCall Op if running a method */
    117  1.1.1.2.8.2  jruoho     union acpi_operand_object       *MethodDesc;        /* Method descriptor if running a method */
    118  1.1.1.2.8.2  jruoho     struct acpi_namespace_node      *MethodNode;        /* Method node if running a method. */
    119  1.1.1.2.8.2  jruoho     ACPI_PARSE_OBJECT               *Op;                /* Current parser op */
    120  1.1.1.2.8.2  jruoho     const ACPI_OPCODE_INFO          *OpInfo;            /* Info on current opcode */
    121  1.1.1.2.8.2  jruoho     ACPI_PARSE_OBJECT               *Origin;            /* Start of walk [Obsolete] */
    122  1.1.1.2.8.2  jruoho     union acpi_operand_object       *ResultObj;
    123  1.1.1.2.8.2  jruoho     ACPI_GENERIC_STATE              *Results;           /* Stack of accumulated results */
    124  1.1.1.2.8.2  jruoho     union acpi_operand_object       *ReturnDesc;        /* Return object, if any */
    125  1.1.1.2.8.2  jruoho     ACPI_GENERIC_STATE              *ScopeInfo;         /* Stack of nested scopes */
    126  1.1.1.2.8.2  jruoho     ACPI_PARSE_OBJECT               *PrevOp;            /* Last op that was processed */
    127  1.1.1.2.8.2  jruoho     ACPI_PARSE_OBJECT               *NextOp;            /* next op to be processed */
    128  1.1.1.2.8.2  jruoho     ACPI_THREAD_STATE               *Thread;
    129  1.1.1.2.8.2  jruoho     ACPI_PARSE_DOWNWARDS            DescendingCallback;
    130  1.1.1.2.8.2  jruoho     ACPI_PARSE_UPWARDS              AscendingCallback;
    131  1.1.1.2.8.2  jruoho 
    132  1.1.1.2.8.2  jruoho } ACPI_WALK_STATE;
    133  1.1.1.2.8.2  jruoho 
    134  1.1.1.2.8.2  jruoho 
    135  1.1.1.2.8.2  jruoho /* Info used by AcpiNsInitializeObjects and AcpiDsInitializeObjects */
    136  1.1.1.2.8.2  jruoho 
    137  1.1.1.2.8.2  jruoho typedef struct acpi_init_walk_info
    138  1.1.1.2.8.2  jruoho {
    139  1.1.1.2.8.2  jruoho     UINT32                          TableIndex;
    140  1.1.1.2.8.2  jruoho     UINT32                          ObjectCount;
    141  1.1.1.2.8.2  jruoho     UINT32                          MethodCount;
    142  1.1.1.2.8.2  jruoho     UINT32                          DeviceCount;
    143  1.1.1.2.8.2  jruoho     UINT32                          OpRegionCount;
    144  1.1.1.2.8.2  jruoho     UINT32                          FieldCount;
    145  1.1.1.2.8.2  jruoho     UINT32                          BufferCount;
    146  1.1.1.2.8.2  jruoho     UINT32                          PackageCount;
    147  1.1.1.2.8.2  jruoho     UINT32                          OpRegionInit;
    148  1.1.1.2.8.2  jruoho     UINT32                          FieldInit;
    149  1.1.1.2.8.2  jruoho     UINT32                          BufferInit;
    150  1.1.1.2.8.2  jruoho     UINT32                          PackageInit;
    151  1.1.1.2.8.2  jruoho     ACPI_OWNER_ID                   OwnerId;
    152  1.1.1.2.8.2  jruoho 
    153  1.1.1.2.8.2  jruoho } ACPI_INIT_WALK_INFO;
    154  1.1.1.2.8.2  jruoho 
    155  1.1.1.2.8.2  jruoho 
    156  1.1.1.2.8.2  jruoho typedef struct acpi_get_devices_info
    157  1.1.1.2.8.2  jruoho {
    158  1.1.1.2.8.2  jruoho     ACPI_WALK_CALLBACK              UserFunction;
    159  1.1.1.2.8.2  jruoho     void                            *Context;
    160  1.1.1.2.8.2  jruoho     char                            *Hid;
    161  1.1.1.2.8.2  jruoho 
    162  1.1.1.2.8.2  jruoho } ACPI_GET_DEVICES_INFO;
    163  1.1.1.2.8.2  jruoho 
    164  1.1.1.2.8.2  jruoho 
    165  1.1.1.2.8.2  jruoho typedef union acpi_aml_operands
    166  1.1.1.2.8.2  jruoho {
    167  1.1.1.2.8.2  jruoho     ACPI_OPERAND_OBJECT             *Operands[7];
    168  1.1.1.2.8.2  jruoho 
    169  1.1.1.2.8.2  jruoho     struct
    170  1.1.1.2.8.2  jruoho     {
    171  1.1.1.2.8.2  jruoho         ACPI_OBJECT_INTEGER             *Type;
    172  1.1.1.2.8.2  jruoho         ACPI_OBJECT_INTEGER             *Code;
    173  1.1.1.2.8.2  jruoho         ACPI_OBJECT_INTEGER             *Argument;
    174  1.1.1.2.8.2  jruoho 
    175  1.1.1.2.8.2  jruoho     } Fatal;
    176  1.1.1.2.8.2  jruoho 
    177  1.1.1.2.8.2  jruoho     struct
    178  1.1.1.2.8.2  jruoho     {
    179  1.1.1.2.8.2  jruoho         ACPI_OPERAND_OBJECT             *Source;
    180  1.1.1.2.8.2  jruoho         ACPI_OBJECT_INTEGER             *Index;
    181  1.1.1.2.8.2  jruoho         ACPI_OPERAND_OBJECT             *Target;
    182  1.1.1.2.8.2  jruoho 
    183  1.1.1.2.8.2  jruoho     } Index;
    184  1.1.1.2.8.2  jruoho 
    185  1.1.1.2.8.2  jruoho     struct
    186  1.1.1.2.8.2  jruoho     {
    187  1.1.1.2.8.2  jruoho         ACPI_OPERAND_OBJECT             *Source;
    188  1.1.1.2.8.2  jruoho         ACPI_OBJECT_INTEGER             *Index;
    189  1.1.1.2.8.2  jruoho         ACPI_OBJECT_INTEGER             *Length;
    190  1.1.1.2.8.2  jruoho         ACPI_OPERAND_OBJECT             *Target;
    191  1.1.1.2.8.2  jruoho 
    192  1.1.1.2.8.2  jruoho     } Mid;
    193  1.1.1.2.8.2  jruoho 
    194  1.1.1.2.8.2  jruoho } ACPI_AML_OPERANDS;
    195  1.1.1.2.8.2  jruoho 
    196  1.1.1.2.8.2  jruoho 
    197  1.1.1.2.8.2  jruoho /*
    198  1.1.1.2.8.2  jruoho  * Structure used to pass object evaluation parameters.
    199  1.1.1.2.8.2  jruoho  * Purpose is to reduce CPU stack use.
    200  1.1.1.2.8.2  jruoho  */
    201  1.1.1.2.8.2  jruoho typedef struct acpi_evaluate_info
    202  1.1.1.2.8.2  jruoho {
    203  1.1.1.2.8.2  jruoho     ACPI_NAMESPACE_NODE             *PrefixNode;
    204  1.1.1.2.8.2  jruoho     char                            *Pathname;
    205  1.1.1.2.8.2  jruoho     ACPI_OPERAND_OBJECT             *ObjDesc;
    206  1.1.1.2.8.2  jruoho     ACPI_OPERAND_OBJECT             **Parameters;
    207  1.1.1.2.8.2  jruoho     ACPI_NAMESPACE_NODE             *ResolvedNode;
    208  1.1.1.2.8.2  jruoho     ACPI_OPERAND_OBJECT             *ReturnObject;
    209  1.1.1.2.8.2  jruoho     UINT8                           ParamCount;
    210  1.1.1.2.8.2  jruoho     UINT8                           PassNumber;
    211  1.1.1.2.8.2  jruoho     UINT8                           ReturnObjectType;
    212  1.1.1.2.8.2  jruoho     UINT8                           Flags;
    213  1.1.1.2.8.2  jruoho 
    214  1.1.1.2.8.2  jruoho } ACPI_EVALUATE_INFO;
    215  1.1.1.2.8.2  jruoho 
    216  1.1.1.2.8.2  jruoho /* Values for Flags above */
    217  1.1.1.2.8.2  jruoho 
    218  1.1.1.2.8.2  jruoho #define ACPI_IGNORE_RETURN_VALUE        1
    219  1.1.1.2.8.2  jruoho 
    220  1.1.1.2.8.2  jruoho 
    221  1.1.1.2.8.2  jruoho /* Info used by AcpiNsInitializeDevices */
    222  1.1.1.2.8.2  jruoho 
    223  1.1.1.2.8.2  jruoho typedef struct acpi_device_walk_info
    224  1.1.1.2.8.2  jruoho {
    225  1.1.1.2.8.2  jruoho     ACPI_TABLE_DESC                 *TableDesc;
    226  1.1.1.2.8.2  jruoho     ACPI_EVALUATE_INFO              *EvaluateInfo;
    227  1.1.1.2.8.2  jruoho     UINT32                          DeviceCount;
    228  1.1.1.2.8.2  jruoho     UINT32                          Num_STA;
    229  1.1.1.2.8.2  jruoho     UINT32                          Num_INI;
    230  1.1.1.2.8.2  jruoho 
    231  1.1.1.2.8.2  jruoho } ACPI_DEVICE_WALK_INFO;
    232  1.1.1.2.8.2  jruoho 
    233  1.1.1.2.8.2  jruoho 
    234  1.1.1.2.8.2  jruoho /* TBD: [Restructure] Merge with struct above */
    235  1.1.1.2.8.2  jruoho 
    236  1.1.1.2.8.2  jruoho typedef struct acpi_walk_info
    237  1.1.1.2.8.2  jruoho {
    238  1.1.1.2.8.2  jruoho     UINT32                          DebugLevel;
    239  1.1.1.2.8.2  jruoho     UINT32                          Count;
    240  1.1.1.2.8.2  jruoho     ACPI_OWNER_ID                   OwnerId;
    241  1.1.1.2.8.2  jruoho     UINT8                           DisplayType;
    242  1.1.1.2.8.2  jruoho 
    243  1.1.1.2.8.2  jruoho } ACPI_WALK_INFO;
    244  1.1.1.2.8.2  jruoho 
    245  1.1.1.2.8.2  jruoho /* Display Types */
    246  1.1.1.2.8.2  jruoho 
    247  1.1.1.2.8.2  jruoho #define ACPI_DISPLAY_SUMMARY        (UINT8) 0
    248  1.1.1.2.8.2  jruoho #define ACPI_DISPLAY_OBJECTS        (UINT8) 1
    249  1.1.1.2.8.2  jruoho #define ACPI_DISPLAY_MASK           (UINT8) 1
    250  1.1.1.2.8.2  jruoho 
    251  1.1.1.2.8.2  jruoho #define ACPI_DISPLAY_SHORT          (UINT8) 2
    252  1.1.1.2.8.2  jruoho 
    253  1.1.1.2.8.2  jruoho 
    254  1.1.1.2.8.2  jruoho #endif
    255