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