Loading...
1/******************************************************************************
2 *
3 * Name: acrestyp.h - Defines, types, and structures for resource descriptors
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, Intel Corp.
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 __ACRESTYP_H__
45#define __ACRESTYP_H__
46
47/*
48 * Definitions for Resource Attributes
49 */
50typedef u16 acpi_rs_length; /* Resource Length field is fixed at 16 bits */
51typedef u32 acpi_rsdesc_size; /* Max Resource Descriptor size is (Length+3) = (64_k-1)+3 */
52
53/*
54 * Memory Attributes
55 */
56#define ACPI_READ_ONLY_MEMORY (u8) 0x00
57#define ACPI_READ_WRITE_MEMORY (u8) 0x01
58
59#define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00
60#define ACPI_CACHABLE_MEMORY (u8) 0x01
61#define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02
62#define ACPI_PREFETCHABLE_MEMORY (u8) 0x03
63
64/*
65 * IO Attributes
66 * The ISA IO ranges are: n000-n0_fFh, n400-n4_fFh, n800-n8_fFh, n_c00-n_cFFh.
67 * The non-ISA IO ranges are: n100-n3_fFh, n500-n7_fFh, n900-n_bFFh, n_cd0-n_fFFh.
68 */
69#define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01
70#define ACPI_ISA_ONLY_RANGES (u8) 0x02
71#define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
72
73/* Type of translation - 1=Sparse, 0=Dense */
74
75#define ACPI_SPARSE_TRANSLATION (u8) 0x01
76
77/*
78 * IO Port Descriptor Decode
79 */
80#define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */
81#define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */
82
83/*
84 * IRQ Attributes
85 */
86#define ACPI_LEVEL_SENSITIVE (u8) 0x00
87#define ACPI_EDGE_SENSITIVE (u8) 0x01
88
89#define ACPI_ACTIVE_HIGH (u8) 0x00
90#define ACPI_ACTIVE_LOW (u8) 0x01
91
92#define ACPI_EXCLUSIVE (u8) 0x00
93#define ACPI_SHARED (u8) 0x01
94
95/*
96 * DMA Attributes
97 */
98#define ACPI_COMPATIBILITY (u8) 0x00
99#define ACPI_TYPE_A (u8) 0x01
100#define ACPI_TYPE_B (u8) 0x02
101#define ACPI_TYPE_F (u8) 0x03
102
103#define ACPI_NOT_BUS_MASTER (u8) 0x00
104#define ACPI_BUS_MASTER (u8) 0x01
105
106#define ACPI_TRANSFER_8 (u8) 0x00
107#define ACPI_TRANSFER_8_16 (u8) 0x01
108#define ACPI_TRANSFER_16 (u8) 0x02
109
110/*
111 * Start Dependent Functions Priority definitions
112 */
113#define ACPI_GOOD_CONFIGURATION (u8) 0x00
114#define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01
115#define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02
116
117/*
118 * 16, 32 and 64-bit Address Descriptor resource types
119 */
120#define ACPI_MEMORY_RANGE (u8) 0x00
121#define ACPI_IO_RANGE (u8) 0x01
122#define ACPI_BUS_NUMBER_RANGE (u8) 0x02
123
124#define ACPI_ADDRESS_NOT_FIXED (u8) 0x00
125#define ACPI_ADDRESS_FIXED (u8) 0x01
126
127#define ACPI_POS_DECODE (u8) 0x00
128#define ACPI_SUB_DECODE (u8) 0x01
129
130#define ACPI_PRODUCER (u8) 0x00
131#define ACPI_CONSUMER (u8) 0x01
132
133/*
134 * If possible, pack the following structures to byte alignment
135 */
136#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
137#pragma pack(1)
138#endif
139
140/* UUID data structures for use in vendor-defined resource descriptors */
141
142struct acpi_uuid {
143 u8 data[ACPI_UUID_LENGTH];
144};
145
146struct acpi_vendor_uuid {
147 u8 subtype;
148 u8 data[ACPI_UUID_LENGTH];
149};
150
151/*
152 * Structures used to describe device resources
153 */
154struct acpi_resource_irq {
155 u8 descriptor_length;
156 u8 triggering;
157 u8 polarity;
158 u8 sharable;
159 u8 interrupt_count;
160 u8 interrupts[1];
161};
162
163struct acpi_resource_dma {
164 u8 type;
165 u8 bus_master;
166 u8 transfer;
167 u8 channel_count;
168 u8 channels[1];
169};
170
171struct acpi_resource_start_dependent {
172 u8 descriptor_length;
173 u8 compatibility_priority;
174 u8 performance_robustness;
175};
176
177/*
178 * The END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
179 * needed because it has no fields
180 */
181
182struct acpi_resource_io {
183 u8 io_decode;
184 u8 alignment;
185 u8 address_length;
186 u16 minimum;
187 u16 maximum;
188};
189
190struct acpi_resource_fixed_io {
191 u16 address;
192 u8 address_length;
193};
194
195struct acpi_resource_vendor {
196 u16 byte_length;
197 u8 byte_data[1];
198};
199
200/* Vendor resource with UUID info (introduced in ACPI 3.0) */
201
202struct acpi_resource_vendor_typed {
203 u16 byte_length;
204 u8 uuid_subtype;
205 u8 uuid[ACPI_UUID_LENGTH];
206 u8 byte_data[1];
207};
208
209struct acpi_resource_end_tag {
210 u8 checksum;
211};
212
213struct acpi_resource_memory24 {
214 u8 write_protect;
215 u16 minimum;
216 u16 maximum;
217 u16 alignment;
218 u16 address_length;
219};
220
221struct acpi_resource_memory32 {
222 u8 write_protect;
223 u32 minimum;
224 u32 maximum;
225 u32 alignment;
226 u32 address_length;
227};
228
229struct acpi_resource_fixed_memory32 {
230 u8 write_protect;
231 u32 address;
232 u32 address_length;
233};
234
235struct acpi_memory_attribute {
236 u8 write_protect;
237 u8 caching;
238 u8 range_type;
239 u8 translation;
240};
241
242struct acpi_io_attribute {
243 u8 range_type;
244 u8 translation;
245 u8 translation_type;
246 u8 reserved1;
247};
248
249union acpi_resource_attribute {
250 struct acpi_memory_attribute mem;
251 struct acpi_io_attribute io;
252
253 /* Used for the *word_space macros */
254
255 u8 type_specific;
256};
257
258struct acpi_resource_source {
259 u8 index;
260 u16 string_length;
261 char *string_ptr;
262};
263
264/* Fields common to all address descriptors, 16/32/64 bit */
265
266#define ACPI_RESOURCE_ADDRESS_COMMON \
267 u8 resource_type; \
268 u8 producer_consumer; \
269 u8 decode; \
270 u8 min_address_fixed; \
271 u8 max_address_fixed; \
272 union acpi_resource_attribute info;
273
274struct acpi_resource_address {
275ACPI_RESOURCE_ADDRESS_COMMON};
276
277struct acpi_resource_address16 {
278 ACPI_RESOURCE_ADDRESS_COMMON u16 granularity;
279 u16 minimum;
280 u16 maximum;
281 u16 translation_offset;
282 u16 address_length;
283 struct acpi_resource_source resource_source;
284};
285
286struct acpi_resource_address32 {
287 ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
288 u32 minimum;
289 u32 maximum;
290 u32 translation_offset;
291 u32 address_length;
292 struct acpi_resource_source resource_source;
293};
294
295struct acpi_resource_address64 {
296 ACPI_RESOURCE_ADDRESS_COMMON u64 granularity;
297 u64 minimum;
298 u64 maximum;
299 u64 translation_offset;
300 u64 address_length;
301 struct acpi_resource_source resource_source;
302};
303
304struct acpi_resource_extended_address64 {
305 ACPI_RESOURCE_ADDRESS_COMMON u8 revision_iD;
306 u64 granularity;
307 u64 minimum;
308 u64 maximum;
309 u64 translation_offset;
310 u64 address_length;
311 u64 type_specific;
312};
313
314struct acpi_resource_extended_irq {
315 u8 producer_consumer;
316 u8 triggering;
317 u8 polarity;
318 u8 sharable;
319 u8 interrupt_count;
320 struct acpi_resource_source resource_source;
321 u32 interrupts[1];
322};
323
324struct acpi_resource_generic_register {
325 u8 space_id;
326 u8 bit_width;
327 u8 bit_offset;
328 u8 access_size;
329 u64 address;
330};
331
332/* ACPI_RESOURCE_TYPEs */
333
334#define ACPI_RESOURCE_TYPE_IRQ 0
335#define ACPI_RESOURCE_TYPE_DMA 1
336#define ACPI_RESOURCE_TYPE_START_DEPENDENT 2
337#define ACPI_RESOURCE_TYPE_END_DEPENDENT 3
338#define ACPI_RESOURCE_TYPE_IO 4
339#define ACPI_RESOURCE_TYPE_FIXED_IO 5
340#define ACPI_RESOURCE_TYPE_VENDOR 6
341#define ACPI_RESOURCE_TYPE_END_TAG 7
342#define ACPI_RESOURCE_TYPE_MEMORY24 8
343#define ACPI_RESOURCE_TYPE_MEMORY32 9
344#define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10
345#define ACPI_RESOURCE_TYPE_ADDRESS16 11
346#define ACPI_RESOURCE_TYPE_ADDRESS32 12
347#define ACPI_RESOURCE_TYPE_ADDRESS64 13
348#define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */
349#define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15
350#define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16
351#define ACPI_RESOURCE_TYPE_MAX 16
352
353/* Master union for resource descriptors */
354
355union acpi_resource_data {
356 struct acpi_resource_irq irq;
357 struct acpi_resource_dma dma;
358 struct acpi_resource_start_dependent start_dpf;
359 struct acpi_resource_io io;
360 struct acpi_resource_fixed_io fixed_io;
361 struct acpi_resource_vendor vendor;
362 struct acpi_resource_vendor_typed vendor_typed;
363 struct acpi_resource_end_tag end_tag;
364 struct acpi_resource_memory24 memory24;
365 struct acpi_resource_memory32 memory32;
366 struct acpi_resource_fixed_memory32 fixed_memory32;
367 struct acpi_resource_address16 address16;
368 struct acpi_resource_address32 address32;
369 struct acpi_resource_address64 address64;
370 struct acpi_resource_extended_address64 ext_address64;
371 struct acpi_resource_extended_irq extended_irq;
372 struct acpi_resource_generic_register generic_reg;
373
374 /* Common fields */
375
376 struct acpi_resource_address address; /* Common 16/32/64 address fields */
377};
378
379/* Common resource header */
380
381struct acpi_resource {
382 u32 type;
383 u32 length;
384 union acpi_resource_data data;
385};
386
387/* restore default alignment */
388
389#pragma pack()
390
391#define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */
392#define ACPI_RS_SIZE_MIN (u32) ACPI_ROUND_UP_TO_NATIVE_WORD (12)
393#define ACPI_RS_SIZE(type) (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))
394
395#define ACPI_NEXT_RESOURCE(res) (struct acpi_resource *)((u8 *) res + res->length)
396
397struct acpi_pci_routing_table {
398 u32 length;
399 u32 pin;
400 u64 address; /* here for 64-bit alignment */
401 u32 source_index;
402 char source[4]; /* pad to 64 bits so sizeof() works in all cases */
403};
404
405#endif /* __ACRESTYP_H__ */
1/******************************************************************************
2 *
3 * Name: acrestyp.h - Defines, types, and structures for resource descriptors
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2016, Intel Corp.
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 __ACRESTYP_H__
45#define __ACRESTYP_H__
46
47/*
48 * Definitions for Resource Attributes
49 */
50typedef u16 acpi_rs_length; /* Resource Length field is fixed at 16 bits */
51typedef u32 acpi_rsdesc_size; /* Max Resource Descriptor size is (Length+3) = (64K-1)+3 */
52
53/*
54 * Memory Attributes
55 */
56#define ACPI_READ_ONLY_MEMORY (u8) 0x00
57#define ACPI_READ_WRITE_MEMORY (u8) 0x01
58
59#define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00
60#define ACPI_CACHABLE_MEMORY (u8) 0x01
61#define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02
62#define ACPI_PREFETCHABLE_MEMORY (u8) 0x03
63
64/*! [Begin] no source code translation */
65/*
66 * IO Attributes
67 * The ISA IO ranges are: n000-n0FFh, n400-n4FFh, n800-n8FFh, nC00-nCFFh.
68 * The non-ISA IO ranges are: n100-n3FFh, n500-n7FFh, n900-nBFFh, nCD0-nFFFh.
69 */
70/*! [End] no source code translation !*/
71
72#define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01
73#define ACPI_ISA_ONLY_RANGES (u8) 0x02
74#define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
75
76/* Type of translation - 1=Sparse, 0=Dense */
77
78#define ACPI_SPARSE_TRANSLATION (u8) 0x01
79
80/*
81 * IO Port Descriptor Decode
82 */
83#define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */
84#define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */
85
86/*
87 * Interrupt attributes - used in multiple descriptors
88 */
89
90/* Triggering */
91
92#define ACPI_LEVEL_SENSITIVE (u8) 0x00
93#define ACPI_EDGE_SENSITIVE (u8) 0x01
94
95/* Polarity */
96
97#define ACPI_ACTIVE_HIGH (u8) 0x00
98#define ACPI_ACTIVE_LOW (u8) 0x01
99#define ACPI_ACTIVE_BOTH (u8) 0x02
100
101/* Sharing */
102
103#define ACPI_EXCLUSIVE (u8) 0x00
104#define ACPI_SHARED (u8) 0x01
105
106/* Wake */
107
108#define ACPI_NOT_WAKE_CAPABLE (u8) 0x00
109#define ACPI_WAKE_CAPABLE (u8) 0x01
110
111/*
112 * DMA Attributes
113 */
114#define ACPI_COMPATIBILITY (u8) 0x00
115#define ACPI_TYPE_A (u8) 0x01
116#define ACPI_TYPE_B (u8) 0x02
117#define ACPI_TYPE_F (u8) 0x03
118
119#define ACPI_NOT_BUS_MASTER (u8) 0x00
120#define ACPI_BUS_MASTER (u8) 0x01
121
122#define ACPI_TRANSFER_8 (u8) 0x00
123#define ACPI_TRANSFER_8_16 (u8) 0x01
124#define ACPI_TRANSFER_16 (u8) 0x02
125
126/*
127 * Start Dependent Functions Priority definitions
128 */
129#define ACPI_GOOD_CONFIGURATION (u8) 0x00
130#define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01
131#define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02
132
133/*
134 * 16, 32 and 64-bit Address Descriptor resource types
135 */
136#define ACPI_MEMORY_RANGE (u8) 0x00
137#define ACPI_IO_RANGE (u8) 0x01
138#define ACPI_BUS_NUMBER_RANGE (u8) 0x02
139
140#define ACPI_ADDRESS_NOT_FIXED (u8) 0x00
141#define ACPI_ADDRESS_FIXED (u8) 0x01
142
143#define ACPI_POS_DECODE (u8) 0x00
144#define ACPI_SUB_DECODE (u8) 0x01
145
146/* Producer/Consumer */
147
148#define ACPI_PRODUCER (u8) 0x00
149#define ACPI_CONSUMER (u8) 0x01
150
151/*
152 * If possible, pack the following structures to byte alignment
153 */
154#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
155#pragma pack(1)
156#endif
157
158/* UUID data structures for use in vendor-defined resource descriptors */
159
160struct acpi_uuid {
161 u8 data[ACPI_UUID_LENGTH];
162};
163
164struct acpi_vendor_uuid {
165 u8 subtype;
166 u8 data[ACPI_UUID_LENGTH];
167};
168
169/*
170 * Structures used to describe device resources
171 */
172struct acpi_resource_irq {
173 u8 descriptor_length;
174 u8 triggering;
175 u8 polarity;
176 u8 sharable;
177 u8 wake_capable;
178 u8 interrupt_count;
179 u8 interrupts[1];
180};
181
182struct acpi_resource_dma {
183 u8 type;
184 u8 bus_master;
185 u8 transfer;
186 u8 channel_count;
187 u8 channels[1];
188};
189
190struct acpi_resource_start_dependent {
191 u8 descriptor_length;
192 u8 compatibility_priority;
193 u8 performance_robustness;
194};
195
196/*
197 * The END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
198 * needed because it has no fields
199 */
200
201struct acpi_resource_io {
202 u8 io_decode;
203 u8 alignment;
204 u8 address_length;
205 u16 minimum;
206 u16 maximum;
207};
208
209struct acpi_resource_fixed_io {
210 u16 address;
211 u8 address_length;
212};
213
214struct acpi_resource_fixed_dma {
215 u16 request_lines;
216 u16 channels;
217 u8 width;
218};
219
220/* Values for Width field above */
221
222#define ACPI_DMA_WIDTH8 0
223#define ACPI_DMA_WIDTH16 1
224#define ACPI_DMA_WIDTH32 2
225#define ACPI_DMA_WIDTH64 3
226#define ACPI_DMA_WIDTH128 4
227#define ACPI_DMA_WIDTH256 5
228
229struct acpi_resource_vendor {
230 u16 byte_length;
231 u8 byte_data[1];
232};
233
234/* Vendor resource with UUID info (introduced in ACPI 3.0) */
235
236struct acpi_resource_vendor_typed {
237 u16 byte_length;
238 u8 uuid_subtype;
239 u8 uuid[ACPI_UUID_LENGTH];
240 u8 byte_data[1];
241};
242
243struct acpi_resource_end_tag {
244 u8 checksum;
245};
246
247struct acpi_resource_memory24 {
248 u8 write_protect;
249 u16 minimum;
250 u16 maximum;
251 u16 alignment;
252 u16 address_length;
253};
254
255struct acpi_resource_memory32 {
256 u8 write_protect;
257 u32 minimum;
258 u32 maximum;
259 u32 alignment;
260 u32 address_length;
261};
262
263struct acpi_resource_fixed_memory32 {
264 u8 write_protect;
265 u32 address;
266 u32 address_length;
267};
268
269struct acpi_memory_attribute {
270 u8 write_protect;
271 u8 caching;
272 u8 range_type;
273 u8 translation;
274};
275
276struct acpi_io_attribute {
277 u8 range_type;
278 u8 translation;
279 u8 translation_type;
280 u8 reserved1;
281};
282
283union acpi_resource_attribute {
284 struct acpi_memory_attribute mem;
285 struct acpi_io_attribute io;
286
287 /* Used for the *word_space macros */
288
289 u8 type_specific;
290};
291
292struct acpi_resource_source {
293 u8 index;
294 u16 string_length;
295 char *string_ptr;
296};
297
298/* Fields common to all address descriptors, 16/32/64 bit */
299
300#define ACPI_RESOURCE_ADDRESS_COMMON \
301 u8 resource_type; \
302 u8 producer_consumer; \
303 u8 decode; \
304 u8 min_address_fixed; \
305 u8 max_address_fixed; \
306 union acpi_resource_attribute info;
307
308struct acpi_address16_attribute {
309 u16 granularity;
310 u16 minimum;
311 u16 maximum;
312 u16 translation_offset;
313 u16 address_length;
314};
315
316struct acpi_address32_attribute {
317 u32 granularity;
318 u32 minimum;
319 u32 maximum;
320 u32 translation_offset;
321 u32 address_length;
322};
323
324struct acpi_address64_attribute {
325 u64 granularity;
326 u64 minimum;
327 u64 maximum;
328 u64 translation_offset;
329 u64 address_length;
330};
331
332struct acpi_resource_address {
333ACPI_RESOURCE_ADDRESS_COMMON};
334
335struct acpi_resource_address16 {
336 ACPI_RESOURCE_ADDRESS_COMMON struct acpi_address16_attribute address;
337 struct acpi_resource_source resource_source;
338};
339
340struct acpi_resource_address32 {
341 ACPI_RESOURCE_ADDRESS_COMMON struct acpi_address32_attribute address;
342 struct acpi_resource_source resource_source;
343};
344
345struct acpi_resource_address64 {
346 ACPI_RESOURCE_ADDRESS_COMMON struct acpi_address64_attribute address;
347 struct acpi_resource_source resource_source;
348};
349
350struct acpi_resource_extended_address64 {
351 ACPI_RESOURCE_ADDRESS_COMMON u8 revision_ID;
352 struct acpi_address64_attribute address;
353 u64 type_specific;
354};
355
356struct acpi_resource_extended_irq {
357 u8 producer_consumer;
358 u8 triggering;
359 u8 polarity;
360 u8 sharable;
361 u8 wake_capable;
362 u8 interrupt_count;
363 struct acpi_resource_source resource_source;
364 u32 interrupts[1];
365};
366
367struct acpi_resource_generic_register {
368 u8 space_id;
369 u8 bit_width;
370 u8 bit_offset;
371 u8 access_size;
372 u64 address;
373};
374
375struct acpi_resource_gpio {
376 u8 revision_id;
377 u8 connection_type;
378 u8 producer_consumer; /* For values, see Producer/Consumer above */
379 u8 pin_config;
380 u8 sharable; /* For values, see Interrupt Attributes above */
381 u8 wake_capable; /* For values, see Interrupt Attributes above */
382 u8 io_restriction;
383 u8 triggering; /* For values, see Interrupt Attributes above */
384 u8 polarity; /* For values, see Interrupt Attributes above */
385 u16 drive_strength;
386 u16 debounce_timeout;
387 u16 pin_table_length;
388 u16 vendor_length;
389 struct acpi_resource_source resource_source;
390 u16 *pin_table;
391 u8 *vendor_data;
392};
393
394/* Values for GPIO connection_type field above */
395
396#define ACPI_RESOURCE_GPIO_TYPE_INT 0
397#define ACPI_RESOURCE_GPIO_TYPE_IO 1
398
399/* Values for pin_config field above */
400
401#define ACPI_PIN_CONFIG_DEFAULT 0
402#define ACPI_PIN_CONFIG_PULLUP 1
403#define ACPI_PIN_CONFIG_PULLDOWN 2
404#define ACPI_PIN_CONFIG_NOPULL 3
405
406/* Values for io_restriction field above */
407
408#define ACPI_IO_RESTRICT_NONE 0
409#define ACPI_IO_RESTRICT_INPUT 1
410#define ACPI_IO_RESTRICT_OUTPUT 2
411#define ACPI_IO_RESTRICT_NONE_PRESERVE 3
412
413/* Common structure for I2C, SPI, and UART serial descriptors */
414
415#define ACPI_RESOURCE_SERIAL_COMMON \
416 u8 revision_id; \
417 u8 type; \
418 u8 producer_consumer; /* For values, see Producer/Consumer above */\
419 u8 slave_mode; \
420 u8 connection_sharing; \
421 u8 type_revision_id; \
422 u16 type_data_length; \
423 u16 vendor_length; \
424 struct acpi_resource_source resource_source; \
425 u8 *vendor_data;
426
427struct acpi_resource_common_serialbus {
428ACPI_RESOURCE_SERIAL_COMMON};
429
430/* Values for the Type field above */
431
432#define ACPI_RESOURCE_SERIAL_TYPE_I2C 1
433#define ACPI_RESOURCE_SERIAL_TYPE_SPI 2
434#define ACPI_RESOURCE_SERIAL_TYPE_UART 3
435
436/* Values for slave_mode field above */
437
438#define ACPI_CONTROLLER_INITIATED 0
439#define ACPI_DEVICE_INITIATED 1
440
441struct acpi_resource_i2c_serialbus {
442 ACPI_RESOURCE_SERIAL_COMMON u8 access_mode;
443 u16 slave_address;
444 u32 connection_speed;
445};
446
447/* Values for access_mode field above */
448
449#define ACPI_I2C_7BIT_MODE 0
450#define ACPI_I2C_10BIT_MODE 1
451
452struct acpi_resource_spi_serialbus {
453 ACPI_RESOURCE_SERIAL_COMMON u8 wire_mode;
454 u8 device_polarity;
455 u8 data_bit_length;
456 u8 clock_phase;
457 u8 clock_polarity;
458 u16 device_selection;
459 u32 connection_speed;
460};
461
462/* Values for wire_mode field above */
463
464#define ACPI_SPI_4WIRE_MODE 0
465#define ACPI_SPI_3WIRE_MODE 1
466
467/* Values for device_polarity field above */
468
469#define ACPI_SPI_ACTIVE_LOW 0
470#define ACPI_SPI_ACTIVE_HIGH 1
471
472/* Values for clock_phase field above */
473
474#define ACPI_SPI_FIRST_PHASE 0
475#define ACPI_SPI_SECOND_PHASE 1
476
477/* Values for clock_polarity field above */
478
479#define ACPI_SPI_START_LOW 0
480#define ACPI_SPI_START_HIGH 1
481
482struct acpi_resource_uart_serialbus {
483 ACPI_RESOURCE_SERIAL_COMMON u8 endian;
484 u8 data_bits;
485 u8 stop_bits;
486 u8 flow_control;
487 u8 parity;
488 u8 lines_enabled;
489 u16 rx_fifo_size;
490 u16 tx_fifo_size;
491 u32 default_baud_rate;
492};
493
494/* Values for Endian field above */
495
496#define ACPI_UART_LITTLE_ENDIAN 0
497#define ACPI_UART_BIG_ENDIAN 1
498
499/* Values for data_bits field above */
500
501#define ACPI_UART_5_DATA_BITS 0
502#define ACPI_UART_6_DATA_BITS 1
503#define ACPI_UART_7_DATA_BITS 2
504#define ACPI_UART_8_DATA_BITS 3
505#define ACPI_UART_9_DATA_BITS 4
506
507/* Values for stop_bits field above */
508
509#define ACPI_UART_NO_STOP_BITS 0
510#define ACPI_UART_1_STOP_BIT 1
511#define ACPI_UART_1P5_STOP_BITS 2
512#define ACPI_UART_2_STOP_BITS 3
513
514/* Values for flow_control field above */
515
516#define ACPI_UART_FLOW_CONTROL_NONE 0
517#define ACPI_UART_FLOW_CONTROL_HW 1
518#define ACPI_UART_FLOW_CONTROL_XON_XOFF 2
519
520/* Values for Parity field above */
521
522#define ACPI_UART_PARITY_NONE 0
523#define ACPI_UART_PARITY_EVEN 1
524#define ACPI_UART_PARITY_ODD 2
525#define ACPI_UART_PARITY_MARK 3
526#define ACPI_UART_PARITY_SPACE 4
527
528/* Values for lines_enabled bitfield above */
529
530#define ACPI_UART_CARRIER_DETECT (1<<2)
531#define ACPI_UART_RING_INDICATOR (1<<3)
532#define ACPI_UART_DATA_SET_READY (1<<4)
533#define ACPI_UART_DATA_TERMINAL_READY (1<<5)
534#define ACPI_UART_CLEAR_TO_SEND (1<<6)
535#define ACPI_UART_REQUEST_TO_SEND (1<<7)
536
537/* ACPI_RESOURCE_TYPEs */
538
539#define ACPI_RESOURCE_TYPE_IRQ 0
540#define ACPI_RESOURCE_TYPE_DMA 1
541#define ACPI_RESOURCE_TYPE_START_DEPENDENT 2
542#define ACPI_RESOURCE_TYPE_END_DEPENDENT 3
543#define ACPI_RESOURCE_TYPE_IO 4
544#define ACPI_RESOURCE_TYPE_FIXED_IO 5
545#define ACPI_RESOURCE_TYPE_VENDOR 6
546#define ACPI_RESOURCE_TYPE_END_TAG 7
547#define ACPI_RESOURCE_TYPE_MEMORY24 8
548#define ACPI_RESOURCE_TYPE_MEMORY32 9
549#define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10
550#define ACPI_RESOURCE_TYPE_ADDRESS16 11
551#define ACPI_RESOURCE_TYPE_ADDRESS32 12
552#define ACPI_RESOURCE_TYPE_ADDRESS64 13
553#define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */
554#define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15
555#define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16
556#define ACPI_RESOURCE_TYPE_GPIO 17 /* ACPI 5.0 */
557#define ACPI_RESOURCE_TYPE_FIXED_DMA 18 /* ACPI 5.0 */
558#define ACPI_RESOURCE_TYPE_SERIAL_BUS 19 /* ACPI 5.0 */
559#define ACPI_RESOURCE_TYPE_MAX 19
560
561/* Master union for resource descriptors */
562
563union acpi_resource_data {
564 struct acpi_resource_irq irq;
565 struct acpi_resource_dma dma;
566 struct acpi_resource_start_dependent start_dpf;
567 struct acpi_resource_io io;
568 struct acpi_resource_fixed_io fixed_io;
569 struct acpi_resource_fixed_dma fixed_dma;
570 struct acpi_resource_vendor vendor;
571 struct acpi_resource_vendor_typed vendor_typed;
572 struct acpi_resource_end_tag end_tag;
573 struct acpi_resource_memory24 memory24;
574 struct acpi_resource_memory32 memory32;
575 struct acpi_resource_fixed_memory32 fixed_memory32;
576 struct acpi_resource_address16 address16;
577 struct acpi_resource_address32 address32;
578 struct acpi_resource_address64 address64;
579 struct acpi_resource_extended_address64 ext_address64;
580 struct acpi_resource_extended_irq extended_irq;
581 struct acpi_resource_generic_register generic_reg;
582 struct acpi_resource_gpio gpio;
583 struct acpi_resource_i2c_serialbus i2c_serial_bus;
584 struct acpi_resource_spi_serialbus spi_serial_bus;
585 struct acpi_resource_uart_serialbus uart_serial_bus;
586 struct acpi_resource_common_serialbus common_serial_bus;
587
588 /* Common fields */
589
590 struct acpi_resource_address address; /* Common 16/32/64 address fields */
591};
592
593/* Common resource header */
594
595struct acpi_resource {
596 u32 type;
597 u32 length;
598 union acpi_resource_data data;
599};
600
601/* restore default alignment */
602
603#pragma pack()
604
605#define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */
606#define ACPI_RS_SIZE_MIN (u32) ACPI_ROUND_UP_TO_NATIVE_WORD (12)
607#define ACPI_RS_SIZE(type) (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))
608
609/* Macro for walking resource templates with multiple descriptors */
610
611#define ACPI_NEXT_RESOURCE(res) \
612 ACPI_ADD_PTR (struct acpi_resource, (res), (res)->length)
613
614struct acpi_pci_routing_table {
615 u32 length;
616 u32 pin;
617 u64 address; /* here for 64-bit alignment */
618 u32 source_index;
619 char source[4]; /* pad to 64 bits so sizeof() works in all cases */
620};
621
622#endif /* __ACRESTYP_H__ */