ACPICA: update Intel copyright
[deliverable/linux.git] / include / acpi / acdisasm.h
CommitLineData
1da177e4
LT
1/******************************************************************************
2 *
3 * Name: acdisasm.h - AML disassembler
4 *
5 *****************************************************************************/
6
7/*
75a44ce0 8 * Copyright (C) 2000 - 2008, Intel Corp.
1da177e4
LT
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
1da177e4
LT
49#define BLOCK_NONE 0
50#define BLOCK_PAREN 1
51#define BLOCK_BRACE 2
52#define BLOCK_COMMA_LIST 4
8313524a 53#define ACPI_DEFAULT_RESNAME *(u32 *) "__RD"
1da177e4 54
4be44fcd
LB
55struct acpi_external_list {
56 char *path;
958dd242 57 char *internal_path;
4be44fcd 58 struct acpi_external_list *next;
958dd242
BM
59 u32 value;
60 u16 length;
61 u8 type;
1da177e4
LT
62};
63
4be44fcd 64extern struct acpi_external_list *acpi_gbl_external_list;
defba1d8 65
793c2388
BM
66typedef const struct acpi_dmtable_info {
67 u8 opcode;
68 u8 offset;
69 char *name;
defba1d8 70
793c2388
BM
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
a6f4a451
BM
100#define ACPI_DMT_ASF 23
101#define ACPI_DMT_DMAR 24
3fa34777
BM
102#define ACPI_DMT_HEST 25
103#define ACPI_DMT_HESTNTFY 26
104#define ACPI_DMT_HESTNTYP 27
105#define ACPI_DMT_MADT 28
106#define ACPI_DMT_SRAT 29
107#define ACPI_DMT_EXIT 30
108#define ACPI_DMT_SIG 31
793c2388
BM
109
110typedef
3e08e2d2 111void (*acpi_dmtable_handler) (struct acpi_table_header * table);
793c2388
BM
112
113struct acpi_dmtable_data {
114 char *signature;
115 struct acpi_dmtable_info *table_info;
3e08e2d2 116 acpi_dmtable_handler table_handler;
14d64b5e 117 char *name;
793c2388 118};
4be44fcd
LB
119
120struct acpi_op_walk_info {
121 u32 level;
958dd242
BM
122 u32 last_level;
123 u32 count;
4be44fcd 124 u32 bit_offset;
52fc0b02 125 u32 flags;
4be44fcd 126 struct acpi_walk_state *walk_state;
1da177e4
LT
127};
128
129typedef
4be44fcd
LB
130acpi_status(*asl_walk_callback) (union acpi_parse_object * op,
131 u32 level, void *context);
1da177e4 132
8313524a
BM
133struct acpi_resource_tag {
134 u32 bit_index;
135 char *tag;
136};
137
793c2388
BM
138/* Strings used for decoding flags to ASL keywords */
139
b229cf92
BM
140extern const char *acpi_gbl_word_decode[];
141extern const char *acpi_gbl_irq_decode[];
142extern const char *acpi_gbl_lock_rule[];
143extern const char *acpi_gbl_access_types[];
144extern const char *acpi_gbl_update_rules[];
145extern const char *acpi_gbl_match_ops[];
793c2388
BM
146
147extern struct acpi_dmtable_info acpi_dm_table_info_asf0[];
148extern struct acpi_dmtable_info acpi_dm_table_info_asf1[];
cc2a472b 149extern struct acpi_dmtable_info acpi_dm_table_info_asf1a[];
793c2388 150extern struct acpi_dmtable_info acpi_dm_table_info_asf2[];
cc2a472b 151extern struct acpi_dmtable_info acpi_dm_table_info_asf2a[];
793c2388
BM
152extern struct acpi_dmtable_info acpi_dm_table_info_asf3[];
153extern struct acpi_dmtable_info acpi_dm_table_info_asf4[];
154extern struct acpi_dmtable_info acpi_dm_table_info_asf_hdr[];
155extern struct acpi_dmtable_info acpi_dm_table_info_boot[];
3fa34777 156extern struct acpi_dmtable_info acpi_dm_table_info_bert[];
793c2388
BM
157extern struct acpi_dmtable_info acpi_dm_table_info_cpep[];
158extern struct acpi_dmtable_info acpi_dm_table_info_cpep0[];
159extern struct acpi_dmtable_info acpi_dm_table_info_dbgp[];
2502fffb
BM
160extern struct acpi_dmtable_info acpi_dm_table_info_dmar[];
161extern struct acpi_dmtable_info acpi_dm_table_info_dmar_hdr[];
162extern struct acpi_dmtable_info acpi_dm_table_info_dmar_scope[];
163extern struct acpi_dmtable_info acpi_dm_table_info_dmar0[];
164extern struct acpi_dmtable_info acpi_dm_table_info_dmar1[];
793c2388 165extern struct acpi_dmtable_info acpi_dm_table_info_ecdt[];
3fa34777
BM
166extern struct acpi_dmtable_info acpi_dm_table_info_einj[];
167extern struct acpi_dmtable_info acpi_dm_table_info_einj0[];
168extern struct acpi_dmtable_info acpi_dm_table_info_erst[];
793c2388
BM
169extern struct acpi_dmtable_info acpi_dm_table_info_facs[];
170extern struct acpi_dmtable_info acpi_dm_table_info_fadt1[];
171extern struct acpi_dmtable_info acpi_dm_table_info_fadt2[];
172extern struct acpi_dmtable_info acpi_dm_table_info_gas[];
173extern struct acpi_dmtable_info acpi_dm_table_info_header[];
3fa34777
BM
174extern struct acpi_dmtable_info acpi_dm_table_info_hest[];
175extern struct acpi_dmtable_info acpi_dm_table_info_hest9[];
176extern struct acpi_dmtable_info acpi_dm_table_info_hest_notify[];
793c2388
BM
177extern struct acpi_dmtable_info acpi_dm_table_info_hpet[];
178extern struct acpi_dmtable_info acpi_dm_table_info_madt[];
179extern struct acpi_dmtable_info acpi_dm_table_info_madt0[];
180extern struct acpi_dmtable_info acpi_dm_table_info_madt1[];
181extern struct acpi_dmtable_info acpi_dm_table_info_madt2[];
182extern struct acpi_dmtable_info acpi_dm_table_info_madt3[];
183extern struct acpi_dmtable_info acpi_dm_table_info_madt4[];
184extern struct acpi_dmtable_info acpi_dm_table_info_madt5[];
185extern struct acpi_dmtable_info acpi_dm_table_info_madt6[];
186extern struct acpi_dmtable_info acpi_dm_table_info_madt7[];
187extern struct acpi_dmtable_info acpi_dm_table_info_madt8[];
188extern struct acpi_dmtable_info acpi_dm_table_info_madt_hdr[];
189extern struct acpi_dmtable_info acpi_dm_table_info_mcfg[];
190extern struct acpi_dmtable_info acpi_dm_table_info_mcfg0[];
191extern struct acpi_dmtable_info acpi_dm_table_info_rsdp1[];
192extern struct acpi_dmtable_info acpi_dm_table_info_rsdp2[];
193extern struct acpi_dmtable_info acpi_dm_table_info_sbst[];
698c0a0c 194extern struct acpi_dmtable_info acpi_dm_table_info_slic[];
793c2388
BM
195extern struct acpi_dmtable_info acpi_dm_table_info_slit[];
196extern struct acpi_dmtable_info acpi_dm_table_info_spcr[];
197extern struct acpi_dmtable_info acpi_dm_table_info_spmi[];
198extern struct acpi_dmtable_info acpi_dm_table_info_srat[];
199extern struct acpi_dmtable_info acpi_dm_table_info_srat0[];
200extern struct acpi_dmtable_info acpi_dm_table_info_srat1[];
201extern struct acpi_dmtable_info acpi_dm_table_info_tcpa[];
202extern struct acpi_dmtable_info acpi_dm_table_info_wdrt[];
203
204/*
205 * dmtable
206 */
207void acpi_dm_dump_data_table(struct acpi_table_header *table);
208
a6f4a451 209acpi_status
793c2388
BM
210acpi_dm_dump_table(u32 table_length,
211 u32 table_offset,
212 void *table,
213 u32 sub_table_length, struct acpi_dmtable_info *info);
214
215void acpi_dm_line_header(u32 offset, u32 byte_length, char *name);
216
217void acpi_dm_line_header2(u32 offset, u32 byte_length, char *name, u32 value);
218
219/*
220 * dmtbdump
221 */
222void acpi_dm_dump_asf(struct acpi_table_header *table);
223
224void acpi_dm_dump_cpep(struct acpi_table_header *table);
225
2502fffb
BM
226void acpi_dm_dump_dmar(struct acpi_table_header *table);
227
3fa34777
BM
228void acpi_dm_dump_einj(struct acpi_table_header *table);
229
230void acpi_dm_dump_erst(struct acpi_table_header *table);
231
793c2388
BM
232void acpi_dm_dump_fadt(struct acpi_table_header *table);
233
3fa34777 234void acpi_dm_dump_hest(struct acpi_table_header *table);
793c2388
BM
235
236void acpi_dm_dump_mcfg(struct acpi_table_header *table);
237
238void acpi_dm_dump_madt(struct acpi_table_header *table);
239
240u32 acpi_dm_dump_rsdp(struct acpi_table_header *table);
241
242void acpi_dm_dump_rsdt(struct acpi_table_header *table);
243
244void acpi_dm_dump_slit(struct acpi_table_header *table);
245
3fa34777
BM
246void acpi_dm_dump_srat(struct acpi_table_header *table);
247
793c2388
BM
248void acpi_dm_dump_xsdt(struct acpi_table_header *table);
249
1da177e4
LT
250/*
251 * dmwalk
252 */
1da177e4 253void
4be44fcd
LB
254acpi_dm_disassemble(struct acpi_walk_state *walk_state,
255 union acpi_parse_object *origin, u32 num_opcodes);
1da177e4 256
8313524a
BM
257void
258acpi_dm_walk_parse_tree(union acpi_parse_object *op,
259 asl_walk_callback descending_callback,
260 asl_walk_callback ascending_callback, void *context);
261
44f6c012
RM
262/*
263 * dmopcode
264 */
1da177e4 265void
4be44fcd
LB
266acpi_dm_disassemble_one_op(struct acpi_walk_state *walk_state,
267 struct acpi_op_walk_info *info,
268 union acpi_parse_object *op);
1da177e4 269
4be44fcd 270void acpi_dm_decode_internal_object(union acpi_operand_object *obj_desc);
1da177e4 271
4be44fcd 272u32 acpi_dm_list_type(union acpi_parse_object *op);
1da177e4 273
4be44fcd 274void acpi_dm_method_flags(union acpi_parse_object *op);
1da177e4 275
4be44fcd 276void acpi_dm_field_flags(union acpi_parse_object *op);
1da177e4 277
4be44fcd 278void acpi_dm_address_space(u8 space_id);
1da177e4 279
4be44fcd 280void acpi_dm_region_flags(union acpi_parse_object *op);
1da177e4 281
4be44fcd 282void acpi_dm_match_op(union acpi_parse_object *op);
1da177e4 283
4be44fcd 284u8 acpi_dm_comma_if_list_member(union acpi_parse_object *op);
1da177e4 285
4be44fcd 286void acpi_dm_comma_if_field_member(union acpi_parse_object *op);
1da177e4
LT
287
288/*
44f6c012 289 * dmnames
1da177e4 290 */
4be44fcd 291u32 acpi_dm_dump_name(char *name);
44f6c012
RM
292
293acpi_status
4be44fcd
LB
294acpi_ps_display_object_pathname(struct acpi_walk_state *walk_state,
295 union acpi_parse_object *op);
44f6c012 296
4be44fcd 297void acpi_dm_namestring(char *name);
1da177e4 298
44f6c012
RM
299/*
300 * dmobject
301 */
1da177e4 302void
4be44fcd
LB
303acpi_dm_display_internal_object(union acpi_operand_object *obj_desc,
304 struct acpi_walk_state *walk_state);
1da177e4 305
4be44fcd 306void acpi_dm_display_arguments(struct acpi_walk_state *walk_state);
1da177e4 307
4be44fcd 308void acpi_dm_display_locals(struct acpi_walk_state *walk_state);
1da177e4
LT
309
310void
4be44fcd
LB
311acpi_dm_dump_method_info(acpi_status status,
312 struct acpi_walk_state *walk_state,
313 union acpi_parse_object *op);
1da177e4
LT
314
315/*
316 * dmbuffer
317 */
4be44fcd 318void acpi_dm_disasm_byte_list(u32 level, u8 * byte_data, u32 byte_count);
44f6c012
RM
319
320void
4be44fcd 321acpi_dm_byte_list(struct acpi_op_walk_info *info, union acpi_parse_object *op);
1da177e4 322
4be44fcd 323void acpi_dm_is_eisa_id(union acpi_parse_object *op);
1da177e4 324
4be44fcd 325void acpi_dm_eisa_id(u32 encoded_id);
1da177e4 326
4be44fcd 327u8 acpi_dm_is_unicode_buffer(union acpi_parse_object *op);
1da177e4 328
4be44fcd 329u8 acpi_dm_is_string_buffer(union acpi_parse_object *op);
1da177e4
LT
330
331/*
332 * dmresrc
333 */
0897831b
BM
334void acpi_dm_dump_integer8(u8 value, char *name);
335
336void acpi_dm_dump_integer16(u16 value, char *name);
337
338void acpi_dm_dump_integer32(u32 value, char *name);
339
340void acpi_dm_dump_integer64(u64 value, char *name);
341
1da177e4 342void
0897831b 343acpi_dm_resource_template(struct acpi_op_walk_info *info,
8313524a 344 union acpi_parse_object *op,
0897831b 345 u8 * byte_data, u32 byte_count);
1da177e4 346
cc2a472b 347acpi_status acpi_dm_is_resource_template(union acpi_parse_object *op);
1da177e4 348
4be44fcd 349void acpi_dm_indent(u32 level);
1da177e4 350
4be44fcd 351void acpi_dm_bit_list(u16 mask);
1da177e4 352
4be44fcd 353void acpi_dm_decode_attribute(u8 attribute);
44f6c012 354
8313524a
BM
355void acpi_dm_descriptor_name(void);
356
1da177e4
LT
357/*
358 * dmresrcl
359 */
1da177e4 360void
50eca3eb 361acpi_dm_word_descriptor(union aml_resource *resource, u32 length, u32 level);
1da177e4
LT
362
363void
50eca3eb 364acpi_dm_dword_descriptor(union aml_resource *resource, u32 length, u32 level);
1da177e4
LT
365
366void
50eca3eb 367acpi_dm_extended_descriptor(union aml_resource *resource,
4be44fcd 368 u32 length, u32 level);
1da177e4
LT
369
370void
50eca3eb 371acpi_dm_qword_descriptor(union aml_resource *resource, u32 length, u32 level);
1da177e4
LT
372
373void
50eca3eb 374acpi_dm_memory24_descriptor(union aml_resource *resource,
4be44fcd 375 u32 length, u32 level);
1da177e4
LT
376
377void
50eca3eb 378acpi_dm_memory32_descriptor(union aml_resource *resource,
4be44fcd 379 u32 length, u32 level);
1da177e4
LT
380
381void
50eca3eb 382acpi_dm_fixed_memory32_descriptor(union aml_resource *resource,
bda663d3 383 u32 length, u32 level);
1da177e4
LT
384
385void
50eca3eb 386acpi_dm_generic_register_descriptor(union aml_resource *resource,
4be44fcd 387 u32 length, u32 level);
1da177e4
LT
388
389void
50eca3eb 390acpi_dm_interrupt_descriptor(union aml_resource *resource,
4be44fcd 391 u32 length, u32 level);
1da177e4
LT
392
393void
50eca3eb 394acpi_dm_vendor_large_descriptor(union aml_resource *resource,
4be44fcd 395 u32 length, u32 level);
1da177e4 396
0897831b
BM
397void acpi_dm_vendor_common(char *name, u8 * byte_data, u32 length, u32 level);
398
1da177e4
LT
399/*
400 * dmresrcs
401 */
1da177e4 402void
50eca3eb 403acpi_dm_irq_descriptor(union aml_resource *resource, u32 length, u32 level);
1da177e4
LT
404
405void
50eca3eb 406acpi_dm_dma_descriptor(union aml_resource *resource, u32 length, u32 level);
1da177e4 407
50eca3eb 408void acpi_dm_io_descriptor(union aml_resource *resource, u32 length, u32 level);
1da177e4
LT
409
410void
50eca3eb 411acpi_dm_fixed_io_descriptor(union aml_resource *resource,
4be44fcd 412 u32 length, u32 level);
1da177e4
LT
413
414void
50eca3eb 415acpi_dm_start_dependent_descriptor(union aml_resource *resource,
4be44fcd 416 u32 length, u32 level);
1da177e4
LT
417
418void
50eca3eb 419acpi_dm_end_dependent_descriptor(union aml_resource *resource,
4be44fcd 420 u32 length, u32 level);
1da177e4
LT
421
422void
50eca3eb 423acpi_dm_vendor_small_descriptor(union aml_resource *resource,
4be44fcd 424 u32 length, u32 level);
1da177e4
LT
425
426/*
427 * dmutils
428 */
958dd242 429void acpi_dm_add_to_external_list(char *path, u8 type, u32 value);
1da177e4 430
8313524a
BM
431/*
432 * dmrestag
433 */
434void acpi_dm_find_resources(union acpi_parse_object *root);
435
436void
437acpi_dm_check_resource_reference(union acpi_parse_object *op,
438 struct acpi_walk_state *walk_state);
439
4be44fcd 440#endif /* __ACDISASM_H__ */
This page took 0.283822 seconds and 5 git commands to generate.