2 /******************************************************************************
4 * Module Name: amlresrc.h - AML resource descriptors
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2005, 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.
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"
54 #define ASL_RESNAME_BUSMASTER "_BM_" /* Master(1), Slave(0) */
55 #define ASL_RESNAME_DECODE "_DEC"
56 #define ASL_RESNAME_DMA "_DMA"
57 #define ASL_RESNAME_DMATYPE "_TYP" /* Compatible(0), A(1), B(2), F(3) */
58 #define ASL_RESNAME_GRANULARITY "_GRA"
59 #define ASL_RESNAME_INTERRUPT "_INT"
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) */
63 #define ASL_RESNAME_LENGTH "_LEN"
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) */
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"
73 #define ASL_RESNAME_READWRITETYPE "_RW_" /* read_only(0), Writeable (1) */
74 #define ASL_RESNAME_TRANSLATION "_TRA"
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) */
79 /* Default sizes for "small" resource descriptors */
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
89 struct asl_resource_node {
92 struct asl_resource_node *next;
96 * Resource descriptors defined in the ACPI specification.
98 * Packing/alignment must be BYTE because these descriptors
99 * are used to overlay the raw AML byte stream.
106 #define AML_RESOURCE_SMALL_HEADER_COMMON \
109 struct aml_resource_small_header {
110 AML_RESOURCE_SMALL_HEADER_COMMON};
112 struct aml_resource_irq {
113 AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask;
117 struct aml_resource_irq_noflags {
118 AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask;
121 struct aml_resource_dma {
122 AML_RESOURCE_SMALL_HEADER_COMMON u8 dma_channel_mask;
126 struct aml_resource_start_dependent {
127 AML_RESOURCE_SMALL_HEADER_COMMON u8 flags;
130 struct aml_resource_start_dependent_noprio {
131 AML_RESOURCE_SMALL_HEADER_COMMON};
133 struct aml_resource_end_dependent {
134 AML_RESOURCE_SMALL_HEADER_COMMON};
136 struct aml_resource_io {
137 AML_RESOURCE_SMALL_HEADER_COMMON u8 flags;
144 struct aml_resource_fixed_io {
145 AML_RESOURCE_SMALL_HEADER_COMMON u16 address;
149 struct aml_resource_vendor_small {
150 AML_RESOURCE_SMALL_HEADER_COMMON};
152 struct aml_resource_end_tag {
153 AML_RESOURCE_SMALL_HEADER_COMMON u8 checksum;
159 #define AML_RESOURCE_LARGE_HEADER_COMMON \
163 struct aml_resource_large_header {
164 AML_RESOURCE_LARGE_HEADER_COMMON};
166 struct aml_resource_memory24 {
167 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
174 struct aml_resource_vendor_large {
175 AML_RESOURCE_LARGE_HEADER_COMMON};
177 struct aml_resource_memory32 {
178 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
185 struct aml_resource_fixed_memory32 {
186 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
191 #define AML_RESOURCE_ADDRESS_COMMON \
196 struct aml_resource_address {
197 AML_RESOURCE_LARGE_HEADER_COMMON AML_RESOURCE_ADDRESS_COMMON};
199 struct aml_resource_extended_address64 {
200 AML_RESOURCE_LARGE_HEADER_COMMON
201 AML_RESOURCE_ADDRESS_COMMON u8 revision_iD;
206 u64 translation_offset;
211 #define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */
213 struct aml_resource_address64 {
214 AML_RESOURCE_LARGE_HEADER_COMMON
215 AML_RESOURCE_ADDRESS_COMMON u64 granularity;
218 u64 translation_offset;
222 struct aml_resource_address32 {
223 AML_RESOURCE_LARGE_HEADER_COMMON
224 AML_RESOURCE_ADDRESS_COMMON u32 granularity;
227 u32 translation_offset;
231 struct aml_resource_address16 {
232 AML_RESOURCE_LARGE_HEADER_COMMON
233 AML_RESOURCE_ADDRESS_COMMON u16 granularity;
236 u16 translation_offset;
240 struct aml_resource_extended_irq {
241 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
244 /* res_source_index, res_source optional fields follow */
247 struct aml_resource_generic_register {
248 AML_RESOURCE_LARGE_HEADER_COMMON u8 address_space_id;
251 u8 access_size; /* ACPI 3.0, was previously Reserved */
255 /* restore default alignment */
259 /* Union of all resource descriptors, so we can allocate the worst case */
262 /* Descriptor headers */
264 struct aml_resource_small_header small_header;
265 struct aml_resource_large_header large_header;
267 /* Small resource descriptors */
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;
278 /* Large resource descriptors */
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;
291 /* Utility overlays */
293 struct aml_resource_address address;