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