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