acstruct.h revision 193335
190075Sobrien/****************************************************************************** 290075Sobrien * 390075Sobrien * Name: acstruct.h - Internal structs 490075Sobrien * 590075Sobrien *****************************************************************************/ 690075Sobrien 790075Sobrien/****************************************************************************** 890075Sobrien * 990075Sobrien * 1. Copyright Notice 1090075Sobrien * 1190075Sobrien * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp. 1290075Sobrien * All rights reserved. 1390075Sobrien * 1490075Sobrien * 2. License 1590075Sobrien * 1690075Sobrien * 2.1. This is your license from Intel Corp. under its intellectual property 1790075Sobrien * rights. You may have additional license terms from the party that provided 1890075Sobrien * you this software, covering your right to use that party's intellectual 1990075Sobrien * property rights. 2090075Sobrien * 2190075Sobrien * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2290075Sobrien * copy of the source code appearing in this file ("Covered Code") an 2390075Sobrien * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2490075Sobrien * base code distributed originally by Intel ("Original Intel Code") to copy, 2590075Sobrien * make derivatives, distribute, use and display any portion of the Covered 2690075Sobrien * Code in any form, with the right to sublicense such rights; and 2790075Sobrien * 2890075Sobrien * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 2990075Sobrien * license (with the right to sublicense), under only those claims of Intel 3090075Sobrien * patents that are infringed by the Original Intel Code, to make, use, sell, 3190075Sobrien * offer to sell, and import the Covered Code and derivative works thereof 3290075Sobrien * solely to the minimum extent necessary to exercise the above copyright 3390075Sobrien * license, and in no event shall the patent license extend to any additions 3490075Sobrien * to or modifications of the Original Intel Code. No other license or right 3590075Sobrien * is granted directly or by implication, estoppel or otherwise; 3690075Sobrien * 3790075Sobrien * The above copyright and patent license is granted only if the following 3890075Sobrien * conditions are met: 3990075Sobrien * 4090075Sobrien * 3. Conditions 4190075Sobrien * 4290075Sobrien * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4390075Sobrien * Redistribution of source code of any substantial portion of the Covered 4490075Sobrien * Code or modification with rights to further distribute source must include 4590075Sobrien * the above Copyright Notice, the above License, this list of Conditions, 4690075Sobrien * and the following Disclaimer and Export Compliance provision. In addition, 4790075Sobrien * Licensee must cause all Covered Code to which Licensee contributes to 4890075Sobrien * contain a file documenting the changes Licensee made to create that Covered 4990075Sobrien * Code and the date of any change. Licensee must include in that file the 5090075Sobrien * documentation of any changes made by any predecessor Licensee. Licensee 5190075Sobrien * must include a prominent statement that the modification is derived, 5290075Sobrien * directly or indirectly, from Original Intel Code. 5390075Sobrien * 5490075Sobrien * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5590075Sobrien * Redistribution of source code of any substantial portion of the Covered 5690075Sobrien * Code or modification without rights to further distribute source must 5790075Sobrien * include the following Disclaimer and Export Compliance provision in the 5890075Sobrien * documentation and/or other materials provided with distribution. In 5990075Sobrien * addition, Licensee may not authorize further sublicense of source of any 6090075Sobrien * portion of the Covered Code, and must include terms to the effect that the 6190075Sobrien * license from Licensee to its licensee is limited to the intellectual 6290075Sobrien * property embodied in the software Licensee provides to its licensee, and 6390075Sobrien * not to intellectual property embodied in modifications its licensee may 6490075Sobrien * make. 6590075Sobrien * 6690075Sobrien * 3.3. Redistribution of Executable. Redistribution in executable form of any 6790075Sobrien * substantial portion of the Covered Code or modification must reproduce the 6890075Sobrien * above Copyright Notice, and the following Disclaimer and Export Compliance 6990075Sobrien * provision in the documentation and/or other materials provided with the 7090075Sobrien * distribution. 7190075Sobrien * 7290075Sobrien * 3.4. Intel retains all right, title, and interest in and to the Original 7390075Sobrien * Intel Code. 7490075Sobrien * 7590075Sobrien * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7690075Sobrien * Intel shall be used in advertising or otherwise to promote the sale, use or 7790075Sobrien * other dealings in products derived from or relating to the Covered Code 7890075Sobrien * without prior written authorization from Intel. 7990075Sobrien * 8090075Sobrien * 4. Disclaimer and Export Compliance 8190075Sobrien * 8290075Sobrien * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8390075Sobrien * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8490075Sobrien * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8590075Sobrien * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8690075Sobrien * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8790075Sobrien * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 8890075Sobrien * PARTICULAR PURPOSE. 8990075Sobrien * 9090075Sobrien * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9190075Sobrien * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9290075Sobrien * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9390075Sobrien * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9490075Sobrien * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9590075Sobrien * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9690075Sobrien * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9790075Sobrien * LIMITED REMEDY. 98132718Skan * 9990075Sobrien * 4.3. Licensee shall not export, either directly or indirectly, any of this 10090075Sobrien * software or system incorporating such software without first obtaining any 10190075Sobrien * required license or other approval from the U. S. Department of Commerce or 102132718Skan * any other agency or department of the United States Government. In the 10390075Sobrien * event Licensee exports any such software from the United States or 104132718Skan * re-exports any such software from a foreign destination, Licensee shall 105132718Skan * ensure that the distribution and export/re-export of the software is in 106132718Skan * compliance with all laws, regulations, orders, or other restrictions of the 10790075Sobrien * U.S. Export Administration Regulations. Licensee agrees that neither it nor 10890075Sobrien * any of its subsidiaries will export/re-export any technical data, process, 10990075Sobrien * software, or service, directly or indirectly, to any country for which the 11090075Sobrien * United States government or any agency thereof requires an export license, 11190075Sobrien * other governmental approval, or letter of assurance, without first obtaining 11290075Sobrien * such license, approval or letter. 11390075Sobrien * 11490075Sobrien *****************************************************************************/ 11590075Sobrien 11690075Sobrien#ifndef __ACSTRUCT_H__ 117132718Skan#define __ACSTRUCT_H__ 118132718Skan 119132718Skan/* acpisrc:StructDefs -- for acpisrc conversion */ 120132718Skan 121132718Skan/***************************************************************************** 122132718Skan * 123132718Skan * Tree walking typedefs and structs 124132718Skan * 12590075Sobrien ****************************************************************************/ 12696263Sobrien 12790075Sobrien 128132718Skan/* 12990075Sobrien * Walk state - current state of a parse tree walk. Used for both a leisurely 130132718Skan * stroll through the tree (for whatever reason), and for control method 131132718Skan * execution. 132132718Skan */ 13390075Sobrien#define ACPI_NEXT_OP_DOWNWARD 1 13490075Sobrien#define ACPI_NEXT_OP_UPWARD 2 13590075Sobrien 13690075Sobrien/* 13790075Sobrien * Groups of definitions for WalkType used for different implementations of 13890075Sobrien * walkers (never simultaneously) - flags for interpreter: 13990075Sobrien */ 14090075Sobrien#define ACPI_WALK_NON_METHOD 0 14190075Sobrien#define ACPI_WALK_METHOD 0x01 14290075Sobrien#define ACPI_WALK_METHOD_RESTART 0x02 14390075Sobrien 144132718Skan/* Flags for iASL compiler only */ 14590075Sobrien 14690075Sobrien#define ACPI_WALK_CONST_REQUIRED 0x10 14790075Sobrien#define ACPI_WALK_CONST_OPTIONAL 0x20 14890075Sobrien 14990075Sobrien 15090075Sobrientypedef struct acpi_walk_state 15190075Sobrien{ 15290075Sobrien struct acpi_walk_state *Next; /* Next WalkState in list */ 15390075Sobrien UINT8 DescriptorType; /* To differentiate various internal objs */ 15490075Sobrien UINT8 WalkType; 15590075Sobrien UINT16 Opcode; /* Current AML opcode */ 15690075Sobrien UINT8 NextOpInfo; /* Info about NextOp */ 15790075Sobrien UINT8 NumOperands; /* Stack pointer for Operands[] array */ 15890075Sobrien UINT8 OperandIndex; /* Index into operand stack, to be used by AcpiDsObjStackPush */ 15990075Sobrien ACPI_OWNER_ID OwnerId; /* Owner of objects created during the walk */ 16090075Sobrien BOOLEAN LastPredicate; /* Result of last predicate */ 161132718Skan UINT8 CurrentResult; 162132718Skan UINT8 ReturnUsed; 163132718Skan UINT8 ScopeDepth; 164132718Skan UINT8 PassNumber; /* Parse pass during table load */ 165 UINT8 ResultSize; /* Total elements for the result stack */ 166 UINT8 ResultCount; /* Current number of occupied elements of result stack */ 167 UINT32 AmlOffset; 168 UINT32 ArgTypes; 169 UINT32 MethodBreakpoint; /* For single stepping */ 170 UINT32 UserBreakpoint; /* User AML breakpoint */ 171 UINT32 ParseFlags; 172 173 ACPI_PARSE_STATE ParserState; /* Current state of parser */ 174 UINT32 PrevArgTypes; 175 UINT32 ArgCount; /* push for fixed or var args */ 176 177 struct acpi_namespace_node Arguments[ACPI_METHOD_NUM_ARGS]; /* Control method arguments */ 178 struct acpi_namespace_node LocalVariables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */ 179 union acpi_operand_object *Operands[ACPI_OBJ_NUM_OPERANDS + 1]; /* Operands passed to the interpreter (+1 for NULL terminator) */ 180 union acpi_operand_object **Params; 181 182 UINT8 *AmlLastWhile; 183 union acpi_operand_object **CallerReturnDesc; 184 ACPI_GENERIC_STATE *ControlState; /* List of control states (nested IFs) */ 185 struct acpi_namespace_node *DeferredNode; /* Used when executing deferred opcodes */ 186 union acpi_operand_object *ImplicitReturnObj; 187 struct acpi_namespace_node *MethodCallNode; /* Called method Node*/ 188 ACPI_PARSE_OBJECT *MethodCallOp; /* MethodCall Op if running a method */ 189 union acpi_operand_object *MethodDesc; /* Method descriptor if running a method */ 190 struct acpi_namespace_node *MethodNode; /* Method node if running a method. */ 191 ACPI_PARSE_OBJECT *Op; /* Current parser op */ 192 const ACPI_OPCODE_INFO *OpInfo; /* Info on current opcode */ 193 ACPI_PARSE_OBJECT *Origin; /* Start of walk [Obsolete] */ 194 union acpi_operand_object *ResultObj; 195 ACPI_GENERIC_STATE *Results; /* Stack of accumulated results */ 196 union acpi_operand_object *ReturnDesc; /* Return object, if any */ 197 ACPI_GENERIC_STATE *ScopeInfo; /* Stack of nested scopes */ 198 ACPI_PARSE_OBJECT *PrevOp; /* Last op that was processed */ 199 ACPI_PARSE_OBJECT *NextOp; /* next op to be processed */ 200 ACPI_THREAD_STATE *Thread; 201 ACPI_PARSE_DOWNWARDS DescendingCallback; 202 ACPI_PARSE_UPWARDS AscendingCallback; 203 204} ACPI_WALK_STATE; 205 206 207/* Info used by AcpiPsInitObjects */ 208 209typedef struct acpi_init_walk_info 210{ 211 UINT16 MethodCount; 212 UINT16 DeviceCount; 213 UINT16 OpRegionCount; 214 UINT16 FieldCount; 215 UINT16 BufferCount; 216 UINT16 PackageCount; 217 UINT16 OpRegionInit; 218 UINT16 FieldInit; 219 UINT16 BufferInit; 220 UINT16 PackageInit; 221 UINT16 ObjectCount; 222 ACPI_OWNER_ID OwnerId; 223 UINT32 TableIndex; 224 225} ACPI_INIT_WALK_INFO; 226 227 228typedef struct acpi_get_devices_info 229{ 230 ACPI_WALK_CALLBACK UserFunction; 231 void *Context; 232 char *Hid; 233 234} ACPI_GET_DEVICES_INFO; 235 236 237typedef union acpi_aml_operands 238{ 239 ACPI_OPERAND_OBJECT *Operands[7]; 240 241 struct 242 { 243 ACPI_OBJECT_INTEGER *Type; 244 ACPI_OBJECT_INTEGER *Code; 245 ACPI_OBJECT_INTEGER *Argument; 246 247 } Fatal; 248 249 struct 250 { 251 ACPI_OPERAND_OBJECT *Source; 252 ACPI_OBJECT_INTEGER *Index; 253 ACPI_OPERAND_OBJECT *Target; 254 255 } Index; 256 257 struct 258 { 259 ACPI_OPERAND_OBJECT *Source; 260 ACPI_OBJECT_INTEGER *Index; 261 ACPI_OBJECT_INTEGER *Length; 262 ACPI_OPERAND_OBJECT *Target; 263 264 } Mid; 265 266} ACPI_AML_OPERANDS; 267 268 269/* 270 * Structure used to pass object evaluation parameters. 271 * Purpose is to reduce CPU stack use. 272 */ 273typedef struct acpi_evaluate_info 274{ 275 ACPI_NAMESPACE_NODE *PrefixNode; 276 char *Pathname; 277 ACPI_OPERAND_OBJECT *ObjDesc; 278 ACPI_OPERAND_OBJECT **Parameters; 279 ACPI_NAMESPACE_NODE *ResolvedNode; 280 ACPI_OPERAND_OBJECT *ReturnObject; 281 UINT8 ParamCount; 282 UINT8 PassNumber; 283 UINT8 ReturnObjectType; 284 UINT8 Flags; 285 286} ACPI_EVALUATE_INFO; 287 288/* Values for Flags above */ 289 290#define ACPI_IGNORE_RETURN_VALUE 1 291 292 293/* Info used by AcpiNsInitializeDevices */ 294 295typedef struct acpi_device_walk_info 296{ 297 UINT16 DeviceCount; 298 UINT16 Num_STA; 299 UINT16 Num_INI; 300 ACPI_TABLE_DESC *TableDesc; 301 ACPI_EVALUATE_INFO *EvaluateInfo; 302 303} ACPI_DEVICE_WALK_INFO; 304 305 306/* TBD: [Restructure] Merge with struct above */ 307 308typedef struct acpi_walk_info 309{ 310 UINT32 DebugLevel; 311 UINT32 Count; 312 ACPI_OWNER_ID OwnerId; 313 UINT8 DisplayType; 314 315} ACPI_WALK_INFO; 316 317/* Display Types */ 318 319#define ACPI_DISPLAY_SUMMARY (UINT8) 0 320#define ACPI_DISPLAY_OBJECTS (UINT8) 1 321#define ACPI_DISPLAY_MASK (UINT8) 1 322 323#define ACPI_DISPLAY_SHORT (UINT8) 2 324 325 326#endif 327