Branch data Line data Source code
1 : : /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 : : /******************************************************************************
3 : : *
4 : : * Name: acdebug.h - ACPI/AML debugger
5 : : *
6 : : * Copyright (C) 2000 - 2020, Intel Corp.
7 : : *
8 : : *****************************************************************************/
9 : :
10 : : #ifndef __ACDEBUG_H__
11 : : #define __ACDEBUG_H__
12 : :
13 : : /* The debugger is used in conjunction with the disassembler most of time */
14 : :
15 : : #ifdef ACPI_DISASSEMBLER
16 : : #include "acdisasm.h"
17 : : #endif
18 : :
19 : : #define ACPI_DEBUG_BUFFER_SIZE 0x4000 /* 16K buffer for return objects */
20 : : #define ACPI_DEBUG_LENGTH_FORMAT " (%.4X bits, %.3X bytes)"
21 : :
22 : : struct acpi_db_command_info {
23 : : const char *name; /* Command Name */
24 : : u8 min_args; /* Minimum arguments required */
25 : : };
26 : :
27 : : struct acpi_db_command_help {
28 : : u8 line_count; /* Number of help lines */
29 : : char *invocation; /* Command Invocation */
30 : : char *description; /* Command Description */
31 : : };
32 : :
33 : : struct acpi_db_argument_info {
34 : : const char *name; /* Argument Name */
35 : : };
36 : :
37 : : struct acpi_db_execute_walk {
38 : : u32 count;
39 : : u32 max_count;
40 : : };
41 : :
42 : : #define PARAM_LIST(pl) pl
43 : :
44 : : #define EX_NO_SINGLE_STEP 1
45 : : #define EX_SINGLE_STEP 2
46 : :
47 : : /*
48 : : * dbxface - external debugger interfaces
49 : : */
50 [ + + + ]: 193137 : ACPI_DBR_DEPENDENT_RETURN_OK(acpi_status
51 : : acpi_db_single_step(struct acpi_walk_state
52 : : *walk_state,
53 : : union acpi_parse_object *op,
54 : : u32 op_type))
55 : 0 : ACPI_DBR_DEPENDENT_RETURN_VOID(void
56 : : acpi_db_signal_break_point(struct
57 : : acpi_walk_state
58 : : *walk_state))
59 : :
60 : : /*
61 : : * dbcmds - debug commands and output routines
62 : : */
63 : : struct acpi_namespace_node *acpi_db_convert_to_node(char *in_string);
64 : :
65 : : void acpi_db_display_table_info(char *table_arg);
66 : :
67 : : void acpi_db_display_template(char *buffer_arg);
68 : :
69 : : void acpi_db_unload_acpi_table(char *name);
70 : :
71 : : void acpi_db_send_notify(char *name, u32 value);
72 : :
73 : : void acpi_db_display_interfaces(char *action_arg, char *interface_name_arg);
74 : :
75 : : acpi_status acpi_db_sleep(char *object_arg);
76 : :
77 : : void acpi_db_trace(char *enable_arg, char *method_arg, char *once_arg);
78 : :
79 : : void acpi_db_display_locks(void);
80 : :
81 : : void acpi_db_display_resources(char *object_arg);
82 : :
83 : : ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_db_display_gpes(void))
84 : :
85 : : void acpi_db_display_handlers(void);
86 : :
87 : : ACPI_HW_DEPENDENT_RETURN_VOID(void
88 : : acpi_db_generate_gpe(char *gpe_arg,
89 : : char *block_arg))
90 : : ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_db_generate_sci(void))
91 : :
92 : : void acpi_db_execute_test(char *type_arg);
93 : :
94 : : /*
95 : : * dbconvert - miscellaneous conversion routines
96 : : */
97 : : acpi_status acpi_db_hex_char_to_value(int hex_char, u8 *return_value);
98 : :
99 : : acpi_status acpi_db_convert_to_package(char *string, union acpi_object *object);
100 : :
101 : : acpi_status
102 : : acpi_db_convert_to_object(acpi_object_type type,
103 : : char *string, union acpi_object *object);
104 : :
105 : : u8 *acpi_db_encode_pld_buffer(struct acpi_pld_info *pld_info);
106 : :
107 : : void acpi_db_dump_pld_buffer(union acpi_object *obj_desc);
108 : :
109 : : /*
110 : : * dbmethod - control method commands
111 : : */
112 : : void
113 : : acpi_db_set_method_breakpoint(char *location,
114 : : struct acpi_walk_state *walk_state,
115 : : union acpi_parse_object *op);
116 : :
117 : : void acpi_db_set_method_call_breakpoint(union acpi_parse_object *op);
118 : :
119 : : void acpi_db_set_method_data(char *type_arg, char *index_arg, char *value_arg);
120 : :
121 : : acpi_status acpi_db_disassemble_method(char *name);
122 : :
123 : : void acpi_db_disassemble_aml(char *statements, union acpi_parse_object *op);
124 : :
125 : : void acpi_db_evaluate_predefined_names(void);
126 : :
127 : : /*
128 : : * dbnames - namespace commands
129 : : */
130 : : void acpi_db_set_scope(char *name);
131 : :
132 : : void acpi_db_dump_namespace(char *start_arg, char *depth_arg);
133 : :
134 : : void acpi_db_dump_namespace_paths(void);
135 : :
136 : : void acpi_db_dump_namespace_by_owner(char *owner_arg, char *depth_arg);
137 : :
138 : : acpi_status acpi_db_find_name_in_namespace(char *name_arg);
139 : :
140 : : void acpi_db_check_predefined_names(void);
141 : :
142 : : acpi_status
143 : : acpi_db_display_objects(char *obj_type_arg, char *display_count_arg);
144 : :
145 : : void acpi_db_check_integrity(void);
146 : :
147 : : void acpi_db_find_references(char *object_arg);
148 : :
149 : : void acpi_db_get_bus_info(void);
150 : :
151 : : acpi_status acpi_db_display_fields(u32 address_space_id);
152 : :
153 : : /*
154 : : * dbdisply - debug display commands
155 : : */
156 : : void acpi_db_display_method_info(union acpi_parse_object *op);
157 : :
158 : : void acpi_db_decode_and_display_object(char *target, char *output_type);
159 : :
160 [ - + ]: 63756 : ACPI_DBR_DEPENDENT_RETURN_VOID(void
161 : : acpi_db_display_result_object(union
162 : : acpi_operand_object
163 : : *obj_desc,
164 : : struct
165 : : acpi_walk_state
166 : : *walk_state))
167 : :
168 : : acpi_status acpi_db_display_all_methods(char *display_count_arg);
169 : :
170 : : void acpi_db_display_arguments(void);
171 : :
172 : : void acpi_db_display_locals(void);
173 : :
174 : : void acpi_db_display_results(void);
175 : :
176 : : void acpi_db_display_calling_tree(void);
177 : :
178 : : void acpi_db_display_object_type(char *object_arg);
179 : :
180 : : ACPI_DBR_DEPENDENT_RETURN_VOID(void
181 : : acpi_db_display_argument_object(union
182 : : acpi_operand_object
183 : : *obj_desc,
184 : : struct
185 : : acpi_walk_state
186 : : *walk_state))
187 : :
188 : : /*
189 : : * dbexec - debugger control method execution
190 : : */
191 : : void
192 : : acpi_db_execute(char *name, char **args, acpi_object_type *types, u32 flags);
193 : :
194 : : void
195 : : acpi_db_create_execution_thread(char *method_name_arg,
196 : : char **arguments, acpi_object_type *types);
197 : :
198 : : void
199 : : acpi_db_create_execution_threads(char *num_threads_arg,
200 : : char *num_loops_arg, char *method_name_arg);
201 : :
202 : : void acpi_db_delete_objects(u32 count, union acpi_object *objects);
203 : :
204 : : #ifdef ACPI_DBG_TRACK_ALLOCATIONS
205 : : u32 acpi_db_get_cache_info(struct acpi_memory_list *cache);
206 : : #endif
207 : :
208 : : /*
209 : : * dbfileio - Debugger file I/O commands
210 : : */
211 : : acpi_object_type
212 : : acpi_db_match_argument(char *user_argument,
213 : : struct acpi_db_argument_info *arguments);
214 : :
215 : : void acpi_db_close_debug_file(void);
216 : :
217 : : void acpi_db_open_debug_file(char *name);
218 : :
219 : : acpi_status acpi_db_load_acpi_table(char *filename);
220 : :
221 : : acpi_status acpi_db_load_tables(struct acpi_new_table_desc *list_head);
222 : :
223 : : /*
224 : : * dbhistry - debugger HISTORY command
225 : : */
226 : : void acpi_db_add_to_history(char *command_line);
227 : :
228 : : void acpi_db_display_history(void);
229 : :
230 : : char *acpi_db_get_from_history(char *command_num_arg);
231 : :
232 : : char *acpi_db_get_history_by_index(u32 commandd_num);
233 : :
234 : : /*
235 : : * dbinput - user front-end to the AML debugger
236 : : */
237 : : acpi_status
238 : : acpi_db_command_dispatch(char *input_buffer,
239 : : struct acpi_walk_state *walk_state,
240 : : union acpi_parse_object *op);
241 : :
242 : : void ACPI_SYSTEM_XFACE acpi_db_execute_thread(void *context);
243 : :
244 : : acpi_status acpi_db_user_commands(void);
245 : :
246 : : char *acpi_db_get_next_token(char *string,
247 : : char **next, acpi_object_type *return_type);
248 : :
249 : : /*
250 : : * dbobject
251 : : */
252 : : void acpi_db_decode_internal_object(union acpi_operand_object *obj_desc);
253 : :
254 : : void
255 : : acpi_db_display_internal_object(union acpi_operand_object *obj_desc,
256 : : struct acpi_walk_state *walk_state);
257 : :
258 : : void acpi_db_decode_arguments(struct acpi_walk_state *walk_state);
259 : :
260 : : void acpi_db_decode_locals(struct acpi_walk_state *walk_state);
261 : :
262 : : void
263 : : acpi_db_dump_method_info(acpi_status status,
264 : : struct acpi_walk_state *walk_state);
265 : :
266 : : /*
267 : : * dbstats - Generation and display of ACPI table statistics
268 : : */
269 : : void acpi_db_generate_statistics(union acpi_parse_object *root, u8 is_method);
270 : :
271 : : acpi_status acpi_db_display_statistics(char *type_arg);
272 : :
273 : : /*
274 : : * dbutils - AML debugger utilities
275 : : */
276 : : void acpi_db_set_output_destination(u32 where);
277 : :
278 : : void acpi_db_dump_external_object(union acpi_object *obj_desc, u32 level);
279 : :
280 : : void acpi_db_prep_namestring(char *name);
281 : :
282 : : struct acpi_namespace_node *acpi_db_local_ns_lookup(char *name);
283 : :
284 : : void acpi_db_uint32_to_hex_string(u32 value, char *buffer);
285 : :
286 : : #endif /* __ACDEBUG_H__ */
|
