1 /******************************************************************************
3 * Name: acdebug.h - ACPI/AML debugger
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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 /* The debugger is used in conjunction with the disassembler most of time */
49 #ifdef ACPI_DISASSEMBLER
53 #define ACPI_DEBUG_BUFFER_SIZE 0x4000 /* 16K buffer for return objects */
55 struct acpi_db_command_info {
56 char *name; /* Command Name */
57 u8 min_args; /* Minimum arguments required */
60 struct acpi_db_command_help {
61 u8 line_count; /* Number of help lines */
62 char *invocation; /* Command Invocation */
63 char *description; /* Command Description */
66 struct acpi_db_argument_info {
67 char *name; /* Argument Name */
70 struct acpi_db_execute_walk {
75 #define PARAM_LIST(pl) pl
77 #define EX_NO_SINGLE_STEP 1
78 #define EX_SINGLE_STEP 2
81 * dbxface - external debugger interfaces
83 ACPI_DBR_DEPENDENT_RETURN_OK(acpi_status
84 acpi_db_single_step(struct acpi_walk_state
86 union acpi_parse_object *op,
88 ACPI_DBR_DEPENDENT_RETURN_VOID(void
89 acpi_db_signal_break_point(struct
94 * dbcmds - debug commands and output routines
96 struct acpi_namespace_node *acpi_db_convert_to_node(char *in_string);
98 void acpi_db_display_table_info(char *table_arg);
100 void acpi_db_display_template(char *buffer_arg);
102 void acpi_db_unload_acpi_table(char *name);
104 void acpi_db_send_notify(char *name, u32 value);
106 void acpi_db_display_interfaces(char *action_arg, char *interface_name_arg);
108 acpi_status acpi_db_sleep(char *object_arg);
110 void acpi_db_trace(char *enable_arg, char *method_arg, char *once_arg);
112 void acpi_db_display_locks(void);
114 void acpi_db_display_resources(char *object_arg);
116 ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_db_display_gpes(void))
118 void acpi_db_display_handlers(void);
120 ACPI_HW_DEPENDENT_RETURN_VOID(void
121 acpi_db_generate_gpe(char *gpe_arg,
123 ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_db_generate_sci(void))
125 void acpi_db_execute_test(char *type_arg);
128 * dbconvert - miscellaneous conversion routines
130 acpi_status acpi_db_hex_char_to_value(int hex_char, u8 *return_value);
132 acpi_status acpi_db_convert_to_package(char *string, union acpi_object *object);
135 acpi_db_convert_to_object(acpi_object_type type,
136 char *string, union acpi_object *object);
138 u8 *acpi_db_encode_pld_buffer(struct acpi_pld_info *pld_info);
140 void acpi_db_dump_pld_buffer(union acpi_object *obj_desc);
143 * dbmethod - control method commands
146 acpi_db_set_method_breakpoint(char *location,
147 struct acpi_walk_state *walk_state,
148 union acpi_parse_object *op);
150 void acpi_db_set_method_call_breakpoint(union acpi_parse_object *op);
152 void acpi_db_set_method_data(char *type_arg, char *index_arg, char *value_arg);
154 acpi_status acpi_db_disassemble_method(char *name);
156 void acpi_db_disassemble_aml(char *statements, union acpi_parse_object *op);
158 void acpi_db_batch_execute(char *count_arg);
161 * dbnames - namespace commands
163 void acpi_db_set_scope(char *name);
165 void acpi_db_dump_namespace(char *start_arg, char *depth_arg);
167 void acpi_db_dump_namespace_paths(void);
169 void acpi_db_dump_namespace_by_owner(char *owner_arg, char *depth_arg);
171 acpi_status acpi_db_find_name_in_namespace(char *name_arg);
173 void acpi_db_check_predefined_names(void);
176 acpi_db_display_objects(char *obj_type_arg, char *display_count_arg);
178 void acpi_db_check_integrity(void);
180 void acpi_db_find_references(char *object_arg);
182 void acpi_db_get_bus_info(void);
185 * dbdisply - debug display commands
187 void acpi_db_display_method_info(union acpi_parse_object *op);
189 void acpi_db_decode_and_display_object(char *target, char *output_type);
191 ACPI_DBR_DEPENDENT_RETURN_VOID(void
192 acpi_db_display_result_object(union
199 acpi_status acpi_db_display_all_methods(char *display_count_arg);
201 void acpi_db_display_arguments(void);
203 void acpi_db_display_locals(void);
205 void acpi_db_display_results(void);
207 void acpi_db_display_calling_tree(void);
209 void acpi_db_display_object_type(char *object_arg);
211 ACPI_DBR_DEPENDENT_RETURN_VOID(void
212 acpi_db_display_argument_object(union
220 * dbexec - debugger control method execution
223 acpi_db_execute(char *name, char **args, acpi_object_type * types, u32 flags);
226 acpi_db_create_execution_threads(char *num_threads_arg,
227 char *num_loops_arg, char *method_name_arg);
229 void acpi_db_delete_objects(u32 count, union acpi_object *objects);
231 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
232 u32 acpi_db_get_cache_info(struct acpi_memory_list *cache);
236 * dbfileio - Debugger file I/O commands
239 acpi_db_match_argument(char *user_argument,
240 struct acpi_db_argument_info *arguments);
242 void acpi_db_close_debug_file(void);
244 void acpi_db_open_debug_file(char *name);
246 acpi_status acpi_db_load_acpi_table(char *filename);
248 acpi_status acpi_db_load_tables(struct acpi_new_table_desc *list_head);
251 * dbhistry - debugger HISTORY command
253 void acpi_db_add_to_history(char *command_line);
255 void acpi_db_display_history(void);
257 char *acpi_db_get_from_history(char *command_num_arg);
259 char *acpi_db_get_history_by_index(u32 commandd_num);
262 * dbinput - user front-end to the AML debugger
265 acpi_db_command_dispatch(char *input_buffer,
266 struct acpi_walk_state *walk_state,
267 union acpi_parse_object *op);
269 void ACPI_SYSTEM_XFACE acpi_db_execute_thread(void *context);
271 acpi_status acpi_db_user_commands(void);
273 char *acpi_db_get_next_token(char *string,
274 char **next, acpi_object_type * return_type);
279 void acpi_db_decode_internal_object(union acpi_operand_object *obj_desc);
282 acpi_db_display_internal_object(union acpi_operand_object *obj_desc,
283 struct acpi_walk_state *walk_state);
285 void acpi_db_decode_arguments(struct acpi_walk_state *walk_state);
287 void acpi_db_decode_locals(struct acpi_walk_state *walk_state);
290 acpi_db_dump_method_info(acpi_status status,
291 struct acpi_walk_state *walk_state);
294 * dbstats - Generation and display of ACPI table statistics
296 void acpi_db_generate_statistics(union acpi_parse_object *root, u8 is_method);
298 acpi_status acpi_db_display_statistics(char *type_arg);
301 * dbutils - AML debugger utilities
303 void acpi_db_set_output_destination(u32 where);
305 void acpi_db_dump_external_object(union acpi_object *obj_desc, u32 level);
307 void acpi_db_prep_namestring(char *name);
309 struct acpi_namespace_node *acpi_db_local_ns_lookup(char *name);
311 void acpi_db_uint32_to_hex_string(u32 value, char *buffer);
313 #endif /* __ACDEBUG_H__ */