[deliverable/linux.git] / include / acpi / acdisasm.h

/******************************************************************************
 *
 * Name: acdisasm.h - AML disassembler
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2005, R. Byron Moore
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef __ACDISASM_H__
#define __ACDISASM_H__

#include "amlresrc.h"


#define BLOCK_NONE              0
#define BLOCK_PAREN             1
#define BLOCK_BRACE             2
#define BLOCK_COMMA_LIST        4

struct acpi_external_list
{
	char                                *path;
	struct acpi_external_list           *next;
};

extern struct acpi_external_list        *acpi_gbl_external_list;
extern const char                       *acpi_gbl_io_decode[2];
extern const char                       *acpi_gbl_word_decode[4];
extern const char                       *acpi_gbl_consume_decode[2];
extern const char                       *acpi_gbl_min_decode[2];
extern const char                       *acpi_gbl_max_decode[2];
extern const char                       *acpi_gbl_DECdecode[2];
extern const char                       *acpi_gbl_RNGdecode[4];
extern const char                       *acpi_gbl_MEMdecode[4];
extern const char                       *acpi_gbl_RWdecode[2];
extern const char                       *acpi_gbl_irq_decode[2];
extern const char                       *acpi_gbl_HEdecode[2];
extern const char                       *acpi_gbl_LLdecode[2];
extern const char                       *acpi_gbl_SHRdecode[2];
extern const char                       *acpi_gbl_TYPdecode[4];
extern const char                       *acpi_gbl_BMdecode[2];
extern const char                       *acpi_gbl_SIZdecode[4];
extern const char                       *acpi_gbl_TTPdecode[2];
extern const char                       *acpi_gbl_MTPdecode[4];
extern const char                       *acpi_gbl_TRSdecode[2];


extern const char                       *acpi_gbl_lock_rule[ACPI_NUM_LOCK_RULES];
extern const char                       *acpi_gbl_access_types[ACPI_NUM_ACCESS_TYPES];
extern const char                       *acpi_gbl_update_rules[ACPI_NUM_UPDATE_RULES];
extern const char                       *acpi_gbl_match_ops[ACPI_NUM_MATCH_OPS];


struct acpi_op_walk_info
{
	u32                             level;
	u32                             bit_offset;
	struct acpi_walk_state          *walk_state;
};

typedef
acpi_status (*asl_walk_callback) (
	union acpi_parse_object             *op,
	u32                                 level,
	void                                *context);


/*
 * dmwalk
 */
void
acpi_dm_disassemble (
	struct acpi_walk_state          *walk_state,
	union acpi_parse_object         *origin,
	u32                             num_opcodes);


/*
 * dmopcode
 */
void
acpi_dm_disassemble_one_op (
	struct acpi_walk_state          *walk_state,
	struct acpi_op_walk_info        *info,
	union acpi_parse_object         *op);

void
acpi_dm_decode_internal_object (
	union acpi_operand_object       *obj_desc);

u32
acpi_dm_list_type (
	union acpi_parse_object         *op);

void
acpi_dm_method_flags (
	union acpi_parse_object         *op);

void
acpi_dm_field_flags (
	union acpi_parse_object         *op);

void
acpi_dm_address_space (
	u8                              space_id);

void
acpi_dm_region_flags (
	union acpi_parse_object         *op);

void
acpi_dm_match_op (
	union acpi_parse_object         *op);

u8
acpi_dm_comma_if_list_member (
	union acpi_parse_object         *op);

void
acpi_dm_comma_if_field_member (
	union acpi_parse_object         *op);


/*
 * dmnames
 */
u32
acpi_dm_dump_name (
	char                            *name);

acpi_status
acpi_ps_display_object_pathname (
	struct acpi_walk_state          *walk_state,
	union acpi_parse_object         *op);

void
acpi_dm_namestring (
	char                            *name);


/*
 * dmobject
 */
void
acpi_dm_display_internal_object (
	union acpi_operand_object       *obj_desc,
	struct acpi_walk_state          *walk_state);

void
acpi_dm_display_arguments (
	struct acpi_walk_state          *walk_state);

void
acpi_dm_display_locals (
	struct acpi_walk_state          *walk_state);

void
acpi_dm_dump_method_info (
	acpi_status                     status,
	struct acpi_walk_state          *walk_state,
	union acpi_parse_object         *op);


/*
 * dmbuffer
 */
void
acpi_dm_disasm_byte_list (
	u32                             level,
	u8                              *byte_data,
	u32                             byte_count);

void
acpi_dm_byte_list (
	struct acpi_op_walk_info        *info,
	union acpi_parse_object         *op);

void
acpi_dm_is_eisa_id (
	union acpi_parse_object         *op);

void
acpi_dm_eisa_id (
	u32                             encoded_id);

u8
acpi_dm_is_unicode_buffer (
	union acpi_parse_object         *op);

u8
acpi_dm_is_string_buffer (
	union acpi_parse_object         *op);


/*
 * dmresrc
 */
void
acpi_dm_resource_descriptor (
	struct acpi_op_walk_info        *info,
	u8                              *byte_data,
	u32                             byte_count);

u8
acpi_dm_is_resource_descriptor (
	union acpi_parse_object         *op);

void
acpi_dm_indent (
	u32                             level);

void
acpi_dm_bit_list (
	u16                             mask);

void
acpi_dm_decode_attribute (
	u8                              attribute);


/*
 * dmresrcl
 */
void
acpi_dm_word_descriptor (
	struct asl_word_address_desc    *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_dword_descriptor (
	struct asl_dword_address_desc   *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_extended_descriptor (
	struct asl_extended_address_desc   *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_qword_descriptor (
	struct asl_qword_address_desc   *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_memory24_descriptor (
	struct asl_memory_24_desc       *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_memory32_descriptor (
	struct asl_memory_32_desc       *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_fixed_mem32_descriptor (
	struct asl_fixed_memory_32_desc *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_generic_register_descriptor (
	struct asl_general_register_desc *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_interrupt_descriptor (
	struct asl_extended_xrupt_desc *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_vendor_large_descriptor (
	struct asl_large_vendor_desc    *resource,
	u32                             length,
	u32                             level);


/*
 * dmresrcs
 */
void
acpi_dm_irq_descriptor (
	struct asl_irq_format_desc      *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_dma_descriptor (
	struct asl_dma_format_desc      *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_io_descriptor (
	struct asl_io_port_desc         *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_fixed_io_descriptor (
	struct asl_fixed_io_port_desc   *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_start_dependent_descriptor (
	struct asl_start_dependent_desc *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_end_dependent_descriptor (
	struct asl_start_dependent_desc *resource,
	u32                             length,
	u32                             level);

void
acpi_dm_vendor_small_descriptor (
	struct asl_small_vendor_desc    *resource,
	u32                             length,
	u32                             level);


/*
 * dmutils
 */
void
acpi_dm_add_to_external_list (
	char                            *path);

#endif  /* __ACDISASM_H__ */
Commit	Line	Data
1da177e4 LT	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
	50	#define BLOCK_NONE 0
	51	#define BLOCK_PAREN 1
	52	#define BLOCK_BRACE 2
	53	#define BLOCK_COMMA_LIST 4
	54
	55	struct acpi_external_list
	56	{
	57	char *path;
	58	struct acpi_external_list *next;
	59	};
	60
	61	extern struct acpi_external_list *acpi_gbl_external_list;
	62	extern const char *acpi_gbl_io_decode[2];
	63	extern const char *acpi_gbl_word_decode[4];
	64	extern const char *acpi_gbl_consume_decode[2];
65	extern const char *acpi_gbl_min_decode[2];
66	extern const char *acpi_gbl_max_decode[2];
67	extern const char *acpi_gbl_DECdecode[2];
68	extern const char *acpi_gbl_RNGdecode[4];
69	extern const char *acpi_gbl_MEMdecode[4];
70	extern const char *acpi_gbl_RWdecode[2];
71	extern const char *acpi_gbl_irq_decode[2];
72	extern const char *acpi_gbl_HEdecode[2];
73	extern const char *acpi_gbl_LLdecode[2];
74	extern const char *acpi_gbl_SHRdecode[2];
75	extern const char *acpi_gbl_TYPdecode[4];
76	extern const char *acpi_gbl_BMdecode[2];
77	extern const char *acpi_gbl_SIZdecode[4];
78	extern const char *acpi_gbl_TTPdecode[2];
79	extern const char *acpi_gbl_MTPdecode[4];
80	extern const char *acpi_gbl_TRSdecode[2];
81
82
83	extern const char *acpi_gbl_lock_rule[ACPI_NUM_LOCK_RULES];
84	extern const char *acpi_gbl_access_types[ACPI_NUM_ACCESS_TYPES];
85	extern const char *acpi_gbl_update_rules[ACPI_NUM_UPDATE_RULES];
86	extern const char *acpi_gbl_match_ops[ACPI_NUM_MATCH_OPS];
87
88
89	struct acpi_op_walk_info
90	{
91	u32 level;
92	u32 bit_offset;
73459f73	93	struct acpi_walk_state *walk_state;
1da177e4 LT	94	};
	95
	96	typedef
	97	acpi_status (*asl_walk_callback) (
	98	union acpi_parse_object *op,
	99	u32 level,
	100	void *context);
	101
	102
	103	/*
	104	* dmwalk
	105	*/
1da177e4 LT	106	void
	107	acpi_dm_disassemble (
	108	struct acpi_walk_state *walk_state,
	109	union acpi_parse_object *origin,
	110	u32 num_opcodes);
	111
1da177e4	112
44f6c012 RM	113	/*
	114	* dmopcode
	115	*/
1da177e4 LT	116	void
	117	acpi_dm_disassemble_one_op (
	118	struct acpi_walk_state *walk_state,
	119	struct acpi_op_walk_info *info,
	120	union acpi_parse_object *op);
	121
	122	void
	123	acpi_dm_decode_internal_object (
	124	union acpi_operand_object *obj_desc);
	125
1da177e4 LT	126	u32
	127	acpi_dm_list_type (
	128	union acpi_parse_object *op);
	129
1da177e4 LT	130	void
	131	acpi_dm_method_flags (
	132	union acpi_parse_object *op);
	133
	134	void
	135	acpi_dm_field_flags (
	136	union acpi_parse_object *op);
	137
	138	void
	139	acpi_dm_address_space (
	140	u8 space_id);
	141
	142	void
	143	acpi_dm_region_flags (
	144	union acpi_parse_object *op);
	145
	146	void
	147	acpi_dm_match_op (
	148	union acpi_parse_object *op);
	149
1da177e4 LT	150	u8
	151	acpi_dm_comma_if_list_member (
	152	union acpi_parse_object *op);
	153
	154	void
	155	acpi_dm_comma_if_field_member (
	156	union acpi_parse_object *op);
	157
	158
	159	/*
44f6c012	160	* dmnames
1da177e4	161	*/
44f6c012 RM	162	u32
	163	acpi_dm_dump_name (
	164	char *name);
	165
	166	acpi_status
	167	acpi_ps_display_object_pathname (
	168	struct acpi_walk_state *walk_state,
	169	union acpi_parse_object *op);
1da177e4 LT	170
1da177e4 LT	171	void
44f6c012 RM	172	acpi_dm_namestring (
	173	char *name);
	174
1da177e4	175
44f6c012 RM	176	/*
	177	* dmobject
	178	*/
1da177e4 LT	179	void
	180	acpi_dm_display_internal_object (
	181	union acpi_operand_object *obj_desc,
	182	struct acpi_walk_state *walk_state);
	183
	184	void
	185	acpi_dm_display_arguments (
	186	struct acpi_walk_state *walk_state);
	187
	188	void
	189	acpi_dm_display_locals (
	190	struct acpi_walk_state *walk_state);
	191
	192	void
	193	acpi_dm_dump_method_info (
	194	acpi_status status,
	195	struct acpi_walk_state *walk_state,
	196	union acpi_parse_object *op);
	197
	198
	199	/*
	200	* dmbuffer
	201	*/
44f6c012 RM	202	void
	203	acpi_dm_disasm_byte_list (
	204	u32 level,
	205	u8 *byte_data,
	206	u32 byte_count);
	207
	208	void
	209	acpi_dm_byte_list (
	210	struct acpi_op_walk_info *info,
	211	union acpi_parse_object *op);
1da177e4 LT	212
1da177e4 LT	213	void
f9f4601f	214	acpi_dm_is_eisa_id (
1da177e4 LT	215	union acpi_parse_object *op);
	216
	217	void
	218	acpi_dm_eisa_id (
	219	u32 encoded_id);
	220
	221	u8
	222	acpi_dm_is_unicode_buffer (
	223	union acpi_parse_object *op);
	224
	225	u8
	226	acpi_dm_is_string_buffer (
	227	union acpi_parse_object *op);
	228
	229
	230	/*
	231	* dmresrc
	232	*/
1da177e4 LT	233	void
	234	acpi_dm_resource_descriptor (
	235	struct acpi_op_walk_info *info,
	236	u8 *byte_data,
	237	u32 byte_count);
	238
	239	u8
	240	acpi_dm_is_resource_descriptor (
	241	union acpi_parse_object *op);
	242
	243	void
	244	acpi_dm_indent (
	245	u32 level);
	246
	247	void
	248	acpi_dm_bit_list (
	249	u16 mask);
	250
	251	void
	252	acpi_dm_decode_attribute (
	253	u8 attribute);
	254
44f6c012	255
1da177e4 LT	256	/*
	257	* dmresrcl
	258	*/
1da177e4 LT	259	void
	260	acpi_dm_word_descriptor (
	261	struct asl_word_address_desc *resource,
	262	u32 length,
	263	u32 level);
	264
	265	void
	266	acpi_dm_dword_descriptor (
	267	struct asl_dword_address_desc *resource,
	268	u32 length,
	269	u32 level);
	270
	271	void
	272	acpi_dm_extended_descriptor (
	273	struct asl_extended_address_desc *resource,
	274	u32 length,
	275	u32 level);
	276
	277	void
	278	acpi_dm_qword_descriptor (
	279	struct asl_qword_address_desc *resource,
	280	u32 length,
	281	u32 level);
	282
	283	void
	284	acpi_dm_memory24_descriptor (
	285	struct asl_memory_24_desc *resource,
	286	u32 length,
	287	u32 level);
	288
	289	void
	290	acpi_dm_memory32_descriptor (
	291	struct asl_memory_32_desc *resource,
	292	u32 length,
	293	u32 level);
	294
	295	void
	296	acpi_dm_fixed_mem32_descriptor (
	297	struct asl_fixed_memory_32_desc *resource,
	298	u32 length,
	299	u32 level);
	300
	301	void
	302	acpi_dm_generic_register_descriptor (
	303	struct asl_general_register_desc *resource,
	304	u32 length,
	305	u32 level);
	306
	307	void
	308	acpi_dm_interrupt_descriptor (
	309	struct asl_extended_xrupt_desc *resource,
	310	u32 length,
	311	u32 level);
	312
	313	void
	314	acpi_dm_vendor_large_descriptor (
	315	struct asl_large_vendor_desc *resource,
	316	u32 length,
	317	u32 level);
	318
	319
	320	/*
	321	* dmresrcs
	322	*/
1da177e4 LT	323	void
	324	acpi_dm_irq_descriptor (
	325	struct asl_irq_format_desc *resource,
	326	u32 length,
	327	u32 level);
	328
	329	void
	330	acpi_dm_dma_descriptor (
	331	struct asl_dma_format_desc *resource,
	332	u32 length,
	333	u32 level);
	334
	335	void
	336	acpi_dm_io_descriptor (
	337	struct asl_io_port_desc *resource,
	338	u32 length,
	339	u32 level);
	340
	341	void
	342	acpi_dm_fixed_io_descriptor (
	343	struct asl_fixed_io_port_desc *resource,
	344	u32 length,
	345	u32 level);
	346
	347	void
	348	acpi_dm_start_dependent_descriptor (
	349	struct asl_start_dependent_desc *resource,
	350	u32 length,
	351	u32 level);
	352
	353	void
	354	acpi_dm_end_dependent_descriptor (
	355	struct asl_start_dependent_desc *resource,
	356	u32 length,
	357	u32 level);
	358
	359	void
	360	acpi_dm_vendor_small_descriptor (
	361	struct asl_small_vendor_desc *resource,
	362	u32 length,
	363	u32 level);
	364
	365
	366	/*
	367	* dmutils
	368	*/
1da177e4 LT	369	void
	370	acpi_dm_add_to_external_list (
	371	char *path);
	372
	373	#endif /* __ACDISASM_H__ */