[mirror_ubuntu-bionic-kernel.git] / include / acpi / amlresrc.h


/******************************************************************************
 *
 * Module Name: amlresrc.h - AML resource descriptors
 *
 *****************************************************************************/

/*
 * 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 __AMLRESRC_H
#define __AMLRESRC_H

#define ASL_RESNAME_ADDRESS                     "_ADR"
#define ASL_RESNAME_ALIGNMENT                   "_ALN"
#define ASL_RESNAME_ADDRESSSPACE                "_ASI"
#define ASL_RESNAME_ACCESSSIZE                  "_ASZ"
#define ASL_RESNAME_TYPESPECIFICATTRIBUTES      "_ATT"
#define ASL_RESNAME_BASEADDRESS                 "_BAS"
#define ASL_RESNAME_BUSMASTER                   "_BM_"	/* Master(1), Slave(0) */
#define ASL_RESNAME_DECODE                      "_DEC"
#define ASL_RESNAME_DMA                         "_DMA"
#define ASL_RESNAME_DMATYPE                     "_TYP"	/* Compatible(0), A(1), B(2), F(3) */
#define ASL_RESNAME_GRANULARITY                 "_GRA"
#define ASL_RESNAME_INTERRUPT                   "_INT"
#define ASL_RESNAME_INTERRUPTLEVEL              "_LL_"	/* active_lo(1), active_hi(0) */
#define ASL_RESNAME_INTERRUPTSHARE              "_SHR"	/* Shareable(1), no_share(0) */
#define ASL_RESNAME_INTERRUPTTYPE               "_HE_"	/* Edge(1), Level(0) */
#define ASL_RESNAME_LENGTH                      "_LEN"
#define ASL_RESNAME_MEMATTRIBUTES               "_MTP"	/* Memory(0), Reserved(1), ACPI(2), NVS(3) */
#define ASL_RESNAME_MEMTYPE                     "_MEM"	/* non_cache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */
#define ASL_RESNAME_MAXADDR                     "_MAX"
#define ASL_RESNAME_MINADDR                     "_MIN"
#define ASL_RESNAME_MAXTYPE                     "_MAF"
#define ASL_RESNAME_MINTYPE                     "_MIF"
#define ASL_RESNAME_REGISTERBITOFFSET           "_RBO"
#define ASL_RESNAME_REGISTERBITWIDTH            "_RBW"
#define ASL_RESNAME_RANGETYPE                   "_RNG"
#define ASL_RESNAME_READWRITETYPE               "_RW_"	/* read_only(0), Writeable (1) */
#define ASL_RESNAME_TRANSLATION                 "_TRA"
#define ASL_RESNAME_TRANSTYPE                   "_TRS"	/* Sparse(1), Dense(0) */
#define ASL_RESNAME_TYPE                        "_TTP"	/* Translation(1), Static (0) */
#define ASL_RESNAME_XFERTYPE                    "_SIz"	/* 8(0), 8_and16(1), 16(2) */

/* Default sizes for "small" resource descriptors */

#define ASL_RDESC_IRQ_SIZE                      0x02
#define ASL_RDESC_DMA_SIZE                      0x02
#define ASL_RDESC_ST_DEPEND_SIZE                0x00
#define ASL_RDESC_END_DEPEND_SIZE               0x00
#define ASL_RDESC_IO_SIZE                       0x07
#define ASL_RDESC_FIXED_IO_SIZE                 0x03
#define ASL_RDESC_END_TAG_SIZE                  0x01

struct asl_resource_node {
	u32 buffer_length;
	void *buffer;
	struct asl_resource_node *next;
};

/*
 * Resource descriptors defined in the ACPI specification.
 *
 * Packing/alignment must be BYTE because these descriptors
 * are used to overlay the AML byte stream.
 */
#pragma pack(1)

struct asl_irq_format_desc {
	u8 descriptor_type;
	u16 irq_mask;
	u8 flags;
};

struct asl_irq_noflags_desc {
	u8 descriptor_type;
	u16 irq_mask;
};

struct asl_dma_format_desc {
	u8 descriptor_type;
	u8 dma_channel_mask;
	u8 flags;
};

struct asl_start_dependent_desc {
	u8 descriptor_type;
	u8 flags;
};

struct asl_start_dependent_noprio_desc {
	u8 descriptor_type;
};

struct asl_end_dependent_desc {
	u8 descriptor_type;
};

struct asl_io_port_desc {
	u8 descriptor_type;
	u8 information;
	u16 address_min;
	u16 address_max;
	u8 alignment;
	u8 length;
};

struct asl_fixed_io_port_desc {
	u8 descriptor_type;
	u16 base_address;
	u8 length;
};

struct asl_small_vendor_desc {
	u8 descriptor_type;
	u8 vendor_defined[7];
};

struct asl_end_tag_desc {
	u8 descriptor_type;
	u8 checksum;
};

/* LARGE descriptors */

struct asl_memory_24_desc {
	u8 descriptor_type;
	u16 length;
	u8 information;
	u16 address_min;
	u16 address_max;
	u16 alignment;
	u16 range_length;
};

struct asl_large_vendor_desc {
	u8 descriptor_type;
	u16 length;
	u8 vendor_defined[1];
};

struct asl_memory_32_desc {
	u8 descriptor_type;
	u16 length;
	u8 information;
	u32 address_min;
	u32 address_max;
	u32 alignment;
	u32 range_length;
};

struct asl_fixed_memory_32_desc {
	u8 descriptor_type;
	u16 length;
	u8 information;
	u32 base_address;
	u32 range_length;
};

struct asl_extended_address_desc {
	u8 descriptor_type;
	u16 length;
	u8 resource_type;
	u8 flags;
	u8 specific_flags;
	u8 revision_iD;
	u8 reserved;
	u64 granularity;
	u64 address_min;
	u64 address_max;
	u64 translation_offset;
	u64 address_length;
	u64 type_specific_attributes;
	u8 optional_fields[2];	/* Used for length calculation only */
};

#define ASL_EXTENDED_ADDRESS_DESC_REVISION          1	/* ACPI 3.0 */

struct asl_qword_address_desc {
	u8 descriptor_type;
	u16 length;
	u8 resource_type;
	u8 flags;
	u8 specific_flags;
	u64 granularity;
	u64 address_min;
	u64 address_max;
	u64 translation_offset;
	u64 address_length;
	u8 optional_fields[2];
};

struct asl_dword_address_desc {
	u8 descriptor_type;
	u16 length;
	u8 resource_type;
	u8 flags;
	u8 specific_flags;
	u32 granularity;
	u32 address_min;
	u32 address_max;
	u32 translation_offset;
	u32 address_length;
	u8 optional_fields[2];
};

struct asl_word_address_desc {
	u8 descriptor_type;
	u16 length;
	u8 resource_type;
	u8 flags;
	u8 specific_flags;
	u16 granularity;
	u16 address_min;
	u16 address_max;
	u16 translation_offset;
	u16 address_length;
	u8 optional_fields[2];
};

struct asl_extended_xrupt_desc {
	u8 descriptor_type;
	u16 length;
	u8 flags;
	u8 table_length;
	u32 interrupt_number[1];
	/* res_source_index, res_source optional fields follow */
};

struct asl_general_register_desc {
	u8 descriptor_type;
	u16 length;
	u8 address_space_id;
	u8 bit_width;
	u8 bit_offset;
	u8 access_size;		/* ACPI 3.0, was Reserved */
	u64 address;
};

/* restore default alignment */

#pragma pack()

/* Union of all resource descriptors, so we can allocate the worst case */

union asl_resource_desc {
	struct asl_irq_format_desc irq;
	struct asl_dma_format_desc dma;
	struct asl_start_dependent_desc std;
	struct asl_end_dependent_desc end;
	struct asl_io_port_desc iop;
	struct asl_fixed_io_port_desc fio;
	struct asl_small_vendor_desc smv;
	struct asl_end_tag_desc et;

	struct asl_memory_24_desc M24;
	struct asl_large_vendor_desc lgv;
	struct asl_memory_32_desc M32;
	struct asl_fixed_memory_32_desc F32;
	struct asl_qword_address_desc qas;
	struct asl_dword_address_desc das;
	struct asl_word_address_desc was;
	struct asl_extended_address_desc eas;
	struct asl_extended_xrupt_desc exx;
	struct asl_general_register_desc grg;
	u32 u32_item;
	u16 u16_item;
	u8 U8item;
};

#endif
Commit	Line	Data
1da177e4 LT	1
	2	/******************************************************************************
	3	*
	4	* Module Name: amlresrc.h - AML resource descriptors
	5	*
	6	*****************************************************************************/
	7
	8	/*
	9	* Copyright (C) 2000 - 2005, R. Byron Moore
	10	* All rights reserved.
	11	*
	12	* Redistribution and use in source and binary forms, with or without
	13	* modification, are permitted provided that the following conditions
	14	* are met:
	15	* 1. Redistributions of source code must retain the above copyright
	16	* notice, this list of conditions, and the following disclaimer,
	17	* without modification.
	18	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	19	* substantially similar to the "NO WARRANTY" disclaimer below
	20	* ("Disclaimer") and any redistribution must be conditioned upon
	21	* including a substantially similar Disclaimer requirement for further
	22	* binary redistribution.
	23	* 3. Neither the names of the above-listed copyright holders nor the names
	24	* of any contributors may be used to endorse or promote products derived
	25	* from this software without specific prior written permission.
	26	*
	27	* Alternatively, this software may be distributed under the terms of the
	28	* GNU General Public License ("GPL") version 2 as published by the Free
	29	* Software Foundation.
	30	*
	31	* NO WARRANTY
	32	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	33	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	34	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	35	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	36	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	37	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	38	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	39	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	40	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	41	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	42	* POSSIBILITY OF SUCH DAMAGES.
	43	*/
	44
1da177e4 LT	45	#ifndef __AMLRESRC_H
	46	#define __AMLRESRC_H
	47
1da177e4 LT	48	#define ASL_RESNAME_ADDRESS "_ADR"
	49	#define ASL_RESNAME_ALIGNMENT "_ALN"
	50	#define ASL_RESNAME_ADDRESSSPACE "_ASI"
	51	#define ASL_RESNAME_ACCESSSIZE "_ASZ"
	52	#define ASL_RESNAME_TYPESPECIFICATTRIBUTES "_ATT"
	53	#define ASL_RESNAME_BASEADDRESS "_BAS"
4be44fcd	54	#define ASL_RESNAME_BUSMASTER "_BM_" /* Master(1), Slave(0) */
1da177e4 LT	55	#define ASL_RESNAME_DECODE "_DEC"
1da177e4 LT	56	#define ASL_RESNAME_DMA "_DMA"
4be44fcd	57	#define ASL_RESNAME_DMATYPE "_TYP" /* Compatible(0), A(1), B(2), F(3) */
1da177e4 LT	58	#define ASL_RESNAME_GRANULARITY "_GRA"
1da177e4 LT	59	#define ASL_RESNAME_INTERRUPT "_INT"
4be44fcd LB	60	#define ASL_RESNAME_INTERRUPTLEVEL "_LL_" /* active_lo(1), active_hi(0) */
	61	#define ASL_RESNAME_INTERRUPTSHARE "_SHR" /* Shareable(1), no_share(0) */
	62	#define ASL_RESNAME_INTERRUPTTYPE "_HE_" /* Edge(1), Level(0) */
1da177e4	63	#define ASL_RESNAME_LENGTH "_LEN"
4be44fcd LB	64	#define ASL_RESNAME_MEMATTRIBUTES "_MTP" /* Memory(0), Reserved(1), ACPI(2), NVS(3) */
4be44fcd LB	65	#define ASL_RESNAME_MEMTYPE "_MEM" /* non_cache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */
1da177e4 LT	66	#define ASL_RESNAME_MAXADDR "_MAX"
	67	#define ASL_RESNAME_MINADDR "_MIN"
	68	#define ASL_RESNAME_MAXTYPE "_MAF"
	69	#define ASL_RESNAME_MINTYPE "_MIF"
	70	#define ASL_RESNAME_REGISTERBITOFFSET "_RBO"
	71	#define ASL_RESNAME_REGISTERBITWIDTH "_RBW"
	72	#define ASL_RESNAME_RANGETYPE "_RNG"
4be44fcd	73	#define ASL_RESNAME_READWRITETYPE "_RW_" /* read_only(0), Writeable (1) */
1da177e4	74	#define ASL_RESNAME_TRANSLATION "_TRA"
4be44fcd LB	75	#define ASL_RESNAME_TRANSTYPE "_TRS" /* Sparse(1), Dense(0) */
	76	#define ASL_RESNAME_TYPE "_TTP" /* Translation(1), Static (0) */
	77	#define ASL_RESNAME_XFERTYPE "_SIz" /* 8(0), 8_and16(1), 16(2) */
1da177e4 LT	78
	79	/* Default sizes for "small" resource descriptors */
	80
	81	#define ASL_RDESC_IRQ_SIZE 0x02
	82	#define ASL_RDESC_DMA_SIZE 0x02
	83	#define ASL_RDESC_ST_DEPEND_SIZE 0x00
	84	#define ASL_RDESC_END_DEPEND_SIZE 0x00
	85	#define ASL_RDESC_IO_SIZE 0x07
	86	#define ASL_RDESC_FIXED_IO_SIZE 0x03
	87	#define ASL_RDESC_END_TAG_SIZE 0x01
	88
4be44fcd LB	89	struct asl_resource_node {
	90	u32 buffer_length;
	91	void *buffer;
	92	struct asl_resource_node *next;
1da177e4 LT	93	};
1da177e4 LT	94
1da177e4 LT	95	/*
	96	* Resource descriptors defined in the ACPI specification.
	97	*
	98	* Packing/alignment must be BYTE because these descriptors
	99	* are used to overlay the AML byte stream.
	100	*/
	101	#pragma pack(1)
	102
4be44fcd LB	103	struct asl_irq_format_desc {
	104	u8 descriptor_type;
	105	u16 irq_mask;
	106	u8 flags;
1da177e4 LT	107	};
1da177e4 LT	108
4be44fcd LB	109	struct asl_irq_noflags_desc {
	110	u8 descriptor_type;
	111	u16 irq_mask;
1da177e4 LT	112	};
1da177e4 LT	113
4be44fcd LB	114	struct asl_dma_format_desc {
	115	u8 descriptor_type;
	116	u8 dma_channel_mask;
	117	u8 flags;
1da177e4 LT	118	};
1da177e4 LT	119
4be44fcd LB	120	struct asl_start_dependent_desc {
	121	u8 descriptor_type;
	122	u8 flags;
1da177e4 LT	123	};
1da177e4 LT	124
4be44fcd LB	125	struct asl_start_dependent_noprio_desc {
4be44fcd LB	126	u8 descriptor_type;
1da177e4 LT	127	};
1da177e4 LT	128
4be44fcd LB	129	struct asl_end_dependent_desc {
4be44fcd LB	130	u8 descriptor_type;
1da177e4 LT	131	};
1da177e4 LT	132
4be44fcd LB	133	struct asl_io_port_desc {
	134	u8 descriptor_type;
	135	u8 information;
	136	u16 address_min;
	137	u16 address_max;
	138	u8 alignment;
	139	u8 length;
1da177e4 LT	140	};
1da177e4 LT	141
4be44fcd LB	142	struct asl_fixed_io_port_desc {
	143	u8 descriptor_type;
	144	u16 base_address;
	145	u8 length;
1da177e4 LT	146	};
1da177e4 LT	147
4be44fcd LB	148	struct asl_small_vendor_desc {
	149	u8 descriptor_type;
	150	u8 vendor_defined[7];
1da177e4 LT	151	};
1da177e4 LT	152
4be44fcd LB	153	struct asl_end_tag_desc {
	154	u8 descriptor_type;
	155	u8 checksum;
1da177e4 LT	156	};
1da177e4 LT	157
1da177e4 LT	158	/* LARGE descriptors */
1da177e4 LT	159
4be44fcd LB	160	struct asl_memory_24_desc {
	161	u8 descriptor_type;
	162	u16 length;
	163	u8 information;
	164	u16 address_min;
	165	u16 address_max;
	166	u16 alignment;
	167	u16 range_length;
1da177e4 LT	168	};
1da177e4 LT	169
4be44fcd LB	170	struct asl_large_vendor_desc {
	171	u8 descriptor_type;
	172	u16 length;
	173	u8 vendor_defined[1];
1da177e4 LT	174	};
1da177e4 LT	175
4be44fcd LB	176	struct asl_memory_32_desc {
	177	u8 descriptor_type;
	178	u16 length;
	179	u8 information;
	180	u32 address_min;
	181	u32 address_max;
	182	u32 alignment;
	183	u32 range_length;
1da177e4 LT	184	};
1da177e4 LT	185
4be44fcd LB	186	struct asl_fixed_memory_32_desc {
	187	u8 descriptor_type;
	188	u16 length;
	189	u8 information;
	190	u32 base_address;
	191	u32 range_length;
1da177e4 LT	192	};
1da177e4 LT	193
4be44fcd LB	194	struct asl_extended_address_desc {
	195	u8 descriptor_type;
	196	u16 length;
	197	u8 resource_type;
	198	u8 flags;
	199	u8 specific_flags;
	200	u8 revision_iD;
	201	u8 reserved;
	202	u64 granularity;
	203	u64 address_min;
	204	u64 address_max;
	205	u64 translation_offset;
	206	u64 address_length;
	207	u64 type_specific_attributes;
	208	u8 optional_fields[2]; /* Used for length calculation only */
1da177e4 LT	209	};
1da177e4 LT	210
4be44fcd LB	211	#define ASL_EXTENDED_ADDRESS_DESC_REVISION 1 /* ACPI 3.0 */
	212
	213	struct asl_qword_address_desc {
	214	u8 descriptor_type;
	215	u16 length;
	216	u8 resource_type;
	217	u8 flags;
	218	u8 specific_flags;
	219	u64 granularity;
	220	u64 address_min;
	221	u64 address_max;
	222	u64 translation_offset;
	223	u64 address_length;
	224	u8 optional_fields[2];
1da177e4 LT	225	};
1da177e4 LT	226
4be44fcd LB	227	struct asl_dword_address_desc {
	228	u8 descriptor_type;
	229	u16 length;
	230	u8 resource_type;
	231	u8 flags;
	232	u8 specific_flags;
	233	u32 granularity;
	234	u32 address_min;
	235	u32 address_max;
	236	u32 translation_offset;
	237	u32 address_length;
	238	u8 optional_fields[2];
1da177e4 LT	239	};
1da177e4 LT	240
4be44fcd LB	241	struct asl_word_address_desc {
	242	u8 descriptor_type;
	243	u16 length;
	244	u8 resource_type;
	245	u8 flags;
	246	u8 specific_flags;
	247	u16 granularity;
	248	u16 address_min;
	249	u16 address_max;
	250	u16 translation_offset;
	251	u16 address_length;
	252	u8 optional_fields[2];
1da177e4 LT	253	};
1da177e4 LT	254
4be44fcd LB	255	struct asl_extended_xrupt_desc {
	256	u8 descriptor_type;
	257	u16 length;
	258	u8 flags;
	259	u8 table_length;
	260	u32 interrupt_number[1];
1da177e4 LT	261	/* res_source_index, res_source optional fields follow */
	262	};
	263
4be44fcd LB	264	struct asl_general_register_desc {
	265	u8 descriptor_type;
	266	u16 length;
	267	u8 address_space_id;
	268	u8 bit_width;
	269	u8 bit_offset;
	270	u8 access_size; /* ACPI 3.0, was Reserved */
	271	u64 address;
1da177e4 LT	272	};
	273
	274	/* restore default alignment */
	275
	276	#pragma pack()
	277
	278	/* Union of all resource descriptors, so we can allocate the worst case */
	279
4be44fcd LB	280	union asl_resource_desc {
	281	struct asl_irq_format_desc irq;
	282	struct asl_dma_format_desc dma;
	283	struct asl_start_dependent_desc std;
	284	struct asl_end_dependent_desc end;
	285	struct asl_io_port_desc iop;
	286	struct asl_fixed_io_port_desc fio;
	287	struct asl_small_vendor_desc smv;
	288	struct asl_end_tag_desc et;
	289
	290	struct asl_memory_24_desc M24;
	291	struct asl_large_vendor_desc lgv;
	292	struct asl_memory_32_desc M32;
	293	struct asl_fixed_memory_32_desc F32;
	294	struct asl_qword_address_desc qas;
	295	struct asl_dword_address_desc das;
	296	struct asl_word_address_desc was;
	297	struct asl_extended_address_desc eas;
	298	struct asl_extended_xrupt_desc exx;
	299	struct asl_general_register_desc grg;
	300	u32 u32_item;
	301	u16 u16_item;
	302	u8 U8item;
1da177e4 LT	303	};
1da177e4 LT	304
1da177e4	305	#endif