1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */ 2 /****************************************************************************** 3 * 4 * Name: acstruct.h - Internal structs 5 * 6 * Copyright (C) 2000 - 2018, Intel Corp. 7 * 8 *****************************************************************************/ 9 10 #ifndef __ACSTRUCT_H__ 11 #define __ACSTRUCT_H__ 12 13 /* acpisrc:struct_defs -- for acpisrc conversion */ 14 15 /***************************************************************************** 16 * 17 * Tree walking typedefs and structs 18 * 19 ****************************************************************************/ 20 21 /* 22 * Walk state - current state of a parse tree walk. Used for both a leisurely 23 * stroll through the tree (for whatever reason), and for control method 24 * execution. 25 */ 26 #define ACPI_NEXT_OP_DOWNWARD 1 27 #define ACPI_NEXT_OP_UPWARD 2 28 29 /* 30 * Groups of definitions for walk_type used for different implementations of 31 * walkers (never simultaneously) - flags for interpreter: 32 */ 33 #define ACPI_WALK_NON_METHOD 0 34 #define ACPI_WALK_METHOD 0x01 35 #define ACPI_WALK_METHOD_RESTART 0x02 36 37 struct acpi_walk_state { 38 struct acpi_walk_state *next; /* Next walk_state in list */ 39 u8 descriptor_type; /* To differentiate various internal objs */ 40 u8 walk_type; 41 u16 opcode; /* Current AML opcode */ 42 u8 next_op_info; /* Info about next_op */ 43 u8 num_operands; /* Stack pointer for Operands[] array */ 44 u8 operand_index; /* Index into operand stack, to be used by acpi_ds_obj_stack_push */ 45 acpi_owner_id owner_id; /* Owner of objects created during the walk */ 46 u8 last_predicate; /* Result of last predicate */ 47 u8 current_result; 48 u8 return_used; 49 u8 scope_depth; 50 u8 pass_number; /* Parse pass during table load */ 51 u8 namespace_override; /* Override existing objects */ 52 u8 result_size; /* Total elements for the result stack */ 53 u8 result_count; /* Current number of occupied elements of result stack */ 54 u8 *aml; 55 u32 arg_types; 56 u32 method_breakpoint; /* For single stepping */ 57 u32 user_breakpoint; /* User AML breakpoint */ 58 u32 parse_flags; 59 60 struct acpi_parse_state parser_state; /* Current state of parser */ 61 u32 prev_arg_types; 62 u32 arg_count; /* push for fixed or var args */ 63 64 struct acpi_namespace_node arguments[ACPI_METHOD_NUM_ARGS]; /* Control method arguments */ 65 struct acpi_namespace_node local_variables[ACPI_METHOD_NUM_LOCALS]; /* Control method locals */ 66 union acpi_operand_object *operands[ACPI_OBJ_NUM_OPERANDS + 1]; /* Operands passed to the interpreter (+1 for NULL terminator) */ 67 union acpi_operand_object **params; 68 69 u8 *aml_last_while; 70 union acpi_operand_object **caller_return_desc; 71 union acpi_generic_state *control_state; /* List of control states (nested IFs) */ 72 struct acpi_namespace_node *deferred_node; /* Used when executing deferred opcodes */ 73 union acpi_operand_object *implicit_return_obj; 74 struct acpi_namespace_node *method_call_node; /* Called method Node */ 75 union acpi_parse_object *method_call_op; /* method_call Op if running a method */ 76 union acpi_operand_object *method_desc; /* Method descriptor if running a method */ 77 struct acpi_namespace_node *method_node; /* Method node if running a method. */ 78 union acpi_parse_object *op; /* Current parser op */ 79 const struct acpi_opcode_info *op_info; /* Info on current opcode */ 80 union acpi_parse_object *origin; /* Start of walk [Obsolete] */ 81 union acpi_operand_object *result_obj; 82 union acpi_generic_state *results; /* Stack of accumulated results */ 83 union acpi_operand_object *return_desc; /* Return object, if any */ 84 union acpi_generic_state *scope_info; /* Stack of nested scopes */ 85 union acpi_parse_object *prev_op; /* Last op that was processed */ 86 union acpi_parse_object *next_op; /* next op to be processed */ 87 struct acpi_thread_state *thread; 88 acpi_parse_downwards descending_callback; 89 acpi_parse_upwards ascending_callback; 90 }; 91 92 /* Info used by acpi_ns_initialize_objects and acpi_ds_initialize_objects */ 93 94 struct acpi_init_walk_info { 95 u32 table_index; 96 u32 object_count; 97 u32 method_count; 98 u32 serial_method_count; 99 u32 non_serial_method_count; 100 u32 serialized_method_count; 101 u32 device_count; 102 u32 op_region_count; 103 u32 field_count; 104 u32 buffer_count; 105 u32 package_count; 106 u32 op_region_init; 107 u32 field_init; 108 u32 buffer_init; 109 u32 package_init; 110 acpi_owner_id owner_id; 111 }; 112 113 struct acpi_get_devices_info { 114 acpi_walk_callback user_function; 115 void *context; 116 const char *hid; 117 }; 118 119 union acpi_aml_operands { 120 union acpi_operand_object *operands[7]; 121 122 struct { 123 struct acpi_object_integer *type; 124 struct acpi_object_integer *code; 125 struct acpi_object_integer *argument; 126 127 } fatal; 128 129 struct { 130 union acpi_operand_object *source; 131 struct acpi_object_integer *index; 132 union acpi_operand_object *target; 133 134 } index; 135 136 struct { 137 union acpi_operand_object *source; 138 struct acpi_object_integer *index; 139 struct acpi_object_integer *length; 140 union acpi_operand_object *target; 141 142 } mid; 143 }; 144 145 /* 146 * Structure used to pass object evaluation information and parameters. 147 * Purpose is to reduce CPU stack use. 148 */ 149 struct acpi_evaluate_info { 150 /* The first 3 elements are passed by the caller to acpi_ns_evaluate */ 151 152 struct acpi_namespace_node *prefix_node; /* Input: starting node */ 153 const char *relative_pathname; /* Input: path relative to prefix_node */ 154 union acpi_operand_object **parameters; /* Input: argument list */ 155 156 struct acpi_namespace_node *node; /* Resolved node (prefix_node:relative_pathname) */ 157 union acpi_operand_object *obj_desc; /* Object attached to the resolved node */ 158 char *full_pathname; /* Full pathname of the resolved node */ 159 160 const union acpi_predefined_info *predefined; /* Used if Node is a predefined name */ 161 union acpi_operand_object *return_object; /* Object returned from the evaluation */ 162 union acpi_operand_object *parent_package; /* Used if return object is a Package */ 163 164 u32 return_flags; /* Used for return value analysis */ 165 u32 return_btype; /* Bitmapped type of the returned object */ 166 u16 param_count; /* Count of the input argument list */ 167 u8 pass_number; /* Parser pass number */ 168 u8 return_object_type; /* Object type of the returned object */ 169 u8 node_flags; /* Same as Node->Flags */ 170 u8 flags; /* General flags */ 171 }; 172 173 /* Values for Flags above */ 174 175 #define ACPI_IGNORE_RETURN_VALUE 1 176 177 /* Defines for return_flags field above */ 178 179 #define ACPI_OBJECT_REPAIRED 1 180 #define ACPI_OBJECT_WRAPPED 2 181 182 /* Info used by acpi_ns_initialize_devices */ 183 184 struct acpi_device_walk_info { 185 struct acpi_table_desc *table_desc; 186 struct acpi_evaluate_info *evaluate_info; 187 u32 device_count; 188 u32 num_STA; 189 u32 num_INI; 190 }; 191 192 /* TBD: [Restructure] Merge with struct above */ 193 194 struct acpi_walk_info { 195 u32 debug_level; 196 u32 count; 197 acpi_owner_id owner_id; 198 u8 display_type; 199 }; 200 201 /* Display Types */ 202 203 #define ACPI_DISPLAY_SUMMARY (u8) 0 204 #define ACPI_DISPLAY_OBJECTS (u8) 1 205 #define ACPI_DISPLAY_MASK (u8) 1 206 207 #define ACPI_DISPLAY_SHORT (u8) 2 208 209 #endif 210