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