Subversion Repositories Kolibri OS

Rev

Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /******************************************************************************
  2.  *
  3.  * Name: acstruct.h - Internal structs
  4.  *
  5.  *****************************************************************************/
  6.  
  7. /******************************************************************************
  8.  *
  9.  * 1. Copyright Notice
  10.  *
  11.  * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
  12.  * All rights reserved.
  13.  *
  14.  * 2. License
  15.  *
  16.  * 2.1. This is your license from Intel Corp. under its intellectual property
  17.  * rights.  You may have additional license terms from the party that provided
  18.  * you this software, covering your right to use that party's intellectual
  19.  * property rights.
  20.  *
  21.  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22.  * copy of the source code appearing in this file ("Covered Code") an
  23.  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24.  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25.  * make derivatives, distribute, use and display any portion of the Covered
  26.  * Code in any form, with the right to sublicense such rights; and
  27.  *
  28.  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29.  * license (with the right to sublicense), under only those claims of Intel
  30.  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31.  * offer to sell, and import the Covered Code and derivative works thereof
  32.  * solely to the minimum extent necessary to exercise the above copyright
  33.  * license, and in no event shall the patent license extend to any additions
  34.  * to or modifications of the Original Intel Code.  No other license or right
  35.  * is granted directly or by implication, estoppel or otherwise;
  36.  *
  37.  * The above copyright and patent license is granted only if the following
  38.  * conditions are met:
  39.  *
  40.  * 3. Conditions
  41.  *
  42.  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43.  * Redistribution of source code of any substantial portion of the Covered
  44.  * Code or modification with rights to further distribute source must include
  45.  * the above Copyright Notice, the above License, this list of Conditions,
  46.  * and the following Disclaimer and Export Compliance provision.  In addition,
  47.  * Licensee must cause all Covered Code to which Licensee contributes to
  48.  * contain a file documenting the changes Licensee made to create that Covered
  49.  * Code and the date of any change.  Licensee must include in that file the
  50.  * documentation of any changes made by any predecessor Licensee.  Licensee
  51.  * must include a prominent statement that the modification is derived,
  52.  * directly or indirectly, from Original Intel Code.
  53.  *
  54.  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55.  * Redistribution of source code of any substantial portion of the Covered
  56.  * Code or modification without rights to further distribute source must
  57.  * include the following Disclaimer and Export Compliance provision in the
  58.  * documentation and/or other materials provided with distribution.  In
  59.  * addition, Licensee may not authorize further sublicense of source of any
  60.  * portion of the Covered Code, and must include terms to the effect that the
  61.  * license from Licensee to its licensee is limited to the intellectual
  62.  * property embodied in the software Licensee provides to its licensee, and
  63.  * not to intellectual property embodied in modifications its licensee may
  64.  * make.
  65.  *
  66.  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67.  * substantial portion of the Covered Code or modification must reproduce the
  68.  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69.  * provision in the documentation and/or other materials provided with the
  70.  * distribution.
  71.  *
  72.  * 3.4. Intel retains all right, title, and interest in and to the Original
  73.  * Intel Code.
  74.  *
  75.  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76.  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77.  * other dealings in products derived from or relating to the Covered Code
  78.  * without prior written authorization from Intel.
  79.  *
  80.  * 4. Disclaimer and Export Compliance
  81.  *
  82.  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83.  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84.  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85.  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86.  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87.  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88.  * PARTICULAR PURPOSE.
  89.  *
  90.  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91.  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92.  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93.  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94.  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95.  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96.  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97.  * LIMITED REMEDY.
  98.  *
  99.  * 4.3. Licensee shall not export, either directly or indirectly, any of this
  100.  * software or system incorporating such software without first obtaining any
  101.  * required license or other approval from the U. S. Department of Commerce or
  102.  * any other agency or department of the United States Government.  In the
  103.  * event Licensee exports any such software from the United States or
  104.  * re-exports any such software from a foreign destination, Licensee shall
  105.  * ensure that the distribution and export/re-export of the software is in
  106.  * compliance with all laws, regulations, orders, or other restrictions of the
  107.  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
  108.  * any of its subsidiaries will export/re-export any technical data, process,
  109.  * software, or service, directly or indirectly, to any country for which the
  110.  * United States government or any agency thereof requires an export license,
  111.  * other governmental approval, or letter of assurance, without first obtaining
  112.  * such license, approval or letter.
  113.  *
  114.  *****************************************************************************/
  115.  
  116. #ifndef __ACSTRUCT_H__
  117. #define __ACSTRUCT_H__
  118.  
  119. /* acpisrc:StructDefs -- for acpisrc conversion */
  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
  130.  * stroll through the tree (for whatever reason), and for control method
  131.  * execution.
  132.  */
  133. #define ACPI_NEXT_OP_DOWNWARD       1
  134. #define ACPI_NEXT_OP_UPWARD         2
  135.  
  136. /*
  137.  * Groups of definitions for WalkType used for different implementations of
  138.  * walkers (never simultaneously) - flags for interpreter:
  139.  */
  140. #define ACPI_WALK_NON_METHOD        0
  141. #define ACPI_WALK_METHOD            0x01
  142. #define ACPI_WALK_METHOD_RESTART    0x02
  143.  
  144. /* Flags for iASL compiler only */
  145.  
  146. #define ACPI_WALK_CONST_REQUIRED    0x10
  147. #define ACPI_WALK_CONST_OPTIONAL    0x20
  148.  
  149.  
  150. typedef struct acpi_walk_state
  151. {
  152.     struct acpi_walk_state          *Next;              /* Next WalkState in list */
  153.     UINT8                           DescriptorType;     /* To differentiate various internal objs */
  154.     UINT8                           WalkType;
  155.     UINT16                          Opcode;             /* Current AML opcode */
  156.     UINT8                           NextOpInfo;         /* Info about NextOp */
  157.     UINT8                           NumOperands;        /* Stack pointer for Operands[] array */
  158.     UINT8                           OperandIndex;       /* Index into operand stack, to be used by AcpiDsObjStackPush */
  159.     ACPI_OWNER_ID                   OwnerId;            /* Owner of objects created during the walk */
  160.     BOOLEAN                         LastPredicate;      /* Result of last predicate */
  161.     UINT8                           CurrentResult;
  162.     UINT8                           ReturnUsed;
  163.     UINT8                           ScopeDepth;
  164.     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 AcpiNsInitializeObjects and AcpiDsInitializeObjects */
  208.  
  209. typedef struct acpi_init_walk_info
  210. {
  211.     UINT32                          TableIndex;
  212.     UINT32                          ObjectCount;
  213.     UINT32                          MethodCount;
  214.     UINT32                          DeviceCount;
  215.     UINT32                          OpRegionCount;
  216.     UINT32                          FieldCount;
  217.     UINT32                          BufferCount;
  218.     UINT32                          PackageCount;
  219.     UINT32                          OpRegionInit;
  220.     UINT32                          FieldInit;
  221.     UINT32                          BufferInit;
  222.     UINT32                          PackageInit;
  223.     ACPI_OWNER_ID                   OwnerId;
  224.  
  225. } ACPI_INIT_WALK_INFO;
  226.  
  227.  
  228. typedef 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.  
  237. typedef 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.  */
  273. typedef 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.  
  295. typedef struct acpi_device_walk_info
  296. {
  297.     ACPI_TABLE_DESC                 *TableDesc;
  298.     ACPI_EVALUATE_INFO              *EvaluateInfo;
  299.     UINT32                          DeviceCount;
  300.     UINT32                          Num_STA;
  301.     UINT32                          Num_INI;
  302.  
  303. } ACPI_DEVICE_WALK_INFO;
  304.  
  305.  
  306. /* TBD: [Restructure] Merge with struct above */
  307.  
  308. typedef 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.