]>
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" |
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" |
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) */ |
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 | }; |
94 | ||
1da177e4 LT |
95 | /* |
96 | * Resource descriptors defined in the ACPI specification. | |
97 | * | |
98 | * Packing/alignment must be BYTE because these descriptors | |
50eca3eb | 99 | * are used to overlay the raw AML byte stream. |
1da177e4 LT |
100 | */ |
101 | #pragma pack(1) | |
102 | ||
50eca3eb BM |
103 | /* |
104 | * SMALL descriptors | |
105 | */ | |
106 | #define AML_RESOURCE_SMALL_HEADER_COMMON \ | |
107 | u8 descriptor_type; | |
108 | ||
109 | struct aml_resource_small_header { | |
110 | AML_RESOURCE_SMALL_HEADER_COMMON}; | |
111 | ||
112 | struct aml_resource_irq { | |
113 | AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask; | |
4be44fcd | 114 | u8 flags; |
1da177e4 LT |
115 | }; |
116 | ||
50eca3eb BM |
117 | struct aml_resource_irq_noflags { |
118 | AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask; | |
1da177e4 LT |
119 | }; |
120 | ||
50eca3eb BM |
121 | struct aml_resource_dma { |
122 | AML_RESOURCE_SMALL_HEADER_COMMON u8 dma_channel_mask; | |
4be44fcd | 123 | u8 flags; |
1da177e4 LT |
124 | }; |
125 | ||
50eca3eb BM |
126 | struct aml_resource_start_dependent { |
127 | AML_RESOURCE_SMALL_HEADER_COMMON u8 flags; | |
1da177e4 LT |
128 | }; |
129 | ||
50eca3eb BM |
130 | struct aml_resource_start_dependent_noprio { |
131 | AML_RESOURCE_SMALL_HEADER_COMMON}; | |
1da177e4 | 132 | |
50eca3eb BM |
133 | struct aml_resource_end_dependent { |
134 | AML_RESOURCE_SMALL_HEADER_COMMON}; | |
1da177e4 | 135 | |
50eca3eb | 136 | struct aml_resource_io { |
0897831b | 137 | AML_RESOURCE_SMALL_HEADER_COMMON u8 flags; |
50eca3eb BM |
138 | u16 minimum; |
139 | u16 maximum; | |
4be44fcd | 140 | u8 alignment; |
50eca3eb | 141 | u8 address_length; |
1da177e4 LT |
142 | }; |
143 | ||
50eca3eb BM |
144 | struct aml_resource_fixed_io { |
145 | AML_RESOURCE_SMALL_HEADER_COMMON u16 address; | |
146 | u8 address_length; | |
1da177e4 LT |
147 | }; |
148 | ||
50eca3eb BM |
149 | struct aml_resource_vendor_small { |
150 | AML_RESOURCE_SMALL_HEADER_COMMON}; | |
1da177e4 | 151 | |
50eca3eb BM |
152 | struct aml_resource_end_tag { |
153 | AML_RESOURCE_SMALL_HEADER_COMMON u8 checksum; | |
1da177e4 LT |
154 | }; |
155 | ||
50eca3eb BM |
156 | /* |
157 | * LARGE descriptors | |
158 | */ | |
159 | #define AML_RESOURCE_LARGE_HEADER_COMMON \ | |
bda663d3 | 160 | u8 descriptor_type;\ |
50eca3eb | 161 | u16 resource_length; |
bda663d3 | 162 | |
50eca3eb BM |
163 | struct aml_resource_large_header { |
164 | AML_RESOURCE_LARGE_HEADER_COMMON}; | |
bda663d3 | 165 | |
50eca3eb | 166 | struct aml_resource_memory24 { |
0897831b | 167 | AML_RESOURCE_LARGE_HEADER_COMMON u8 flags; |
50eca3eb BM |
168 | u16 minimum; |
169 | u16 maximum; | |
4be44fcd | 170 | u16 alignment; |
50eca3eb | 171 | u16 address_length; |
1da177e4 LT |
172 | }; |
173 | ||
50eca3eb BM |
174 | struct aml_resource_vendor_large { |
175 | AML_RESOURCE_LARGE_HEADER_COMMON}; | |
1da177e4 | 176 | |
50eca3eb | 177 | struct aml_resource_memory32 { |
0897831b | 178 | AML_RESOURCE_LARGE_HEADER_COMMON u8 flags; |
50eca3eb BM |
179 | u32 minimum; |
180 | u32 maximum; | |
4be44fcd | 181 | u32 alignment; |
50eca3eb | 182 | u32 address_length; |
1da177e4 LT |
183 | }; |
184 | ||
50eca3eb | 185 | struct aml_resource_fixed_memory32 { |
0897831b | 186 | AML_RESOURCE_LARGE_HEADER_COMMON u8 flags; |
50eca3eb BM |
187 | u32 address; |
188 | u32 address_length; | |
1da177e4 LT |
189 | }; |
190 | ||
50eca3eb BM |
191 | #define AML_RESOURCE_ADDRESS_COMMON \ |
192 | u8 resource_type; \ | |
193 | u8 flags; \ | |
194 | u8 specific_flags; | |
195 | ||
196 | struct aml_resource_address { | |
197 | AML_RESOURCE_LARGE_HEADER_COMMON AML_RESOURCE_ADDRESS_COMMON}; | |
198 | ||
199 | struct aml_resource_extended_address64 { | |
200 | AML_RESOURCE_LARGE_HEADER_COMMON | |
201 | AML_RESOURCE_ADDRESS_COMMON u8 revision_iD; | |
4be44fcd LB |
202 | u8 reserved; |
203 | u64 granularity; | |
50eca3eb BM |
204 | u64 minimum; |
205 | u64 maximum; | |
4be44fcd LB |
206 | u64 translation_offset; |
207 | u64 address_length; | |
0897831b | 208 | u64 type_specific; |
1da177e4 LT |
209 | }; |
210 | ||
50eca3eb | 211 | #define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */ |
4be44fcd | 212 | |
50eca3eb BM |
213 | struct aml_resource_address64 { |
214 | AML_RESOURCE_LARGE_HEADER_COMMON | |
215 | AML_RESOURCE_ADDRESS_COMMON u64 granularity; | |
216 | u64 minimum; | |
217 | u64 maximum; | |
4be44fcd LB |
218 | u64 translation_offset; |
219 | u64 address_length; | |
1da177e4 LT |
220 | }; |
221 | ||
50eca3eb BM |
222 | struct aml_resource_address32 { |
223 | AML_RESOURCE_LARGE_HEADER_COMMON | |
224 | AML_RESOURCE_ADDRESS_COMMON u32 granularity; | |
225 | u32 minimum; | |
226 | u32 maximum; | |
4be44fcd LB |
227 | u32 translation_offset; |
228 | u32 address_length; | |
1da177e4 LT |
229 | }; |
230 | ||
50eca3eb BM |
231 | struct aml_resource_address16 { |
232 | AML_RESOURCE_LARGE_HEADER_COMMON | |
233 | AML_RESOURCE_ADDRESS_COMMON u16 granularity; | |
234 | u16 minimum; | |
235 | u16 maximum; | |
4be44fcd LB |
236 | u16 translation_offset; |
237 | u16 address_length; | |
1da177e4 LT |
238 | }; |
239 | ||
50eca3eb BM |
240 | struct aml_resource_extended_irq { |
241 | AML_RESOURCE_LARGE_HEADER_COMMON u8 flags; | |
0897831b BM |
242 | u8 interrupt_count; |
243 | u32 interrupts[1]; | |
1da177e4 LT |
244 | /* res_source_index, res_source optional fields follow */ |
245 | }; | |
246 | ||
50eca3eb BM |
247 | struct aml_resource_generic_register { |
248 | AML_RESOURCE_LARGE_HEADER_COMMON u8 address_space_id; | |
4be44fcd LB |
249 | u8 bit_width; |
250 | u8 bit_offset; | |
50eca3eb | 251 | u8 access_size; /* ACPI 3.0, was previously Reserved */ |
4be44fcd | 252 | u64 address; |
1da177e4 LT |
253 | }; |
254 | ||
255 | /* restore default alignment */ | |
256 | ||
257 | #pragma pack() | |
258 | ||
259 | /* Union of all resource descriptors, so we can allocate the worst case */ | |
260 | ||
50eca3eb BM |
261 | union aml_resource { |
262 | /* Descriptor headers */ | |
263 | ||
264 | struct aml_resource_small_header small_header; | |
265 | struct aml_resource_large_header large_header; | |
266 | ||
267 | /* Small resource descriptors */ | |
268 | ||
269 | struct aml_resource_irq irq; | |
270 | struct aml_resource_dma dma; | |
271 | struct aml_resource_start_dependent start_dpf; | |
272 | struct aml_resource_end_dependent end_dpf; | |
273 | struct aml_resource_io io; | |
274 | struct aml_resource_fixed_io fixed_io; | |
275 | struct aml_resource_vendor_small vendor_small; | |
276 | struct aml_resource_end_tag end_tag; | |
277 | ||
278 | /* Large resource descriptors */ | |
279 | ||
280 | struct aml_resource_memory24 memory24; | |
281 | struct aml_resource_generic_register generic_reg; | |
282 | struct aml_resource_vendor_large vendor_large; | |
283 | struct aml_resource_memory32 memory32; | |
284 | struct aml_resource_fixed_memory32 fixed_memory32; | |
285 | struct aml_resource_address16 address16; | |
286 | struct aml_resource_address32 address32; | |
287 | struct aml_resource_address64 address64; | |
288 | struct aml_resource_extended_address64 ext_address64; | |
289 | struct aml_resource_extended_irq extended_irq; | |
290 | ||
291 | /* Utility overlays */ | |
292 | ||
293 | struct aml_resource_address address; | |
4be44fcd LB |
294 | u32 u32_item; |
295 | u16 u16_item; | |
296 | u8 U8item; | |
1da177e4 LT |
297 | }; |
298 | ||
1da177e4 | 299 | #endif |