2 /******************************************************************************
4 * Module Name: amlresrc.h - AML resource descriptors
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2006, R. Byron Moore
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
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.
45 /* acpisrc:struct_defs -- for acpisrc conversion */
50 /*! [Begin] no source code translation */
53 * Resource descriptor tags, as defined in the ACPI specification.
54 * Used to symbolically reference fields within a descriptor.
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"
68 #define ACPI_RESTAG_INTERRUPTLEVEL "_LL_" /* ActiveLo(1), ActiveHi(0) */
69 #define ACPI_RESTAG_INTERRUPTSHARE "_SHR" /* Shareable(1), NoShare(0) */
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) */
73 #define ACPI_RESTAG_MEMTYPE "_MEM" /* NonCache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */
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"
81 #define ACPI_RESTAG_READWRITETYPE "_RW_" /* ReadOnly(0), Writeable (1) */
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) */
85 #define ACPI_RESTAG_XFERTYPE "_SIZ" /* 8(0), 8And16(1), 16(2) */
86 /*! [End] no source code translation !*/
88 /* Default sizes for "small" resource descriptors */
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
98 struct asl_resource_node {
101 struct asl_resource_node *next;
104 /* Macros used to generate AML resource length fields */
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))
110 * Resource descriptors defined in the ACPI specification.
112 * Packing/alignment must be BYTE because these descriptors
113 * are used to overlay the raw AML byte stream.
120 #define AML_RESOURCE_SMALL_HEADER_COMMON \
123 struct aml_resource_small_header {
124 AML_RESOURCE_SMALL_HEADER_COMMON};
126 struct aml_resource_irq {
127 AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask;
131 struct aml_resource_irq_noflags {
132 AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask;
135 struct aml_resource_dma {
136 AML_RESOURCE_SMALL_HEADER_COMMON u8 dma_channel_mask;
140 struct aml_resource_start_dependent {
141 AML_RESOURCE_SMALL_HEADER_COMMON u8 flags;
144 struct aml_resource_start_dependent_noprio {
145 AML_RESOURCE_SMALL_HEADER_COMMON};
147 struct aml_resource_end_dependent {
148 AML_RESOURCE_SMALL_HEADER_COMMON};
150 struct aml_resource_io {
151 AML_RESOURCE_SMALL_HEADER_COMMON u8 flags;
158 struct aml_resource_fixed_io {
159 AML_RESOURCE_SMALL_HEADER_COMMON u16 address;
163 struct aml_resource_vendor_small {
164 AML_RESOURCE_SMALL_HEADER_COMMON};
166 struct aml_resource_end_tag {
167 AML_RESOURCE_SMALL_HEADER_COMMON u8 checksum;
173 #define AML_RESOURCE_LARGE_HEADER_COMMON \
177 struct aml_resource_large_header {
178 AML_RESOURCE_LARGE_HEADER_COMMON};
180 struct aml_resource_memory24 {
181 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
188 struct aml_resource_vendor_large {
189 AML_RESOURCE_LARGE_HEADER_COMMON};
191 struct aml_resource_memory32 {
192 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
199 struct aml_resource_fixed_memory32 {
200 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
205 #define AML_RESOURCE_ADDRESS_COMMON \
210 struct aml_resource_address {
211 AML_RESOURCE_LARGE_HEADER_COMMON AML_RESOURCE_ADDRESS_COMMON};
213 struct aml_resource_extended_address64 {
214 AML_RESOURCE_LARGE_HEADER_COMMON
215 AML_RESOURCE_ADDRESS_COMMON u8 revision_iD;
220 u64 translation_offset;
225 #define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */
227 struct aml_resource_address64 {
228 AML_RESOURCE_LARGE_HEADER_COMMON
229 AML_RESOURCE_ADDRESS_COMMON u64 granularity;
232 u64 translation_offset;
236 struct aml_resource_address32 {
237 AML_RESOURCE_LARGE_HEADER_COMMON
238 AML_RESOURCE_ADDRESS_COMMON u32 granularity;
241 u32 translation_offset;
245 struct aml_resource_address16 {
246 AML_RESOURCE_LARGE_HEADER_COMMON
247 AML_RESOURCE_ADDRESS_COMMON u16 granularity;
250 u16 translation_offset;
254 struct aml_resource_extended_irq {
255 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
258 /* res_source_index, res_source optional fields follow */
261 struct aml_resource_generic_register {
262 AML_RESOURCE_LARGE_HEADER_COMMON u8 address_space_id;
265 u8 access_size; /* ACPI 3.0, was previously Reserved */
269 /* restore default alignment */
273 /* Union of all resource descriptors, so we can allocate the worst case */
276 /* Descriptor headers */
279 struct aml_resource_small_header small_header;
280 struct aml_resource_large_header large_header;
282 /* Small resource descriptors */
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;
293 /* Large resource descriptors */
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;
306 /* Utility overlays */
308 struct aml_resource_address address;