xref: /openbmc/linux/drivers/acpi/acpica/rsinfo.c (revision 82e6fdd6)
1 /*******************************************************************************
2  *
3  * Module Name: rsinfo - Dispatch and Info tables
4  *
5  ******************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2018, 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 	acpi_rs_convert_pin_function,	/* 0x14, ACPI_RESOURCE_TYPE_PIN_FUNCTION */
84 	acpi_rs_convert_pin_config,	/* 0x15, ACPI_RESOURCE_TYPE_PIN_CONFIG */
85 	acpi_rs_convert_pin_group,	/* 0x16, ACPI_RESOURCE_TYPE_PIN_GROUP */
86 	acpi_rs_convert_pin_group_function,	/* 0x17, ACPI_RESOURCE_TYPE_PIN_GROUP_FUNCTION */
87 	acpi_rs_convert_pin_group_config,	/* 0x18, ACPI_RESOURCE_TYPE_PIN_GROUP_CONFIG */
88 };
89 
90 /* Dispatch tables for AML-to-resource (Get Resource) conversion functions */
91 
92 struct acpi_rsconvert_info *acpi_gbl_get_resource_dispatch[] = {
93 	/* Small descriptors */
94 
95 	NULL,			/* 0x00, Reserved */
96 	NULL,			/* 0x01, Reserved */
97 	NULL,			/* 0x02, Reserved */
98 	NULL,			/* 0x03, Reserved */
99 	acpi_rs_get_irq,	/* 0x04, ACPI_RESOURCE_NAME_IRQ */
100 	acpi_rs_convert_dma,	/* 0x05, ACPI_RESOURCE_NAME_DMA */
101 	acpi_rs_get_start_dpf,	/* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */
102 	acpi_rs_convert_end_dpf,	/* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */
103 	acpi_rs_convert_io,	/* 0x08, ACPI_RESOURCE_NAME_IO */
104 	acpi_rs_convert_fixed_io,	/* 0x09, ACPI_RESOURCE_NAME_FIXED_IO */
105 	acpi_rs_convert_fixed_dma,	/* 0x0A, ACPI_RESOURCE_NAME_FIXED_DMA */
106 	NULL,			/* 0x0B, Reserved */
107 	NULL,			/* 0x0C, Reserved */
108 	NULL,			/* 0x0D, Reserved */
109 	acpi_rs_get_vendor_small,	/* 0x0E, ACPI_RESOURCE_NAME_VENDOR_SMALL */
110 	acpi_rs_convert_end_tag,	/* 0x0F, ACPI_RESOURCE_NAME_END_TAG */
111 
112 	/* Large descriptors */
113 
114 	NULL,			/* 0x00, Reserved */
115 	acpi_rs_convert_memory24,	/* 0x01, ACPI_RESOURCE_NAME_MEMORY24 */
116 	acpi_rs_convert_generic_reg,	/* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */
117 	NULL,			/* 0x03, Reserved */
118 	acpi_rs_get_vendor_large,	/* 0x04, ACPI_RESOURCE_NAME_VENDOR_LARGE */
119 	acpi_rs_convert_memory32,	/* 0x05, ACPI_RESOURCE_NAME_MEMORY32 */
120 	acpi_rs_convert_fixed_memory32,	/* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY32 */
121 	acpi_rs_convert_address32,	/* 0x07, ACPI_RESOURCE_NAME_ADDRESS32 */
122 	acpi_rs_convert_address16,	/* 0x08, ACPI_RESOURCE_NAME_ADDRESS16 */
123 	acpi_rs_convert_ext_irq,	/* 0x09, ACPI_RESOURCE_NAME_EXTENDED_IRQ */
124 	acpi_rs_convert_address64,	/* 0x0A, ACPI_RESOURCE_NAME_ADDRESS64 */
125 	acpi_rs_convert_ext_address64,	/* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 */
126 	acpi_rs_convert_gpio,	/* 0x0C, ACPI_RESOURCE_NAME_GPIO */
127 	acpi_rs_convert_pin_function,	/* 0x0D, ACPI_RESOURCE_NAME_PIN_FUNCTION */
128 	NULL,			/* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS - Use subtype table below */
129 	acpi_rs_convert_pin_config,	/* 0x0F, ACPI_RESOURCE_NAME_PIN_CONFIG */
130 	acpi_rs_convert_pin_group,	/* 0x10, ACPI_RESOURCE_NAME_PIN_GROUP */
131 	acpi_rs_convert_pin_group_function,	/* 0x11, ACPI_RESOURCE_NAME_PIN_GROUP_FUNCTION */
132 	acpi_rs_convert_pin_group_config,	/* 0x12, ACPI_RESOURCE_NAME_PIN_GROUP_CONFIG */
133 };
134 
135 /* Subtype table for serial_bus -- I2C, SPI, and UART */
136 
137 struct acpi_rsconvert_info *acpi_gbl_convert_resource_serial_bus_dispatch[] = {
138 	NULL,
139 	acpi_rs_convert_i2c_serial_bus,
140 	acpi_rs_convert_spi_serial_bus,
141 	acpi_rs_convert_uart_serial_bus,
142 };
143 
144 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUGGER)
145 
146 /* Dispatch table for resource dump functions */
147 
148 struct acpi_rsdump_info *acpi_gbl_dump_resource_dispatch[] = {
149 	acpi_rs_dump_irq,	/* ACPI_RESOURCE_TYPE_IRQ */
150 	acpi_rs_dump_dma,	/* ACPI_RESOURCE_TYPE_DMA */
151 	acpi_rs_dump_start_dpf,	/* ACPI_RESOURCE_TYPE_START_DEPENDENT */
152 	acpi_rs_dump_end_dpf,	/* ACPI_RESOURCE_TYPE_END_DEPENDENT */
153 	acpi_rs_dump_io,	/* ACPI_RESOURCE_TYPE_IO */
154 	acpi_rs_dump_fixed_io,	/* ACPI_RESOURCE_TYPE_FIXED_IO */
155 	acpi_rs_dump_vendor,	/* ACPI_RESOURCE_TYPE_VENDOR */
156 	acpi_rs_dump_end_tag,	/* ACPI_RESOURCE_TYPE_END_TAG */
157 	acpi_rs_dump_memory24,	/* ACPI_RESOURCE_TYPE_MEMORY24 */
158 	acpi_rs_dump_memory32,	/* ACPI_RESOURCE_TYPE_MEMORY32 */
159 	acpi_rs_dump_fixed_memory32,	/* ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
160 	acpi_rs_dump_address16,	/* ACPI_RESOURCE_TYPE_ADDRESS16 */
161 	acpi_rs_dump_address32,	/* ACPI_RESOURCE_TYPE_ADDRESS32 */
162 	acpi_rs_dump_address64,	/* ACPI_RESOURCE_TYPE_ADDRESS64 */
163 	acpi_rs_dump_ext_address64,	/* ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
164 	acpi_rs_dump_ext_irq,	/* ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
165 	acpi_rs_dump_generic_reg,	/* ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
166 	acpi_rs_dump_gpio,	/* ACPI_RESOURCE_TYPE_GPIO */
167 	acpi_rs_dump_fixed_dma,	/* ACPI_RESOURCE_TYPE_FIXED_DMA */
168 	NULL,			/* ACPI_RESOURCE_TYPE_SERIAL_BUS */
169 	acpi_rs_dump_pin_function,	/* ACPI_RESOURCE_TYPE_PIN_FUNCTION */
170 	acpi_rs_dump_pin_config,	/* ACPI_RESOURCE_TYPE_PIN_CONFIG */
171 	acpi_rs_dump_pin_group,	/* ACPI_RESOURCE_TYPE_PIN_GROUP */
172 	acpi_rs_dump_pin_group_function,	/* ACPI_RESOURCE_TYPE_PIN_GROUP_FUNCTION */
173 	acpi_rs_dump_pin_group_config,	/* ACPI_RESOURCE_TYPE_PIN_GROUP_CONFIG */
174 };
175 
176 struct acpi_rsdump_info *acpi_gbl_dump_serial_bus_dispatch[] = {
177 	NULL,
178 	acpi_rs_dump_i2c_serial_bus,	/* AML_RESOURCE_I2C_BUS_TYPE */
179 	acpi_rs_dump_spi_serial_bus,	/* AML_RESOURCE_SPI_BUS_TYPE */
180 	acpi_rs_dump_uart_serial_bus,	/* AML_RESOURCE_UART_BUS_TYPE */
181 };
182 #endif
183 
184 /*
185  * Base sizes for external AML resource descriptors, indexed by internal type.
186  * Includes size of the descriptor header (1 byte for small descriptors,
187  * 3 bytes for large descriptors)
188  */
189 const u8 acpi_gbl_aml_resource_sizes[] = {
190 	sizeof(struct aml_resource_irq),	/* ACPI_RESOURCE_TYPE_IRQ (optional Byte 3 always created) */
191 	sizeof(struct aml_resource_dma),	/* ACPI_RESOURCE_TYPE_DMA */
192 	sizeof(struct aml_resource_start_dependent),	/* ACPI_RESOURCE_TYPE_START_DEPENDENT (optional Byte 1 always created) */
193 	sizeof(struct aml_resource_end_dependent),	/* ACPI_RESOURCE_TYPE_END_DEPENDENT */
194 	sizeof(struct aml_resource_io),	/* ACPI_RESOURCE_TYPE_IO */
195 	sizeof(struct aml_resource_fixed_io),	/* ACPI_RESOURCE_TYPE_FIXED_IO */
196 	sizeof(struct aml_resource_vendor_small),	/* ACPI_RESOURCE_TYPE_VENDOR */
197 	sizeof(struct aml_resource_end_tag),	/* ACPI_RESOURCE_TYPE_END_TAG */
198 	sizeof(struct aml_resource_memory24),	/* ACPI_RESOURCE_TYPE_MEMORY24 */
199 	sizeof(struct aml_resource_memory32),	/* ACPI_RESOURCE_TYPE_MEMORY32 */
200 	sizeof(struct aml_resource_fixed_memory32),	/* ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
201 	sizeof(struct aml_resource_address16),	/* ACPI_RESOURCE_TYPE_ADDRESS16 */
202 	sizeof(struct aml_resource_address32),	/* ACPI_RESOURCE_TYPE_ADDRESS32 */
203 	sizeof(struct aml_resource_address64),	/* ACPI_RESOURCE_TYPE_ADDRESS64 */
204 	sizeof(struct aml_resource_extended_address64),	/*ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
205 	sizeof(struct aml_resource_extended_irq),	/* ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
206 	sizeof(struct aml_resource_generic_register),	/* ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
207 	sizeof(struct aml_resource_gpio),	/* ACPI_RESOURCE_TYPE_GPIO */
208 	sizeof(struct aml_resource_fixed_dma),	/* ACPI_RESOURCE_TYPE_FIXED_DMA */
209 	sizeof(struct aml_resource_common_serialbus),	/* ACPI_RESOURCE_TYPE_SERIAL_BUS */
210 	sizeof(struct aml_resource_pin_function),	/* ACPI_RESOURCE_TYPE_PIN_FUNCTION */
211 	sizeof(struct aml_resource_pin_config),	/* ACPI_RESOURCE_TYPE_PIN_CONFIG */
212 	sizeof(struct aml_resource_pin_group),	/* ACPI_RESOURCE_TYPE_PIN_GROUP */
213 	sizeof(struct aml_resource_pin_group_function),	/* ACPI_RESOURCE_TYPE_PIN_GROUP_FUNCTION */
214 	sizeof(struct aml_resource_pin_group_config),	/* ACPI_RESOURCE_TYPE_PIN_GROUP_CONFIG */
215 };
216 
217 const u8 acpi_gbl_resource_struct_sizes[] = {
218 	/* Small descriptors */
219 
220 	0,
221 	0,
222 	0,
223 	0,
224 	ACPI_RS_SIZE(struct acpi_resource_irq),
225 	ACPI_RS_SIZE(struct acpi_resource_dma),
226 	ACPI_RS_SIZE(struct acpi_resource_start_dependent),
227 	ACPI_RS_SIZE_MIN,
228 	ACPI_RS_SIZE(struct acpi_resource_io),
229 	ACPI_RS_SIZE(struct acpi_resource_fixed_io),
230 	ACPI_RS_SIZE(struct acpi_resource_fixed_dma),
231 	0,
232 	0,
233 	0,
234 	ACPI_RS_SIZE(struct acpi_resource_vendor),
235 	ACPI_RS_SIZE_MIN,
236 
237 	/* Large descriptors */
238 
239 	0,
240 	ACPI_RS_SIZE(struct acpi_resource_memory24),
241 	ACPI_RS_SIZE(struct acpi_resource_generic_register),
242 	0,
243 	ACPI_RS_SIZE(struct acpi_resource_vendor),
244 	ACPI_RS_SIZE(struct acpi_resource_memory32),
245 	ACPI_RS_SIZE(struct acpi_resource_fixed_memory32),
246 	ACPI_RS_SIZE(struct acpi_resource_address32),
247 	ACPI_RS_SIZE(struct acpi_resource_address16),
248 	ACPI_RS_SIZE(struct acpi_resource_extended_irq),
249 	ACPI_RS_SIZE(struct acpi_resource_address64),
250 	ACPI_RS_SIZE(struct acpi_resource_extended_address64),
251 	ACPI_RS_SIZE(struct acpi_resource_gpio),
252 	ACPI_RS_SIZE(struct acpi_resource_pin_function),
253 	ACPI_RS_SIZE(struct acpi_resource_common_serialbus),
254 	ACPI_RS_SIZE(struct acpi_resource_pin_config),
255 	ACPI_RS_SIZE(struct acpi_resource_pin_group),
256 	ACPI_RS_SIZE(struct acpi_resource_pin_group_function),
257 	ACPI_RS_SIZE(struct acpi_resource_pin_group_config),
258 };
259 
260 const u8 acpi_gbl_aml_resource_serial_bus_sizes[] = {
261 	0,
262 	sizeof(struct aml_resource_i2c_serialbus),
263 	sizeof(struct aml_resource_spi_serialbus),
264 	sizeof(struct aml_resource_uart_serialbus),
265 };
266 
267 const u8 acpi_gbl_resource_struct_serial_bus_sizes[] = {
268 	0,
269 	ACPI_RS_SIZE(struct acpi_resource_i2c_serialbus),
270 	ACPI_RS_SIZE(struct acpi_resource_spi_serialbus),
271 	ACPI_RS_SIZE(struct acpi_resource_uart_serialbus),
272 };
273