acpi/acpica/acdebug.h

0001 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
0002 /******************************************************************************
0003  *
0004  * Name: acdebug.h - ACPI/AML debugger
0005  *
0006  * Copyright (C) 2000 - 2022, Intel Corp.
0007  *
0008  *****************************************************************************/
0009
0010 #ifndef __ACDEBUG_H__
0011 #define __ACDEBUG_H__
0012
0013 /* The debugger is used in conjunction with the disassembler most of time */
0014
0015 #ifdef ACPI_DISASSEMBLER
0016 #include "acdisasm.h"
0017 #endif
0018
0019 #define ACPI_DEBUG_BUFFER_SIZE      0x4000  /* 16K buffer for return objects */
0020 #define ACPI_DEBUG_LENGTH_FORMAT    " (%.4X bits, %.3X bytes)"
0021
0022 struct acpi_db_command_info {
0023     const char *name;   /* Command Name */
0024     u8 min_args;        /* Minimum arguments required */
0025 };
0026
0027 struct acpi_db_command_help {
0028     u8 line_count;      /* Number of help lines */
0029     char *invocation;   /* Command Invocation */
0030     char *description;  /* Command Description */
0031 };
0032
0033 struct acpi_db_argument_info {
0034     const char *name;   /* Argument Name */
0035 };
0036
0037 struct acpi_db_execute_walk {
0038     u32 count;
0039     u32 max_count;
0040     char name_seg[ACPI_NAMESEG_SIZE + 1];
0041 };
0042
0043 #define PARAM_LIST(pl)                  pl
0044
0045 #define EX_NO_SINGLE_STEP               1
0046 #define EX_SINGLE_STEP                  2
0047 #define EX_ALL                          4
0048
0049 /*
0050  * dbxface - external debugger interfaces
0051  */
0052 ACPI_DBR_DEPENDENT_RETURN_OK(acpi_status
0053                  acpi_db_single_step(struct acpi_walk_state
0054                          *walk_state,
0055                          union acpi_parse_object *op,
0056                          u32 op_type))
0057  ACPI_DBR_DEPENDENT_RETURN_VOID(void
0058                 acpi_db_signal_break_point(struct
0059                                acpi_walk_state
0060                                *walk_state))
0061
0062 /*
0063  * dbcmds - debug commands and output routines
0064  */
0065 struct acpi_namespace_node *acpi_db_convert_to_node(char *in_string);
0066
0067 void acpi_db_display_table_info(char *table_arg);
0068
0069 void acpi_db_display_template(char *buffer_arg);
0070
0071 void acpi_db_unload_acpi_table(char *name);
0072
0073 void acpi_db_send_notify(char *name, u32 value);
0074
0075 void acpi_db_display_interfaces(char *action_arg, char *interface_name_arg);
0076
0077 acpi_status acpi_db_sleep(char *object_arg);
0078
0079 void acpi_db_trace(char *enable_arg, char *method_arg, char *once_arg);
0080
0081 void acpi_db_display_locks(void);
0082
0083 void acpi_db_display_resources(char *object_arg);
0084
0085 ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_db_display_gpes(void))
0086
0087 void acpi_db_display_handlers(void);
0088
0089 ACPI_HW_DEPENDENT_RETURN_VOID(void
0090                   acpi_db_generate_gpe(char *gpe_arg,
0091                            char *block_arg))
0092 ACPI_HW_DEPENDENT_RETURN_VOID(void acpi_db_generate_sci(void))
0093
0094 void acpi_db_execute_test(char *type_arg);
0095
0096 /*
0097  * dbconvert - miscellaneous conversion routines
0098  */
0099 acpi_status acpi_db_hex_char_to_value(int hex_char, u8 *return_value);
0100
0101 acpi_status acpi_db_convert_to_package(char *string, union acpi_object *object);
0102
0103 acpi_status
0104 acpi_db_convert_to_object(acpi_object_type type,
0105               char *string, union acpi_object *object);
0106
0107 u8 *acpi_db_encode_pld_buffer(struct acpi_pld_info *pld_info);
0108
0109 void acpi_db_dump_pld_buffer(union acpi_object *obj_desc);
0110
0111 /*
0112  * dbmethod - control method commands
0113  */
0114 void
0115 acpi_db_set_method_breakpoint(char *location,
0116                   struct acpi_walk_state *walk_state,
0117                   union acpi_parse_object *op);
0118
0119 void acpi_db_set_method_call_breakpoint(union acpi_parse_object *op);
0120
0121 void acpi_db_set_method_data(char *type_arg, char *index_arg, char *value_arg);
0122
0123 acpi_status acpi_db_disassemble_method(char *name);
0124
0125 void acpi_db_disassemble_aml(char *statements, union acpi_parse_object *op);
0126
0127 void acpi_db_evaluate_predefined_names(void);
0128
0129 void acpi_db_evaluate_all(char *name_seg);
0130
0131 /*
0132  * dbnames - namespace commands
0133  */
0134 void acpi_db_set_scope(char *name);
0135
0136 void acpi_db_dump_namespace(char *start_arg, char *depth_arg);
0137
0138 void acpi_db_dump_namespace_paths(void);
0139
0140 void acpi_db_dump_namespace_by_owner(char *owner_arg, char *depth_arg);
0141
0142 acpi_status acpi_db_find_name_in_namespace(char *name_arg);
0143
0144 void acpi_db_check_predefined_names(void);
0145
0146 acpi_status
0147 acpi_db_display_objects(char *obj_type_arg, char *display_count_arg);
0148
0149 void acpi_db_check_integrity(void);
0150
0151 void acpi_db_find_references(char *object_arg);
0152
0153 void acpi_db_get_bus_info(void);
0154
0155 acpi_status acpi_db_display_fields(u32 address_space_id);
0156
0157 /*
0158  * dbdisply - debug display commands
0159  */
0160 void acpi_db_display_method_info(union acpi_parse_object *op);
0161
0162 void acpi_db_decode_and_display_object(char *target, char *output_type);
0163
0164 ACPI_DBR_DEPENDENT_RETURN_VOID(void
0165                    acpi_db_display_result_object(union
0166                                  acpi_operand_object
0167                                  *obj_desc,
0168                                  struct
0169                                  acpi_walk_state
0170                                  *walk_state))
0171
0172 acpi_status acpi_db_display_all_methods(char *display_count_arg);
0173
0174 void acpi_db_display_arguments(void);
0175
0176 void acpi_db_display_locals(void);
0177
0178 void acpi_db_display_results(void);
0179
0180 void acpi_db_display_calling_tree(void);
0181
0182 void acpi_db_display_object_type(char *object_arg);
0183
0184 ACPI_DBR_DEPENDENT_RETURN_VOID(void
0185                    acpi_db_display_argument_object(union
0186                                    acpi_operand_object
0187                                    *obj_desc,
0188                                    struct
0189                                    acpi_walk_state
0190                                    *walk_state))
0191
0192 /*
0193  * dbexec - debugger control method execution
0194  */
0195 void
0196 acpi_db_execute(char *name, char **args, acpi_object_type *types, u32 flags);
0197
0198 void
0199 acpi_db_create_execution_thread(char *method_name_arg,
0200                 char **arguments, acpi_object_type *types);
0201
0202 void
0203 acpi_db_create_execution_threads(char *num_threads_arg,
0204                  char *num_loops_arg, char *method_name_arg);
0205
0206 void acpi_db_delete_objects(u32 count, union acpi_object *objects);
0207
0208 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
0209 u32 acpi_db_get_cache_info(struct acpi_memory_list *cache);
0210 #endif
0211
0212 /*
0213  * dbfileio - Debugger file I/O commands
0214  */
0215 acpi_object_type
0216 acpi_db_match_argument(char *user_argument,
0217                struct acpi_db_argument_info *arguments);
0218
0219 void acpi_db_close_debug_file(void);
0220
0221 void acpi_db_open_debug_file(char *name);
0222
0223 acpi_status acpi_db_load_acpi_table(char *filename);
0224
0225 acpi_status acpi_db_load_tables(struct acpi_new_table_desc *list_head);
0226
0227 /*
0228  * dbhistry - debugger HISTORY command
0229  */
0230 void acpi_db_add_to_history(char *command_line);
0231
0232 void acpi_db_display_history(void);
0233
0234 char *acpi_db_get_from_history(char *command_num_arg);
0235
0236 char *acpi_db_get_history_by_index(u32 commandd_num);
0237
0238 /*
0239  * dbinput - user front-end to the AML debugger
0240  */
0241 acpi_status
0242 acpi_db_command_dispatch(char *input_buffer,
0243              struct acpi_walk_state *walk_state,
0244              union acpi_parse_object *op);
0245
0246 void ACPI_SYSTEM_XFACE acpi_db_execute_thread(void *context);
0247
0248 acpi_status acpi_db_user_commands(void);
0249
0250 char *acpi_db_get_next_token(char *string,
0251                  char **next, acpi_object_type *return_type);
0252
0253 /*
0254  * dbobject
0255  */
0256 void acpi_db_decode_internal_object(union acpi_operand_object *obj_desc);
0257
0258 void
0259 acpi_db_display_internal_object(union acpi_operand_object *obj_desc,
0260                 struct acpi_walk_state *walk_state);
0261
0262 void acpi_db_decode_arguments(struct acpi_walk_state *walk_state);
0263
0264 void acpi_db_decode_locals(struct acpi_walk_state *walk_state);
0265
0266 void
0267 acpi_db_dump_method_info(acpi_status status,
0268              struct acpi_walk_state *walk_state);
0269
0270 /*
0271  * dbstats - Generation and display of ACPI table statistics
0272  */
0273 void acpi_db_generate_statistics(union acpi_parse_object *root, u8 is_method);
0274
0275 acpi_status acpi_db_display_statistics(char *type_arg);
0276
0277 /*
0278  * dbutils - AML debugger utilities
0279  */
0280 void acpi_db_set_output_destination(u32 where);
0281
0282 void acpi_db_dump_external_object(union acpi_object *obj_desc, u32 level);
0283
0284 void acpi_db_prep_namestring(char *name);
0285
0286 struct acpi_namespace_node *acpi_db_local_ns_lookup(char *name);
0287
0288 void acpi_db_uint32_to_hex_string(u32 value, char *buffer);
0289
0290 #endif              /* __ACDEBUG_H__ */