1 /*******************************************************************************
3 * Module Name: rslist - Linked list utilities
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
119 #include <contrib/dev/acpica/acpi.h>
120 #include <contrib/dev/acpica/acresrc.h>
122 #define _COMPONENT ACPI_RESOURCES
123 ACPI_MODULE_NAME ("rslist")
126 /* Local prototypes */
128 static ACPI_RSCONVERT_INFO *
129 AcpiRsGetConversionInfo (
133 AcpiRsValidateResourceLength (
137 /*******************************************************************************
139 * FUNCTION: AcpiRsValidateResourceLength
141 * PARAMETERS: Aml - Pointer to the AML resource descriptor
143 * RETURN: Status - AE_OK if the resource length appears valid
145 * DESCRIPTION: Validate the ResourceLength. Fixed-length descriptors must
146 * have the exact length; variable-length descriptors must be
147 * at least as long as the minimum. Certain Small descriptors
148 * can vary in size by at most one byte.
150 ******************************************************************************/
153 AcpiRsValidateResourceLength (
156 ACPI_RESOURCE_INFO *ResourceInfo;
157 UINT16 MinimumAmlResourceLength;
158 UINT16 ResourceLength;
161 ACPI_FUNCTION_ENTRY ();
164 /* Get the size and type info about this resource descriptor */
166 ResourceInfo = AcpiRsGetResourceInfo (Aml->SmallHeader.DescriptorType);
169 return (AE_AML_INVALID_RESOURCE_TYPE);
172 ResourceLength = AcpiUtGetResourceLength (Aml);
173 MinimumAmlResourceLength = ResourceInfo->MinimumAmlResourceLength;
175 /* Validate based upon the type of resource, fixed length or variable */
177 if (ResourceInfo->LengthType == ACPI_FIXED_LENGTH)
179 /* Fixed length resource, length must match exactly */
181 if (ResourceLength != MinimumAmlResourceLength)
183 return (AE_AML_BAD_RESOURCE_LENGTH);
186 else if (ResourceInfo->LengthType == ACPI_VARIABLE_LENGTH)
188 /* Variable length resource, must be at least the minimum */
190 if (ResourceLength < MinimumAmlResourceLength)
192 return (AE_AML_BAD_RESOURCE_LENGTH);
197 /* Small variable length resource, allowed to be (Min) or (Min-1) */
199 if ((ResourceLength > MinimumAmlResourceLength) ||
200 (ResourceLength < (MinimumAmlResourceLength - 1)))
202 return (AE_AML_BAD_RESOURCE_LENGTH);
210 /*******************************************************************************
212 * FUNCTION: AcpiRsGetConversionInfo
214 * PARAMETERS: ResourceType - Byte 0 of a resource descriptor
216 * RETURN: Pointer to the resource conversion info table
218 * DESCRIPTION: Get the conversion table associated with this resource type
220 ******************************************************************************/
222 static ACPI_RSCONVERT_INFO *
223 AcpiRsGetConversionInfo (
226 ACPI_FUNCTION_ENTRY ();
229 /* Determine if this is a small or large resource */
231 if (ResourceType & ACPI_RESOURCE_NAME_LARGE)
233 /* Large Resource Type -- bits 6:0 contain the name */
235 if (ResourceType > ACPI_RESOURCE_NAME_LARGE_MAX)
240 return (AcpiGbl_LgGetResourceDispatch [
241 (ResourceType & ACPI_RESOURCE_NAME_LARGE_MASK)]);
245 /* Small Resource Type -- bits 6:3 contain the name */
247 return (AcpiGbl_SmGetResourceDispatch [
248 ((ResourceType & ACPI_RESOURCE_NAME_SMALL_MASK) >> 3)]);
253 /*******************************************************************************
255 * FUNCTION: AcpiRsConvertAmlToResources
257 * PARAMETERS: AmlBuffer - Pointer to the resource byte stream
258 * AmlBufferLength - Length of AmlBuffer
259 * OutputBuffer - Pointer to the buffer that will
260 * contain the output structures
264 * DESCRIPTION: Takes the resource byte stream and parses it, creating a
265 * linked list of resources in the caller's output buffer
267 ******************************************************************************/
270 AcpiRsConvertAmlToResources (
272 UINT32 AmlBufferLength,
275 UINT8 *Buffer = OutputBuffer;
277 ACPI_SIZE BytesParsed = 0;
278 ACPI_RESOURCE *Resource;
279 ACPI_RSDESC_SIZE DescriptorLength;
280 ACPI_RSCONVERT_INFO *Info;
283 ACPI_FUNCTION_TRACE ("RsConvertAmlToResources");
286 /* Loop until end-of-buffer or an EndTag is found */
288 while (BytesParsed < AmlBufferLength)
290 /* Get the conversion table associated with this Descriptor Type */
292 Info = AcpiRsGetConversionInfo (*AmlBuffer);
295 /* No table indicates an invalid resource type */
297 return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
300 DescriptorLength = AcpiUtGetDescriptorLength (AmlBuffer);
303 * Perform limited validation of the resource length, based upon
304 * what we know about the resource type
306 Status = AcpiRsValidateResourceLength (
307 ACPI_CAST_PTR (AML_RESOURCE, AmlBuffer));
308 if (ACPI_FAILURE (Status))
310 return_ACPI_STATUS (Status);
313 /* Convert the AML byte stream resource to a local resource struct */
315 Status = AcpiRsConvertAmlToResource (
316 ACPI_CAST_PTR (ACPI_RESOURCE, Buffer),
317 ACPI_CAST_PTR (AML_RESOURCE, AmlBuffer),
319 if (ACPI_FAILURE (Status))
322 "Could not convert AML resource (type %X) to resource, %s\n",
323 *AmlBuffer, AcpiFormatException (Status)));
324 return_ACPI_STATUS (Status);
327 /* Set the aligned length of the new resource descriptor */
329 Resource = ACPI_CAST_PTR (ACPI_RESOURCE, Buffer);
330 Resource->Length = (UINT32) ACPI_ALIGN_RESOURCE_SIZE (Resource->Length);
332 /* Normal exit on completion of an EndTag resource descriptor */
334 if (AcpiUtGetResourceType (AmlBuffer) == ACPI_RESOURCE_NAME_END_TAG)
336 return_ACPI_STATUS (AE_OK);
339 /* Update counter and point to the next input resource */
341 BytesParsed += DescriptorLength;
342 AmlBuffer += DescriptorLength;
344 /* Point to the next structure in the output buffer */
346 Buffer += Resource->Length;
349 /* Completed buffer, but did not find an EndTag resource descriptor */
351 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
355 /*******************************************************************************
357 * FUNCTION: AcpiRsConvertResourcesToAml
359 * PARAMETERS: Resource - Pointer to the resource linked list
360 * AmlSizeNeeded - Calculated size of the byte stream
361 * needed from calling AcpiRsGetAmlLength()
362 * The size of the OutputBuffer is
363 * guaranteed to be >= AmlSizeNeeded
364 * OutputBuffer - Pointer to the buffer that will
365 * contain the byte stream
369 * DESCRIPTION: Takes the resource linked list and parses it, creating a
370 * byte stream of resources in the caller's output buffer
372 ******************************************************************************/
375 AcpiRsConvertResourcesToAml (
376 ACPI_RESOURCE *Resource,
377 ACPI_SIZE AmlSizeNeeded,
380 UINT8 *AmlBuffer = OutputBuffer;
381 UINT8 *EndAmlBuffer = OutputBuffer + AmlSizeNeeded;
385 ACPI_FUNCTION_TRACE ("RsConvertResourcesToAml");
388 /* Walk the resource descriptor list, convert each descriptor */
390 while (AmlBuffer < EndAmlBuffer)
392 /* Validate the Resource Type */
394 if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)
396 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
397 "Invalid descriptor type (%X) in resource list\n",
399 return_ACPI_STATUS (AE_BAD_DATA);
402 /* Perform the conversion */
404 Status = AcpiRsConvertResourceToAml (Resource,
405 ACPI_CAST_PTR (AML_RESOURCE, AmlBuffer),
406 AcpiGbl_SetResourceDispatch[Resource->Type]);
407 if (ACPI_FAILURE (Status))
409 ACPI_REPORT_ERROR (("Could not convert resource (type %X) to AML, %s\n",
410 Resource->Type, AcpiFormatException (Status)));
411 return_ACPI_STATUS (Status);
414 /* Perform final sanity check on the new AML resource descriptor */
416 Status = AcpiRsValidateResourceLength (
417 ACPI_CAST_PTR (AML_RESOURCE, AmlBuffer));
418 if (ACPI_FAILURE (Status))
420 return_ACPI_STATUS (Status);
423 /* Check for end-of-list, normal exit */
425 if (Resource->Type == ACPI_RESOURCE_TYPE_END_TAG)
427 /* An End Tag indicates the end of the input Resource Template */
429 return_ACPI_STATUS (AE_OK);
433 * Extract the total length of the new descriptor and set the
434 * AmlBuffer to point to the next (output) resource descriptor
436 AmlBuffer += AcpiUtGetDescriptorLength (AmlBuffer);
438 /* Point to the next input resource descriptor */
440 Resource = ACPI_PTR_ADD (ACPI_RESOURCE, Resource, Resource->Length);
442 /* Check for end-of-list, normal exit */
446 /* Completed buffer, but did not find an EndTag resource descriptor */
448 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);