1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: acstruct.h - Internal structs
5 *
6 * Copyright (C) 2000 - 2023, 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
37struct 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	u16 method_nesting_depth;
64	u8 method_is_nested;
65
66	struct acpi_namespace_node arguments[ACPI_METHOD_NUM_ARGS];	/* Control method arguments */
67	struct acpi_namespace_node local_variables[ACPI_METHOD_NUM_LOCALS];	/* Control method locals */
68	union acpi_operand_object *operands[ACPI_OBJ_NUM_OPERANDS + 1];	/* Operands passed to the interpreter (+1 for NULL terminator) */
69	union acpi_operand_object **params;
70
71	u8 *aml_last_while;
72	union acpi_operand_object **caller_return_desc;
73	union acpi_generic_state *control_state;	/* List of control states (nested IFs) */
74	struct acpi_namespace_node *deferred_node;	/* Used when executing deferred opcodes */
75	union acpi_operand_object *implicit_return_obj;
76	struct acpi_namespace_node *method_call_node;	/* Called method Node */
77	union acpi_parse_object *method_call_op;	/* method_call Op if running a method */
78	union acpi_operand_object *method_desc;	/* Method descriptor if running a method */
79	struct acpi_namespace_node *method_node;	/* Method node if running a method */
80	char *method_pathname;	/* Full pathname of running method */
81	union acpi_parse_object *op;	/* Current parser op */
82	const struct acpi_opcode_info *op_info;	/* Info on current opcode */
83	union acpi_parse_object *origin;	/* Start of walk [Obsolete] */
84	union acpi_operand_object *result_obj;
85	union acpi_generic_state *results;	/* Stack of accumulated results */
86	union acpi_operand_object *return_desc;	/* Return object, if any */
87	union acpi_generic_state *scope_info;	/* Stack of nested scopes */
88	union acpi_parse_object *prev_op;	/* Last op that was processed */
89	union acpi_parse_object *next_op;	/* next op to be processed */
90	struct acpi_thread_state *thread;
91	acpi_parse_downwards descending_callback;
92	acpi_parse_upwards ascending_callback;
93};
94
95/* Info used by acpi_ns_initialize_objects and acpi_ds_initialize_objects */
96
97struct acpi_init_walk_info {
98	u32 table_index;
99	u32 object_count;
100	u32 method_count;
101	u32 serial_method_count;
102	u32 non_serial_method_count;
103	u32 serialized_method_count;
104	u32 device_count;
105	u32 op_region_count;
106	u32 field_count;
107	u32 buffer_count;
108	u32 package_count;
109	u32 op_region_init;
110	u32 field_init;
111	u32 buffer_init;
112	u32 package_init;
113	acpi_owner_id owner_id;
114};
115
116struct acpi_get_devices_info {
117	acpi_walk_callback user_function;
118	void *context;
119	const char *hid;
120};
121
122union acpi_aml_operands {
123	union acpi_operand_object *operands[7];
124
125	struct {
126		struct acpi_object_integer *type;
127		struct acpi_object_integer *code;
128		struct acpi_object_integer *argument;
129
130	} fatal;
131
132	struct {
133		union acpi_operand_object *source;
134		struct acpi_object_integer *index;
135		union acpi_operand_object *target;
136
137	} index;
138
139	struct {
140		union acpi_operand_object *source;
141		struct acpi_object_integer *index;
142		struct acpi_object_integer *length;
143		union acpi_operand_object *target;
144
145	} mid;
146};
147
148/*
149 * Structure used to pass object evaluation information and parameters.
150 * Purpose is to reduce CPU stack use.
151 */
152struct acpi_evaluate_info {
153	/* The first 3 elements are passed by the caller to acpi_ns_evaluate */
154
155	struct acpi_namespace_node *prefix_node;	/* Input: starting node */
156	const char *relative_pathname;	/* Input: path relative to prefix_node */
157	union acpi_operand_object **parameters;	/* Input: argument list */
158
159	struct acpi_namespace_node *node;	/* Resolved node (prefix_node:relative_pathname) */
160	union acpi_operand_object *obj_desc;	/* Object attached to the resolved node */
161	char *full_pathname;	/* Full pathname of the resolved node */
162
163	const union acpi_predefined_info *predefined;	/* Used if Node is a predefined name */
164	union acpi_operand_object *return_object;	/* Object returned from the evaluation */
165	union acpi_operand_object *parent_package;	/* Used if return object is a Package */
166
167	u32 return_flags;	/* Used for return value analysis */
168	u32 return_btype;	/* Bitmapped type of the returned object */
169	u16 param_count;	/* Count of the input argument list */
170	u16 node_flags;		/* Same as Node->Flags */
171	u8 pass_number;		/* Parser pass number */
172	u8 return_object_type;	/* Object type of the returned object */
173	u8 flags;		/* General flags */
174};
175
176/* Values for Flags above */
177
178#define ACPI_IGNORE_RETURN_VALUE    1
179
180/* Defines for return_flags field above */
181
182#define ACPI_OBJECT_REPAIRED        1
183#define ACPI_OBJECT_WRAPPED         2
184
185/* Info used by acpi_ns_initialize_devices */
186
187struct acpi_device_walk_info {
188	struct acpi_table_desc *table_desc;
189	struct acpi_evaluate_info *evaluate_info;
190	u32 device_count;
191	u32 num_STA;
192	u32 num_INI;
193};
194
195/* Info used by Acpi  acpi_db_display_fields */
196
197struct acpi_region_walk_info {
198	u32 debug_level;
199	u32 count;
200	acpi_owner_id owner_id;
201	u8 display_type;
202	u32 address_space_id;
203};
204
205/* TBD: [Restructure] Merge with struct above */
206
207struct acpi_walk_info {
208	u32 debug_level;
209	u32 count;
210	acpi_owner_id owner_id;
211	u8 display_type;
212};
213
214/* Display Types */
215
216#define ACPI_DISPLAY_SUMMARY        (u8) 0
217#define ACPI_DISPLAY_OBJECTS        (u8) 1
218#define ACPI_DISPLAY_MASK           (u8) 1
219
220#define ACPI_DISPLAY_SHORT          (u8) 2
221
222#endif
223