Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /****************************************************************************** |
| 2 | * |
| 3 | * Name: acstruct.h - Internal structs |
| 4 | * |
| 5 | *****************************************************************************/ |
| 6 | |
| 7 | /* |
Len Brown | 75a44ce | 2008-04-23 23:00:13 -0400 | [diff] [blame] | 8 | * Copyright (C) 2000 - 2008, Intel Corp. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Bob Moore | 61686124 | 2006-03-17 16:44:00 -0500 | [diff] [blame] | 47 | /* acpisrc:struct_defs -- for acpisrc conversion */ |
| 48 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | /***************************************************************************** |
| 50 | * |
| 51 | * Tree walking typedefs and structs |
| 52 | * |
| 53 | ****************************************************************************/ |
| 54 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 55 | /* |
Bob Moore | 4119532 | 2006-05-26 16:36:00 -0400 | [diff] [blame] | 56 | * Walk state - current state of a parse tree walk. Used for both a leisurely |
| 57 | * stroll through the tree (for whatever reason), and for control method |
| 58 | * execution. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | #define ACPI_NEXT_OP_DOWNWARD 1 |
| 61 | #define ACPI_NEXT_OP_UPWARD 2 |
| 62 | |
Bob Moore | 4119532 | 2006-05-26 16:36:00 -0400 | [diff] [blame] | 63 | /* |
| 64 | * Groups of definitions for walk_type used for different implementations of |
| 65 | * walkers (never simultaneously) - flags for interpreter: |
| 66 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | #define ACPI_WALK_NON_METHOD 0 |
Bob Moore | 4119532 | 2006-05-26 16:36:00 -0400 | [diff] [blame] | 68 | #define ACPI_WALK_METHOD 0x01 |
| 69 | #define ACPI_WALK_METHOD_RESTART 0x02 |
| 70 | |
| 71 | /* Flags for i_aSL compiler only */ |
| 72 | |
| 73 | #define ACPI_WALK_CONST_REQUIRED 0x10 |
| 74 | #define ACPI_WALK_CONST_OPTIONAL 0x20 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 76 | struct acpi_walk_state { |
Bob Moore | 61686124 | 2006-03-17 16:44:00 -0500 | [diff] [blame] | 77 | struct acpi_walk_state *next; /* Next walk_state in list */ |
| 78 | u8 descriptor_type; /* To differentiate various internal objs */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 79 | u8 walk_type; |
Bob Moore | 61686124 | 2006-03-17 16:44:00 -0500 | [diff] [blame] | 80 | u16 opcode; /* Current AML opcode */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 81 | u8 next_op_info; /* Info about next_op */ |
| 82 | u8 num_operands; /* Stack pointer for Operands[] array */ |
Bob Moore | 773069d | 2008-04-10 19:06:36 +0400 | [diff] [blame] | 83 | u8 operand_index; /* Index into operand stack, to be used by acpi_ds_obj_stack_push */ |
Bob Moore | 61686124 | 2006-03-17 16:44:00 -0500 | [diff] [blame] | 84 | acpi_owner_id owner_id; /* Owner of objects created during the walk */ |
| 85 | u8 last_predicate; /* Result of last predicate */ |
| 86 | u8 current_result; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 87 | u8 return_used; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 88 | u8 scope_depth; |
| 89 | u8 pass_number; /* Parse pass during table load */ |
Bob Moore | 773069d | 2008-04-10 19:06:36 +0400 | [diff] [blame] | 90 | u8 result_size; /* Total elements for the result stack */ |
| 91 | u8 result_count; /* Current number of occupied elements of result stack */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 92 | u32 aml_offset; |
| 93 | u32 arg_types; |
| 94 | u32 method_breakpoint; /* For single stepping */ |
| 95 | u32 user_breakpoint; /* User AML breakpoint */ |
| 96 | u32 parse_flags; |
Bob Moore | 61686124 | 2006-03-17 16:44:00 -0500 | [diff] [blame] | 97 | |
| 98 | struct acpi_parse_state parser_state; /* Current state of parser */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 99 | u32 prev_arg_types; |
Bob Moore | 793c238 | 2006-03-31 00:00:00 -0500 | [diff] [blame] | 100 | u32 arg_count; /* push for fixed or var args */ |
Bob Moore | 61686124 | 2006-03-17 16:44:00 -0500 | [diff] [blame] | 101 | |
| 102 | struct acpi_namespace_node arguments[ACPI_METHOD_NUM_ARGS]; /* Control method arguments */ |
| 103 | struct acpi_namespace_node local_variables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */ |
| 104 | union acpi_operand_object *operands[ACPI_OBJ_NUM_OPERANDS + 1]; /* Operands passed to the interpreter (+1 for NULL terminator) */ |
| 105 | union acpi_operand_object **params; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 106 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 107 | u8 *aml_last_while; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 108 | union acpi_operand_object **caller_return_desc; |
| 109 | union acpi_generic_state *control_state; /* List of control states (nested IFs) */ |
| 110 | struct acpi_namespace_node *deferred_node; /* Used when executing deferred opcodes */ |
| 111 | struct acpi_gpe_event_info *gpe_event_info; /* Info for GPE (_Lxx/_Exx methods only */ |
| 112 | union acpi_operand_object *implicit_return_obj; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 113 | struct acpi_namespace_node *method_call_node; /* Called method Node */ |
| 114 | union acpi_parse_object *method_call_op; /* method_call Op if running a method */ |
| 115 | union acpi_operand_object *method_desc; /* Method descriptor if running a method */ |
| 116 | struct acpi_namespace_node *method_node; /* Method node if running a method. */ |
| 117 | union acpi_parse_object *op; /* Current parser op */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 118 | const struct acpi_opcode_info *op_info; /* Info on current opcode */ |
| 119 | union acpi_parse_object *origin; /* Start of walk [Obsolete] */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 120 | union acpi_operand_object *result_obj; |
| 121 | union acpi_generic_state *results; /* Stack of accumulated results */ |
| 122 | union acpi_operand_object *return_desc; /* Return object, if any */ |
| 123 | union acpi_generic_state *scope_info; /* Stack of nested scopes */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 124 | union acpi_parse_object *prev_op; /* Last op that was processed */ |
| 125 | union acpi_parse_object *next_op; /* next op to be processed */ |
Bob Moore | 61686124 | 2006-03-17 16:44:00 -0500 | [diff] [blame] | 126 | struct acpi_thread_state *thread; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 127 | acpi_parse_downwards descending_callback; |
| 128 | acpi_parse_upwards ascending_callback; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | }; |
| 130 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | /* Info used by acpi_ps_init_objects */ |
| 132 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 133 | struct acpi_init_walk_info { |
| 134 | u16 method_count; |
| 135 | u16 device_count; |
| 136 | u16 op_region_count; |
| 137 | u16 field_count; |
| 138 | u16 buffer_count; |
| 139 | u16 package_count; |
| 140 | u16 op_region_init; |
| 141 | u16 field_init; |
| 142 | u16 buffer_init; |
| 143 | u16 package_init; |
| 144 | u16 object_count; |
Bob Moore | f3d2e78 | 2007-02-02 19:48:18 +0300 | [diff] [blame] | 145 | acpi_owner_id owner_id; |
| 146 | acpi_native_uint table_index; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | }; |
| 148 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 149 | struct acpi_get_devices_info { |
| 150 | acpi_walk_callback user_function; |
| 151 | void *context; |
Al Viro | 70b30fb | 2007-08-21 16:18:20 +0100 | [diff] [blame] | 152 | const char *hid; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | }; |
| 154 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 155 | union acpi_aml_operands { |
| 156 | union acpi_operand_object *operands[7]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 157 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 158 | struct { |
| 159 | struct acpi_object_integer *type; |
| 160 | struct acpi_object_integer *code; |
| 161 | struct acpi_object_integer *argument; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | |
| 163 | } fatal; |
| 164 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 165 | struct { |
| 166 | union acpi_operand_object *source; |
| 167 | struct acpi_object_integer *index; |
| 168 | union acpi_operand_object *target; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 169 | |
| 170 | } index; |
| 171 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 172 | struct { |
| 173 | union acpi_operand_object *source; |
| 174 | struct acpi_object_integer *index; |
| 175 | struct acpi_object_integer *length; |
| 176 | union acpi_operand_object *target; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 177 | |
| 178 | } mid; |
| 179 | }; |
| 180 | |
Bob Moore | 4119532 | 2006-05-26 16:36:00 -0400 | [diff] [blame] | 181 | /* |
| 182 | * Structure used to pass object evaluation parameters. |
| 183 | * Purpose is to reduce CPU stack use. |
| 184 | */ |
| 185 | struct acpi_evaluate_info { |
| 186 | struct acpi_namespace_node *prefix_node; |
| 187 | char *pathname; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 188 | union acpi_operand_object *obj_desc; |
| 189 | union acpi_operand_object **parameters; |
Bob Moore | 4119532 | 2006-05-26 16:36:00 -0400 | [diff] [blame] | 190 | struct acpi_namespace_node *resolved_node; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 191 | union acpi_operand_object *return_object; |
| 192 | u8 pass_number; |
| 193 | u8 parameter_type; |
| 194 | u8 return_object_type; |
Bob Moore | 4119532 | 2006-05-26 16:36:00 -0400 | [diff] [blame] | 195 | u8 flags; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 196 | }; |
| 197 | |
| 198 | /* Types for parameter_type above */ |
| 199 | |
| 200 | #define ACPI_PARAM_ARGS 0 |
| 201 | #define ACPI_PARAM_GPE 1 |
| 202 | |
Bob Moore | 4119532 | 2006-05-26 16:36:00 -0400 | [diff] [blame] | 203 | /* Values for Flags above */ |
| 204 | |
| 205 | #define ACPI_IGNORE_RETURN_VALUE 1 |
| 206 | |
| 207 | /* Info used by acpi_ns_initialize_devices */ |
| 208 | |
| 209 | struct acpi_device_walk_info { |
| 210 | u16 device_count; |
| 211 | u16 num_STA; |
| 212 | u16 num_INI; |
| 213 | struct acpi_table_desc *table_desc; |
| 214 | struct acpi_evaluate_info *evaluate_info; |
| 215 | }; |
| 216 | |
| 217 | /* TBD: [Restructure] Merge with struct above */ |
| 218 | |
| 219 | struct acpi_walk_info { |
| 220 | u32 debug_level; |
| 221 | u32 count; |
| 222 | acpi_owner_id owner_id; |
| 223 | u8 display_type; |
| 224 | }; |
| 225 | |
| 226 | /* Display Types */ |
| 227 | |
| 228 | #define ACPI_DISPLAY_SUMMARY (u8) 0 |
| 229 | #define ACPI_DISPLAY_OBJECTS (u8) 1 |
| 230 | #define ACPI_DISPLAY_MASK (u8) 1 |
| 231 | |
| 232 | #define ACPI_DISPLAY_SHORT (u8) 2 |
| 233 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 234 | #endif |