1 /*******************************************************************************
2 *
3 * Module Name: rslist - Linked list utilities
4 *
5 ******************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acresrc.h"
155
156 #define _COMPONENT ACPI_RESOURCES
157 ACPI_MODULE_NAME ("rslist")
158
159
160 /*******************************************************************************
161 *
162 * FUNCTION: AcpiRsConvertAmlToResources
163 *
164 * PARAMETERS: ACPI_WALK_AML_CALLBACK
165 * ResourcePtr - Pointer to the buffer that will
166 * contain the output structures
167 *
168 * RETURN: Status
169 *
170 * DESCRIPTION: Convert an AML resource to an internal representation of the
171 * resource that is aligned and easier to access.
172 *
173 ******************************************************************************/
174
175 ACPI_STATUS
AcpiRsConvertAmlToResources(UINT8 * Aml,UINT32 Length,UINT32 Offset,UINT8 ResourceIndex,void ** Context)176 AcpiRsConvertAmlToResources (
177 UINT8 *Aml,
178 UINT32 Length,
179 UINT32 Offset,
180 UINT8 ResourceIndex,
181 void **Context)
182 {
183 ACPI_RESOURCE **ResourcePtr = ACPI_CAST_INDIRECT_PTR (
184 ACPI_RESOURCE, Context);
185 ACPI_RESOURCE *Resource;
186 AML_RESOURCE *AmlResource;
187 ACPI_RSCONVERT_INFO *ConversionTable;
188 ACPI_STATUS Status;
189
190
191 ACPI_FUNCTION_TRACE (RsConvertAmlToResources);
192
193
194 /*
195 * Check that the input buffer and all subsequent pointers into it
196 * are aligned on a native word boundary. Most important on IA64
197 */
198 Resource = *ResourcePtr;
199 if (ACPI_IS_MISALIGNED (Resource))
200 {
201 ACPI_WARNING ((AE_INFO,
202 "Misaligned resource pointer %p", Resource));
203 }
204
205 /* Get the appropriate conversion info table */
206
207 AmlResource = ACPI_CAST_PTR (AML_RESOURCE, Aml);
208
209 if (AcpiUtGetResourceType (Aml) ==
210 ACPI_RESOURCE_NAME_SERIAL_BUS)
211 {
212 /* Avoid undefined behavior: member access within misaligned address */
213
214 AML_RESOURCE_COMMON_SERIALBUS CommonSerialBus;
215 memcpy(&CommonSerialBus, AmlResource, sizeof(CommonSerialBus));
216
217 if (CommonSerialBus.Type >
218 AML_RESOURCE_MAX_SERIALBUSTYPE)
219 {
220 ConversionTable = NULL;
221 }
222 else
223 {
224 /* This is an I2C, SPI, UART, or CSI2 SerialBus descriptor */
225
226 ConversionTable = AcpiGbl_ConvertResourceSerialBusDispatch [
227 CommonSerialBus.Type];
228 }
229 }
230 else
231 {
232 ConversionTable = AcpiGbl_GetResourceDispatch[ResourceIndex];
233 }
234
235 if (!ConversionTable)
236 {
237 ACPI_ERROR ((AE_INFO,
238 "Invalid/unsupported resource descriptor: Type 0x%2.2X",
239 ResourceIndex));
240 return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
241 }
242
243 /* Convert the AML byte stream resource to a local resource struct */
244
245 Status = AcpiRsConvertAmlToResource (
246 Resource, AmlResource, ConversionTable);
247 if (ACPI_FAILURE (Status))
248 {
249 ACPI_EXCEPTION ((AE_INFO, Status,
250 "Could not convert AML resource (Type 0x%X)", *Aml));
251 return_ACPI_STATUS (Status);
252 }
253
254 if (!Resource->Length)
255 {
256 ACPI_EXCEPTION ((AE_INFO, Status,
257 "Zero-length resource returned from RsConvertAmlToResource"));
258 }
259
260 ACPI_DEBUG_PRINT ((ACPI_DB_RESOURCES,
261 "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
262 AcpiUtGetResourceType (Aml), Length,
263 Resource->Length));
264
265 /* Point to the next structure in the output buffer */
266
267 *ResourcePtr = ACPI_NEXT_RESOURCE (Resource);
268 return_ACPI_STATUS (AE_OK);
269 }
270
271
272 /*******************************************************************************
273 *
274 * FUNCTION: AcpiRsConvertResourcesToAml
275 *
276 * PARAMETERS: Resource - Pointer to the resource linked list
277 * AmlSizeNeeded - Calculated size of the byte stream
278 * needed from calling AcpiRsGetAmlLength()
279 * The size of the OutputBuffer is
280 * guaranteed to be >= AmlSizeNeeded
281 * OutputBuffer - Pointer to the buffer that will
282 * contain the byte stream
283 *
284 * RETURN: Status
285 *
286 * DESCRIPTION: Takes the resource linked list and parses it, creating a
287 * byte stream of resources in the caller's output buffer
288 *
289 ******************************************************************************/
290
291 ACPI_STATUS
AcpiRsConvertResourcesToAml(ACPI_RESOURCE * Resource,ACPI_SIZE AmlSizeNeeded,UINT8 * OutputBuffer)292 AcpiRsConvertResourcesToAml (
293 ACPI_RESOURCE *Resource,
294 ACPI_SIZE AmlSizeNeeded,
295 UINT8 *OutputBuffer)
296 {
297 UINT8 *Aml = OutputBuffer;
298 UINT8 *EndAml = OutputBuffer + AmlSizeNeeded;
299 ACPI_RSCONVERT_INFO *ConversionTable;
300 ACPI_STATUS Status;
301
302
303 ACPI_FUNCTION_TRACE (RsConvertResourcesToAml);
304
305
306 /* Walk the resource descriptor list, convert each descriptor */
307
308 while (Aml < EndAml)
309 {
310 /* Validate the (internal) Resource Type */
311
312 if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)
313 {
314 ACPI_ERROR ((AE_INFO,
315 "Invalid descriptor type (0x%X) in resource list",
316 Resource->Type));
317 return_ACPI_STATUS (AE_BAD_DATA);
318 }
319
320 /* Sanity check the length. It must not be zero, or we loop forever */
321
322 if (!Resource->Length)
323 {
324 ACPI_ERROR ((AE_INFO,
325 "Invalid zero length descriptor in resource list\n"));
326 return_ACPI_STATUS (AE_AML_BAD_RESOURCE_LENGTH);
327 }
328
329 /* Perform the conversion */
330
331 if (Resource->Type == ACPI_RESOURCE_TYPE_SERIAL_BUS)
332 {
333 if (Resource->Data.CommonSerialBus.Type >
334 AML_RESOURCE_MAX_SERIALBUSTYPE)
335 {
336 ConversionTable = NULL;
337 }
338 else
339 {
340 /* This is an I2C, SPI, UART or CSI2 SerialBus descriptor */
341
342 ConversionTable = AcpiGbl_ConvertResourceSerialBusDispatch[
343 Resource->Data.CommonSerialBus.Type];
344 }
345 }
346 else
347 {
348 ConversionTable = AcpiGbl_SetResourceDispatch[Resource->Type];
349 }
350
351 if (!ConversionTable)
352 {
353 ACPI_ERROR ((AE_INFO,
354 "Invalid/unsupported resource descriptor: Type 0x%2.2X",
355 Resource->Type));
356 return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
357 }
358
359 Status = AcpiRsConvertResourceToAml (Resource,
360 ACPI_CAST_PTR (AML_RESOURCE, Aml), ConversionTable);
361 if (ACPI_FAILURE (Status))
362 {
363 ACPI_EXCEPTION ((AE_INFO, Status,
364 "Could not convert resource (type 0x%X) to AML",
365 Resource->Type));
366 return_ACPI_STATUS (Status);
367 }
368
369 /* Perform final sanity check on the new AML resource descriptor */
370
371 Status = AcpiUtValidateResource (
372 NULL, ACPI_CAST_PTR (AML_RESOURCE, Aml), NULL);
373 if (ACPI_FAILURE (Status))
374 {
375 return_ACPI_STATUS (Status);
376 }
377
378 /* Check for end-of-list, normal exit */
379
380 if (Resource->Type == ACPI_RESOURCE_TYPE_END_TAG)
381 {
382 /* An End Tag indicates the end of the input Resource Template */
383
384 return_ACPI_STATUS (AE_OK);
385 }
386
387 /*
388 * Extract the total length of the new descriptor and set the
389 * Aml to point to the next (output) resource descriptor
390 */
391 Aml += AcpiUtGetDescriptorLength (Aml);
392
393 /* Point to the next input resource descriptor */
394
395 Resource = ACPI_NEXT_RESOURCE (Resource);
396 }
397
398 /* Completed buffer, but did not find an EndTag resource descriptor */
399
400 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
401 }
402
