1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
/******************************************************************************
*
* Module Name: amlresrc.h - AML resource descriptors
*
*****************************************************************************/
/*
* Copyright (C) 2000 - 2011, Intel Corp.
* 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.
*/
/* acpisrc:StructDefs -- for acpisrc conversion */
#ifndef __AMLRESRC_H
#define __AMLRESRC_H
/*
* Resource descriptor tags, as defined in the ACPI specification.
* Used to symbolically reference fields within a descriptor.
*/
#define ACPI_RESTAG_ADDRESS "_ADR"
#define ACPI_RESTAG_ALIGNMENT "_ALN"
#define ACPI_RESTAG_ADDRESSSPACE "_ASI"
#define ACPI_RESTAG_ACCESSSIZE "_ASZ"
#define ACPI_RESTAG_TYPESPECIFICATTRIBUTES "_ATT"
#define ACPI_RESTAG_BASEADDRESS "_BAS"
#define ACPI_RESTAG_BUSMASTER "_BM_" /* Master(1), Slave(0) */
#define ACPI_RESTAG_DECODE "_DEC"
#define ACPI_RESTAG_DMA "_DMA"
#define ACPI_RESTAG_DMATYPE "_TYP" /* Compatible(0), A(1), B(2), F(3) */
#define ACPI_RESTAG_GRANULARITY "_GRA"
#define ACPI_RESTAG_INTERRUPT "_INT"
#define ACPI_RESTAG_INTERRUPTLEVEL "_LL_" /* ActiveLo(1), ActiveHi(0) */
#define ACPI_RESTAG_INTERRUPTSHARE "_SHR" /* Shareable(1), NoShare(0) */
#define ACPI_RESTAG_INTERRUPTTYPE "_HE_" /* Edge(1), Level(0) */
#define ACPI_RESTAG_LENGTH "_LEN"
#define ACPI_RESTAG_MEMATTRIBUTES "_MTP" /* Memory(0), Reserved(1), ACPI(2), NVS(3) */
#define ACPI_RESTAG_MEMTYPE "_MEM" /* NonCache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */
#define ACPI_RESTAG_MAXADDR "_MAX"
#define ACPI_RESTAG_MINADDR "_MIN"
#define ACPI_RESTAG_MAXTYPE "_MAF"
#define ACPI_RESTAG_MINTYPE "_MIF"
#define ACPI_RESTAG_REGISTERBITOFFSET "_RBO"
#define ACPI_RESTAG_REGISTERBITWIDTH "_RBW"
#define ACPI_RESTAG_RANGETYPE "_RNG"
#define ACPI_RESTAG_READWRITETYPE "_RW_" /* ReadOnly(0), Writeable (1) */
#define ACPI_RESTAG_TRANSLATION "_TRA"
#define ACPI_RESTAG_TRANSTYPE "_TRS" /* Sparse(1), Dense(0) */
#define ACPI_RESTAG_TYPE "_TTP" /* Translation(1), Static (0) */
#define ACPI_RESTAG_XFERTYPE "_SIZ" /* 8(0), 8And16(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
typedef struct asl_resource_node
{
UINT32 BufferLength;
void *Buffer;
struct asl_resource_node *Next;
} ASL_RESOURCE_NODE;
/* Macros used to generate AML resource length fields */
#define ACPI_AML_SIZE_LARGE(r) (sizeof (r) - sizeof (AML_RESOURCE_LARGE_HEADER))
#define ACPI_AML_SIZE_SMALL(r) (sizeof (r) - sizeof (AML_RESOURCE_SMALL_HEADER))
/*
* Resource descriptors defined in the ACPI specification.
*
* Packing/alignment must be BYTE because these descriptors
* are used to overlay the raw AML byte stream.
*/
#pragma pack(1)
/*
* SMALL descriptors
*/
#define AML_RESOURCE_SMALL_HEADER_COMMON \
UINT8 DescriptorType;
typedef struct aml_resource_small_header
{
AML_RESOURCE_SMALL_HEADER_COMMON
} AML_RESOURCE_SMALL_HEADER;
typedef struct aml_resource_irq
{
AML_RESOURCE_SMALL_HEADER_COMMON
UINT16 IrqMask;
UINT8 Flags;
} AML_RESOURCE_IRQ;
typedef struct aml_resource_irq_noflags
{
AML_RESOURCE_SMALL_HEADER_COMMON
UINT16 IrqMask;
} AML_RESOURCE_IRQ_NOFLAGS;
typedef struct aml_resource_dma
{
AML_RESOURCE_SMALL_HEADER_COMMON
UINT8 DmaChannelMask;
UINT8 Flags;
} AML_RESOURCE_DMA;
typedef struct aml_resource_start_dependent
{
AML_RESOURCE_SMALL_HEADER_COMMON
UINT8 Flags;
} AML_RESOURCE_START_DEPENDENT;
typedef struct aml_resource_start_dependent_noprio
{
AML_RESOURCE_SMALL_HEADER_COMMON
} AML_RESOURCE_START_DEPENDENT_NOPRIO;
typedef struct aml_resource_end_dependent
{
AML_RESOURCE_SMALL_HEADER_COMMON
} AML_RESOURCE_END_DEPENDENT;
typedef struct aml_resource_io
{
AML_RESOURCE_SMALL_HEADER_COMMON
UINT8 Flags;
UINT16 Minimum;
UINT16 Maximum;
UINT8 Alignment;
UINT8 AddressLength;
} AML_RESOURCE_IO;
typedef struct aml_resource_fixed_io
{
AML_RESOURCE_SMALL_HEADER_COMMON
UINT16 Address;
UINT8 AddressLength;
} AML_RESOURCE_FIXED_IO;
typedef struct aml_resource_vendor_small
{
AML_RESOURCE_SMALL_HEADER_COMMON
} AML_RESOURCE_VENDOR_SMALL;
typedef struct aml_resource_end_tag
{
AML_RESOURCE_SMALL_HEADER_COMMON
UINT8 Checksum;
} AML_RESOURCE_END_TAG;
/*
* LARGE descriptors
*/
#define AML_RESOURCE_LARGE_HEADER_COMMON \
UINT8 DescriptorType;\
UINT16 ResourceLength;
typedef struct aml_resource_large_header
{
AML_RESOURCE_LARGE_HEADER_COMMON
} AML_RESOURCE_LARGE_HEADER;
/* General Flags for address space resource descriptors */
#define ACPI_RESOURCE_FLAG_DEC 2
#define ACPI_RESOURCE_FLAG_MIF 4
#define ACPI_RESOURCE_FLAG_MAF 8
typedef struct aml_resource_memory24
{
AML_RESOURCE_LARGE_HEADER_COMMON
UINT8 Flags;
UINT16 Minimum;
UINT16 Maximum;
UINT16 Alignment;
UINT16 AddressLength;
} AML_RESOURCE_MEMORY24;
typedef struct aml_resource_vendor_large
{
AML_RESOURCE_LARGE_HEADER_COMMON
} AML_RESOURCE_VENDOR_LARGE;
typedef struct aml_resource_memory32
{
AML_RESOURCE_LARGE_HEADER_COMMON
UINT8 Flags;
UINT32 Minimum;
UINT32 Maximum;
UINT32 Alignment;
UINT32 AddressLength;
} AML_RESOURCE_MEMORY32;
typedef struct aml_resource_fixed_memory32
{
AML_RESOURCE_LARGE_HEADER_COMMON
UINT8 Flags;
UINT32 Address;
UINT32 AddressLength;
} AML_RESOURCE_FIXED_MEMORY32;
#define AML_RESOURCE_ADDRESS_COMMON \
UINT8 ResourceType; \
UINT8 Flags; \
UINT8 SpecificFlags;
typedef struct aml_resource_address
{
AML_RESOURCE_LARGE_HEADER_COMMON
AML_RESOURCE_ADDRESS_COMMON
} AML_RESOURCE_ADDRESS;
typedef struct aml_resource_extended_address64
{
AML_RESOURCE_LARGE_HEADER_COMMON
AML_RESOURCE_ADDRESS_COMMON
UINT8 RevisionID;
UINT8 Reserved;
UINT64 Granularity;
UINT64 Minimum;
UINT64 Maximum;
UINT64 TranslationOffset;
UINT64 AddressLength;
UINT64 TypeSpecific;
} AML_RESOURCE_EXTENDED_ADDRESS64;
#define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */
typedef struct aml_resource_address64
{
AML_RESOURCE_LARGE_HEADER_COMMON
AML_RESOURCE_ADDRESS_COMMON
UINT64 Granularity;
UINT64 Minimum;
UINT64 Maximum;
UINT64 TranslationOffset;
UINT64 AddressLength;
} AML_RESOURCE_ADDRESS64;
typedef struct aml_resource_address32
{
AML_RESOURCE_LARGE_HEADER_COMMON
AML_RESOURCE_ADDRESS_COMMON
UINT32 Granularity;
UINT32 Minimum;
UINT32 Maximum;
UINT32 TranslationOffset;
UINT32 AddressLength;
} AML_RESOURCE_ADDRESS32;
typedef struct aml_resource_address16
{
AML_RESOURCE_LARGE_HEADER_COMMON
AML_RESOURCE_ADDRESS_COMMON
UINT16 Granularity;
UINT16 Minimum;
UINT16 Maximum;
UINT16 TranslationOffset;
UINT16 AddressLength;
} AML_RESOURCE_ADDRESS16;
typedef struct aml_resource_extended_irq
{
AML_RESOURCE_LARGE_HEADER_COMMON
UINT8 Flags;
UINT8 InterruptCount;
UINT32 Interrupts[1];
/* ResSourceIndex, ResSource optional fields follow */
} AML_RESOURCE_EXTENDED_IRQ;
typedef struct aml_resource_generic_register
{
AML_RESOURCE_LARGE_HEADER_COMMON
UINT8 AddressSpaceId;
UINT8 BitWidth;
UINT8 BitOffset;
UINT8 AccessSize; /* ACPI 3.0, was previously Reserved */
UINT64 Address;
} AML_RESOURCE_GENERIC_REGISTER;
/* restore default alignment */
#pragma pack()
/* Union of all resource descriptors, so we can allocate the worst case */
typedef union aml_resource
{
/* Descriptor headers */
UINT8 DescriptorType;
AML_RESOURCE_SMALL_HEADER SmallHeader;
AML_RESOURCE_LARGE_HEADER LargeHeader;
/* Small resource descriptors */
AML_RESOURCE_IRQ Irq;
AML_RESOURCE_DMA Dma;
AML_RESOURCE_START_DEPENDENT StartDpf;
AML_RESOURCE_END_DEPENDENT EndDpf;
AML_RESOURCE_IO Io;
AML_RESOURCE_FIXED_IO FixedIo;
AML_RESOURCE_VENDOR_SMALL VendorSmall;
AML_RESOURCE_END_TAG EndTag;
/* Large resource descriptors */
AML_RESOURCE_MEMORY24 Memory24;
AML_RESOURCE_GENERIC_REGISTER GenericReg;
AML_RESOURCE_VENDOR_LARGE VendorLarge;
AML_RESOURCE_MEMORY32 Memory32;
AML_RESOURCE_FIXED_MEMORY32 FixedMemory32;
AML_RESOURCE_ADDRESS16 Address16;
AML_RESOURCE_ADDRESS32 Address32;
AML_RESOURCE_ADDRESS64 Address64;
AML_RESOURCE_EXTENDED_ADDRESS64 ExtAddress64;
AML_RESOURCE_EXTENDED_IRQ ExtendedIrq;
/* Utility overlays */
AML_RESOURCE_ADDRESS Address;
UINT32 DwordItem;
UINT16 WordItem;
UINT8 ByteItem;
} AML_RESOURCE;
#endif
|