1/******************************************************************************
2 *
3 * Name: acdisasm.h - AML disassembler
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2007, 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#define ACPI_DEFAULT_RESNAME    *(u32 *) "__RD"
54
55struct acpi_external_list {
56	char *path;
57	char *internal_path;
58	struct acpi_external_list *next;
59	u32 value;
60	u16 length;
61	u8 type;
62};
63
64extern struct acpi_external_list *acpi_gbl_external_list;
65
66typedef const struct acpi_dmtable_info {
67	u8 opcode;
68	u8 offset;
69	char *name;
70
71} acpi_dmtable_info;
72
73/*
74 * Values for Opcode above.
75 * Note: 0-7 must not change, used as a flag shift value
76 */
77#define ACPI_DMT_FLAG0                  0
78#define ACPI_DMT_FLAG1                  1
79#define ACPI_DMT_FLAG2                  2
80#define ACPI_DMT_FLAG3                  3
81#define ACPI_DMT_FLAG4                  4
82#define ACPI_DMT_FLAG5                  5
83#define ACPI_DMT_FLAG6                  6
84#define ACPI_DMT_FLAG7                  7
85#define ACPI_DMT_FLAGS0                 8
86#define ACPI_DMT_FLAGS2                 9
87#define ACPI_DMT_UINT8                  10
88#define ACPI_DMT_UINT16                 11
89#define ACPI_DMT_UINT24                 12
90#define ACPI_DMT_UINT32                 13
91#define ACPI_DMT_UINT56                 14
92#define ACPI_DMT_UINT64                 15
93#define ACPI_DMT_STRING                 16
94#define ACPI_DMT_NAME4                  17
95#define ACPI_DMT_NAME6                  18
96#define ACPI_DMT_NAME8                  19
97#define ACPI_DMT_CHKSUM                 20
98#define ACPI_DMT_SPACEID                21
99#define ACPI_DMT_GAS                    22
100#define ACPI_DMT_DMAR                   23
101#define ACPI_DMT_MADT                   24
102#define ACPI_DMT_SRAT                   25
103#define ACPI_DMT_EXIT                   26
104#define ACPI_DMT_SIG                    27
105
106typedef
107void (*ACPI_TABLE_HANDLER) (struct acpi_table_header * table);
108
109struct acpi_dmtable_data {
110	char *signature;
111	struct acpi_dmtable_info *table_info;
112	ACPI_TABLE_HANDLER table_handler;
113	char *name;
114};
115
116struct acpi_op_walk_info {
117	u32 level;
118	u32 last_level;
119	u32 count;
120	u32 bit_offset;
121	u32 flags;
122	struct acpi_walk_state *walk_state;
123};
124
125typedef
126acpi_status(*asl_walk_callback) (union acpi_parse_object * op,
127				 u32 level, void *context);
128
129struct acpi_resource_tag {
130	u32 bit_index;
131	char *tag;
132};
133
134/* Strings used for decoding flags to ASL keywords */
135
136extern const char *acpi_gbl_word_decode[];
137extern const char *acpi_gbl_irq_decode[];
138extern const char *acpi_gbl_lock_rule[];
139extern const char *acpi_gbl_access_types[];
140extern const char *acpi_gbl_update_rules[];
141extern const char *acpi_gbl_match_ops[];
142
143extern struct acpi_dmtable_info acpi_dm_table_info_asf0[];
144extern struct acpi_dmtable_info acpi_dm_table_info_asf1[];
145extern struct acpi_dmtable_info acpi_dm_table_info_asf1a[];
146extern struct acpi_dmtable_info acpi_dm_table_info_asf2[];
147extern struct acpi_dmtable_info acpi_dm_table_info_asf2a[];
148extern struct acpi_dmtable_info acpi_dm_table_info_asf3[];
149extern struct acpi_dmtable_info acpi_dm_table_info_asf4[];
150extern struct acpi_dmtable_info acpi_dm_table_info_asf_hdr[];
151extern struct acpi_dmtable_info acpi_dm_table_info_boot[];
152extern struct acpi_dmtable_info acpi_dm_table_info_cpep[];
153extern struct acpi_dmtable_info acpi_dm_table_info_cpep0[];
154extern struct acpi_dmtable_info acpi_dm_table_info_dbgp[];
155extern struct acpi_dmtable_info acpi_dm_table_info_dmar[];
156extern struct acpi_dmtable_info acpi_dm_table_info_dmar_hdr[];
157extern struct acpi_dmtable_info acpi_dm_table_info_dmar_scope[];
158extern struct acpi_dmtable_info acpi_dm_table_info_dmar0[];
159extern struct acpi_dmtable_info acpi_dm_table_info_dmar1[];
160extern struct acpi_dmtable_info acpi_dm_table_info_ecdt[];
161extern struct acpi_dmtable_info acpi_dm_table_info_facs[];
162extern struct acpi_dmtable_info acpi_dm_table_info_fadt1[];
163extern struct acpi_dmtable_info acpi_dm_table_info_fadt2[];
164extern struct acpi_dmtable_info acpi_dm_table_info_gas[];
165extern struct acpi_dmtable_info acpi_dm_table_info_header[];
166extern struct acpi_dmtable_info acpi_dm_table_info_hpet[];
167extern struct acpi_dmtable_info acpi_dm_table_info_madt[];
168extern struct acpi_dmtable_info acpi_dm_table_info_madt0[];
169extern struct acpi_dmtable_info acpi_dm_table_info_madt1[];
170extern struct acpi_dmtable_info acpi_dm_table_info_madt2[];
171extern struct acpi_dmtable_info acpi_dm_table_info_madt3[];
172extern struct acpi_dmtable_info acpi_dm_table_info_madt4[];
173extern struct acpi_dmtable_info acpi_dm_table_info_madt5[];
174extern struct acpi_dmtable_info acpi_dm_table_info_madt6[];
175extern struct acpi_dmtable_info acpi_dm_table_info_madt7[];
176extern struct acpi_dmtable_info acpi_dm_table_info_madt8[];
177extern struct acpi_dmtable_info acpi_dm_table_info_madt_hdr[];
178extern struct acpi_dmtable_info acpi_dm_table_info_mcfg[];
179extern struct acpi_dmtable_info acpi_dm_table_info_mcfg0[];
180extern struct acpi_dmtable_info acpi_dm_table_info_rsdp1[];
181extern struct acpi_dmtable_info acpi_dm_table_info_rsdp2[];
182extern struct acpi_dmtable_info acpi_dm_table_info_sbst[];
183extern struct acpi_dmtable_info acpi_dm_table_info_slit[];
184extern struct acpi_dmtable_info acpi_dm_table_info_spcr[];
185extern struct acpi_dmtable_info acpi_dm_table_info_spmi[];
186extern struct acpi_dmtable_info acpi_dm_table_info_srat[];
187extern struct acpi_dmtable_info acpi_dm_table_info_srat0[];
188extern struct acpi_dmtable_info acpi_dm_table_info_srat1[];
189extern struct acpi_dmtable_info acpi_dm_table_info_tcpa[];
190extern struct acpi_dmtable_info acpi_dm_table_info_wdrt[];
191
192/*
193 * dmtable
194 */
195void acpi_dm_dump_data_table(struct acpi_table_header *table);
196
197void
198acpi_dm_dump_table(u32 table_length,
199		   u32 table_offset,
200		   void *table,
201		   u32 sub_table_length, struct acpi_dmtable_info *info);
202
203void acpi_dm_line_header(u32 offset, u32 byte_length, char *name);
204
205void acpi_dm_line_header2(u32 offset, u32 byte_length, char *name, u32 value);
206
207/*
208 * dmtbdump
209 */
210void acpi_dm_dump_asf(struct acpi_table_header *table);
211
212void acpi_dm_dump_cpep(struct acpi_table_header *table);
213
214void acpi_dm_dump_dmar(struct acpi_table_header *table);
215
216void acpi_dm_dump_fadt(struct acpi_table_header *table);
217
218void acpi_dm_dump_srat(struct acpi_table_header *table);
219
220void acpi_dm_dump_mcfg(struct acpi_table_header *table);
221
222void acpi_dm_dump_madt(struct acpi_table_header *table);
223
224u32 acpi_dm_dump_rsdp(struct acpi_table_header *table);
225
226void acpi_dm_dump_rsdt(struct acpi_table_header *table);
227
228void acpi_dm_dump_slit(struct acpi_table_header *table);
229
230void acpi_dm_dump_xsdt(struct acpi_table_header *table);
231
232/*
233 * dmwalk
234 */
235void
236acpi_dm_disassemble(struct acpi_walk_state *walk_state,
237		    union acpi_parse_object *origin, u32 num_opcodes);
238
239void
240acpi_dm_walk_parse_tree(union acpi_parse_object *op,
241			asl_walk_callback descending_callback,
242			asl_walk_callback ascending_callback, void *context);
243
244/*
245 * dmopcode
246 */
247void
248acpi_dm_disassemble_one_op(struct acpi_walk_state *walk_state,
249			   struct acpi_op_walk_info *info,
250			   union acpi_parse_object *op);
251
252void acpi_dm_decode_internal_object(union acpi_operand_object *obj_desc);
253
254u32 acpi_dm_list_type(union acpi_parse_object *op);
255
256void acpi_dm_method_flags(union acpi_parse_object *op);
257
258void acpi_dm_field_flags(union acpi_parse_object *op);
259
260void acpi_dm_address_space(u8 space_id);
261
262void acpi_dm_region_flags(union acpi_parse_object *op);
263
264void acpi_dm_match_op(union acpi_parse_object *op);
265
266u8 acpi_dm_comma_if_list_member(union acpi_parse_object *op);
267
268void acpi_dm_comma_if_field_member(union acpi_parse_object *op);
269
270/*
271 * dmnames
272 */
273u32 acpi_dm_dump_name(char *name);
274
275acpi_status
276acpi_ps_display_object_pathname(struct acpi_walk_state *walk_state,
277				union acpi_parse_object *op);
278
279void acpi_dm_namestring(char *name);
280
281/*
282 * dmobject
283 */
284void
285acpi_dm_display_internal_object(union acpi_operand_object *obj_desc,
286				struct acpi_walk_state *walk_state);
287
288void acpi_dm_display_arguments(struct acpi_walk_state *walk_state);
289
290void acpi_dm_display_locals(struct acpi_walk_state *walk_state);
291
292void
293acpi_dm_dump_method_info(acpi_status status,
294			 struct acpi_walk_state *walk_state,
295			 union acpi_parse_object *op);
296
297/*
298 * dmbuffer
299 */
300void acpi_dm_disasm_byte_list(u32 level, u8 * byte_data, u32 byte_count);
301
302void
303acpi_dm_byte_list(struct acpi_op_walk_info *info, union acpi_parse_object *op);
304
305void acpi_dm_is_eisa_id(union acpi_parse_object *op);
306
307void acpi_dm_eisa_id(u32 encoded_id);
308
309u8 acpi_dm_is_unicode_buffer(union acpi_parse_object *op);
310
311u8 acpi_dm_is_string_buffer(union acpi_parse_object *op);
312
313/*
314 * dmresrc
315 */
316void acpi_dm_dump_integer8(u8 value, char *name);
317
318void acpi_dm_dump_integer16(u16 value, char *name);
319
320void acpi_dm_dump_integer32(u32 value, char *name);
321
322void acpi_dm_dump_integer64(u64 value, char *name);
323
324void
325acpi_dm_resource_template(struct acpi_op_walk_info *info,
326			  union acpi_parse_object *op,
327			  u8 * byte_data, u32 byte_count);
328
329acpi_status acpi_dm_is_resource_template(union acpi_parse_object *op);
330
331void acpi_dm_indent(u32 level);
332
333void acpi_dm_bit_list(u16 mask);
334
335void acpi_dm_decode_attribute(u8 attribute);
336
337void acpi_dm_descriptor_name(void);
338
339/*
340 * dmresrcl
341 */
342void
343acpi_dm_word_descriptor(union aml_resource *resource, u32 length, u32 level);
344
345void
346acpi_dm_dword_descriptor(union aml_resource *resource, u32 length, u32 level);
347
348void
349acpi_dm_extended_descriptor(union aml_resource *resource,
350			    u32 length, u32 level);
351
352void
353acpi_dm_qword_descriptor(union aml_resource *resource, u32 length, u32 level);
354
355void
356acpi_dm_memory24_descriptor(union aml_resource *resource,
357			    u32 length, u32 level);
358
359void
360acpi_dm_memory32_descriptor(union aml_resource *resource,
361			    u32 length, u32 level);
362
363void
364acpi_dm_fixed_memory32_descriptor(union aml_resource *resource,
365				  u32 length, u32 level);
366
367void
368acpi_dm_generic_register_descriptor(union aml_resource *resource,
369				    u32 length, u32 level);
370
371void
372acpi_dm_interrupt_descriptor(union aml_resource *resource,
373			     u32 length, u32 level);
374
375void
376acpi_dm_vendor_large_descriptor(union aml_resource *resource,
377				u32 length, u32 level);
378
379void acpi_dm_vendor_common(char *name, u8 * byte_data, u32 length, u32 level);
380
381/*
382 * dmresrcs
383 */
384void
385acpi_dm_irq_descriptor(union aml_resource *resource, u32 length, u32 level);
386
387void
388acpi_dm_dma_descriptor(union aml_resource *resource, u32 length, u32 level);
389
390void acpi_dm_io_descriptor(union aml_resource *resource, u32 length, u32 level);
391
392void
393acpi_dm_fixed_io_descriptor(union aml_resource *resource,
394			    u32 length, u32 level);
395
396void
397acpi_dm_start_dependent_descriptor(union aml_resource *resource,
398				   u32 length, u32 level);
399
400void
401acpi_dm_end_dependent_descriptor(union aml_resource *resource,
402				 u32 length, u32 level);
403
404void
405acpi_dm_vendor_small_descriptor(union aml_resource *resource,
406				u32 length, u32 level);
407
408/*
409 * dmutils
410 */
411void acpi_dm_add_to_external_list(char *path, u8 type, u32 value);
412
413/*
414 * dmrestag
415 */
416void acpi_dm_find_resources(union acpi_parse_object *root);
417
418void
419acpi_dm_check_resource_reference(union acpi_parse_object *op,
420				 struct acpi_walk_state *walk_state);
421
422#endif				/* __ACDISASM_H__ */
423