include/acpi/acstruct.h

   1 /******************************************************************************
   2  *
   3  * Name: acstruct.h - Internal structs
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2006, R. Byron Moore
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #ifndef __ACSTRUCT_H__
  45 #define __ACSTRUCT_H__
  46
  47 /* acpisrc:struct_defs -- for acpisrc conversion */
  48
  49 /*****************************************************************************
  50  *
  51  * Tree walking typedefs and structs
  52  *
  53  ****************************************************************************/
  54
  55 /*
  56  * Walk state - current state of a parse tree walk.  Used for both a leisurely stroll through
  57  * the tree (for whatever reason), and for control method execution.
  58  */
  59 #define ACPI_NEXT_OP_DOWNWARD       1
  60 #define ACPI_NEXT_OP_UPWARD         2
  61
  62 #define ACPI_WALK_NON_METHOD        0
  63 #define ACPI_WALK_METHOD            1
  64 #define ACPI_WALK_METHOD_RESTART    2
  65 #define ACPI_WALK_CONST_REQUIRED    3
  66 #define ACPI_WALK_CONST_OPTIONAL    4
  67
  68 struct acpi_walk_state {
  69         struct acpi_walk_state *next;   /* Next walk_state in list */
  70         u8 descriptor_type;     /* To differentiate various internal objs */
  71         u8 walk_type;
  72         u16 opcode;             /* Current AML opcode */
  73         u8 next_op_info;        /* Info about next_op */
  74         u8 num_operands;        /* Stack pointer for Operands[] array */
  75         acpi_owner_id owner_id; /* Owner of objects created during the walk */
  76         u8 last_predicate;      /* Result of last predicate */
  77         u8 current_result;
  78         u8 return_used;
  79         u8 scope_depth;
  80         u8 pass_number;         /* Parse pass during table load */
  81         u32 aml_offset;
  82         u32 arg_types;
  83         u32 method_breakpoint;  /* For single stepping */
  84         u32 user_breakpoint;    /* User AML breakpoint */
  85         u32 parse_flags;
  86
  87         struct acpi_parse_state parser_state;   /* Current state of parser */
  88         u32 prev_arg_types;
  89         u32 arg_count;          /* push for fixed or var args */
  90
  91         struct acpi_namespace_node arguments[ACPI_METHOD_NUM_ARGS];     /* Control method arguments */
  92         struct acpi_namespace_node local_variables[ACPI_METHOD_NUM_LOCALS];     /* Control method locals */
  93         union acpi_operand_object *operands[ACPI_OBJ_NUM_OPERANDS + 1]; /* Operands passed to the interpreter (+1 for NULL terminator) */
  94         union acpi_operand_object **params;
  95
  96         u8 *aml_last_while;
  97         union acpi_operand_object **caller_return_desc;
  98         union acpi_generic_state *control_state;        /* List of control states (nested IFs) */
  99         struct acpi_namespace_node *deferred_node;      /* Used when executing deferred opcodes */
 100         struct acpi_gpe_event_info *gpe_event_info;     /* Info for GPE (_Lxx/_Exx methods only */
 101         union acpi_operand_object *implicit_return_obj;
 102         struct acpi_namespace_node *method_call_node;   /* Called method Node */
 103         union acpi_parse_object *method_call_op;        /* method_call Op if running a method */
 104         union acpi_operand_object *method_desc; /* Method descriptor if running a method */
 105         struct acpi_namespace_node *method_node;        /* Method node if running a method. */
 106         union acpi_parse_object *op;    /* Current parser op */
 107         const struct acpi_opcode_info *op_info; /* Info on current opcode */
 108         union acpi_parse_object *origin;        /* Start of walk [Obsolete] */
 109         union acpi_operand_object *result_obj;
 110         union acpi_generic_state *results;      /* Stack of accumulated results */
 111         union acpi_operand_object *return_desc; /* Return object, if any */
 112         union acpi_generic_state *scope_info;   /* Stack of nested scopes */
 113         union acpi_parse_object *prev_op;       /* Last op that was processed */
 114         union acpi_parse_object *next_op;       /* next op to be processed */
 115         struct acpi_thread_state *thread;
 116         acpi_parse_downwards descending_callback;
 117         acpi_parse_upwards ascending_callback;
 118 };
 119
 120 /* Info used by acpi_ps_init_objects */
 121
 122 struct acpi_init_walk_info {
 123         u16 method_count;
 124         u16 device_count;
 125         u16 op_region_count;
 126         u16 field_count;
 127         u16 buffer_count;
 128         u16 package_count;
 129         u16 op_region_init;
 130         u16 field_init;
 131         u16 buffer_init;
 132         u16 package_init;
 133         u16 object_count;
 134         struct acpi_table_desc *table_desc;
 135 };
 136
 137 /* Info used by acpi_ns_initialize_devices */
 138
 139 struct acpi_device_walk_info {
 140         u16 device_count;
 141         u16 num_STA;
 142         u16 num_INI;
 143         struct acpi_table_desc *table_desc;
 144 };
 145
 146 /* TBD: [Restructure] Merge with struct above */
 147
 148 struct acpi_walk_info {
 149         u32 debug_level;
 150         u32 count;
 151         acpi_owner_id owner_id;
 152         u8 display_type;
 153 };
 154
 155 /* Display Types */
 156
 157 #define ACPI_DISPLAY_SUMMARY        (u8) 0
 158 #define ACPI_DISPLAY_OBJECTS        (u8) 1
 159 #define ACPI_DISPLAY_MASK           (u8) 1
 160
 161 #define ACPI_DISPLAY_SHORT          (u8) 2
 162
 163 struct acpi_get_devices_info {
 164         acpi_walk_callback user_function;
 165         void *context;
 166         char *hid;
 167 };
 168
 169 union acpi_aml_operands {
 170         union acpi_operand_object *operands[7];
 171
 172         struct {
 173                 struct acpi_object_integer *type;
 174                 struct acpi_object_integer *code;
 175                 struct acpi_object_integer *argument;
 176
 177         } fatal;
 178
 179         struct {
 180                 union acpi_operand_object *source;
 181                 struct acpi_object_integer *index;
 182                 union acpi_operand_object *target;
 183
 184         } index;
 185
 186         struct {
 187                 union acpi_operand_object *source;
 188                 struct acpi_object_integer *index;
 189                 struct acpi_object_integer *length;
 190                 union acpi_operand_object *target;
 191
 192         } mid;
 193 };
 194
 195 /* Internal method parameter list */
 196
 197 struct acpi_parameter_info {
 198         struct acpi_namespace_node *node;
 199         union acpi_operand_object *obj_desc;
 200         union acpi_operand_object **parameters;
 201         union acpi_operand_object *return_object;
 202         u8 pass_number;
 203         u8 parameter_type;
 204         u8 return_object_type;
 205 };
 206
 207 /* Types for parameter_type above */
 208
 209 #define ACPI_PARAM_ARGS                 0
 210 #define ACPI_PARAM_GPE                  1
 211
 212 #endif