xref: /netbsd-src/sys/external/bsd/acpica/dist/resources/rsinfo.c (revision 046a29855e04359424fd074e8313af6b6be8cfb6)
1 /*******************************************************************************
2  *
3  * Module Name: rsinfo - Dispatch and Info tables
4  *
5  ******************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2023, 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 MERCHANTABILITY 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.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 
62 
63 /* Dispatch table for resource-to-AML (Set Resource) conversion functions */
64 
65 ACPI_RSCONVERT_INFO         *AcpiGbl_SetResourceDispatch[] =
66 {
67     AcpiRsSetIrq,                   /* 0x00, ACPI_RESOURCE_TYPE_IRQ */
68     AcpiRsConvertDma,               /* 0x01, ACPI_RESOURCE_TYPE_DMA */
69     AcpiRsSetStartDpf,              /* 0x02, ACPI_RESOURCE_TYPE_START_DEPENDENT */
70     AcpiRsConvertEndDpf,            /* 0x03, ACPI_RESOURCE_TYPE_END_DEPENDENT */
71     AcpiRsConvertIo,                /* 0x04, ACPI_RESOURCE_TYPE_IO */
72     AcpiRsConvertFixedIo,           /* 0x05, ACPI_RESOURCE_TYPE_FIXED_IO */
73     AcpiRsSetVendor,                /* 0x06, ACPI_RESOURCE_TYPE_VENDOR */
74     AcpiRsConvertEndTag,            /* 0x07, ACPI_RESOURCE_TYPE_END_TAG */
75     AcpiRsConvertMemory24,          /* 0x08, ACPI_RESOURCE_TYPE_MEMORY24 */
76     AcpiRsConvertMemory32,          /* 0x09, ACPI_RESOURCE_TYPE_MEMORY32 */
77     AcpiRsConvertFixedMemory32,     /* 0x0A, ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
78     AcpiRsConvertAddress16,         /* 0x0B, ACPI_RESOURCE_TYPE_ADDRESS16 */
79     AcpiRsConvertAddress32,         /* 0x0C, ACPI_RESOURCE_TYPE_ADDRESS32 */
80     AcpiRsConvertAddress64,         /* 0x0D, ACPI_RESOURCE_TYPE_ADDRESS64 */
81     AcpiRsConvertExtAddress64,      /* 0x0E, ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
82     AcpiRsConvertExtIrq,            /* 0x0F, ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
83     AcpiRsConvertGenericReg,        /* 0x10, ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
84     AcpiRsConvertGpio,              /* 0x11, ACPI_RESOURCE_TYPE_GPIO */
85     AcpiRsConvertFixedDma,          /* 0x12, ACPI_RESOURCE_TYPE_FIXED_DMA */
86     NULL,                           /* 0x13, ACPI_RESOURCE_TYPE_SERIAL_BUS - Use subtype table below */
87     AcpiRsConvertPinFunction,       /* 0x14, ACPI_RESOURCE_TYPE_PIN_FUNCTION */
88     AcpiRsConvertPinConfig,         /* 0x15, ACPI_RESOURCE_TYPE_PIN_CONFIG */
89     AcpiRsConvertPinGroup,          /* 0x16, ACPI_RESOURCE_TYPE_PIN_GROUP */
90     AcpiRsConvertPinGroupFunction,  /* 0x17, ACPI_RESOURCE_TYPE_PIN_GROUP_FUNCTION */
91     AcpiRsConvertPinGroupConfig,    /* 0x18, ACPI_RESOURCE_TYPE_PIN_GROUP_CONFIG */
92     AcpiRsConvertClockInput,        /* 0x19, ACPI_RESOURCE_TYPE_CLOCK_INPUT */
93 };
94 
95 /* Dispatch tables for AML-to-resource (Get Resource) conversion functions */
96 
97 ACPI_RSCONVERT_INFO         *AcpiGbl_GetResourceDispatch[] =
98 {
99     /* Small descriptors */
100 
101     NULL,                           /* 0x00, Reserved */
102     NULL,                           /* 0x01, Reserved */
103     NULL,                           /* 0x02, Reserved */
104     NULL,                           /* 0x03, Reserved */
105     AcpiRsGetIrq,                   /* 0x04, ACPI_RESOURCE_NAME_IRQ */
106     AcpiRsConvertDma,               /* 0x05, ACPI_RESOURCE_NAME_DMA */
107     AcpiRsGetStartDpf,              /* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */
108     AcpiRsConvertEndDpf,            /* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */
109     AcpiRsConvertIo,                /* 0x08, ACPI_RESOURCE_NAME_IO */
110     AcpiRsConvertFixedIo,           /* 0x09, ACPI_RESOURCE_NAME_FIXED_IO */
111     AcpiRsConvertFixedDma,          /* 0x0A, ACPI_RESOURCE_NAME_FIXED_DMA */
112     NULL,                           /* 0x0B, Reserved */
113     NULL,                           /* 0x0C, Reserved */
114     NULL,                           /* 0x0D, Reserved */
115     AcpiRsGetVendorSmall,           /* 0x0E, ACPI_RESOURCE_NAME_VENDOR_SMALL */
116     AcpiRsConvertEndTag,            /* 0x0F, ACPI_RESOURCE_NAME_END_TAG */
117 
118     /* Large descriptors */
119 
120     NULL,                           /* 0x00, Reserved */
121     AcpiRsConvertMemory24,          /* 0x01, ACPI_RESOURCE_NAME_MEMORY24 */
122     AcpiRsConvertGenericReg,        /* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */
123     NULL,                           /* 0x03, Reserved */
124     AcpiRsGetVendorLarge,           /* 0x04, ACPI_RESOURCE_NAME_VENDOR_LARGE */
125     AcpiRsConvertMemory32,          /* 0x05, ACPI_RESOURCE_NAME_MEMORY32 */
126     AcpiRsConvertFixedMemory32,     /* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY32 */
127     AcpiRsConvertAddress32,         /* 0x07, ACPI_RESOURCE_NAME_ADDRESS32 */
128     AcpiRsConvertAddress16,         /* 0x08, ACPI_RESOURCE_NAME_ADDRESS16 */
129     AcpiRsConvertExtIrq,            /* 0x09, ACPI_RESOURCE_NAME_EXTENDED_IRQ */
130     AcpiRsConvertAddress64,         /* 0x0A, ACPI_RESOURCE_NAME_ADDRESS64 */
131     AcpiRsConvertExtAddress64,      /* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 */
132     AcpiRsConvertGpio,              /* 0x0C, ACPI_RESOURCE_NAME_GPIO */
133     AcpiRsConvertPinFunction,       /* 0x0D, ACPI_RESOURCE_NAME_PIN_FUNCTION */
134     NULL,                           /* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS - Use subtype table below */
135     AcpiRsConvertPinConfig,         /* 0x0F, ACPI_RESOURCE_NAME_PIN_CONFIG */
136     AcpiRsConvertPinGroup,          /* 0x10, ACPI_RESOURCE_NAME_PIN_GROUP */
137     AcpiRsConvertPinGroupFunction,  /* 0x11, ACPI_RESOURCE_NAME_PIN_GROUP_FUNCTION */
138     AcpiRsConvertPinGroupConfig,    /* 0x12, ACPI_RESOURCE_NAME_PIN_GROUP_CONFIG */
139     AcpiRsConvertClockInput,        /* 0x13, ACPI_RESOURCE_NAME_CLOCK_INPUT */
140 };
141 
142 /* Subtype table for SerialBus -- I2C, SPI, UART, and CSI2 */
143 
144 ACPI_RSCONVERT_INFO         *AcpiGbl_ConvertResourceSerialBusDispatch[] =
145 {
146     NULL,
147     AcpiRsConvertI2cSerialBus,
148     AcpiRsConvertSpiSerialBus,
149     AcpiRsConvertUartSerialBus,
150     AcpiRsConvertCsi2SerialBus
151 };
152 
153 
154 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUGGER)
155 
156 /* Dispatch table for resource dump functions */
157 
158 ACPI_RSDUMP_INFO            *AcpiGbl_DumpResourceDispatch[] =
159 {
160     AcpiRsDumpIrq,                  /* ACPI_RESOURCE_TYPE_IRQ */
161     AcpiRsDumpDma,                  /* ACPI_RESOURCE_TYPE_DMA */
162     AcpiRsDumpStartDpf,             /* ACPI_RESOURCE_TYPE_START_DEPENDENT */
163     AcpiRsDumpEndDpf,               /* ACPI_RESOURCE_TYPE_END_DEPENDENT */
164     AcpiRsDumpIo,                   /* ACPI_RESOURCE_TYPE_IO */
165     AcpiRsDumpFixedIo,              /* ACPI_RESOURCE_TYPE_FIXED_IO */
166     AcpiRsDumpVendor,               /* ACPI_RESOURCE_TYPE_VENDOR */
167     AcpiRsDumpEndTag,               /* ACPI_RESOURCE_TYPE_END_TAG */
168     AcpiRsDumpMemory24,             /* ACPI_RESOURCE_TYPE_MEMORY24 */
169     AcpiRsDumpMemory32,             /* ACPI_RESOURCE_TYPE_MEMORY32 */
170     AcpiRsDumpFixedMemory32,        /* ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
171     AcpiRsDumpAddress16,            /* ACPI_RESOURCE_TYPE_ADDRESS16 */
172     AcpiRsDumpAddress32,            /* ACPI_RESOURCE_TYPE_ADDRESS32 */
173     AcpiRsDumpAddress64,            /* ACPI_RESOURCE_TYPE_ADDRESS64 */
174     AcpiRsDumpExtAddress64,         /* ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
175     AcpiRsDumpExtIrq,               /* ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
176     AcpiRsDumpGenericReg,           /* ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
177     AcpiRsDumpGpio,                 /* ACPI_RESOURCE_TYPE_GPIO */
178     AcpiRsDumpFixedDma,             /* ACPI_RESOURCE_TYPE_FIXED_DMA */
179     NULL,                           /* ACPI_RESOURCE_TYPE_SERIAL_BUS */
180     AcpiRsDumpPinFunction,          /* ACPI_RESOURCE_TYPE_PIN_FUNCTION */
181     AcpiRsDumpPinConfig,            /* ACPI_RESOURCE_TYPE_PIN_CONFIG */
182     AcpiRsDumpPinGroup,             /* ACPI_RESOURCE_TYPE_PIN_GROUP */
183     AcpiRsDumpPinGroupFunction,     /* ACPI_RESOURCE_TYPE_PIN_GROUP_FUNCTION */
184     AcpiRsDumpPinGroupConfig,       /* ACPI_RESOURCE_TYPE_PIN_GROUP_CONFIG */
185     AcpiRsDumpClockInput,           /* ACPI_RESOURCE_TYPE_CLOCK_INPUT */
186 };
187 
188 ACPI_RSDUMP_INFO            *AcpiGbl_DumpSerialBusDispatch[] =
189 {
190     NULL,
191     AcpiRsDumpI2cSerialBus,         /* AML_RESOURCE_I2C_BUS_TYPE */
192     AcpiRsDumpSpiSerialBus,         /* AML_RESOURCE_SPI_BUS_TYPE */
193     AcpiRsDumpUartSerialBus,        /* AML_RESOURCE_UART_BUS_TYPE */
194     AcpiRsDumpCsi2SerialBus,        /* AML_RESOURCE_CSI2_BUS_TYPE */
195 };
196 #endif
197 
198 
199 /*
200  * Base sizes for external AML resource descriptors, indexed by internal type.
201  * Includes size of the descriptor header (1 byte for small descriptors,
202  * 3 bytes for large descriptors)
203  */
204 const UINT8                 AcpiGbl_AmlResourceSizes[] =
205 {
206     sizeof (AML_RESOURCE_IRQ),              /* ACPI_RESOURCE_TYPE_IRQ (optional Byte 3 always created) */
207     sizeof (AML_RESOURCE_DMA),              /* ACPI_RESOURCE_TYPE_DMA */
208     sizeof (AML_RESOURCE_START_DEPENDENT),  /* ACPI_RESOURCE_TYPE_START_DEPENDENT (optional Byte 1 always created) */
209     sizeof (AML_RESOURCE_END_DEPENDENT),    /* ACPI_RESOURCE_TYPE_END_DEPENDENT */
210     sizeof (AML_RESOURCE_IO),               /* ACPI_RESOURCE_TYPE_IO */
211     sizeof (AML_RESOURCE_FIXED_IO),         /* ACPI_RESOURCE_TYPE_FIXED_IO */
212     sizeof (AML_RESOURCE_VENDOR_SMALL),     /* ACPI_RESOURCE_TYPE_VENDOR */
213     sizeof (AML_RESOURCE_END_TAG),          /* ACPI_RESOURCE_TYPE_END_TAG */
214     sizeof (AML_RESOURCE_MEMORY24),         /* ACPI_RESOURCE_TYPE_MEMORY24 */
215     sizeof (AML_RESOURCE_MEMORY32),         /* ACPI_RESOURCE_TYPE_MEMORY32 */
216     sizeof (AML_RESOURCE_FIXED_MEMORY32),   /* ACPI_RESOURCE_TYPE_FIXED_MEMORY32 */
217     sizeof (AML_RESOURCE_ADDRESS16),        /* ACPI_RESOURCE_TYPE_ADDRESS16 */
218     sizeof (AML_RESOURCE_ADDRESS32),        /* ACPI_RESOURCE_TYPE_ADDRESS32 */
219     sizeof (AML_RESOURCE_ADDRESS64),        /* ACPI_RESOURCE_TYPE_ADDRESS64 */
220     sizeof (AML_RESOURCE_EXTENDED_ADDRESS64),/*ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 */
221     sizeof (AML_RESOURCE_EXTENDED_IRQ),     /* ACPI_RESOURCE_TYPE_EXTENDED_IRQ */
222     sizeof (AML_RESOURCE_GENERIC_REGISTER), /* ACPI_RESOURCE_TYPE_GENERIC_REGISTER */
223     sizeof (AML_RESOURCE_GPIO),             /* ACPI_RESOURCE_TYPE_GPIO */
224     sizeof (AML_RESOURCE_FIXED_DMA),        /* ACPI_RESOURCE_TYPE_FIXED_DMA */
225     sizeof (AML_RESOURCE_COMMON_SERIALBUS), /* ACPI_RESOURCE_TYPE_SERIAL_BUS */
226     sizeof (AML_RESOURCE_PIN_FUNCTION),     /* ACPI_RESOURCE_TYPE_PIN_FUNCTION */
227     sizeof (AML_RESOURCE_PIN_CONFIG),       /* ACPI_RESOURCE_TYPE_PIN_CONFIG */
228     sizeof (AML_RESOURCE_PIN_GROUP),        /* ACPI_RESOURCE_TYPE_PIN_GROUP */
229     sizeof (AML_RESOURCE_PIN_GROUP_FUNCTION), /* ACPI_RESOURCE_TYPE_PIN_GROUP_FUNCTION */
230     sizeof (AML_RESOURCE_PIN_GROUP_CONFIG), /* ACPI_RESOURCE_TYPE_PIN_GROUP_CONFIG */
231     sizeof (AML_RESOURCE_CLOCK_INPUT),      /* ACPI_RESOURCE_TYPE_CLOCK_INPUT */
232 };
233 
234 
235 const UINT8                 AcpiGbl_ResourceStructSizes[] =
236 {
237     /* Small descriptors */
238 
239     0,
240     0,
241     0,
242     0,
243     ACPI_RS_SIZE (ACPI_RESOURCE_IRQ),
244     ACPI_RS_SIZE (ACPI_RESOURCE_DMA),
245     ACPI_RS_SIZE (ACPI_RESOURCE_START_DEPENDENT),
246     ACPI_RS_SIZE_MIN,
247     ACPI_RS_SIZE (ACPI_RESOURCE_IO),
248     ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_IO),
249     ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_DMA),
250     0,
251     0,
252     0,
253     ACPI_RS_SIZE (ACPI_RESOURCE_VENDOR),
254     ACPI_RS_SIZE_MIN,
255 
256     /* Large descriptors */
257 
258     0,
259     ACPI_RS_SIZE (ACPI_RESOURCE_MEMORY24),
260     ACPI_RS_SIZE (ACPI_RESOURCE_GENERIC_REGISTER),
261     0,
262     ACPI_RS_SIZE (ACPI_RESOURCE_VENDOR),
263     ACPI_RS_SIZE (ACPI_RESOURCE_MEMORY32),
264     ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_MEMORY32),
265     ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS32),
266     ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS16),
267     ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_IRQ),
268     ACPI_RS_SIZE (ACPI_RESOURCE_ADDRESS64),
269     ACPI_RS_SIZE (ACPI_RESOURCE_EXTENDED_ADDRESS64),
270     ACPI_RS_SIZE (ACPI_RESOURCE_GPIO),
271     ACPI_RS_SIZE (ACPI_RESOURCE_PIN_FUNCTION),
272     ACPI_RS_SIZE (ACPI_RESOURCE_COMMON_SERIALBUS),
273     ACPI_RS_SIZE (ACPI_RESOURCE_PIN_CONFIG),
274     ACPI_RS_SIZE (ACPI_RESOURCE_PIN_GROUP),
275     ACPI_RS_SIZE (ACPI_RESOURCE_PIN_GROUP_FUNCTION),
276     ACPI_RS_SIZE (ACPI_RESOURCE_PIN_GROUP_CONFIG),
277     ACPI_RS_SIZE (ACPI_RESOURCE_CLOCK_INPUT),
278 };
279 
280 const UINT8                 AcpiGbl_AmlResourceSerialBusSizes[] =
281 {
282     0,
283     sizeof (AML_RESOURCE_I2C_SERIALBUS),
284     sizeof (AML_RESOURCE_SPI_SERIALBUS),
285     sizeof (AML_RESOURCE_UART_SERIALBUS),
286     sizeof (AML_RESOURCE_CSI2_SERIALBUS),
287 };
288 
289 const UINT8                 AcpiGbl_ResourceStructSerialBusSizes[] =
290 {
291     0,
292     ACPI_RS_SIZE (ACPI_RESOURCE_I2C_SERIALBUS),
293     ACPI_RS_SIZE (ACPI_RESOURCE_SPI_SERIALBUS),
294     ACPI_RS_SIZE (ACPI_RESOURCE_UART_SERIALBUS),
295     ACPI_RS_SIZE (ACPI_RESOURCE_CSI2_SERIALBUS),
296 };
297