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