[ACPI] ACPICA 20050815
[linux-2.6] / include / acpi / acdisasm.h
1 /******************************************************************************
2  *
3  * Name: acdisasm.h - AML disassembler
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 __ACDISASM_H__
45 #define __ACDISASM_H__
46
47 #include "amlresrc.h"
48
49 #define BLOCK_NONE              0
50 #define BLOCK_PAREN             1
51 #define BLOCK_BRACE             2
52 #define BLOCK_COMMA_LIST        4
53
54 struct acpi_external_list {
55         char *path;
56         struct acpi_external_list *next;
57 };
58
59 extern struct acpi_external_list *acpi_gbl_external_list;
60 extern const char *acpi_gbl_io_decode[2];
61 extern const char *acpi_gbl_word_decode[4];
62 extern const char *acpi_gbl_consume_decode[2];
63 extern const char *acpi_gbl_min_decode[2];
64 extern const char *acpi_gbl_max_decode[2];
65 extern const char *acpi_gbl_DECdecode[2];
66 extern const char *acpi_gbl_RNGdecode[4];
67 extern const char *acpi_gbl_MEMdecode[4];
68 extern const char *acpi_gbl_RWdecode[2];
69 extern const char *acpi_gbl_irq_decode[2];
70 extern const char *acpi_gbl_HEdecode[2];
71 extern const char *acpi_gbl_LLdecode[2];
72 extern const char *acpi_gbl_SHRdecode[2];
73 extern const char *acpi_gbl_TYPdecode[4];
74 extern const char *acpi_gbl_BMdecode[2];
75 extern const char *acpi_gbl_SIZdecode[4];
76 extern const char *acpi_gbl_TTPdecode[2];
77 extern const char *acpi_gbl_MTPdecode[4];
78 extern const char *acpi_gbl_TRSdecode[2];
79
80 extern const char *acpi_gbl_lock_rule[ACPI_NUM_LOCK_RULES];
81 extern const char *acpi_gbl_access_types[ACPI_NUM_ACCESS_TYPES];
82 extern const char *acpi_gbl_update_rules[ACPI_NUM_UPDATE_RULES];
83 extern const char *acpi_gbl_match_ops[ACPI_NUM_MATCH_OPS];
84
85 struct acpi_op_walk_info {
86         u32 level;
87         u32 bit_offset;
88         struct acpi_walk_state *walk_state;
89 };
90
91 typedef
92 acpi_status(*asl_walk_callback) (union acpi_parse_object * op,
93                                  u32 level, void *context);
94
95 /*
96  * dmwalk
97  */
98 void
99 acpi_dm_disassemble(struct acpi_walk_state *walk_state,
100                     union acpi_parse_object *origin, u32 num_opcodes);
101
102 /*
103  * dmopcode
104  */
105 void
106 acpi_dm_disassemble_one_op(struct acpi_walk_state *walk_state,
107                            struct acpi_op_walk_info *info,
108                            union acpi_parse_object *op);
109
110 void acpi_dm_decode_internal_object(union acpi_operand_object *obj_desc);
111
112 u32 acpi_dm_list_type(union acpi_parse_object *op);
113
114 void acpi_dm_method_flags(union acpi_parse_object *op);
115
116 void acpi_dm_field_flags(union acpi_parse_object *op);
117
118 void acpi_dm_address_space(u8 space_id);
119
120 void acpi_dm_region_flags(union acpi_parse_object *op);
121
122 void acpi_dm_match_op(union acpi_parse_object *op);
123
124 u8 acpi_dm_comma_if_list_member(union acpi_parse_object *op);
125
126 void acpi_dm_comma_if_field_member(union acpi_parse_object *op);
127
128 /*
129  * dmnames
130  */
131 u32 acpi_dm_dump_name(char *name);
132
133 acpi_status
134 acpi_ps_display_object_pathname(struct acpi_walk_state *walk_state,
135                                 union acpi_parse_object *op);
136
137 void acpi_dm_namestring(char *name);
138
139 /*
140  * dmobject
141  */
142 void
143 acpi_dm_display_internal_object(union acpi_operand_object *obj_desc,
144                                 struct acpi_walk_state *walk_state);
145
146 void acpi_dm_display_arguments(struct acpi_walk_state *walk_state);
147
148 void acpi_dm_display_locals(struct acpi_walk_state *walk_state);
149
150 void
151 acpi_dm_dump_method_info(acpi_status status,
152                          struct acpi_walk_state *walk_state,
153                          union acpi_parse_object *op);
154
155 /*
156  * dmbuffer
157  */
158 void acpi_dm_disasm_byte_list(u32 level, u8 * byte_data, u32 byte_count);
159
160 void
161 acpi_dm_byte_list(struct acpi_op_walk_info *info, union acpi_parse_object *op);
162
163 void acpi_dm_is_eisa_id(union acpi_parse_object *op);
164
165 void acpi_dm_eisa_id(u32 encoded_id);
166
167 u8 acpi_dm_is_unicode_buffer(union acpi_parse_object *op);
168
169 u8 acpi_dm_is_string_buffer(union acpi_parse_object *op);
170
171 /*
172  * dmresrc
173  */
174 void
175 acpi_dm_resource_descriptor(struct acpi_op_walk_info *info,
176                             u8 * byte_data, u32 byte_count);
177
178 u8 acpi_dm_is_resource_descriptor(union acpi_parse_object *op);
179
180 void acpi_dm_indent(u32 level);
181
182 void acpi_dm_bit_list(u16 mask);
183
184 void acpi_dm_decode_attribute(u8 attribute);
185
186 /*
187  * dmresrcl
188  */
189 void
190 acpi_dm_word_descriptor(struct asl_word_address_desc *resource,
191                         u32 length, u32 level);
192
193 void
194 acpi_dm_dword_descriptor(struct asl_dword_address_desc *resource,
195                          u32 length, u32 level);
196
197 void
198 acpi_dm_extended_descriptor(struct asl_extended_address_desc *resource,
199                             u32 length, u32 level);
200
201 void
202 acpi_dm_qword_descriptor(struct asl_qword_address_desc *resource,
203                          u32 length, u32 level);
204
205 void
206 acpi_dm_memory24_descriptor(struct asl_memory_24_desc *resource,
207                             u32 length, u32 level);
208
209 void
210 acpi_dm_memory32_descriptor(struct asl_memory_32_desc *resource,
211                             u32 length, u32 level);
212
213 void
214 acpi_dm_fixed_mem32_descriptor(struct asl_fixed_memory_32_desc *resource,
215                                u32 length, u32 level);
216
217 void
218 acpi_dm_generic_register_descriptor(struct asl_general_register_desc *resource,
219                                     u32 length, u32 level);
220
221 void
222 acpi_dm_interrupt_descriptor(struct asl_extended_xrupt_desc *resource,
223                              u32 length, u32 level);
224
225 void
226 acpi_dm_vendor_large_descriptor(struct asl_large_vendor_desc *resource,
227                                 u32 length, u32 level);
228
229 /*
230  * dmresrcs
231  */
232 void
233 acpi_dm_irq_descriptor(struct asl_irq_format_desc *resource,
234                        u32 length, u32 level);
235
236 void
237 acpi_dm_dma_descriptor(struct asl_dma_format_desc *resource,
238                        u32 length, u32 level);
239
240 void
241 acpi_dm_io_descriptor(struct asl_io_port_desc *resource, u32 length, u32 level);
242
243 void
244 acpi_dm_fixed_io_descriptor(struct asl_fixed_io_port_desc *resource,
245                             u32 length, u32 level);
246
247 void
248 acpi_dm_start_dependent_descriptor(struct asl_start_dependent_desc *resource,
249                                    u32 length, u32 level);
250
251 void
252 acpi_dm_end_dependent_descriptor(struct asl_start_dependent_desc *resource,
253                                  u32 length, u32 level);
254
255 void
256 acpi_dm_vendor_small_descriptor(struct asl_small_vendor_desc *resource,
257                                 u32 length, u32 level);
258
259 /*
260  * dmutils
261  */
262 void acpi_dm_add_to_external_list(char *path);
263
264 #endif                          /* __ACDISASM_H__ */