LXR linux/drivers/acpi/acpica/acdebug.h

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