summaryrefslogtreecommitdiffstats
path: root/include/acpi/amlresrc.h
blob: b20ec303df074f669844653289ff5bd4a983f104 (plain)
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

/******************************************************************************
 *
 * 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