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

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