sys/contrib/dev/acpica-unix-20050211/include/acstruct.h

   1 /******************************************************************************
   2  *
   3  * Name: acstruct.h - Internal structs
   4  *       $Revision: 29 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117 #ifndef __ACSTRUCT_H__
 118 #define __ACSTRUCT_H__
 119
 120
 121 /*****************************************************************************
 122  *
 123  * Tree walking typedefs and structs
 124  *
 125  ****************************************************************************/
 126
 127
 128 /*
 129  * Walk state - current state of a parse tree walk.  Used for both a leisurely stroll through
 130  * the tree (for whatever reason), and for control method execution.
 131  */
 132
 133 #define ACPI_NEXT_OP_DOWNWARD       1
 134 #define ACPI_NEXT_OP_UPWARD         2
 135
 136 #define ACPI_WALK_NON_METHOD        0
 137 #define ACPI_WALK_METHOD            1
 138 #define ACPI_WALK_METHOD_RESTART    2
 139 #define ACPI_WALK_CONST_REQUIRED    3
 140 #define ACPI_WALK_CONST_OPTIONAL    4
 141
 142 typedef struct acpi_walk_state
 143 {
 144     UINT8                       DataType;                           /* To differentiate various internal objs MUST BE FIRST!*/\
 145     UINT8                       WalkType;
 146     ACPI_OWNER_ID               OwnerId;                            /* Owner of objects created during the walk */
 147     BOOLEAN                     LastPredicate;                      /* Result of last predicate */
 148     UINT8                       Reserved;                           /* For alignment */
 149     UINT8                       CurrentResult;                      /* */
 150     UINT8                       NextOpInfo;                         /* Info about NextOp */
 151     UINT8                       NumOperands;                        /* Stack pointer for Operands[] array */
 152     UINT8                       ReturnUsed;
 153     UINT16                      Opcode;                             /* Current AML opcode */
 154     UINT8                       ScopeDepth;
 155     UINT8                       Reserved1;
 156     UINT32                      ArgCount;                           /* push for fixed or var args */
 157     UINT32                      AmlOffset;
 158     UINT32                      ArgTypes;
 159     UINT32                      MethodBreakpoint;                   /* For single stepping */
 160     UINT32                      UserBreakpoint;                     /* User AML breakpoint */
 161     UINT32                      ParseFlags;
 162     UINT32                      PrevArgTypes;
 163
 164     UINT8                       *AmlLastWhile;
 165     struct acpi_namespace_node  Arguments[ACPI_METHOD_NUM_ARGS];    /* Control method arguments */
 166     union acpi_operand_object   **CallerReturnDesc;
 167     ACPI_GENERIC_STATE          *ControlState;                      /* List of control states (nested IFs) */
 168     struct acpi_namespace_node  *DeferredNode;                      /* Used when executing deferred opcodes */
 169     struct acpi_gpe_event_info  *GpeEventInfo;                      /* Info for GPE (_Lxx/_Exx methods only */
 170     struct acpi_namespace_node  LocalVariables[ACPI_METHOD_NUM_LOCALS];     /* Control method locals */
 171     struct acpi_namespace_node  *MethodCallNode;                    /* Called method Node*/
 172     ACPI_PARSE_OBJECT           *MethodCallOp;                      /* MethodCall Op if running a method */
 173     union acpi_operand_object   *MethodDesc;                        /* Method descriptor if running a method */
 174     struct acpi_namespace_node  *MethodNode;                        /* Method node if running a method. */
 175     ACPI_PARSE_OBJECT           *Op;                                /* Current parser op */
 176     union acpi_operand_object   *Operands[ACPI_OBJ_NUM_OPERANDS+1]; /* Operands passed to the interpreter (+1 for NULL terminator) */
 177     const ACPI_OPCODE_INFO      *OpInfo;                            /* Info on current opcode */
 178     ACPI_PARSE_OBJECT           *Origin;                            /* Start of walk [Obsolete] */
 179     union acpi_operand_object   **Params;
 180     ACPI_PARSE_STATE            ParserState;                        /* Current state of parser */
 181     union acpi_operand_object   *ResultObj;
 182     ACPI_GENERIC_STATE          *Results;                           /* Stack of accumulated results */
 183     union acpi_operand_object   *ReturnDesc;                        /* Return object, if any */
 184     ACPI_GENERIC_STATE          *ScopeInfo;                         /* Stack of nested scopes */
 185
 186     ACPI_PARSE_OBJECT           *PrevOp;                            /* Last op that was processed */
 187     ACPI_PARSE_OBJECT           *NextOp;                            /* next op to be processed */
 188     ACPI_PARSE_DOWNWARDS        DescendingCallback;
 189     ACPI_PARSE_UPWARDS          AscendingCallback;
 190     ACPI_THREAD_STATE           *Thread;
 191     struct acpi_walk_state      *Next;                              /* Next WalkState in list */
 192
 193 } ACPI_WALK_STATE;
 194
 195
 196 /* Info used by AcpiPsInitObjects */
 197
 198 typedef struct acpi_init_walk_info
 199 {
 200     UINT16                  MethodCount;
 201     UINT16                  DeviceCount;
 202     UINT16                  OpRegionCount;
 203     UINT16                  FieldCount;
 204     UINT16                  BufferCount;
 205     UINT16                  PackageCount;
 206     UINT16                  OpRegionInit;
 207     UINT16                  FieldInit;
 208     UINT16                  BufferInit;
 209     UINT16                  PackageInit;
 210     UINT16                  ObjectCount;
 211     ACPI_TABLE_DESC         *TableDesc;
 212
 213 } ACPI_INIT_WALK_INFO;
 214
 215
 216 /* Info used by AcpiNsInitializeDevices */
 217
 218 typedef struct acpi_device_walk_info
 219 {
 220     UINT16                  DeviceCount;
 221     UINT16                  Num_STA;
 222     UINT16                  Num_INI;
 223     ACPI_TABLE_DESC         *TableDesc;
 224
 225 } ACPI_DEVICE_WALK_INFO;
 226
 227
 228 /* TBD: [Restructure] Merge with struct above */
 229
 230 typedef struct acpi_walk_info
 231 {
 232     UINT32                  DebugLevel;
 233     UINT32                  OwnerId;
 234     UINT8                   DisplayType;
 235
 236 } ACPI_WALK_INFO;
 237
 238 /* Display Types */
 239
 240 #define ACPI_DISPLAY_SUMMARY    0
 241 #define ACPI_DISPLAY_OBJECTS    1
 242
 243 typedef struct acpi_get_devices_info
 244 {
 245     ACPI_WALK_CALLBACK      UserFunction;
 246     void                    *Context;
 247     char                    *Hid;
 248
 249 } ACPI_GET_DEVICES_INFO;
 250
 251
 252 typedef union acpi_aml_operands
 253 {
 254     ACPI_OPERAND_OBJECT         *Operands[7];
 255
 256     struct
 257     {
 258         ACPI_OBJECT_INTEGER     *Type;
 259         ACPI_OBJECT_INTEGER     *Code;
 260         ACPI_OBJECT_INTEGER     *Argument;
 261
 262     } Fatal;
 263
 264     struct
 265     {
 266         ACPI_OPERAND_OBJECT     *Source;
 267         ACPI_OBJECT_INTEGER     *Index;
 268         ACPI_OPERAND_OBJECT     *Target;
 269
 270     } Index;
 271
 272     struct
 273     {
 274         ACPI_OPERAND_OBJECT     *Source;
 275         ACPI_OBJECT_INTEGER     *Index;
 276         ACPI_OBJECT_INTEGER     *Length;
 277         ACPI_OPERAND_OBJECT     *Target;
 278
 279     } Mid;
 280
 281 } ACPI_AML_OPERANDS;
 282
 283
 284 /* Internal method parameter list */
 285
 286 typedef struct acpi_parameter_info
 287 {
 288     ACPI_NAMESPACE_NODE     *Node;
 289     ACPI_OPERAND_OBJECT     **Parameters;
 290     ACPI_OPERAND_OBJECT     *ReturnObject;
 291     UINT8                   ParameterType;
 292     UINT8                   ReturnObjectType;
 293
 294 } ACPI_PARAMETER_INFO;
 295
 296 /* Types for ParameterType above */
 297
 298 #define ACPI_PARAM_ARGS                 0
 299 #define ACPI_PARAM_GPE                  1
 300
 301
 302 #endif