xref: /openbmc/linux/drivers/acpi/acpica/rsinfo.c (revision 32981ea5)
1 /*******************************************************************************
2  *
3  * Module Name: rsinfo - Dispatch and Info tables
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 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acresrc.h"
47 
48 #define _COMPONENT          ACPI_RESOURCES
49 ACPI_MODULE_NAME("rsinfo")
50 
51 /*
52  * Resource dispatch and information tables. Any new resource types (either
53  * Large or Small) must be reflected in each of these tables, so they are here
54  * in one place.
55  *
56  * The tables for Large descriptors are indexed by bits 6:0 of the AML
57  * descriptor type byte. The tables for Small descriptors are indexed by
58  * bits 6:3 of the descriptor byte. The tables for internal resource
59  * descriptors are indexed by the acpi_resource_type field.
60  */
61 /* Dispatch table for resource-to-AML (Set Resource) conversion functions */
62 struct acpi_rsconvert_info *acpi_gbl_set_resource_dispatch[] = {
63 	acpi_rs_set_irq,	/* 0x00, ACPI_RESOURCE_TYPE_IRQ */
64 	acpi_rs_convert_dma,	/* 0x01, ACPI_RESOURCE_TYPE_DMA */
65 	acpi_rs_set_start_dpf,	/* 0x02, ACPI_RESOURCE_TYPE_START_DEPENDENT */
66 	acpi_rs_convert_end_dpf,	/* 0x03, ACPI_RESOURCE_TYPE_END_DEPENDENT */
67 	acpi_rs_convert_io,	/* 0x04, ACPI_RESOURCE_TYPE_IO */
68 	acpi_rs_convert_fixed_io,	/* 0x05, ACPI_RESOURCE_TYPE_FIXED_IO */
69 	acpi_rs_set_vendor,	/* 0x06, ACPI_RESOURCE_TYPE_VENDOR */
70 	acpi_rs_convert_end_tag,	/* 0x07, ACPI_RESOURCE_TYPE_END_TAG */
71 	acpi_rs_convert_memory24,	/* 0x08, ACPI_RESOURCE_TYPE_MEMORY24 */
72 	acpi_rs_convert_memory32,	/* 0x09, ACPI_RESOURCE_TYPE_MEMORY32 */
73 	acpi_rs_convert_fixed_memory32,	/* 0x0A, ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
74 	acpi_rs_convert_address16,	/* 0x0B, ACPI_RESOURCE_TYPE_ADDRESS16 */
75 	acpi_rs_convert_address32,	/* 0x0C, ACPI_RESOURCE_TYPE_ADDRESS32 */
76 	acpi_rs_convert_address64,	/* 0x0D, ACPI_RESOURCE_TYPE_ADDRESS64 */
77 	acpi_rs_convert_ext_address64,	/* 0x0E, ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
78 	acpi_rs_convert_ext_irq,	/* 0x0F, ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
79 	acpi_rs_convert_generic_reg,	/* 0x10, ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
80 	acpi_rs_convert_gpio,	/* 0x11, ACPI_RESOURCE_TYPE_GPIO */
81 	acpi_rs_convert_fixed_dma,	/* 0x12, ACPI_RESOURCE_TYPE_FIXED_DMA */
82 	NULL,			/* 0x13, ACPI_RESOURCE_TYPE_SERIAL_BUS - Use subtype table below */
83 };
84 
85 /* Dispatch tables for AML-to-resource (Get Resource) conversion functions */
86 
87 struct acpi_rsconvert_info *acpi_gbl_get_resource_dispatch[] = {
88 	/* Small descriptors */
89 
90 	NULL,			/* 0x00, Reserved */
91 	NULL,			/* 0x01, Reserved */
92 	NULL,			/* 0x02, Reserved */
93 	NULL,			/* 0x03, Reserved */
94 	acpi_rs_get_irq,	/* 0x04, ACPI_RESOURCE_NAME_IRQ */
95 	acpi_rs_convert_dma,	/* 0x05, ACPI_RESOURCE_NAME_DMA */
96 	acpi_rs_get_start_dpf,	/* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */
97 	acpi_rs_convert_end_dpf,	/* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */
98 	acpi_rs_convert_io,	/* 0x08, ACPI_RESOURCE_NAME_IO */
99 	acpi_rs_convert_fixed_io,	/* 0x09, ACPI_RESOURCE_NAME_FIXED_IO */
100 	acpi_rs_convert_fixed_dma,	/* 0x0A, ACPI_RESOURCE_NAME_FIXED_DMA */
101 	NULL,			/* 0x0B, Reserved */
102 	NULL,			/* 0x0C, Reserved */
103 	NULL,			/* 0x0D, Reserved */
104 	acpi_rs_get_vendor_small,	/* 0x0E, ACPI_RESOURCE_NAME_VENDOR_SMALL */
105 	acpi_rs_convert_end_tag,	/* 0x0F, ACPI_RESOURCE_NAME_END_TAG */
106 
107 	/* Large descriptors */
108 
109 	NULL,			/* 0x00, Reserved */
110 	acpi_rs_convert_memory24,	/* 0x01, ACPI_RESOURCE_NAME_MEMORY24 */
111 	acpi_rs_convert_generic_reg,	/* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */
112 	NULL,			/* 0x03, Reserved */
113 	acpi_rs_get_vendor_large,	/* 0x04, ACPI_RESOURCE_NAME_VENDOR_LARGE */
114 	acpi_rs_convert_memory32,	/* 0x05, ACPI_RESOURCE_NAME_MEMORY32 */
115 	acpi_rs_convert_fixed_memory32,	/* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY32 */
116 	acpi_rs_convert_address32,	/* 0x07, ACPI_RESOURCE_NAME_ADDRESS32 */
117 	acpi_rs_convert_address16,	/* 0x08, ACPI_RESOURCE_NAME_ADDRESS16 */
118 	acpi_rs_convert_ext_irq,	/* 0x09, ACPI_RESOURCE_NAME_EXTENDED_IRQ */
119 	acpi_rs_convert_address64,	/* 0x0A, ACPI_RESOURCE_NAME_ADDRESS64 */
120 	acpi_rs_convert_ext_address64,	/* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 */
121 	acpi_rs_convert_gpio,	/* 0x0C, ACPI_RESOURCE_NAME_GPIO */
122 	NULL,			/* 0x0D, Reserved */
123 	NULL,			/* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS - Use subtype table below */
124 };
125 
126 /* Subtype table for serial_bus -- I2C, SPI, and UART */
127 
128 struct acpi_rsconvert_info *acpi_gbl_convert_resource_serial_bus_dispatch[] = {
129 	NULL,
130 	acpi_rs_convert_i2c_serial_bus,
131 	acpi_rs_convert_spi_serial_bus,
132 	acpi_rs_convert_uart_serial_bus,
133 };
134 
135 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUGGER)
136 
137 /* Dispatch table for resource dump functions */
138 
139 struct acpi_rsdump_info *acpi_gbl_dump_resource_dispatch[] = {
140 	acpi_rs_dump_irq,	/* ACPI_RESOURCE_TYPE_IRQ */
141 	acpi_rs_dump_dma,	/* ACPI_RESOURCE_TYPE_DMA */
142 	acpi_rs_dump_start_dpf,	/* ACPI_RESOURCE_TYPE_START_DEPENDENT */
143 	acpi_rs_dump_end_dpf,	/* ACPI_RESOURCE_TYPE_END_DEPENDENT */
144 	acpi_rs_dump_io,	/* ACPI_RESOURCE_TYPE_IO */
145 	acpi_rs_dump_fixed_io,	/* ACPI_RESOURCE_TYPE_FIXED_IO */
146 	acpi_rs_dump_vendor,	/* ACPI_RESOURCE_TYPE_VENDOR */
147 	acpi_rs_dump_end_tag,	/* ACPI_RESOURCE_TYPE_END_TAG */
148 	acpi_rs_dump_memory24,	/* ACPI_RESOURCE_TYPE_MEMORY24 */
149 	acpi_rs_dump_memory32,	/* ACPI_RESOURCE_TYPE_MEMORY32 */
150 	acpi_rs_dump_fixed_memory32,	/* ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
151 	acpi_rs_dump_address16,	/* ACPI_RESOURCE_TYPE_ADDRESS16 */
152 	acpi_rs_dump_address32,	/* ACPI_RESOURCE_TYPE_ADDRESS32 */
153 	acpi_rs_dump_address64,	/* ACPI_RESOURCE_TYPE_ADDRESS64 */
154 	acpi_rs_dump_ext_address64,	/* ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
155 	acpi_rs_dump_ext_irq,	/* ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
156 	acpi_rs_dump_generic_reg,	/* ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
157 	acpi_rs_dump_gpio,	/* ACPI_RESOURCE_TYPE_GPIO */
158 	acpi_rs_dump_fixed_dma,	/* ACPI_RESOURCE_TYPE_FIXED_DMA */
159 	NULL,			/* ACPI_RESOURCE_TYPE_SERIAL_BUS */
160 };
161 
162 struct acpi_rsdump_info *acpi_gbl_dump_serial_bus_dispatch[] = {
163 	NULL,
164 	acpi_rs_dump_i2c_serial_bus,	/* AML_RESOURCE_I2C_BUS_TYPE */
165 	acpi_rs_dump_spi_serial_bus,	/* AML_RESOURCE_SPI_BUS_TYPE */
166 	acpi_rs_dump_uart_serial_bus,	/* AML_RESOURCE_UART_BUS_TYPE */
167 };
168 #endif
169 
170 /*
171  * Base sizes for external AML resource descriptors, indexed by internal type.
172  * Includes size of the descriptor header (1 byte for small descriptors,
173  * 3 bytes for large descriptors)
174  */
175 const u8 acpi_gbl_aml_resource_sizes[] = {
176 	sizeof(struct aml_resource_irq),	/* ACPI_RESOURCE_TYPE_IRQ (optional Byte 3 always created) */
177 	sizeof(struct aml_resource_dma),	/* ACPI_RESOURCE_TYPE_DMA */
178 	sizeof(struct aml_resource_start_dependent),	/* ACPI_RESOURCE_TYPE_START_DEPENDENT (optional Byte 1 always created) */
179 	sizeof(struct aml_resource_end_dependent),	/* ACPI_RESOURCE_TYPE_END_DEPENDENT */
180 	sizeof(struct aml_resource_io),	/* ACPI_RESOURCE_TYPE_IO */
181 	sizeof(struct aml_resource_fixed_io),	/* ACPI_RESOURCE_TYPE_FIXED_IO */
182 	sizeof(struct aml_resource_vendor_small),	/* ACPI_RESOURCE_TYPE_VENDOR */
183 	sizeof(struct aml_resource_end_tag),	/* ACPI_RESOURCE_TYPE_END_TAG */
184 	sizeof(struct aml_resource_memory24),	/* ACPI_RESOURCE_TYPE_MEMORY24 */
185 	sizeof(struct aml_resource_memory32),	/* ACPI_RESOURCE_TYPE_MEMORY32 */
186 	sizeof(struct aml_resource_fixed_memory32),	/* ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
187 	sizeof(struct aml_resource_address16),	/* ACPI_RESOURCE_TYPE_ADDRESS16 */
188 	sizeof(struct aml_resource_address32),	/* ACPI_RESOURCE_TYPE_ADDRESS32 */
189 	sizeof(struct aml_resource_address64),	/* ACPI_RESOURCE_TYPE_ADDRESS64 */
190 	sizeof(struct aml_resource_extended_address64),	/*ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
191 	sizeof(struct aml_resource_extended_irq),	/* ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
192 	sizeof(struct aml_resource_generic_register),	/* ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
193 	sizeof(struct aml_resource_gpio),	/* ACPI_RESOURCE_TYPE_GPIO */
194 	sizeof(struct aml_resource_fixed_dma),	/* ACPI_RESOURCE_TYPE_FIXED_DMA */
195 	sizeof(struct aml_resource_common_serialbus),	/* ACPI_RESOURCE_TYPE_SERIAL_BUS */
196 };
197 
198 const u8 acpi_gbl_resource_struct_sizes[] = {
199 	/* Small descriptors */
200 
201 	0,
202 	0,
203 	0,
204 	0,
205 	ACPI_RS_SIZE(struct acpi_resource_irq),
206 	ACPI_RS_SIZE(struct acpi_resource_dma),
207 	ACPI_RS_SIZE(struct acpi_resource_start_dependent),
208 	ACPI_RS_SIZE_MIN,
209 	ACPI_RS_SIZE(struct acpi_resource_io),
210 	ACPI_RS_SIZE(struct acpi_resource_fixed_io),
211 	ACPI_RS_SIZE(struct acpi_resource_fixed_dma),
212 	0,
213 	0,
214 	0,
215 	ACPI_RS_SIZE(struct acpi_resource_vendor),
216 	ACPI_RS_SIZE_MIN,
217 
218 	/* Large descriptors */
219 
220 	0,
221 	ACPI_RS_SIZE(struct acpi_resource_memory24),
222 	ACPI_RS_SIZE(struct acpi_resource_generic_register),
223 	0,
224 	ACPI_RS_SIZE(struct acpi_resource_vendor),
225 	ACPI_RS_SIZE(struct acpi_resource_memory32),
226 	ACPI_RS_SIZE(struct acpi_resource_fixed_memory32),
227 	ACPI_RS_SIZE(struct acpi_resource_address32),
228 	ACPI_RS_SIZE(struct acpi_resource_address16),
229 	ACPI_RS_SIZE(struct acpi_resource_extended_irq),
230 	ACPI_RS_SIZE(struct acpi_resource_address64),
231 	ACPI_RS_SIZE(struct acpi_resource_extended_address64),
232 	ACPI_RS_SIZE(struct acpi_resource_gpio),
233 	ACPI_RS_SIZE(struct acpi_resource_common_serialbus)
234 };
235 
236 const u8 acpi_gbl_aml_resource_serial_bus_sizes[] = {
237 	0,
238 	sizeof(struct aml_resource_i2c_serialbus),
239 	sizeof(struct aml_resource_spi_serialbus),
240 	sizeof(struct aml_resource_uart_serialbus),
241 };
242 
243 const u8 acpi_gbl_resource_struct_serial_bus_sizes[] = {
244 	0,
245 	ACPI_RS_SIZE(struct acpi_resource_i2c_serialbus),
246 	ACPI_RS_SIZE(struct acpi_resource_spi_serialbus),
247 	ACPI_RS_SIZE(struct acpi_resource_uart_serialbus),
248 };
249