1 /******************************************************************************
3 * Name: acdisasm.h - AML disassembler
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #ifndef __ACDISASM_H__
45 #define __ACDISASM_H__
52 #define BLOCK_COMMA_LIST 4
53 #define ACPI_DEFAULT_RESNAME *(u32 *) "__RD"
55 struct acpi_external_list {
57 struct acpi_external_list *next;
60 extern struct acpi_external_list *acpi_gbl_external_list;
62 typedef const struct acpi_dmtable_info {
70 * Values for Opcode above.
71 * Note: 0-7 must not change, used as a flag shift value
73 #define ACPI_DMT_FLAG0 0
74 #define ACPI_DMT_FLAG1 1
75 #define ACPI_DMT_FLAG2 2
76 #define ACPI_DMT_FLAG3 3
77 #define ACPI_DMT_FLAG4 4
78 #define ACPI_DMT_FLAG5 5
79 #define ACPI_DMT_FLAG6 6
80 #define ACPI_DMT_FLAG7 7
81 #define ACPI_DMT_FLAGS0 8
82 #define ACPI_DMT_FLAGS2 9
83 #define ACPI_DMT_UINT8 10
84 #define ACPI_DMT_UINT16 11
85 #define ACPI_DMT_UINT24 12
86 #define ACPI_DMT_UINT32 13
87 #define ACPI_DMT_UINT56 14
88 #define ACPI_DMT_UINT64 15
89 #define ACPI_DMT_STRING 16
90 #define ACPI_DMT_NAME4 17
91 #define ACPI_DMT_NAME6 18
92 #define ACPI_DMT_NAME8 19
93 #define ACPI_DMT_CHKSUM 20
94 #define ACPI_DMT_SPACEID 21
95 #define ACPI_DMT_GAS 22
96 #define ACPI_DMT_MADT 23
97 #define ACPI_DMT_SRAT 24
98 #define ACPI_DMT_EXIT 25
101 void (*ACPI_TABLE_HANDLER) (struct acpi_table_header * table);
103 struct acpi_dmtable_data {
105 struct acpi_dmtable_info *table_info;
106 ACPI_TABLE_HANDLER table_handler;
109 struct acpi_op_walk_info {
113 struct acpi_walk_state *walk_state;
117 acpi_status(*asl_walk_callback) (union acpi_parse_object * op,
118 u32 level, void *context);
120 struct acpi_resource_tag {
125 /* Strings used for decoding flags to ASL keywords */
127 extern const char *acpi_gbl_word_decode[4];
128 extern const char *acpi_gbl_irq_decode[2];
129 extern const char *acpi_gbl_lock_rule[ACPI_NUM_LOCK_RULES];
130 extern const char *acpi_gbl_access_types[ACPI_NUM_ACCESS_TYPES];
131 extern const char *acpi_gbl_update_rules[ACPI_NUM_UPDATE_RULES];
132 extern const char *acpi_gbl_match_ops[ACPI_NUM_MATCH_OPS];
134 extern struct acpi_dmtable_info acpi_dm_table_info_asf0[];
135 extern struct acpi_dmtable_info acpi_dm_table_info_asf1[];
136 extern struct acpi_dmtable_info acpi_dm_table_info_asf2[];
137 extern struct acpi_dmtable_info acpi_dm_table_info_asf3[];
138 extern struct acpi_dmtable_info acpi_dm_table_info_asf4[];
139 extern struct acpi_dmtable_info acpi_dm_table_info_asf_hdr[];
140 extern struct acpi_dmtable_info acpi_dm_table_info_boot[];
141 extern struct acpi_dmtable_info acpi_dm_table_info_cpep[];
142 extern struct acpi_dmtable_info acpi_dm_table_info_cpep0[];
143 extern struct acpi_dmtable_info acpi_dm_table_info_dbgp[];
144 extern struct acpi_dmtable_info acpi_dm_table_info_ecdt[];
145 extern struct acpi_dmtable_info acpi_dm_table_info_facs[];
146 extern struct acpi_dmtable_info acpi_dm_table_info_fadt1[];
147 extern struct acpi_dmtable_info acpi_dm_table_info_fadt2[];
148 extern struct acpi_dmtable_info acpi_dm_table_info_gas[];
149 extern struct acpi_dmtable_info acpi_dm_table_info_header[];
150 extern struct acpi_dmtable_info acpi_dm_table_info_hpet[];
151 extern struct acpi_dmtable_info acpi_dm_table_info_madt[];
152 extern struct acpi_dmtable_info acpi_dm_table_info_madt0[];
153 extern struct acpi_dmtable_info acpi_dm_table_info_madt1[];
154 extern struct acpi_dmtable_info acpi_dm_table_info_madt2[];
155 extern struct acpi_dmtable_info acpi_dm_table_info_madt3[];
156 extern struct acpi_dmtable_info acpi_dm_table_info_madt4[];
157 extern struct acpi_dmtable_info acpi_dm_table_info_madt5[];
158 extern struct acpi_dmtable_info acpi_dm_table_info_madt6[];
159 extern struct acpi_dmtable_info acpi_dm_table_info_madt7[];
160 extern struct acpi_dmtable_info acpi_dm_table_info_madt8[];
161 extern struct acpi_dmtable_info acpi_dm_table_info_madt_hdr[];
162 extern struct acpi_dmtable_info acpi_dm_table_info_mcfg[];
163 extern struct acpi_dmtable_info acpi_dm_table_info_mcfg0[];
164 extern struct acpi_dmtable_info acpi_dm_table_info_rsdp1[];
165 extern struct acpi_dmtable_info acpi_dm_table_info_rsdp2[];
166 extern struct acpi_dmtable_info acpi_dm_table_info_sbst[];
167 extern struct acpi_dmtable_info acpi_dm_table_info_slit[];
168 extern struct acpi_dmtable_info acpi_dm_table_info_spcr[];
169 extern struct acpi_dmtable_info acpi_dm_table_info_spmi[];
170 extern struct acpi_dmtable_info acpi_dm_table_info_srat[];
171 extern struct acpi_dmtable_info acpi_dm_table_info_srat0[];
172 extern struct acpi_dmtable_info acpi_dm_table_info_srat1[];
173 extern struct acpi_dmtable_info acpi_dm_table_info_tcpa[];
174 extern struct acpi_dmtable_info acpi_dm_table_info_wdrt[];
179 void acpi_dm_dump_data_table(struct acpi_table_header *table);
182 acpi_dm_dump_table(u32 table_length,
185 u32 sub_table_length, struct acpi_dmtable_info *info);
187 void acpi_dm_line_header(u32 offset, u32 byte_length, char *name);
189 void acpi_dm_line_header2(u32 offset, u32 byte_length, char *name, u32 value);
194 void acpi_dm_dump_asf(struct acpi_table_header *table);
196 void acpi_dm_dump_cpep(struct acpi_table_header *table);
198 void acpi_dm_dump_fadt(struct acpi_table_header *table);
200 void acpi_dm_dump_srat(struct acpi_table_header *table);
202 void acpi_dm_dump_mcfg(struct acpi_table_header *table);
204 void acpi_dm_dump_madt(struct acpi_table_header *table);
206 u32 acpi_dm_dump_rsdp(struct acpi_table_header *table);
208 void acpi_dm_dump_rsdt(struct acpi_table_header *table);
210 void acpi_dm_dump_slit(struct acpi_table_header *table);
212 void acpi_dm_dump_xsdt(struct acpi_table_header *table);
218 acpi_dm_disassemble(struct acpi_walk_state *walk_state,
219 union acpi_parse_object *origin, u32 num_opcodes);
222 acpi_dm_walk_parse_tree(union acpi_parse_object *op,
223 asl_walk_callback descending_callback,
224 asl_walk_callback ascending_callback, void *context);
230 acpi_dm_disassemble_one_op(struct acpi_walk_state *walk_state,
231 struct acpi_op_walk_info *info,
232 union acpi_parse_object *op);
234 void acpi_dm_decode_internal_object(union acpi_operand_object *obj_desc);
236 u32 acpi_dm_list_type(union acpi_parse_object *op);
238 void acpi_dm_method_flags(union acpi_parse_object *op);
240 void acpi_dm_field_flags(union acpi_parse_object *op);
242 void acpi_dm_address_space(u8 space_id);
244 void acpi_dm_region_flags(union acpi_parse_object *op);
246 void acpi_dm_match_op(union acpi_parse_object *op);
248 u8 acpi_dm_comma_if_list_member(union acpi_parse_object *op);
250 void acpi_dm_comma_if_field_member(union acpi_parse_object *op);
255 u32 acpi_dm_dump_name(char *name);
258 acpi_ps_display_object_pathname(struct acpi_walk_state *walk_state,
259 union acpi_parse_object *op);
261 void acpi_dm_namestring(char *name);
267 acpi_dm_display_internal_object(union acpi_operand_object *obj_desc,
268 struct acpi_walk_state *walk_state);
270 void acpi_dm_display_arguments(struct acpi_walk_state *walk_state);
272 void acpi_dm_display_locals(struct acpi_walk_state *walk_state);
275 acpi_dm_dump_method_info(acpi_status status,
276 struct acpi_walk_state *walk_state,
277 union acpi_parse_object *op);
282 void acpi_dm_disasm_byte_list(u32 level, u8 * byte_data, u32 byte_count);
285 acpi_dm_byte_list(struct acpi_op_walk_info *info, union acpi_parse_object *op);
287 void acpi_dm_is_eisa_id(union acpi_parse_object *op);
289 void acpi_dm_eisa_id(u32 encoded_id);
291 u8 acpi_dm_is_unicode_buffer(union acpi_parse_object *op);
293 u8 acpi_dm_is_string_buffer(union acpi_parse_object *op);
298 void acpi_dm_dump_integer8(u8 value, char *name);
300 void acpi_dm_dump_integer16(u16 value, char *name);
302 void acpi_dm_dump_integer32(u32 value, char *name);
304 void acpi_dm_dump_integer64(u64 value, char *name);
307 acpi_dm_resource_template(struct acpi_op_walk_info *info,
308 union acpi_parse_object *op,
309 u8 * byte_data, u32 byte_count);
311 u8 acpi_dm_is_resource_template(union acpi_parse_object *op);
313 void acpi_dm_indent(u32 level);
315 void acpi_dm_bit_list(u16 mask);
317 void acpi_dm_decode_attribute(u8 attribute);
319 void acpi_dm_descriptor_name(void);
325 acpi_dm_word_descriptor(union aml_resource *resource, u32 length, u32 level);
328 acpi_dm_dword_descriptor(union aml_resource *resource, u32 length, u32 level);
331 acpi_dm_extended_descriptor(union aml_resource *resource,
332 u32 length, u32 level);
335 acpi_dm_qword_descriptor(union aml_resource *resource, u32 length, u32 level);
338 acpi_dm_memory24_descriptor(union aml_resource *resource,
339 u32 length, u32 level);
342 acpi_dm_memory32_descriptor(union aml_resource *resource,
343 u32 length, u32 level);
346 acpi_dm_fixed_memory32_descriptor(union aml_resource *resource,
347 u32 length, u32 level);
350 acpi_dm_generic_register_descriptor(union aml_resource *resource,
351 u32 length, u32 level);
354 acpi_dm_interrupt_descriptor(union aml_resource *resource,
355 u32 length, u32 level);
358 acpi_dm_vendor_large_descriptor(union aml_resource *resource,
359 u32 length, u32 level);
361 void acpi_dm_vendor_common(char *name, u8 * byte_data, u32 length, u32 level);
367 acpi_dm_irq_descriptor(union aml_resource *resource, u32 length, u32 level);
370 acpi_dm_dma_descriptor(union aml_resource *resource, u32 length, u32 level);
372 void acpi_dm_io_descriptor(union aml_resource *resource, u32 length, u32 level);
375 acpi_dm_fixed_io_descriptor(union aml_resource *resource,
376 u32 length, u32 level);
379 acpi_dm_start_dependent_descriptor(union aml_resource *resource,
380 u32 length, u32 level);
383 acpi_dm_end_dependent_descriptor(union aml_resource *resource,
384 u32 length, u32 level);
387 acpi_dm_vendor_small_descriptor(union aml_resource *resource,
388 u32 length, u32 level);
393 void acpi_dm_add_to_external_list(char *path);
398 void acpi_dm_find_resources(union acpi_parse_object *root);
401 acpi_dm_check_resource_reference(union acpi_parse_object *op,
402 struct acpi_walk_state *walk_state);
404 #endif /* __ACDISASM_H__ */