blob: 70ce3b4d006edc99a0171372005f262a7284db84 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define ACPI_DEBUG_BUFFER_SIZE 4196
48
Len Brown4be44fc2005-08-05 00:44:28 -040049struct command_info {
50 char *name; /* Command Name */
51 u8 min_args; /* Minimum arguments required */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052};
53
Len Brown4be44fc2005-08-05 00:44:28 -040054struct argument_info {
55 char *name; /* Argument Name */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#define PARAM_LIST(pl) pl
Linus Torvalds1da177e2005-04-16 15:20:36 -070059#define DBTEST_OUTPUT_LEVEL(lvl) if (acpi_gbl_db_opt_verbose)
Linus Torvalds1da177e2005-04-16 15:20:36 -070060#define VERBOSE_PRINT(fp) DBTEST_OUTPUT_LEVEL(lvl) {\
61 acpi_os_printf PARAM_LIST(fp);}
62
63#define EX_NO_SINGLE_STEP 1
64#define EX_SINGLE_STEP 2
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066/*
67 * dbxface - external debugger interfaces
68 */
Len Brown4be44fc2005-08-05 00:44:28 -040069acpi_status acpi_db_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
Len Brown4be44fc2005-08-05 00:44:28 -040071void acpi_db_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040074acpi_db_single_step(struct acpi_walk_state *walk_state,
75 union acpi_parse_object *op, u32 op_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77/*
78 * dbcmds - debug commands and output routines
79 */
Len Brown4be44fc2005-08-05 00:44:28 -040080acpi_status acpi_db_disassemble_method(char *name);
81
82void acpi_db_display_table_info(char *table_arg);
83
84void acpi_db_unload_acpi_table(char *table_arg, char *instance_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86void
Len Brown4be44fc2005-08-05 00:44:28 -040087acpi_db_set_method_breakpoint(char *location,
88 struct acpi_walk_state *walk_state,
89 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Len Brown4be44fc2005-08-05 00:44:28 -040091void acpi_db_set_method_call_breakpoint(union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Len Brown4be44fc2005-08-05 00:44:28 -040093void acpi_db_get_bus_info(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Len Brown4be44fc2005-08-05 00:44:28 -040095void acpi_db_disassemble_aml(char *statements, union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Len Brown4be44fc2005-08-05 00:44:28 -040097void acpi_db_dump_namespace(char *start_arg, char *depth_arg);
Robert Moore73459f72005-06-24 00:00:00 -040098
Len Brown4be44fc2005-08-05 00:44:28 -040099void acpi_db_dump_namespace_by_owner(char *owner_arg, char *depth_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Len Brown4be44fc2005-08-05 00:44:28 -0400101void acpi_db_send_notify(char *name, u32 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Len Brown4be44fc2005-08-05 00:44:28 -0400103void acpi_db_set_method_data(char *type_arg, char *index_arg, char *value_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400106acpi_db_display_objects(char *obj_type_arg, char *display_count_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Len Brown4be44fc2005-08-05 00:44:28 -0400108acpi_status acpi_db_find_name_in_namespace(char *name_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Len Brown4be44fc2005-08-05 00:44:28 -0400110void acpi_db_set_scope(char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Len Brown4be44fc2005-08-05 00:44:28 -0400112acpi_status acpi_db_sleep(char *object_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Len Brown4be44fc2005-08-05 00:44:28 -0400114void acpi_db_find_references(char *object_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Len Brown4be44fc2005-08-05 00:44:28 -0400116void acpi_db_display_locks(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Len Brown4be44fc2005-08-05 00:44:28 -0400118void acpi_db_display_resources(char *object_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Len Brown4be44fc2005-08-05 00:44:28 -0400120void acpi_db_display_gpes(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
Len Brown4be44fc2005-08-05 00:44:28 -0400122void acpi_db_check_integrity(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Len Brown4be44fc2005-08-05 00:44:28 -0400124void acpi_db_generate_gpe(char *gpe_arg, char *block_arg);
Robert Moore44f6c012005-04-18 22:49:35 -0400125
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126/*
127 * dbdisply - debug display commands
128 */
Len Brown4be44fc2005-08-05 00:44:28 -0400129void acpi_db_display_method_info(union acpi_parse_object *op);
130
131void acpi_db_decode_and_display_object(char *target, char *output_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133void
Len Brown4be44fc2005-08-05 00:44:28 -0400134acpi_db_display_result_object(union acpi_operand_object *obj_desc,
135 struct acpi_walk_state *walk_state);
136
137acpi_status acpi_db_display_all_methods(char *display_count_arg);
138
139void acpi_db_display_arguments(void);
140
141void acpi_db_display_locals(void);
142
143void acpi_db_display_results(void);
144
145void acpi_db_display_calling_tree(void);
146
147void acpi_db_display_object_type(char *object_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149void
Len Brown4be44fc2005-08-05 00:44:28 -0400150acpi_db_display_argument_object(union acpi_operand_object *obj_desc,
151 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
153/*
154 * dbexec - debugger control method execution
155 */
Len Brown4be44fc2005-08-05 00:44:28 -0400156void acpi_db_execute(char *name, char **args, u32 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158void
Len Brown4be44fc2005-08-05 00:44:28 -0400159acpi_db_create_execution_threads(char *num_threads_arg,
160 char *num_loops_arg, char *method_name_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162/*
163 * dbfileio - Debugger file I/O commands
164 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165acpi_object_type
Len Brown4be44fc2005-08-05 00:44:28 -0400166acpi_db_match_argument(char *user_argument, struct argument_info *arguments);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Len Brown4be44fc2005-08-05 00:44:28 -0400168void acpi_db_close_debug_file(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Len Brown4be44fc2005-08-05 00:44:28 -0400170void acpi_db_open_debug_file(char *name);
171
172acpi_status acpi_db_load_acpi_table(char *filename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400175acpi_db_get_table_from_file(char *filename, struct acpi_table_header **table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400178acpi_db_read_table_from_file(char *filename, struct acpi_table_header **table);
Robert Moore44f6c012005-04-18 22:49:35 -0400179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180/*
181 * dbhistry - debugger HISTORY command
182 */
Len Brown4be44fc2005-08-05 00:44:28 -0400183void acpi_db_add_to_history(char *command_line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Len Brown4be44fc2005-08-05 00:44:28 -0400185void acpi_db_display_history(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Len Brown4be44fc2005-08-05 00:44:28 -0400187char *acpi_db_get_from_history(char *command_num_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189/*
190 * dbinput - user front-end to the AML debugger
191 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400193acpi_db_command_dispatch(char *input_buffer,
194 struct acpi_walk_state *walk_state,
195 union acpi_parse_object *op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Len Brown4be44fc2005-08-05 00:44:28 -0400197void ACPI_SYSTEM_XFACE acpi_db_execute_thread(void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199/*
200 * dbstats - Generation and display of ACPI table statistics
201 */
Len Brown4be44fc2005-08-05 00:44:28 -0400202void acpi_db_generate_statistics(union acpi_parse_object *root, u8 is_method);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Len Brown4be44fc2005-08-05 00:44:28 -0400204acpi_status acpi_db_display_statistics(char *type_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206/*
207 * dbutils - AML debugger utilities
208 */
Len Brown4be44fc2005-08-05 00:44:28 -0400209void acpi_db_set_output_destination(u32 where);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
Len Brown4be44fc2005-08-05 00:44:28 -0400211void acpi_db_dump_external_object(union acpi_object *obj_desc, u32 level);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Len Brown4be44fc2005-08-05 00:44:28 -0400213void acpi_db_prep_namestring(char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Len Brown4be44fc2005-08-05 00:44:28 -0400215struct acpi_namespace_node *acpi_db_local_ns_lookup(char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Len Brown4be44fc2005-08-05 00:44:28 -0400217#endif /* __ACDEBUG_H__ */