acstruct.h revision 107325
1158115Sume/****************************************************************************** 2158115Sume * 3158115Sume * Name: acstruct.h - Internal structs 4158115Sume * $Revision: 20 $ 5158115Sume * 6158115Sume *****************************************************************************/ 7158115Sume 8158115Sume/****************************************************************************** 9158115Sume * 10158115Sume * 1. Copyright Notice 11158115Sume * 12158115Sume * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp. 13158115Sume * All rights reserved. 14158115Sume * 15158115Sume * 2. License 16158115Sume * 17158115Sume * 2.1. This is your license from Intel Corp. under its intellectual property 18158115Sume * rights. You may have additional license terms from the party that provided 19158115Sume * you this software, covering your right to use that party's intellectual 20158115Sume * property rights. 21158115Sume * 22158115Sume * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23158115Sume * copy of the source code appearing in this file ("Covered Code") an 24158115Sume * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25158115Sume * base code distributed originally by Intel ("Original Intel Code") to copy, 26158115Sume * make derivatives, distribute, use and display any portion of the Covered 27158115Sume * Code in any form, with the right to sublicense such rights; and 28158115Sume * 29171795Sbushman * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30171795Sbushman * license (with the right to sublicense), under only those claims of Intel 31158115Sume * patents that are infringed by the Original Intel Code, to make, use, sell, 32158115Sume * offer to sell, and import the Covered Code and derivative works thereof 33158115Sume * solely to the minimum extent necessary to exercise the above copyright 34158115Sume * license, and in no event shall the patent license extend to any additions 35158115Sume * to or modifications of the Original Intel Code. No other license or right 36158115Sume * is granted directly or by implication, estoppel or otherwise; 37158115Sume * 38158115Sume * The above copyright and patent license is granted only if the following 39158115Sume * conditions are met: 40158115Sume * 41158115Sume * 3. Conditions 42171795Sbushman * 43171795Sbushman * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44158115Sume * Redistribution of source code of any substantial portion of the Covered 45158115Sume * Code or modification with rights to further distribute source must include 46158115Sume * the above Copyright Notice, the above License, this list of Conditions, 47158115Sume * and the following Disclaimer and Export Compliance provision. In addition, 48158115Sume * Licensee must cause all Covered Code to which Licensee contributes to 49158115Sume * contain a file documenting the changes Licensee made to create that Covered 50158115Sume * Code and the date of any change. Licensee must include in that file the 51158115Sume * documentation of any changes made by any predecessor Licensee. Licensee 52158115Sume * must include a prominent statement that the modification is derived, 53158115Sume * directly or indirectly, from Original Intel Code. 54158115Sume * 55158115Sume * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56158115Sume * Redistribution of source code of any substantial portion of the Covered 57158115Sume * Code or modification without rights to further distribute source must 58158115Sume * include the following Disclaimer and Export Compliance provision in the 59158115Sume * documentation and/or other materials provided with distribution. In 60158115Sume * addition, Licensee may not authorize further sublicense of source of any 61158115Sume * portion of the Covered Code, and must include terms to the effect that the 62158115Sume * license from Licensee to its licensee is limited to the intellectual 63158115Sume * property embodied in the software Licensee provides to its licensee, and 64158115Sume * not to intellectual property embodied in modifications its licensee may 65158115Sume * make. 66158115Sume * 67158115Sume * 3.3. Redistribution of Executable. Redistribution in executable form of any 68158115Sume * substantial portion of the Covered Code or modification must reproduce the 69158115Sume * above Copyright Notice, and the following Disclaimer and Export Compliance 70158115Sume * provision in the documentation and/or other materials provided with the 71158115Sume * distribution. 72158115Sume * 73158115Sume * 3.4. Intel retains all right, title, and interest in and to the Original 74158115Sume * Intel Code. 75158115Sume * 76158115Sume * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77158115Sume * Intel shall be used in advertising or otherwise to promote the sale, use or 78158115Sume * other dealings in products derived from or relating to the Covered Code 79158115Sume * without prior written authorization from Intel. 80158115Sume * 81158115Sume * 4. Disclaimer and Export Compliance 82158115Sume * 83158115Sume * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84158115Sume * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85158115Sume * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86158115Sume * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87158115Sume * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88158115Sume * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89158115Sume * PARTICULAR PURPOSE. 90158115Sume * 91158115Sume * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92158115Sume * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93158115Sume * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94158115Sume * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95158115Sume * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96158115Sume * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97158115Sume * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98158115Sume * LIMITED REMEDY. 99158115Sume * 100158115Sume * 4.3. Licensee shall not export, either directly or indirectly, any of this 101158115Sume * software or system incorporating such software without first obtaining any 102158115Sume * required license or other approval from the U. S. Department of Commerce or 103158115Sume * any other agency or department of the United States Government. In the 104158115Sume * event Licensee exports any such software from the United States or 105158115Sume * re-exports any such software from a foreign destination, Licensee shall 106158115Sume * ensure that the distribution and export/re-export of the software is in 107158115Sume * compliance with all laws, regulations, orders, or other restrictions of the 108158115Sume * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109158115Sume * any of its subsidiaries will export/re-export any technical data, process, 110158115Sume * software, or service, directly or indirectly, to any country for which the 111158115Sume * United States government or any agency thereof requires an export license, 112158115Sume * other governmental approval, or letter of assurance, without first obtaining 113158115Sume * such license, approval or letter. 114158115Sume * 115158115Sume *****************************************************************************/ 116158115Sume 117158115Sume#ifndef __ACSTRUCT_H__ 118194112Sdes#define __ACSTRUCT_H__ 119194112Sdes 120194112Sdes 121158115Sume/***************************************************************************** 122194112Sdes * 123158115Sume * Tree walking typedefs and structs 124194112Sdes * 125194112Sdes ****************************************************************************/ 126194112Sdes 127194112Sdes 128194112Sdes/* 129194112Sdes * Walk state - current state of a parse tree walk. Used for both a leisurely stroll through 130158115Sume * the tree (for whatever reason), and for control method execution. 131158115Sume */ 132194112Sdes 133158115Sume#define ACPI_NEXT_OP_DOWNWARD 1 134194112Sdes#define ACPI_NEXT_OP_UPWARD 2 135194112Sdes 136194112Sdes#define ACPI_WALK_NON_METHOD 0 137194112Sdes#define ACPI_WALK_METHOD 1 138158115Sume#define ACPI_WALK_METHOD_RESTART 2 139194112Sdes#define ACPI_WALK_CONST_REQUIRED 3 140194112Sdes#define ACPI_WALK_CONST_OPTIONAL 4 141194112Sdes 142158115Sumetypedef struct acpi_walk_state 143194112Sdes{ 144158115Sume UINT8 DataType; /* To differentiate various internal objs MUST BE FIRST!*/\ 145194112Sdes ACPI_OWNER_ID OwnerId; /* Owner of objects created during the walk */ 146158115Sume BOOLEAN LastPredicate; /* Result of last predicate */ 147158115Sume UINT8 CurrentResult; /* */ 148158115Sume UINT8 NextOpInfo; /* Info about NextOp */ 149 UINT8 NumOperands; /* Stack pointer for Operands[] array */ 150 UINT8 ReturnUsed; 151 UINT8 WalkType; 152 UINT16 Opcode; /* Current AML opcode */ 153 UINT8 ScopeDepth; 154 UINT8 Reserved1; 155 UINT32 ArgCount; /* push for fixed or var args */ 156 UINT32 AmlOffset; 157 UINT32 ArgTypes; 158 UINT32 MethodBreakpoint; /* For single stepping */ 159 UINT32 UserBreakpoint; /* User AML breakpoint */ 160 UINT32 ParseFlags; 161 UINT32 PrevArgTypes; 162 163 164 UINT8 *AmlLastWhile; 165 struct acpi_node Arguments[MTH_NUM_ARGS]; /* Control method arguments */ 166 union acpi_operand_obj **CallerReturnDesc; 167 ACPI_GENERIC_STATE *ControlState; /* List of control states (nested IFs) */ 168 struct acpi_node LocalVariables[MTH_NUM_LOCALS]; /* Control method locals */ 169 struct acpi_node *MethodCallNode; /* Called method Node*/ 170 ACPI_PARSE_OBJECT *MethodCallOp; /* MethodCall Op if running a method */ 171 union acpi_operand_obj *MethodDesc; /* Method descriptor if running a method */ 172 struct acpi_node *MethodNode; /* Method Node if running a method */ 173 ACPI_PARSE_OBJECT *Op; /* Current parser op */ 174 union acpi_operand_obj *Operands[OBJ_NUM_OPERANDS+1]; /* Operands passed to the interpreter (+1 for NULL terminator) */ 175 const ACPI_OPCODE_INFO *OpInfo; /* Info on current opcode */ 176 ACPI_PARSE_OBJECT *Origin; /* Start of walk [Obsolete] */ 177 union acpi_operand_obj **Params; 178 ACPI_PARSE_STATE ParserState; /* Current state of parser */ 179 union acpi_operand_obj *ResultObj; 180 ACPI_GENERIC_STATE *Results; /* Stack of accumulated results */ 181 union acpi_operand_obj *ReturnDesc; /* Return object, if any */ 182 ACPI_GENERIC_STATE *ScopeInfo; /* Stack of nested scopes */ 183 184 ACPI_PARSE_OBJECT *PrevOp; /* Last op that was processed */ 185 ACPI_PARSE_OBJECT *NextOp; /* next op to be processed */ 186 ACPI_PARSE_DOWNWARDS DescendingCallback; 187 ACPI_PARSE_UPWARDS AscendingCallback; 188 ACPI_THREAD_STATE *Thread; 189 struct acpi_walk_state *Next; /* Next WalkState in list */ 190 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 OwnerId; 233 UINT8 DisplayType; 234 235} ACPI_WALK_INFO; 236 237/* Display Types */ 238 239#define ACPI_DISPLAY_SUMMARY 0 240#define ACPI_DISPLAY_OBJECTS 1 241 242typedef struct acpi_get_devices_info 243{ 244 ACPI_WALK_CALLBACK UserFunction; 245 void *Context; 246 NATIVE_CHAR *Hid; 247 248} ACPI_GET_DEVICES_INFO; 249 250 251typedef union acpi_aml_operands 252{ 253 ACPI_OPERAND_OBJECT *Operands[7]; 254 255 struct 256 { 257 ACPI_OBJECT_INTEGER *Type; 258 ACPI_OBJECT_INTEGER *Code; 259 ACPI_OBJECT_INTEGER *Argument; 260 261 } Fatal; 262 263 struct 264 { 265 ACPI_OPERAND_OBJECT *Source; 266 ACPI_OBJECT_INTEGER *Index; 267 ACPI_OPERAND_OBJECT *Target; 268 269 } Index; 270 271 struct 272 { 273 ACPI_OPERAND_OBJECT *Source; 274 ACPI_OBJECT_INTEGER *Index; 275 ACPI_OBJECT_INTEGER *Length; 276 ACPI_OPERAND_OBJECT *Target; 277 278 } Mid; 279 280} ACPI_AML_OPERANDS; 281 282 283#endif 284