drivers/acpi/acpica/acdebug.h

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