acstruct.h revision 151937
1/****************************************************************************** 2 * 3 * Name: acstruct.h - Internal structs 4 * $Revision: 1.37 $ 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#define ACPI_NEXT_OP_DOWNWARD 1 133#define ACPI_NEXT_OP_UPWARD 2 134 135#define ACPI_WALK_NON_METHOD 0 136#define ACPI_WALK_METHOD 1 137#define ACPI_WALK_METHOD_RESTART 2 138#define ACPI_WALK_CONST_REQUIRED 3 139#define ACPI_WALK_CONST_OPTIONAL 4 140 141typedef struct acpi_walk_state 142{ 143 UINT8 DataType; /* To differentiate various internal objs MUST BE FIRST!*/\ 144 UINT8 WalkType; 145 ACPI_OWNER_ID OwnerId; /* Owner of objects created during the walk */ 146 BOOLEAN LastPredicate; /* Result of last predicate */ 147 UINT8 CurrentResult; /* */ 148 UINT8 NextOpInfo; /* Info about NextOp */ 149 UINT8 NumOperands; /* Stack pointer for Operands[] array */ 150 UINT8 ReturnUsed; 151 UINT16 Opcode; /* Current AML opcode */ 152 UINT8 ScopeDepth; 153 UINT8 PassNumber; /* Parse pass during table load */ 154 UINT32 ArgCount; /* push for fixed or var args */ 155 UINT32 AmlOffset; 156 UINT32 ArgTypes; 157 UINT32 MethodBreakpoint; /* For single stepping */ 158 UINT32 UserBreakpoint; /* User AML breakpoint */ 159 UINT32 ParseFlags; 160 UINT32 PrevArgTypes; 161 162 UINT8 *AmlLastWhile; 163 struct acpi_namespace_node Arguments[ACPI_METHOD_NUM_ARGS]; /* Control method arguments */ 164 union acpi_operand_object **CallerReturnDesc; 165 ACPI_GENERIC_STATE *ControlState; /* List of control states (nested IFs) */ 166 struct acpi_namespace_node *DeferredNode; /* Used when executing deferred opcodes */ 167 struct acpi_gpe_event_info *GpeEventInfo; /* Info for GPE (_Lxx/_Exx methods only */ 168 union acpi_operand_object *ImplicitReturnObj; 169 struct acpi_namespace_node LocalVariables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */ 170 struct acpi_namespace_node *MethodCallNode; /* Called method Node*/ 171 ACPI_PARSE_OBJECT *MethodCallOp; /* MethodCall Op if running a method */ 172 union acpi_operand_object *MethodDesc; /* Method descriptor if running a method */ 173 struct acpi_namespace_node *MethodNode; /* Method node if running a method. */ 174 ACPI_PARSE_OBJECT *Op; /* Current parser op */ 175 union acpi_operand_object *Operands[ACPI_OBJ_NUM_OPERANDS+1]; /* Operands passed to the interpreter (+1 for NULL terminator) */ 176 const ACPI_OPCODE_INFO *OpInfo; /* Info on current opcode */ 177 ACPI_PARSE_OBJECT *Origin; /* Start of walk [Obsolete] */ 178 union acpi_operand_object **Params; 179 ACPI_PARSE_STATE ParserState; /* Current state of parser */ 180 union acpi_operand_object *ResultObj; 181 ACPI_GENERIC_STATE *Results; /* Stack of accumulated results */ 182 union acpi_operand_object *ReturnDesc; /* Return object, if any */ 183 ACPI_GENERIC_STATE *ScopeInfo; /* Stack of nested scopes */ 184 185 ACPI_PARSE_OBJECT *PrevOp; /* Last op that was processed */ 186 ACPI_PARSE_OBJECT *NextOp; /* next op to be processed */ 187 ACPI_PARSE_DOWNWARDS DescendingCallback; 188 ACPI_PARSE_UPWARDS AscendingCallback; 189 ACPI_THREAD_STATE *Thread; 190 struct acpi_walk_state *Next; /* Next WalkState in list */ 191 192} ACPI_WALK_STATE; 193 194 195/* Info used by AcpiPsInitObjects */ 196 197typedef struct acpi_init_walk_info 198{ 199 UINT16 MethodCount; 200 UINT16 DeviceCount; 201 UINT16 OpRegionCount; 202 UINT16 FieldCount; 203 UINT16 BufferCount; 204 UINT16 PackageCount; 205 UINT16 OpRegionInit; 206 UINT16 FieldInit; 207 UINT16 BufferInit; 208 UINT16 PackageInit; 209 UINT16 ObjectCount; 210 ACPI_TABLE_DESC *TableDesc; 211 212} ACPI_INIT_WALK_INFO; 213 214 215/* Info used by AcpiNsInitializeDevices */ 216 217typedef struct acpi_device_walk_info 218{ 219 UINT16 DeviceCount; 220 UINT16 Num_STA; 221 UINT16 Num_INI; 222 ACPI_TABLE_DESC *TableDesc; 223 224} ACPI_DEVICE_WALK_INFO; 225 226 227/* TBD: [Restructure] Merge with struct above */ 228 229typedef struct acpi_walk_info 230{ 231 UINT32 DebugLevel; 232 UINT32 Count; 233 ACPI_OWNER_ID OwnerId; 234 UINT8 DisplayType; 235 236} ACPI_WALK_INFO; 237 238/* Display Types */ 239 240#define ACPI_DISPLAY_SUMMARY (UINT8) 0 241#define ACPI_DISPLAY_OBJECTS (UINT8) 1 242#define ACPI_DISPLAY_MASK (UINT8) 1 243 244#define ACPI_DISPLAY_SHORT (UINT8) 2 245 246typedef struct acpi_get_devices_info 247{ 248 ACPI_WALK_CALLBACK UserFunction; 249 void *Context; 250 char *Hid; 251 252} ACPI_GET_DEVICES_INFO; 253 254 255typedef union acpi_aml_operands 256{ 257 ACPI_OPERAND_OBJECT *Operands[7]; 258 259 struct 260 { 261 ACPI_OBJECT_INTEGER *Type; 262 ACPI_OBJECT_INTEGER *Code; 263 ACPI_OBJECT_INTEGER *Argument; 264 265 } Fatal; 266 267 struct 268 { 269 ACPI_OPERAND_OBJECT *Source; 270 ACPI_OBJECT_INTEGER *Index; 271 ACPI_OPERAND_OBJECT *Target; 272 273 } Index; 274 275 struct 276 { 277 ACPI_OPERAND_OBJECT *Source; 278 ACPI_OBJECT_INTEGER *Index; 279 ACPI_OBJECT_INTEGER *Length; 280 ACPI_OPERAND_OBJECT *Target; 281 282 } Mid; 283 284} ACPI_AML_OPERANDS; 285 286 287/* Internal method parameter list */ 288 289typedef struct acpi_parameter_info 290{ 291 ACPI_NAMESPACE_NODE *Node; 292 ACPI_OPERAND_OBJECT *ObjDesc; 293 ACPI_OPERAND_OBJECT **Parameters; 294 ACPI_OPERAND_OBJECT *ReturnObject; 295 UINT8 PassNumber; 296 UINT8 ParameterType; 297 UINT8 ReturnObjectType; 298 299} ACPI_PARAMETER_INFO; 300 301/* Types for ParameterType above */ 302 303#define ACPI_PARAM_ARGS 0 304#define ACPI_PARAM_GPE 1 305 306 307#endif 308