drivers/acpi/acstruct.h

0001 /******************************************************************************
0002  *
0003  * Name: acstruct.h - Internal structs
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights.  You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code.  No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision.  In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change.  Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee.  Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution.  In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government.  In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************/
0115
0116 #ifndef __ACSTRUCT_H__
0117 #define __ACSTRUCT_H__
0118
0119 /* acpisrc:StructDefs -- for acpisrc conversion */
0120
0121 /*****************************************************************************
0122  *
0123  * Tree walking typedefs and structs
0124  *
0125  ****************************************************************************/
0126
0127
0128 /*
0129  * Walk state - current state of a parse tree walk.  Used for both a leisurely
0130  * stroll through the tree (for whatever reason), and for control method
0131  * execution.
0132  */
0133 #define ACPI_NEXT_OP_DOWNWARD       1
0134 #define ACPI_NEXT_OP_UPWARD         2
0135
0136 /*
0137  * Groups of definitions for WalkType used for different implementations of
0138  * walkers (never simultaneously) - flags for interpreter:
0139  */
0140 #define ACPI_WALK_NON_METHOD        0
0141 #define ACPI_WALK_METHOD            0x01
0142 #define ACPI_WALK_METHOD_RESTART    0x02
0143
0144 /* Flags for iASL compiler only */
0145
0146 #define ACPI_WALK_CONST_REQUIRED    0x10
0147 #define ACPI_WALK_CONST_OPTIONAL    0x20
0148
0149
0150 typedef struct acpi_walk_state
0151 {
0152     struct acpi_walk_state          *Next;              /* Next WalkState in list */
0153     UINT8                           DescriptorType;     /* To differentiate various internal objs */
0154     UINT8                           WalkType;
0155     UINT16                          Opcode;             /* Current AML opcode */
0156     UINT8                           NextOpInfo;         /* Info about NextOp */
0157     UINT8                           NumOperands;        /* Stack pointer for Operands[] array */
0158     UINT8                           OperandIndex;       /* Index into operand stack, to be used by AcpiDsObjStackPush */
0159     ACPI_OWNER_ID                   OwnerId;            /* Owner of objects created during the walk */
0160     BOOLEAN                         LastPredicate;      /* Result of last predicate */
0161     UINT8                           CurrentResult;
0162     UINT8                           ReturnUsed;
0163     UINT8                           ScopeDepth;
0164     UINT8                           PassNumber;         /* Parse pass during table load */
0165     UINT8                           ResultSize;         /* Total elements for the result stack */
0166     UINT8                           ResultCount;        /* Current number of occupied elements of result stack */
0167     UINT32                          AmlOffset;
0168     UINT32                          ArgTypes;
0169     UINT32                          MethodBreakpoint;   /* For single stepping */
0170     UINT32                          UserBreakpoint;     /* User AML breakpoint */
0171     UINT32                          ParseFlags;
0172
0173     ACPI_PARSE_STATE                ParserState;        /* Current state of parser */
0174     UINT32                          PrevArgTypes;
0175     UINT32                          ArgCount;           /* push for fixed or var args */
0176
0177     struct acpi_namespace_node      Arguments[ACPI_METHOD_NUM_ARGS];        /* Control method arguments */
0178     struct acpi_namespace_node      LocalVariables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */
0179     union acpi_operand_object       *Operands[ACPI_OBJ_NUM_OPERANDS + 1];   /* Operands passed to the interpreter (+1 for NULL terminator) */
0180     union acpi_operand_object       **Params;
0181
0182     UINT8                           *AmlLastWhile;
0183     union acpi_operand_object       **CallerReturnDesc;
0184     ACPI_GENERIC_STATE              *ControlState;      /* List of control states (nested IFs) */
0185     struct acpi_namespace_node      *DeferredNode;      /* Used when executing deferred opcodes */
0186     union acpi_operand_object       *ImplicitReturnObj;
0187     struct acpi_namespace_node      *MethodCallNode;    /* Called method Node*/
0188     ACPI_PARSE_OBJECT               *MethodCallOp;      /* MethodCall Op if running a method */
0189     union acpi_operand_object       *MethodDesc;        /* Method descriptor if running a method */
0190     struct acpi_namespace_node      *MethodNode;        /* Method node if running a method. */
0191     ACPI_PARSE_OBJECT               *Op;                /* Current parser op */
0192     const ACPI_OPCODE_INFO          *OpInfo;            /* Info on current opcode */
0193     ACPI_PARSE_OBJECT               *Origin;            /* Start of walk [Obsolete] */
0194     union acpi_operand_object       *ResultObj;
0195     ACPI_GENERIC_STATE              *Results;           /* Stack of accumulated results */
0196     union acpi_operand_object       *ReturnDesc;        /* Return object, if any */
0197     ACPI_GENERIC_STATE              *ScopeInfo;         /* Stack of nested scopes */
0198     ACPI_PARSE_OBJECT               *PrevOp;            /* Last op that was processed */
0199     ACPI_PARSE_OBJECT               *NextOp;            /* next op to be processed */
0200     ACPI_THREAD_STATE               *Thread;
0201     ACPI_PARSE_DOWNWARDS            DescendingCallback;
0202     ACPI_PARSE_UPWARDS              AscendingCallback;
0203
0204 } ACPI_WALK_STATE;
0205
0206
0207 /* Info used by AcpiPsInitObjects */
0208
0209 typedef struct acpi_init_walk_info
0210 {
0211     UINT16                          MethodCount;
0212     UINT16                          DeviceCount;
0213     UINT16                          OpRegionCount;
0214     UINT16                          FieldCount;
0215     UINT16                          BufferCount;
0216     UINT16                          PackageCount;
0217     UINT16                          OpRegionInit;
0218     UINT16                          FieldInit;
0219     UINT16                          BufferInit;
0220     UINT16                          PackageInit;
0221     UINT16                          ObjectCount;
0222     ACPI_OWNER_ID                   OwnerId;
0223     UINT32                          TableIndex;
0224
0225 } ACPI_INIT_WALK_INFO;
0226
0227
0228 typedef struct acpi_get_devices_info
0229 {
0230     ACPI_WALK_CALLBACK              UserFunction;
0231     void                            *Context;
0232     char                            *Hid;
0233
0234 } ACPI_GET_DEVICES_INFO;
0235
0236
0237 typedef union acpi_aml_operands
0238 {
0239     ACPI_OPERAND_OBJECT             *Operands[7];
0240
0241     struct
0242     {
0243         ACPI_OBJECT_INTEGER             *Type;
0244         ACPI_OBJECT_INTEGER             *Code;
0245         ACPI_OBJECT_INTEGER             *Argument;
0246
0247     } Fatal;
0248
0249     struct
0250     {
0251         ACPI_OPERAND_OBJECT             *Source;
0252         ACPI_OBJECT_INTEGER             *Index;
0253         ACPI_OPERAND_OBJECT             *Target;
0254
0255     } Index;
0256
0257     struct
0258     {
0259         ACPI_OPERAND_OBJECT             *Source;
0260         ACPI_OBJECT_INTEGER             *Index;
0261         ACPI_OBJECT_INTEGER             *Length;
0262         ACPI_OPERAND_OBJECT             *Target;
0263
0264     } Mid;
0265
0266 } ACPI_AML_OPERANDS;
0267
0268
0269 /*
0270  * Structure used to pass object evaluation parameters.
0271  * Purpose is to reduce CPU stack use.
0272  */
0273 typedef struct acpi_evaluate_info
0274 {
0275     ACPI_NAMESPACE_NODE             *PrefixNode;
0276     char                            *Pathname;
0277     ACPI_OPERAND_OBJECT             *ObjDesc;
0278     ACPI_OPERAND_OBJECT             **Parameters;
0279     ACPI_NAMESPACE_NODE             *ResolvedNode;
0280     ACPI_OPERAND_OBJECT             *ReturnObject;
0281     UINT8                           ParamCount;
0282     UINT8                           PassNumber;
0283     UINT8                           ReturnObjectType;
0284     UINT8                           Flags;
0285
0286 } ACPI_EVALUATE_INFO;
0287
0288 /* Values for Flags above */
0289
0290 #define ACPI_IGNORE_RETURN_VALUE        1
0291
0292
0293 /* Info used by AcpiNsInitializeDevices */
0294
0295 typedef struct acpi_device_walk_info
0296 {
0297     UINT16                          DeviceCount;
0298     UINT16                          Num_STA;
0299     UINT16                          Num_INI;
0300     ACPI_TABLE_DESC                 *TableDesc;
0301     ACPI_EVALUATE_INFO              *EvaluateInfo;
0302
0303 } ACPI_DEVICE_WALK_INFO;
0304
0305
0306 /* TBD: [Restructure] Merge with struct above */
0307
0308 typedef struct acpi_walk_info
0309 {
0310     UINT32                          DebugLevel;
0311     UINT32                          Count;
0312     ACPI_OWNER_ID                   OwnerId;
0313     UINT8                           DisplayType;
0314
0315 } ACPI_WALK_INFO;
0316
0317 /* Display Types */
0318
0319 #define ACPI_DISPLAY_SUMMARY        (UINT8) 0
0320 #define ACPI_DISPLAY_OBJECTS        (UINT8) 1
0321 #define ACPI_DISPLAY_MASK           (UINT8) 1
0322
0323 #define ACPI_DISPLAY_SHORT          (UINT8) 2
0324
0325
0326 #endif