]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/acpi/amlresrc.h
ACPI: ACPICA 20060421
[mirror_ubuntu-bionic-kernel.git] / include / acpi / amlresrc.h
CommitLineData
1da177e4
LT
1
2/******************************************************************************
3 *
4 * Module Name: amlresrc.h - AML resource descriptors
5 *
6 *****************************************************************************/
7
8/*
4a90c7e8 9 * Copyright (C) 2000 - 2006, R. Byron Moore
1da177e4
LT
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
61686124
BM
45/* acpisrc:struct_defs -- for acpisrc conversion */
46
1da177e4
LT
47#ifndef __AMLRESRC_H
48#define __AMLRESRC_H
49
61686124
BM
50/*! [Begin] no source code translation */
51
52/*
53 * Resource descriptor tags, as defined in the ACPI specification.
54 * Used to symbolically reference fields within a descriptor.
55 */
8313524a
BM
56#define ACPI_RESTAG_ADDRESS "_ADR"
57#define ACPI_RESTAG_ALIGNMENT "_ALN"
58#define ACPI_RESTAG_ADDRESSSPACE "_ASI"
59#define ACPI_RESTAG_ACCESSSIZE "_ASZ"
60#define ACPI_RESTAG_TYPESPECIFICATTRIBUTES "_ATT"
61#define ACPI_RESTAG_BASEADDRESS "_BAS"
62#define ACPI_RESTAG_BUSMASTER "_BM_" /* Master(1), Slave(0) */
63#define ACPI_RESTAG_DECODE "_DEC"
64#define ACPI_RESTAG_DMA "_DMA"
65#define ACPI_RESTAG_DMATYPE "_TYP" /* Compatible(0), A(1), B(2), F(3) */
66#define ACPI_RESTAG_GRANULARITY "_GRA"
67#define ACPI_RESTAG_INTERRUPT "_INT"
61686124
BM
68#define ACPI_RESTAG_INTERRUPTLEVEL "_LL_" /* ActiveLo(1), ActiveHi(0) */
69#define ACPI_RESTAG_INTERRUPTSHARE "_SHR" /* Shareable(1), NoShare(0) */
8313524a
BM
70#define ACPI_RESTAG_INTERRUPTTYPE "_HE_" /* Edge(1), Level(0) */
71#define ACPI_RESTAG_LENGTH "_LEN"
72#define ACPI_RESTAG_MEMATTRIBUTES "_MTP" /* Memory(0), Reserved(1), ACPI(2), NVS(3) */
61686124 73#define ACPI_RESTAG_MEMTYPE "_MEM" /* NonCache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */
8313524a
BM
74#define ACPI_RESTAG_MAXADDR "_MAX"
75#define ACPI_RESTAG_MINADDR "_MIN"
76#define ACPI_RESTAG_MAXTYPE "_MAF"
77#define ACPI_RESTAG_MINTYPE "_MIF"
78#define ACPI_RESTAG_REGISTERBITOFFSET "_RBO"
79#define ACPI_RESTAG_REGISTERBITWIDTH "_RBW"
80#define ACPI_RESTAG_RANGETYPE "_RNG"
61686124 81#define ACPI_RESTAG_READWRITETYPE "_RW_" /* ReadOnly(0), Writeable (1) */
8313524a
BM
82#define ACPI_RESTAG_TRANSLATION "_TRA"
83#define ACPI_RESTAG_TRANSTYPE "_TRS" /* Sparse(1), Dense(0) */
84#define ACPI_RESTAG_TYPE "_TTP" /* Translation(1), Static (0) */
61686124
BM
85#define ACPI_RESTAG_XFERTYPE "_SIZ" /* 8(0), 8And16(1), 16(2) */
86/*! [End] no source code translation !*/
1da177e4
LT
87
88/* Default sizes for "small" resource descriptors */
89
90#define ASL_RDESC_IRQ_SIZE 0x02
91#define ASL_RDESC_DMA_SIZE 0x02
92#define ASL_RDESC_ST_DEPEND_SIZE 0x00
93#define ASL_RDESC_END_DEPEND_SIZE 0x00
94#define ASL_RDESC_IO_SIZE 0x07
95#define ASL_RDESC_FIXED_IO_SIZE 0x03
96#define ASL_RDESC_END_TAG_SIZE 0x01
97
4be44fcd
LB
98struct asl_resource_node {
99 u32 buffer_length;
100 void *buffer;
101 struct asl_resource_node *next;
1da177e4
LT
102};
103
96db255c
BM
104/* Macros used to generate AML resource length fields */
105
106#define ACPI_AML_SIZE_LARGE(r) (sizeof (r) - sizeof (struct aml_resource_large_header))
107#define ACPI_AML_SIZE_SMALL(r) (sizeof (r) - sizeof (struct aml_resource_small_header))
108
1da177e4
LT
109/*
110 * Resource descriptors defined in the ACPI specification.
111 *
112 * Packing/alignment must be BYTE because these descriptors
50eca3eb 113 * are used to overlay the raw AML byte stream.
1da177e4
LT
114 */
115#pragma pack(1)
116
50eca3eb
BM
117/*
118 * SMALL descriptors
119 */
120#define AML_RESOURCE_SMALL_HEADER_COMMON \
61686124 121 u8 descriptor_type;
50eca3eb
BM
122
123struct aml_resource_small_header {
124AML_RESOURCE_SMALL_HEADER_COMMON};
125
126struct aml_resource_irq {
127 AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask;
4be44fcd 128 u8 flags;
1da177e4
LT
129};
130
50eca3eb
BM
131struct aml_resource_irq_noflags {
132 AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask;
1da177e4
LT
133};
134
50eca3eb
BM
135struct aml_resource_dma {
136 AML_RESOURCE_SMALL_HEADER_COMMON u8 dma_channel_mask;
4be44fcd 137 u8 flags;
1da177e4
LT
138};
139
50eca3eb
BM
140struct aml_resource_start_dependent {
141 AML_RESOURCE_SMALL_HEADER_COMMON u8 flags;
1da177e4
LT
142};
143
50eca3eb
BM
144struct aml_resource_start_dependent_noprio {
145AML_RESOURCE_SMALL_HEADER_COMMON};
1da177e4 146
50eca3eb
BM
147struct aml_resource_end_dependent {
148AML_RESOURCE_SMALL_HEADER_COMMON};
1da177e4 149
50eca3eb 150struct aml_resource_io {
0897831b 151 AML_RESOURCE_SMALL_HEADER_COMMON u8 flags;
50eca3eb
BM
152 u16 minimum;
153 u16 maximum;
4be44fcd 154 u8 alignment;
50eca3eb 155 u8 address_length;
1da177e4
LT
156};
157
50eca3eb
BM
158struct aml_resource_fixed_io {
159 AML_RESOURCE_SMALL_HEADER_COMMON u16 address;
160 u8 address_length;
1da177e4
LT
161};
162
50eca3eb
BM
163struct aml_resource_vendor_small {
164AML_RESOURCE_SMALL_HEADER_COMMON};
1da177e4 165
50eca3eb
BM
166struct aml_resource_end_tag {
167 AML_RESOURCE_SMALL_HEADER_COMMON u8 checksum;
1da177e4
LT
168};
169
50eca3eb
BM
170/*
171 * LARGE descriptors
172 */
173#define AML_RESOURCE_LARGE_HEADER_COMMON \
61686124
BM
174 u8 descriptor_type;\
175 u16 resource_length;
bda663d3 176
50eca3eb
BM
177struct aml_resource_large_header {
178AML_RESOURCE_LARGE_HEADER_COMMON};
bda663d3 179
50eca3eb 180struct aml_resource_memory24 {
0897831b 181 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
50eca3eb
BM
182 u16 minimum;
183 u16 maximum;
4be44fcd 184 u16 alignment;
50eca3eb 185 u16 address_length;
1da177e4
LT
186};
187
50eca3eb
BM
188struct aml_resource_vendor_large {
189AML_RESOURCE_LARGE_HEADER_COMMON};
1da177e4 190
50eca3eb 191struct aml_resource_memory32 {
0897831b 192 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
50eca3eb
BM
193 u32 minimum;
194 u32 maximum;
4be44fcd 195 u32 alignment;
50eca3eb 196 u32 address_length;
1da177e4
LT
197};
198
50eca3eb 199struct aml_resource_fixed_memory32 {
0897831b 200 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
50eca3eb
BM
201 u32 address;
202 u32 address_length;
1da177e4
LT
203};
204
50eca3eb 205#define AML_RESOURCE_ADDRESS_COMMON \
61686124
BM
206 u8 resource_type; \
207 u8 flags; \
208 u8 specific_flags;
50eca3eb
BM
209
210struct aml_resource_address {
211AML_RESOURCE_LARGE_HEADER_COMMON AML_RESOURCE_ADDRESS_COMMON};
212
213struct aml_resource_extended_address64 {
214 AML_RESOURCE_LARGE_HEADER_COMMON
215 AML_RESOURCE_ADDRESS_COMMON u8 revision_iD;
4be44fcd
LB
216 u8 reserved;
217 u64 granularity;
50eca3eb
BM
218 u64 minimum;
219 u64 maximum;
4be44fcd
LB
220 u64 translation_offset;
221 u64 address_length;
0897831b 222 u64 type_specific;
1da177e4
LT
223};
224
50eca3eb 225#define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */
4be44fcd 226
50eca3eb
BM
227struct aml_resource_address64 {
228 AML_RESOURCE_LARGE_HEADER_COMMON
229 AML_RESOURCE_ADDRESS_COMMON u64 granularity;
230 u64 minimum;
231 u64 maximum;
4be44fcd
LB
232 u64 translation_offset;
233 u64 address_length;
1da177e4
LT
234};
235
50eca3eb
BM
236struct aml_resource_address32 {
237 AML_RESOURCE_LARGE_HEADER_COMMON
238 AML_RESOURCE_ADDRESS_COMMON u32 granularity;
239 u32 minimum;
240 u32 maximum;
4be44fcd
LB
241 u32 translation_offset;
242 u32 address_length;
1da177e4
LT
243};
244
50eca3eb
BM
245struct aml_resource_address16 {
246 AML_RESOURCE_LARGE_HEADER_COMMON
247 AML_RESOURCE_ADDRESS_COMMON u16 granularity;
248 u16 minimum;
249 u16 maximum;
4be44fcd
LB
250 u16 translation_offset;
251 u16 address_length;
1da177e4
LT
252};
253
50eca3eb
BM
254struct aml_resource_extended_irq {
255 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
0897831b
BM
256 u8 interrupt_count;
257 u32 interrupts[1];
1da177e4
LT
258 /* res_source_index, res_source optional fields follow */
259};
260
50eca3eb
BM
261struct aml_resource_generic_register {
262 AML_RESOURCE_LARGE_HEADER_COMMON u8 address_space_id;
4be44fcd
LB
263 u8 bit_width;
264 u8 bit_offset;
50eca3eb 265 u8 access_size; /* ACPI 3.0, was previously Reserved */
4be44fcd 266 u64 address;
1da177e4
LT
267};
268
269/* restore default alignment */
270
271#pragma pack()
272
273/* Union of all resource descriptors, so we can allocate the worst case */
274
50eca3eb
BM
275union aml_resource {
276 /* Descriptor headers */
277
8313524a 278 u8 descriptor_type;
50eca3eb
BM
279 struct aml_resource_small_header small_header;
280 struct aml_resource_large_header large_header;
281
282 /* Small resource descriptors */
283
284 struct aml_resource_irq irq;
285 struct aml_resource_dma dma;
286 struct aml_resource_start_dependent start_dpf;
287 struct aml_resource_end_dependent end_dpf;
288 struct aml_resource_io io;
289 struct aml_resource_fixed_io fixed_io;
290 struct aml_resource_vendor_small vendor_small;
291 struct aml_resource_end_tag end_tag;
292
293 /* Large resource descriptors */
294
295 struct aml_resource_memory24 memory24;
296 struct aml_resource_generic_register generic_reg;
297 struct aml_resource_vendor_large vendor_large;
298 struct aml_resource_memory32 memory32;
299 struct aml_resource_fixed_memory32 fixed_memory32;
300 struct aml_resource_address16 address16;
301 struct aml_resource_address32 address32;
302 struct aml_resource_address64 address64;
303 struct aml_resource_extended_address64 ext_address64;
304 struct aml_resource_extended_irq extended_irq;
305
306 /* Utility overlays */
307
308 struct aml_resource_address address;
4be44fcd
LB
309 u32 u32_item;
310 u16 u16_item;
311 u8 U8item;
1da177e4
LT
312};
313
1da177e4 314#endif