acpi/acpica/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 - 2024, 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  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #ifndef __ACSTRUCT_H__
0153 #define __ACSTRUCT_H__
0154
0155 /* acpisrc:StructDefs -- for acpisrc conversion */
0156
0157 /*****************************************************************************
0158  *
0159  * Tree walking typedefs and structs
0160  *
0161  ****************************************************************************/
0162
0163
0164 /*
0165  * Walk state - current state of a parse tree walk. Used for both a leisurely
0166  * stroll through the tree (for whatever reason), and for control method
0167  * execution.
0168  */
0169 #define ACPI_NEXT_OP_DOWNWARD       1
0170 #define ACPI_NEXT_OP_UPWARD         2
0171
0172 /*
0173  * Groups of definitions for WalkType used for different implementations of
0174  * walkers (never simultaneously) - flags for interpreter:
0175  */
0176 #define ACPI_WALK_NON_METHOD        0
0177 #define ACPI_WALK_METHOD            0x01
0178 #define ACPI_WALK_METHOD_RESTART    0x02
0179
0180
0181 typedef struct acpi_walk_state
0182 {
0183     struct acpi_walk_state          *Next;              /* Next WalkState in list */
0184     UINT8                           DescriptorType;     /* To differentiate various internal objs */
0185     UINT8                           WalkType;
0186     UINT16                          Opcode;             /* Current AML opcode */
0187     UINT8                           NextOpInfo;         /* Info about NextOp */
0188     UINT8                           NumOperands;        /* Stack pointer for Operands[] array */
0189     UINT8                           OperandIndex;       /* Index into operand stack, to be used by AcpiDsObjStackPush */
0190     ACPI_OWNER_ID                   OwnerId;            /* Owner of objects created during the walk */
0191     BOOLEAN                         LastPredicate;      /* Result of last predicate */
0192     UINT8                           CurrentResult;
0193     UINT8                           ReturnUsed;
0194     UINT8                           ScopeDepth;
0195     UINT8                           PassNumber;         /* Parse pass during table load */
0196     BOOLEAN                         NamespaceOverride;  /* Override existing objects */
0197     UINT8                           ResultSize;         /* Total elements for the result stack */
0198     UINT8                           ResultCount;        /* Current number of occupied elements of result stack */
0199     UINT8                           *Aml;
0200     UINT32                          ArgTypes;
0201     UINT32                          MethodBreakpoint;   /* For single stepping */
0202     UINT32                          UserBreakpoint;     /* User AML breakpoint */
0203     UINT32                          ParseFlags;
0204
0205     ACPI_PARSE_STATE                ParserState;        /* Current state of parser */
0206     UINT32                          PrevArgTypes;
0207     UINT32                          ArgCount;           /* push for fixed or var args */
0208     UINT16                          MethodNestingDepth;
0209     UINT8                           MethodIsNested;
0210
0211     struct acpi_namespace_node      Arguments[ACPI_METHOD_NUM_ARGS];        /* Control method arguments */
0212     struct acpi_namespace_node      LocalVariables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */
0213     union acpi_operand_object       *Operands[ACPI_OBJ_NUM_OPERANDS + 1];   /* Operands passed to the interpreter (+1 for NULL terminator) */
0214     union acpi_operand_object       **Params;
0215
0216     UINT8                           *AmlLastWhile;
0217     union acpi_operand_object       **CallerReturnDesc;
0218     ACPI_GENERIC_STATE              *ControlState;      /* List of control states (nested IFs) */
0219     struct acpi_namespace_node      *DeferredNode;      /* Used when executing deferred opcodes */
0220     union acpi_operand_object       *ImplicitReturnObj;
0221     struct acpi_namespace_node      *MethodCallNode;    /* Called method Node*/
0222     ACPI_PARSE_OBJECT               *MethodCallOp;      /* MethodCall Op if running a method */
0223     union acpi_operand_object       *MethodDesc;        /* Method descriptor if running a method */
0224     struct acpi_namespace_node      *MethodNode;        /* Method node if running a method */
0225     char                            *MethodPathname;    /* Full pathname of running method */
0226     ACPI_PARSE_OBJECT               *Op;                /* Current parser op */
0227     const ACPI_OPCODE_INFO          *OpInfo;            /* Info on current opcode */
0228     ACPI_PARSE_OBJECT               *Origin;            /* Start of walk [Obsolete] */
0229     union acpi_operand_object       *ResultObj;
0230     ACPI_GENERIC_STATE              *Results;           /* Stack of accumulated results */
0231     union acpi_operand_object       *ReturnDesc;        /* Return object, if any */
0232     ACPI_GENERIC_STATE              *ScopeInfo;         /* Stack of nested scopes */
0233     ACPI_PARSE_OBJECT               *PrevOp;            /* Last op that was processed */
0234     ACPI_PARSE_OBJECT               *NextOp;            /* next op to be processed */
0235     ACPI_THREAD_STATE               *Thread;
0236     ACPI_PARSE_DOWNWARDS            DescendingCallback;
0237     ACPI_PARSE_UPWARDS              AscendingCallback;
0238
0239 } ACPI_WALK_STATE;
0240
0241
0242 /* Info used by AcpiNsInitializeObjects and AcpiDsInitializeObjects */
0243
0244 typedef struct acpi_init_walk_info
0245 {
0246     UINT32                          TableIndex;
0247     UINT32                          ObjectCount;
0248     UINT32                          MethodCount;
0249     UINT32                          SerialMethodCount;
0250     UINT32                          NonSerialMethodCount;
0251     UINT32                          SerializedMethodCount;
0252     UINT32                          DeviceCount;
0253     UINT32                          OpRegionCount;
0254     UINT32                          FieldCount;
0255     UINT32                          BufferCount;
0256     UINT32                          PackageCount;
0257     UINT32                          OpRegionInit;
0258     UINT32                          FieldInit;
0259     UINT32                          BufferInit;
0260     UINT32                          PackageInit;
0261     ACPI_OWNER_ID                   OwnerId;
0262
0263 } ACPI_INIT_WALK_INFO;
0264
0265
0266 typedef struct acpi_get_devices_info
0267 {
0268     ACPI_WALK_CALLBACK              UserFunction;
0269     void                            *Context;
0270     char                            *Hid;
0271
0272 } ACPI_GET_DEVICES_INFO;
0273
0274
0275 typedef union acpi_aml_operands
0276 {
0277     ACPI_OPERAND_OBJECT             *Operands[7];
0278
0279     struct
0280     {
0281         ACPI_OBJECT_INTEGER             *Type;
0282         ACPI_OBJECT_INTEGER             *Code;
0283         ACPI_OBJECT_INTEGER             *Argument;
0284
0285     } Fatal;
0286
0287     struct
0288     {
0289         ACPI_OPERAND_OBJECT             *Source;
0290         ACPI_OBJECT_INTEGER             *Index;
0291         ACPI_OPERAND_OBJECT             *Target;
0292
0293     } Index;
0294
0295     struct
0296     {
0297         ACPI_OPERAND_OBJECT             *Source;
0298         ACPI_OBJECT_INTEGER             *Index;
0299         ACPI_OBJECT_INTEGER             *Length;
0300         ACPI_OPERAND_OBJECT             *Target;
0301
0302     } Mid;
0303
0304 } ACPI_AML_OPERANDS;
0305
0306
0307 /*
0308  * Structure used to pass object evaluation information and parameters.
0309  * Purpose is to reduce CPU stack use.
0310  */
0311 typedef struct acpi_evaluate_info
0312 {
0313     /* The first 3 elements are passed by the caller to AcpiNsEvaluate */
0314
0315     ACPI_NAMESPACE_NODE             *PrefixNode;        /* Input: starting node */
0316     const char                      *RelativePathname;  /* Input: path relative to PrefixNode */
0317     ACPI_OPERAND_OBJECT             **Parameters;       /* Input: argument list */
0318
0319     ACPI_NAMESPACE_NODE             *Node;              /* Resolved node (PrefixNode:RelativePathname) */
0320     ACPI_OPERAND_OBJECT             *ObjDesc;           /* Object attached to the resolved node */
0321     char                            *FullPathname;      /* Full pathname of the resolved node */
0322
0323     const ACPI_PREDEFINED_INFO      *Predefined;        /* Used if Node is a predefined name */
0324     ACPI_OPERAND_OBJECT             *ReturnObject;      /* Object returned from the evaluation */
0325     union acpi_operand_object       *ParentPackage;     /* Used if return object is a Package */
0326
0327     UINT32                          ReturnFlags;        /* Used for return value analysis */
0328     UINT32                          ReturnBtype;        /* Bitmapped type of the returned object */
0329     UINT16                          ParamCount;         /* Count of the input argument list */
0330     UINT16                          NodeFlags;          /* Same as Node->Flags */
0331     UINT8                           PassNumber;         /* Parser pass number */
0332     UINT8                           ReturnObjectType;   /* Object type of the returned object */
0333     UINT8                           Flags;              /* General flags */
0334
0335 } ACPI_EVALUATE_INFO;
0336
0337 /* Values for Flags above */
0338
0339 #define ACPI_IGNORE_RETURN_VALUE    1
0340
0341 /* Defines for ReturnFlags field above */
0342
0343 #define ACPI_OBJECT_REPAIRED        1
0344 #define ACPI_OBJECT_WRAPPED         2
0345
0346
0347 /* Info used by AcpiNsInitializeDevices */
0348
0349 typedef struct acpi_device_walk_info
0350 {
0351     ACPI_TABLE_DESC                 *TableDesc;
0352     ACPI_EVALUATE_INFO              *EvaluateInfo;
0353     UINT32                          DeviceCount;
0354     UINT32                          Num_STA;
0355     UINT32                          Num_INI;
0356
0357 } ACPI_DEVICE_WALK_INFO;
0358
0359
0360 /* Info used by Acpi  AcpiDbDisplayFields */
0361
0362 typedef struct acpi_region_walk_info
0363 {
0364     UINT32                          DebugLevel;
0365     UINT32                          Count;
0366     ACPI_OWNER_ID                   OwnerId;
0367     UINT8                           DisplayType;
0368     UINT32                          AddressSpaceId;
0369
0370 } ACPI_REGION_WALK_INFO;
0371
0372
0373 /* TBD: [Restructure] Merge with struct above */
0374
0375 typedef struct acpi_walk_info
0376 {
0377     UINT32                          DebugLevel;
0378     UINT32                          Count;
0379     ACPI_OWNER_ID                   OwnerId;
0380     UINT8                           DisplayType;
0381
0382 } ACPI_WALK_INFO;
0383
0384 /* Display Types */
0385
0386 #define ACPI_DISPLAY_SUMMARY        (UINT8) 0
0387 #define ACPI_DISPLAY_OBJECTS        (UINT8) 1
0388 #define ACPI_DISPLAY_MASK           (UINT8) 1
0389
0390 #define ACPI_DISPLAY_SHORT          (UINT8) 2
0391
0392
0393 #endif