1 /******************************************************************************
3 * Name: acdebug.h - ACPI/AML debugger
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
47 #define ACPI_DEBUG_BUFFER_SIZE 0x4000 /* 16K buffer for return objects */
49 struct acpi_db_command_info {
50 char *name; /* Command Name */
51 u8 min_args; /* Minimum arguments required */
54 struct acpi_db_command_help {
55 u8 line_count; /* Number of help lines */
56 char *invocation; /* Command Invocation */
57 char *description; /* Command Description */
60 struct acpi_db_argument_info {
61 char *name; /* Argument Name */
64 struct acpi_db_execute_walk {
69 #define PARAM_LIST(pl) pl
70 #define DBTEST_OUTPUT_LEVEL(lvl) if (acpi_gbl_db_opt_verbose)
71 #define VERBOSE_PRINT(fp) DBTEST_OUTPUT_LEVEL(lvl) {\
72 acpi_os_printf PARAM_LIST(fp);}
74 #define EX_NO_SINGLE_STEP 1
75 #define EX_SINGLE_STEP 2
78 * dbxface - external debugger interfaces
80 acpi_status acpi_db_initialize(void);
82 void acpi_db_terminate(void);
85 acpi_db_single_step(struct acpi_walk_state *walk_state,
86 union acpi_parse_object *op, u32 op_type);
89 * dbcmds - debug commands and output routines
91 struct acpi_namespace_node *acpi_db_convert_to_node(char *in_string);
93 void acpi_db_display_table_info(char *table_arg);
95 void acpi_db_display_template(char *buffer_arg);
97 void acpi_db_unload_acpi_table(char *name);
99 void acpi_db_send_notify(char *name, u32 value);
101 void acpi_db_display_interfaces(char *action_arg, char *interface_name_arg);
103 acpi_status acpi_db_sleep(char *object_arg);
105 void acpi_db_trace(char *enable_arg, char *method_arg, char *once_arg);
107 void acpi_db_display_locks(void);
109 void acpi_db_display_resources(char *object_arg);
111 ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_db_display_gpes(void))
113 void acpi_db_display_handlers(void);
115 ACPI_HW_DEPENDENT_RETURN_VOID(void
116 acpi_db_generate_gpe(char *gpe_arg,
118 ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_db_generate_sci(void))
120 void acpi_db_execute_test(char *type_arg);
123 * dbconvert - miscellaneous conversion routines
125 acpi_status acpi_db_hex_char_to_value(int hex_char, u8 *return_value);
127 acpi_status acpi_db_convert_to_package(char *string, union acpi_object *object);
130 acpi_db_convert_to_object(acpi_object_type type,
131 char *string, union acpi_object *object);
133 u8 *acpi_db_encode_pld_buffer(struct acpi_pld_info *pld_info);
135 void acpi_db_dump_pld_buffer(union acpi_object *obj_desc);
138 * dbmethod - control method commands
141 acpi_db_set_method_breakpoint(char *location,
142 struct acpi_walk_state *walk_state,
143 union acpi_parse_object *op);
145 void acpi_db_set_method_call_breakpoint(union acpi_parse_object *op);
147 void acpi_db_set_method_data(char *type_arg, char *index_arg, char *value_arg);
149 acpi_status acpi_db_disassemble_method(char *name);
151 void acpi_db_disassemble_aml(char *statements, union acpi_parse_object *op);
153 void acpi_db_batch_execute(char *count_arg);
156 * dbnames - namespace commands
158 void acpi_db_set_scope(char *name);
160 void acpi_db_dump_namespace(char *start_arg, char *depth_arg);
162 void acpi_db_dump_namespace_paths(void);
164 void acpi_db_dump_namespace_by_owner(char *owner_arg, char *depth_arg);
166 acpi_status acpi_db_find_name_in_namespace(char *name_arg);
168 void acpi_db_check_predefined_names(void);
171 acpi_db_display_objects(char *obj_type_arg, char *display_count_arg);
173 void acpi_db_check_integrity(void);
175 void acpi_db_find_references(char *object_arg);
177 void acpi_db_get_bus_info(void);
180 * dbdisply - debug display commands
182 void acpi_db_display_method_info(union acpi_parse_object *op);
184 void acpi_db_decode_and_display_object(char *target, char *output_type);
187 acpi_db_display_result_object(union acpi_operand_object *obj_desc,
188 struct acpi_walk_state *walk_state);
190 acpi_status acpi_db_display_all_methods(char *display_count_arg);
192 void acpi_db_display_arguments(void);
194 void acpi_db_display_locals(void);
196 void acpi_db_display_results(void);
198 void acpi_db_display_calling_tree(void);
200 void acpi_db_display_object_type(char *object_arg);
203 acpi_db_display_argument_object(union acpi_operand_object *obj_desc,
204 struct acpi_walk_state *walk_state);
207 * dbexec - debugger control method execution
210 acpi_db_execute(char *name, char **args, acpi_object_type * types, u32 flags);
213 acpi_db_create_execution_threads(char *num_threads_arg,
214 char *num_loops_arg, char *method_name_arg);
216 void acpi_db_delete_objects(u32 count, union acpi_object *objects);
218 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
219 u32 acpi_db_get_cache_info(struct acpi_memory_list *cache);
223 * dbfileio - Debugger file I/O commands
226 acpi_db_match_argument(char *user_argument,
227 struct acpi_db_argument_info *arguments);
229 void acpi_db_close_debug_file(void);
231 void acpi_db_open_debug_file(char *name);
233 acpi_status acpi_db_load_acpi_table(char *filename);
236 acpi_db_get_table_from_file(char *filename,
237 struct acpi_table_header **table,
238 u8 must_be_aml_table);
241 * dbhistry - debugger HISTORY command
243 void acpi_db_add_to_history(char *command_line);
245 void acpi_db_display_history(void);
247 char *acpi_db_get_from_history(char *command_num_arg);
249 char *acpi_db_get_history_by_index(u32 commandd_num);
252 * dbinput - user front-end to the AML debugger
255 acpi_db_command_dispatch(char *input_buffer,
256 struct acpi_walk_state *walk_state,
257 union acpi_parse_object *op);
259 void ACPI_SYSTEM_XFACE acpi_db_execute_thread(void *context);
261 acpi_status acpi_db_user_commands(char prompt, union acpi_parse_object *op);
263 char *acpi_db_get_next_token(char *string,
264 char **next, acpi_object_type * return_type);
269 void acpi_db_decode_internal_object(union acpi_operand_object *obj_desc);
272 acpi_db_display_internal_object(union acpi_operand_object *obj_desc,
273 struct acpi_walk_state *walk_state);
275 void acpi_db_decode_arguments(struct acpi_walk_state *walk_state);
277 void acpi_db_decode_locals(struct acpi_walk_state *walk_state);
280 acpi_db_dump_method_info(acpi_status status,
281 struct acpi_walk_state *walk_state);
284 * dbstats - Generation and display of ACPI table statistics
286 void acpi_db_generate_statistics(union acpi_parse_object *root, u8 is_method);
288 acpi_status acpi_db_display_statistics(char *type_arg);
291 * dbutils - AML debugger utilities
293 void acpi_db_set_output_destination(u32 where);
295 void acpi_db_dump_external_object(union acpi_object *obj_desc, u32 level);
297 void acpi_db_prep_namestring(char *name);
299 struct acpi_namespace_node *acpi_db_local_ns_lookup(char *name);
301 void acpi_db_uint32_to_hex_string(u32 value, char *buffer);
303 #endif /* __ACDEBUG_H__ */