sys/contrib/dev/acpica/source/include/acstruct.h

   1 /******************************************************************************
   2  *
   3  * Name: acstruct.h - Internal structs
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2014, 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 __ACSTRUCT_H__
  45 #define __ACSTRUCT_H__
  46
  47 /* acpisrc:StructDefs -- for acpisrc conversion */
  48
  49 /*****************************************************************************
  50  *
  51  * Tree walking typedefs and structs
  52  *
  53  ****************************************************************************/
  54
  55
  56 /*
  57  * Walk state - current state of a parse tree walk. Used for both a leisurely
  58  * stroll through the tree (for whatever reason), and for control method
  59  * execution.
  60  */
  61 #define ACPI_NEXT_OP_DOWNWARD       1
  62 #define ACPI_NEXT_OP_UPWARD         2
  63
  64 /*
  65  * Groups of definitions for WalkType used for different implementations of
  66  * walkers (never simultaneously) - flags for interpreter:
  67  */
  68 #define ACPI_WALK_NON_METHOD        0
  69 #define ACPI_WALK_METHOD            0x01
  70 #define ACPI_WALK_METHOD_RESTART    0x02
  71
  72 /* Flags for iASL compiler only */
  73
  74 #define ACPI_WALK_CONST_REQUIRED    0x10
  75 #define ACPI_WALK_CONST_OPTIONAL    0x20
  76
  77
  78 typedef struct acpi_walk_state
  79 {
  80     struct acpi_walk_state          *Next;              /* Next WalkState in list */
  81     UINT8                           DescriptorType;     /* To differentiate various internal objs */
  82     UINT8                           WalkType;
  83     UINT16                          Opcode;             /* Current AML opcode */
  84     UINT8                           NextOpInfo;         /* Info about NextOp */
  85     UINT8                           NumOperands;        /* Stack pointer for Operands[] array */
  86     UINT8                           OperandIndex;       /* Index into operand stack, to be used by AcpiDsObjStackPush */
  87     ACPI_OWNER_ID                   OwnerId;            /* Owner of objects created during the walk */
  88     BOOLEAN                         LastPredicate;      /* Result of last predicate */
  89     UINT8                           CurrentResult;
  90     UINT8                           ReturnUsed;
  91     UINT8                           ScopeDepth;
  92     UINT8                           PassNumber;         /* Parse pass during table load */
  93     UINT8                           ResultSize;         /* Total elements for the result stack */
  94     UINT8                           ResultCount;        /* Current number of occupied elements of result stack */
  95     UINT32                          AmlOffset;
  96     UINT32                          ArgTypes;
  97     UINT32                          MethodBreakpoint;   /* For single stepping */
  98     UINT32                          UserBreakpoint;     /* User AML breakpoint */
  99     UINT32                          ParseFlags;
 100
 101     ACPI_PARSE_STATE                ParserState;        /* Current state of parser */
 102     UINT32                          PrevArgTypes;
 103     UINT32                          ArgCount;           /* push for fixed or var args */
 104
 105     struct acpi_namespace_node      Arguments[ACPI_METHOD_NUM_ARGS];        /* Control method arguments */
 106     struct acpi_namespace_node      LocalVariables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */
 107     union acpi_operand_object       *Operands[ACPI_OBJ_NUM_OPERANDS + 1];   /* Operands passed to the interpreter (+1 for NULL terminator) */
 108     union acpi_operand_object       **Params;
 109
 110     UINT8                           *AmlLastWhile;
 111     union acpi_operand_object       **CallerReturnDesc;
 112     ACPI_GENERIC_STATE              *ControlState;      /* List of control states (nested IFs) */
 113     struct acpi_namespace_node      *DeferredNode;      /* Used when executing deferred opcodes */
 114     union acpi_operand_object       *ImplicitReturnObj;
 115     struct acpi_namespace_node      *MethodCallNode;    /* Called method Node*/
 116     ACPI_PARSE_OBJECT               *MethodCallOp;      /* MethodCall Op if running a method */
 117     union acpi_operand_object       *MethodDesc;        /* Method descriptor if running a method */
 118     struct acpi_namespace_node      *MethodNode;        /* Method node if running a method. */
 119     ACPI_PARSE_OBJECT               *Op;                /* Current parser op */
 120     const ACPI_OPCODE_INFO          *OpInfo;            /* Info on current opcode */
 121     ACPI_PARSE_OBJECT               *Origin;            /* Start of walk [Obsolete] */
 122     union acpi_operand_object       *ResultObj;
 123     ACPI_GENERIC_STATE              *Results;           /* Stack of accumulated results */
 124     union acpi_operand_object       *ReturnDesc;        /* Return object, if any */
 125     ACPI_GENERIC_STATE              *ScopeInfo;         /* Stack of nested scopes */
 126     ACPI_PARSE_OBJECT               *PrevOp;            /* Last op that was processed */
 127     ACPI_PARSE_OBJECT               *NextOp;            /* next op to be processed */
 128     ACPI_THREAD_STATE               *Thread;
 129     ACPI_PARSE_DOWNWARDS            DescendingCallback;
 130     ACPI_PARSE_UPWARDS              AscendingCallback;
 131
 132 } ACPI_WALK_STATE;
 133
 134
 135 /* Info used by AcpiNsInitializeObjects and AcpiDsInitializeObjects */
 136
 137 typedef struct acpi_init_walk_info
 138 {
 139     UINT32                          TableIndex;
 140     UINT32                          ObjectCount;
 141     UINT32                          MethodCount;
 142     UINT32                          SerialMethodCount;
 143     UINT32                          NonSerialMethodCount;
 144     UINT32                          SerializedMethodCount;
 145     UINT32                          DeviceCount;
 146     UINT32                          OpRegionCount;
 147     UINT32                          FieldCount;
 148     UINT32                          BufferCount;
 149     UINT32                          PackageCount;
 150     UINT32                          OpRegionInit;
 151     UINT32                          FieldInit;
 152     UINT32                          BufferInit;
 153     UINT32                          PackageInit;
 154     ACPI_OWNER_ID                   OwnerId;
 155
 156 } ACPI_INIT_WALK_INFO;
 157
 158
 159 typedef struct acpi_get_devices_info
 160 {
 161     ACPI_WALK_CALLBACK              UserFunction;
 162     void                            *Context;
 163     char                            *Hid;
 164
 165 } ACPI_GET_DEVICES_INFO;
 166
 167
 168 typedef union acpi_aml_operands
 169 {
 170     ACPI_OPERAND_OBJECT             *Operands[7];
 171
 172     struct
 173     {
 174         ACPI_OBJECT_INTEGER             *Type;
 175         ACPI_OBJECT_INTEGER             *Code;
 176         ACPI_OBJECT_INTEGER             *Argument;
 177
 178     } Fatal;
 179
 180     struct
 181     {
 182         ACPI_OPERAND_OBJECT             *Source;
 183         ACPI_OBJECT_INTEGER             *Index;
 184         ACPI_OPERAND_OBJECT             *Target;
 185
 186     } Index;
 187
 188     struct
 189     {
 190         ACPI_OPERAND_OBJECT             *Source;
 191         ACPI_OBJECT_INTEGER             *Index;
 192         ACPI_OBJECT_INTEGER             *Length;
 193         ACPI_OPERAND_OBJECT             *Target;
 194
 195     } Mid;
 196
 197 } ACPI_AML_OPERANDS;
 198
 199
 200 /*
 201  * Structure used to pass object evaluation information and parameters.
 202  * Purpose is to reduce CPU stack use.
 203  */
 204 typedef struct acpi_evaluate_info
 205 {
 206     /* The first 3 elements are passed by the caller to AcpiNsEvaluate */
 207
 208     ACPI_NAMESPACE_NODE             *PrefixNode;        /* Input: starting node */
 209     char                            *RelativePathname;  /* Input: path relative to PrefixNode */
 210     ACPI_OPERAND_OBJECT             **Parameters;       /* Input: argument list */
 211
 212     ACPI_NAMESPACE_NODE             *Node;              /* Resolved node (PrefixNode:RelativePathname) */
 213     ACPI_OPERAND_OBJECT             *ObjDesc;           /* Object attached to the resolved node */
 214     char                            *FullPathname;      /* Full pathname of the resolved node */
 215
 216     const ACPI_PREDEFINED_INFO      *Predefined;        /* Used if Node is a predefined name */
 217     ACPI_OPERAND_OBJECT             *ReturnObject;      /* Object returned from the evaluation */
 218     union acpi_operand_object       *ParentPackage;     /* Used if return object is a Package */
 219
 220     UINT32                          ReturnFlags;        /* Used for return value analysis */
 221     UINT32                          ReturnBtype;        /* Bitmapped type of the returned object */
 222     UINT16                          ParamCount;         /* Count of the input argument list */
 223     UINT8                           PassNumber;         /* Parser pass number */
 224     UINT8                           ReturnObjectType;   /* Object type of the returned object */
 225     UINT8                           NodeFlags;          /* Same as Node->Flags */
 226     UINT8                           Flags;              /* General flags */
 227
 228 } ACPI_EVALUATE_INFO;
 229
 230 /* Values for Flags above */
 231
 232 #define ACPI_IGNORE_RETURN_VALUE    1
 233
 234 /* Defines for ReturnFlags field above */
 235
 236 #define ACPI_OBJECT_REPAIRED        1
 237 #define ACPI_OBJECT_WRAPPED         2
 238
 239
 240 /* Info used by AcpiNsInitializeDevices */
 241
 242 typedef struct acpi_device_walk_info
 243 {
 244     ACPI_TABLE_DESC                 *TableDesc;
 245     ACPI_EVALUATE_INFO              *EvaluateInfo;
 246     UINT32                          DeviceCount;
 247     UINT32                          Num_STA;
 248     UINT32                          Num_INI;
 249
 250 } ACPI_DEVICE_WALK_INFO;
 251
 252
 253 /* TBD: [Restructure] Merge with struct above */
 254
 255 typedef struct acpi_walk_info
 256 {
 257     UINT32                          DebugLevel;
 258     UINT32                          Count;
 259     ACPI_OWNER_ID                   OwnerId;
 260     UINT8                           DisplayType;
 261
 262 } ACPI_WALK_INFO;
 263
 264 /* Display Types */
 265
 266 #define ACPI_DISPLAY_SUMMARY        (UINT8) 0
 267 #define ACPI_DISPLAY_OBJECTS        (UINT8) 1
 268 #define ACPI_DISPLAY_MASK           (UINT8) 1
 269
 270 #define ACPI_DISPLAY_SHORT          (UINT8) 2
 271
 272
 273 #endif