include/acpi/acdebug.h

   1 /******************************************************************************
   2  *
   3  * Name: acdebug.h - ACPI/AML debugger
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, R. Byron Moore
   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
  48 #define ACPI_DEBUG_BUFFER_SIZE  4196
  49
  50 struct command_info
  51 {
  52         char                            *name;          /* Command Name */
  53         u8                              min_args;       /* Minimum arguments required */
  54 };
  55
  56
  57 struct argument_info
  58 {
  59         char                            *name;          /* Argument Name */
  60 };
  61
  62
  63 #define PARAM_LIST(pl)                  pl
  64 #define DBTEST_OUTPUT_LEVEL(lvl)        if (acpi_gbl_db_opt_verbose)
  65 #define VERBOSE_PRINT(fp)               DBTEST_OUTPUT_LEVEL(lvl) {\
  66                           acpi_os_printf PARAM_LIST(fp);}
  67
  68 #define EX_NO_SINGLE_STEP               1
  69 #define EX_SINGLE_STEP                  2
  70
  71
  72 /*
  73  * dbxface - external debugger interfaces
  74  */
  75 acpi_status
  76 acpi_db_initialize (
  77         void);
  78
  79 void
  80 acpi_db_terminate (
  81         void);
  82
  83 acpi_status
  84 acpi_db_single_step (
  85         struct acpi_walk_state          *walk_state,
  86         union acpi_parse_object         *op,
  87         u32                             op_type);
  88
  89
  90 /*
  91  * dbcmds - debug commands and output routines
  92  */
  93 acpi_status
  94 acpi_db_disassemble_method (
  95         char                            *name);
  96
  97 void
  98 acpi_db_display_table_info (
  99         char                            *table_arg);
 100
 101 void
 102 acpi_db_unload_acpi_table (
 103         char                            *table_arg,
 104         char                            *instance_arg);
 105
 106 void
 107 acpi_db_set_method_breakpoint (
 108         char                            *location,
 109         struct acpi_walk_state          *walk_state,
 110         union acpi_parse_object         *op);
 111
 112 void
 113 acpi_db_set_method_call_breakpoint (
 114         union acpi_parse_object         *op);
 115
 116 void
 117 acpi_db_disassemble_aml (
 118         char                            *statements,
 119         union acpi_parse_object         *op);
 120
 121 void
 122 acpi_db_dump_namespace (
 123         char                            *start_arg,
 124         char                            *depth_arg);
 125
 126 void
 127 acpi_db_dump_namespace_by_owner (
 128         char                            *owner_arg,
 129         char                            *depth_arg);
 130
 131 void
 132 acpi_db_send_notify (
 133         char                            *name,
 134         u32                             value);
 135
 136 void
 137 acpi_db_set_method_data (
 138         char                            *type_arg,
 139         char                            *index_arg,
 140         char                            *value_arg);
 141
 142 acpi_status
 143 acpi_db_display_objects (
 144         char                            *obj_type_arg,
 145         char                            *display_count_arg);
 146
 147 acpi_status
 148 acpi_db_find_name_in_namespace (
 149         char                            *name_arg);
 150
 151 void
 152 acpi_db_set_scope (
 153         char                            *name);
 154
 155 acpi_status
 156 acpi_db_sleep (
 157         char                            *object_arg);
 158
 159 void
 160 acpi_db_find_references (
 161         char                            *object_arg);
 162
 163 void
 164 acpi_db_display_locks (
 165         void);
 166
 167 void
 168 acpi_db_display_resources (
 169         char                            *object_arg);
 170
 171 void
 172 acpi_db_display_gpes (
 173         void);
 174
 175 void
 176 acpi_db_check_integrity (
 177         void);
 178
 179 void
 180 acpi_db_generate_gpe (
 181         char                            *gpe_arg,
 182         char                            *block_arg);
 183
 184
 185 /*
 186  * dbdisply - debug display commands
 187  */
 188 void
 189 acpi_db_display_method_info (
 190         union acpi_parse_object         *op);
 191
 192 void
 193 acpi_db_decode_and_display_object (
 194         char                            *target,
 195         char                            *output_type);
 196
 197 void
 198 acpi_db_display_result_object (
 199         union acpi_operand_object       *obj_desc,
 200         struct acpi_walk_state          *walk_state);
 201
 202 acpi_status
 203 acpi_db_display_all_methods (
 204         char                            *display_count_arg);
 205
 206 void
 207 acpi_db_display_arguments (
 208         void);
 209
 210 void
 211 acpi_db_display_locals (
 212         void);
 213
 214 void
 215 acpi_db_display_results (
 216         void);
 217
 218 void
 219 acpi_db_display_calling_tree (
 220         void);
 221
 222 void
 223 acpi_db_display_object_type (
 224         char                            *object_arg);
 225
 226 void
 227 acpi_db_display_argument_object (
 228         union acpi_operand_object       *obj_desc,
 229         struct acpi_walk_state          *walk_state);
 230
 231
 232 /*
 233  * dbexec - debugger control method execution
 234  */
 235 void
 236 acpi_db_execute (
 237         char                            *name,
 238         char                            **args,
 239         u32                             flags);
 240
 241 void
 242 acpi_db_create_execution_threads (
 243         char                            *num_threads_arg,
 244         char                            *num_loops_arg,
 245         char                            *method_name_arg);
 246
 247
 248 /*
 249  * dbfileio - Debugger file I/O commands
 250  */
 251 acpi_object_type
 252 acpi_db_match_argument (
 253         char                            *user_argument,
 254         struct argument_info            *arguments);
 255
 256 void
 257 acpi_db_close_debug_file (
 258         void);
 259
 260 void
 261 acpi_db_open_debug_file (
 262         char                            *name);
 263
 264 acpi_status
 265 acpi_db_load_acpi_table (
 266         char                            *filename);
 267
 268 acpi_status
 269 acpi_db_get_table_from_file (
 270         char                            *filename,
 271         struct acpi_table_header        **table);
 272
 273 acpi_status
 274 acpi_db_read_table_from_file (
 275         char                            *filename,
 276         struct acpi_table_header        **table);
 277
 278
 279 /*
 280  * dbhistry - debugger HISTORY command
 281  */
 282 void
 283 acpi_db_add_to_history (
 284         char                            *command_line);
 285
 286 void
 287 acpi_db_display_history (
 288         void);
 289
 290 char *
 291 acpi_db_get_from_history (
 292         char                            *command_num_arg);
 293
 294
 295 /*
 296  * dbinput - user front-end to the AML debugger
 297  */
 298 acpi_status
 299 acpi_db_command_dispatch (
 300         char                            *input_buffer,
 301         struct acpi_walk_state          *walk_state,
 302         union acpi_parse_object         *op);
 303
 304 void ACPI_SYSTEM_XFACE
 305 acpi_db_execute_thread (
 306         void                            *context);
 307
 308
 309 /*
 310  * dbstats - Generation and display of ACPI table statistics
 311  */
 312 void
 313 acpi_db_generate_statistics (
 314         union acpi_parse_object         *root,
 315         u8                              is_method);
 316
 317 acpi_status
 318 acpi_db_display_statistics (
 319         char                            *type_arg);
 320
 321
 322 /*
 323  * dbutils - AML debugger utilities
 324  */
 325 void
 326 acpi_db_set_output_destination (
 327         u32                             where);
 328
 329 void
 330 acpi_db_dump_object (
 331         union acpi_object               *obj_desc,
 332         u32                             level);
 333
 334 void
 335 acpi_db_prep_namestring (
 336         char                            *name);
 337
 338 struct acpi_namespace_node *
 339 acpi_db_local_ns_lookup (
 340         char                            *name);
 341
 342 #endif  /* __ACDEBUG_H__ */