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