1bc36eafdSMike Gerdts /*******************************************************************************
2bc36eafdSMike Gerdts *
3bc36eafdSMike Gerdts * Module Name: rscreate - Create resource lists/tables
4bc36eafdSMike Gerdts *
5bc36eafdSMike Gerdts ******************************************************************************/
6bc36eafdSMike Gerdts
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi *
9*35786f68SRobert Mustacchi * 1. Copyright Notice
10*35786f68SRobert Mustacchi *
11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12bc36eafdSMike Gerdts * All rights reserved.
13bc36eafdSMike Gerdts *
14*35786f68SRobert Mustacchi * 2. License
15*35786f68SRobert Mustacchi *
16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi * property rights.
20*35786f68SRobert Mustacchi *
21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi *
28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi *
37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi * conditions are met:
39*35786f68SRobert Mustacchi *
40*35786f68SRobert Mustacchi * 3. Conditions
41*35786f68SRobert Mustacchi *
42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi *
54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi * make.
65*35786f68SRobert Mustacchi *
66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi * distribution.
71*35786f68SRobert Mustacchi *
72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi * Intel Code.
74*35786f68SRobert Mustacchi *
75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi *
80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi *
82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi *
90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi * LIMITED REMEDY.
98*35786f68SRobert Mustacchi *
99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi * such license, approval or letter.
113*35786f68SRobert Mustacchi *
114*35786f68SRobert Mustacchi *****************************************************************************
115*35786f68SRobert Mustacchi *
116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi * following license:
118*35786f68SRobert Mustacchi *
119bc36eafdSMike Gerdts * Redistribution and use in source and binary forms, with or without
120bc36eafdSMike Gerdts * modification, are permitted provided that the following conditions
121bc36eafdSMike Gerdts * are met:
122bc36eafdSMike Gerdts * 1. Redistributions of source code must retain the above copyright
123bc36eafdSMike Gerdts * notice, this list of conditions, and the following disclaimer,
124bc36eafdSMike Gerdts * without modification.
125bc36eafdSMike Gerdts * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126bc36eafdSMike Gerdts * substantially similar to the "NO WARRANTY" disclaimer below
127bc36eafdSMike Gerdts * ("Disclaimer") and any redistribution must be conditioned upon
128bc36eafdSMike Gerdts * including a substantially similar Disclaimer requirement for further
129bc36eafdSMike Gerdts * binary redistribution.
130bc36eafdSMike Gerdts * 3. Neither the names of the above-listed copyright holders nor the names
131bc36eafdSMike Gerdts * of any contributors may be used to endorse or promote products derived
132bc36eafdSMike Gerdts * from this software without specific prior written permission.
133bc36eafdSMike Gerdts *
134*35786f68SRobert Mustacchi * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135*35786f68SRobert Mustacchi * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137*35786f68SRobert Mustacchi * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi *
146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
147bc36eafdSMike Gerdts * GNU General Public License ("GPL") version 2 as published by the Free
148bc36eafdSMike Gerdts * Software Foundation.
149bc36eafdSMike Gerdts *
150*35786f68SRobert Mustacchi *****************************************************************************/
151bc36eafdSMike Gerdts
152bc36eafdSMike Gerdts #include "acpi.h"
153bc36eafdSMike Gerdts #include "accommon.h"
154bc36eafdSMike Gerdts #include "acresrc.h"
155bc36eafdSMike Gerdts #include "acnamesp.h"
156bc36eafdSMike Gerdts
157bc36eafdSMike Gerdts #define _COMPONENT ACPI_RESOURCES
158bc36eafdSMike Gerdts ACPI_MODULE_NAME ("rscreate")
159bc36eafdSMike Gerdts
160bc36eafdSMike Gerdts
161bc36eafdSMike Gerdts /*******************************************************************************
162bc36eafdSMike Gerdts *
163bc36eafdSMike Gerdts * FUNCTION: AcpiBufferToResource
164bc36eafdSMike Gerdts *
165bc36eafdSMike Gerdts * PARAMETERS: AmlBuffer - Pointer to the resource byte stream
166bc36eafdSMike Gerdts * AmlBufferLength - Length of the AmlBuffer
167bc36eafdSMike Gerdts * ResourcePtr - Where the converted resource is returned
168bc36eafdSMike Gerdts *
169bc36eafdSMike Gerdts * RETURN: Status
170bc36eafdSMike Gerdts *
171bc36eafdSMike Gerdts * DESCRIPTION: Convert a raw AML buffer to a resource list
172bc36eafdSMike Gerdts *
173bc36eafdSMike Gerdts ******************************************************************************/
174bc36eafdSMike Gerdts
175bc36eafdSMike Gerdts ACPI_STATUS
AcpiBufferToResource(UINT8 * AmlBuffer,UINT16 AmlBufferLength,ACPI_RESOURCE ** ResourcePtr)176bc36eafdSMike Gerdts AcpiBufferToResource (
177bc36eafdSMike Gerdts UINT8 *AmlBuffer,
178bc36eafdSMike Gerdts UINT16 AmlBufferLength,
179bc36eafdSMike Gerdts ACPI_RESOURCE **ResourcePtr)
180bc36eafdSMike Gerdts {
181bc36eafdSMike Gerdts ACPI_STATUS Status;
182bc36eafdSMike Gerdts ACPI_SIZE ListSizeNeeded;
183bc36eafdSMike Gerdts void *Resource;
184bc36eafdSMike Gerdts void *CurrentResourcePtr;
185bc36eafdSMike Gerdts
186bc36eafdSMike Gerdts
187bc36eafdSMike Gerdts ACPI_FUNCTION_TRACE (AcpiBufferToResource);
188bc36eafdSMike Gerdts
189bc36eafdSMike Gerdts
190bc36eafdSMike Gerdts /*
191bc36eafdSMike Gerdts * Note: we allow AE_AML_NO_RESOURCE_END_TAG, since an end tag
192bc36eafdSMike Gerdts * is not required here.
193bc36eafdSMike Gerdts */
194bc36eafdSMike Gerdts
195bc36eafdSMike Gerdts /* Get the required length for the converted resource */
196bc36eafdSMike Gerdts
197bc36eafdSMike Gerdts Status = AcpiRsGetListLength (
198bc36eafdSMike Gerdts AmlBuffer, AmlBufferLength, &ListSizeNeeded);
199bc36eafdSMike Gerdts if (Status == AE_AML_NO_RESOURCE_END_TAG)
200bc36eafdSMike Gerdts {
201bc36eafdSMike Gerdts Status = AE_OK;
202bc36eafdSMike Gerdts }
203bc36eafdSMike Gerdts if (ACPI_FAILURE (Status))
204bc36eafdSMike Gerdts {
205bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
206bc36eafdSMike Gerdts }
207bc36eafdSMike Gerdts
208bc36eafdSMike Gerdts /* Allocate a buffer for the converted resource */
209bc36eafdSMike Gerdts
210bc36eafdSMike Gerdts Resource = ACPI_ALLOCATE_ZEROED (ListSizeNeeded);
211bc36eafdSMike Gerdts CurrentResourcePtr = Resource;
212bc36eafdSMike Gerdts if (!Resource)
213bc36eafdSMike Gerdts {
214bc36eafdSMike Gerdts return_ACPI_STATUS (AE_NO_MEMORY);
215bc36eafdSMike Gerdts }
216bc36eafdSMike Gerdts
217bc36eafdSMike Gerdts /* Perform the AML-to-Resource conversion */
218bc36eafdSMike Gerdts
219bc36eafdSMike Gerdts Status = AcpiUtWalkAmlResources (NULL, AmlBuffer, AmlBufferLength,
220bc36eafdSMike Gerdts AcpiRsConvertAmlToResources, &CurrentResourcePtr);
221bc36eafdSMike Gerdts if (Status == AE_AML_NO_RESOURCE_END_TAG)
222bc36eafdSMike Gerdts {
223bc36eafdSMike Gerdts Status = AE_OK;
224bc36eafdSMike Gerdts }
225bc36eafdSMike Gerdts if (ACPI_FAILURE (Status))
226bc36eafdSMike Gerdts {
227bc36eafdSMike Gerdts ACPI_FREE (Resource);
228bc36eafdSMike Gerdts }
229bc36eafdSMike Gerdts else
230bc36eafdSMike Gerdts {
231bc36eafdSMike Gerdts *ResourcePtr = Resource;
232bc36eafdSMike Gerdts }
233bc36eafdSMike Gerdts
234bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
235bc36eafdSMike Gerdts }
236bc36eafdSMike Gerdts
ACPI_EXPORT_SYMBOL(AcpiBufferToResource)237bc36eafdSMike Gerdts ACPI_EXPORT_SYMBOL (AcpiBufferToResource)
238bc36eafdSMike Gerdts
239bc36eafdSMike Gerdts
240bc36eafdSMike Gerdts /*******************************************************************************
241bc36eafdSMike Gerdts *
242bc36eafdSMike Gerdts * FUNCTION: AcpiRsCreateResourceList
243bc36eafdSMike Gerdts *
244bc36eafdSMike Gerdts * PARAMETERS: AmlBuffer - Pointer to the resource byte stream
245bc36eafdSMike Gerdts * OutputBuffer - Pointer to the user's buffer
246bc36eafdSMike Gerdts *
247bc36eafdSMike Gerdts * RETURN: Status: AE_OK if okay, else a valid ACPI_STATUS code
248bc36eafdSMike Gerdts * If OutputBuffer is not large enough, OutputBufferLength
249bc36eafdSMike Gerdts * indicates how large OutputBuffer should be, else it
250bc36eafdSMike Gerdts * indicates how may UINT8 elements of OutputBuffer are valid.
251bc36eafdSMike Gerdts *
252bc36eafdSMike Gerdts * DESCRIPTION: Takes the byte stream returned from a _CRS, _PRS control method
253bc36eafdSMike Gerdts * execution and parses the stream to create a linked list
254bc36eafdSMike Gerdts * of device resources.
255bc36eafdSMike Gerdts *
256bc36eafdSMike Gerdts ******************************************************************************/
257bc36eafdSMike Gerdts
258bc36eafdSMike Gerdts ACPI_STATUS
259bc36eafdSMike Gerdts AcpiRsCreateResourceList (
260bc36eafdSMike Gerdts ACPI_OPERAND_OBJECT *AmlBuffer,
261bc36eafdSMike Gerdts ACPI_BUFFER *OutputBuffer)
262bc36eafdSMike Gerdts {
263bc36eafdSMike Gerdts
264bc36eafdSMike Gerdts ACPI_STATUS Status;
265bc36eafdSMike Gerdts UINT8 *AmlStart;
266bc36eafdSMike Gerdts ACPI_SIZE ListSizeNeeded = 0;
267bc36eafdSMike Gerdts UINT32 AmlBufferLength;
268bc36eafdSMike Gerdts void *Resource;
269bc36eafdSMike Gerdts
270bc36eafdSMike Gerdts
271bc36eafdSMike Gerdts ACPI_FUNCTION_TRACE (RsCreateResourceList);
272bc36eafdSMike Gerdts
273bc36eafdSMike Gerdts
274bc36eafdSMike Gerdts ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "AmlBuffer = %p\n",
275bc36eafdSMike Gerdts AmlBuffer));
276bc36eafdSMike Gerdts
277bc36eafdSMike Gerdts /* Params already validated, so we don't re-validate here */
278bc36eafdSMike Gerdts
279bc36eafdSMike Gerdts AmlBufferLength = AmlBuffer->Buffer.Length;
280bc36eafdSMike Gerdts AmlStart = AmlBuffer->Buffer.Pointer;
281bc36eafdSMike Gerdts
282bc36eafdSMike Gerdts /*
283bc36eafdSMike Gerdts * Pass the AmlBuffer into a module that can calculate
284bc36eafdSMike Gerdts * the buffer size needed for the linked list
285bc36eafdSMike Gerdts */
286bc36eafdSMike Gerdts Status = AcpiRsGetListLength (AmlStart, AmlBufferLength,
287bc36eafdSMike Gerdts &ListSizeNeeded);
288bc36eafdSMike Gerdts
289bc36eafdSMike Gerdts ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Status=%X ListSizeNeeded=%X\n",
290bc36eafdSMike Gerdts Status, (UINT32) ListSizeNeeded));
291bc36eafdSMike Gerdts if (ACPI_FAILURE (Status))
292bc36eafdSMike Gerdts {
293bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
294bc36eafdSMike Gerdts }
295bc36eafdSMike Gerdts
296bc36eafdSMike Gerdts /* Validate/Allocate/Clear caller buffer */
297bc36eafdSMike Gerdts
298bc36eafdSMike Gerdts Status = AcpiUtInitializeBuffer (OutputBuffer, ListSizeNeeded);
299bc36eafdSMike Gerdts if (ACPI_FAILURE (Status))
300bc36eafdSMike Gerdts {
301bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
302bc36eafdSMike Gerdts }
303bc36eafdSMike Gerdts
304bc36eafdSMike Gerdts /* Do the conversion */
305bc36eafdSMike Gerdts
306bc36eafdSMike Gerdts Resource = OutputBuffer->Pointer;
307bc36eafdSMike Gerdts Status = AcpiUtWalkAmlResources (NULL, AmlStart, AmlBufferLength,
308bc36eafdSMike Gerdts AcpiRsConvertAmlToResources, &Resource);
309bc36eafdSMike Gerdts if (ACPI_FAILURE (Status))
310bc36eafdSMike Gerdts {
311bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
312bc36eafdSMike Gerdts }
313bc36eafdSMike Gerdts
314bc36eafdSMike Gerdts ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
315bc36eafdSMike Gerdts OutputBuffer->Pointer, (UINT32) OutputBuffer->Length));
316bc36eafdSMike Gerdts return_ACPI_STATUS (AE_OK);
317bc36eafdSMike Gerdts }
318bc36eafdSMike Gerdts
319bc36eafdSMike Gerdts
320bc36eafdSMike Gerdts /*******************************************************************************
321bc36eafdSMike Gerdts *
322bc36eafdSMike Gerdts * FUNCTION: AcpiRsCreatePciRoutingTable
323bc36eafdSMike Gerdts *
324bc36eafdSMike Gerdts * PARAMETERS: PackageObject - Pointer to a package containing one
325bc36eafdSMike Gerdts * of more ACPI_OPERAND_OBJECTs
326bc36eafdSMike Gerdts * OutputBuffer - Pointer to the user's buffer
327bc36eafdSMike Gerdts *
328bc36eafdSMike Gerdts * RETURN: Status AE_OK if okay, else a valid ACPI_STATUS code.
329bc36eafdSMike Gerdts * If the OutputBuffer is too small, the error will be
330bc36eafdSMike Gerdts * AE_BUFFER_OVERFLOW and OutputBuffer->Length will point
331bc36eafdSMike Gerdts * to the size buffer needed.
332bc36eafdSMike Gerdts *
333bc36eafdSMike Gerdts * DESCRIPTION: Takes the ACPI_OPERAND_OBJECT package and creates a
334bc36eafdSMike Gerdts * linked list of PCI interrupt descriptions
335bc36eafdSMike Gerdts *
336bc36eafdSMike Gerdts * NOTE: It is the caller's responsibility to ensure that the start of the
337bc36eafdSMike Gerdts * output buffer is aligned properly (if necessary).
338bc36eafdSMike Gerdts *
339bc36eafdSMike Gerdts ******************************************************************************/
340bc36eafdSMike Gerdts
341bc36eafdSMike Gerdts ACPI_STATUS
AcpiRsCreatePciRoutingTable(ACPI_OPERAND_OBJECT * PackageObject,ACPI_BUFFER * OutputBuffer)342bc36eafdSMike Gerdts AcpiRsCreatePciRoutingTable (
343bc36eafdSMike Gerdts ACPI_OPERAND_OBJECT *PackageObject,
344bc36eafdSMike Gerdts ACPI_BUFFER *OutputBuffer)
345bc36eafdSMike Gerdts {
346bc36eafdSMike Gerdts UINT8 *Buffer;
347bc36eafdSMike Gerdts ACPI_OPERAND_OBJECT **TopObjectList;
348bc36eafdSMike Gerdts ACPI_OPERAND_OBJECT **SubObjectList;
349bc36eafdSMike Gerdts ACPI_OPERAND_OBJECT *ObjDesc;
350bc36eafdSMike Gerdts ACPI_SIZE BufferSizeNeeded = 0;
351bc36eafdSMike Gerdts UINT32 NumberOfElements;
352bc36eafdSMike Gerdts UINT32 Index;
353bc36eafdSMike Gerdts ACPI_PCI_ROUTING_TABLE *UserPrt;
354bc36eafdSMike Gerdts ACPI_NAMESPACE_NODE *Node;
355bc36eafdSMike Gerdts ACPI_STATUS Status;
356bc36eafdSMike Gerdts ACPI_BUFFER PathBuffer;
357bc36eafdSMike Gerdts
358bc36eafdSMike Gerdts
359bc36eafdSMike Gerdts ACPI_FUNCTION_TRACE (RsCreatePciRoutingTable);
360bc36eafdSMike Gerdts
361bc36eafdSMike Gerdts
362bc36eafdSMike Gerdts /* Params already validated, so we don't re-validate here */
363bc36eafdSMike Gerdts
364bc36eafdSMike Gerdts /* Get the required buffer length */
365bc36eafdSMike Gerdts
366bc36eafdSMike Gerdts Status = AcpiRsGetPciRoutingTableLength (
367bc36eafdSMike Gerdts PackageObject,&BufferSizeNeeded);
368bc36eafdSMike Gerdts if (ACPI_FAILURE (Status))
369bc36eafdSMike Gerdts {
370bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
371bc36eafdSMike Gerdts }
372bc36eafdSMike Gerdts
373bc36eafdSMike Gerdts ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "BufferSizeNeeded = %X\n",
374bc36eafdSMike Gerdts (UINT32) BufferSizeNeeded));
375bc36eafdSMike Gerdts
376bc36eafdSMike Gerdts /* Validate/Allocate/Clear caller buffer */
377bc36eafdSMike Gerdts
378bc36eafdSMike Gerdts Status = AcpiUtInitializeBuffer (OutputBuffer, BufferSizeNeeded);
379bc36eafdSMike Gerdts if (ACPI_FAILURE (Status))
380bc36eafdSMike Gerdts {
381bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
382bc36eafdSMike Gerdts }
383bc36eafdSMike Gerdts
384bc36eafdSMike Gerdts /*
385bc36eafdSMike Gerdts * Loop through the ACPI_INTERNAL_OBJECTS - Each object should be a
386bc36eafdSMike Gerdts * package that in turn contains an UINT64 Address, a UINT8 Pin,
387bc36eafdSMike Gerdts * a Name, and a UINT8 SourceIndex.
388bc36eafdSMike Gerdts */
389bc36eafdSMike Gerdts TopObjectList = PackageObject->Package.Elements;
390bc36eafdSMike Gerdts NumberOfElements = PackageObject->Package.Count;
391bc36eafdSMike Gerdts Buffer = OutputBuffer->Pointer;
392bc36eafdSMike Gerdts UserPrt = ACPI_CAST_PTR (ACPI_PCI_ROUTING_TABLE, Buffer);
393bc36eafdSMike Gerdts
394bc36eafdSMike Gerdts for (Index = 0; Index < NumberOfElements; Index++)
395bc36eafdSMike Gerdts {
396bc36eafdSMike Gerdts /*
397bc36eafdSMike Gerdts * Point UserPrt past this current structure
398bc36eafdSMike Gerdts *
399bc36eafdSMike Gerdts * NOTE: On the first iteration, UserPrt->Length will
400bc36eafdSMike Gerdts * be zero because we cleared the return buffer earlier
401bc36eafdSMike Gerdts */
402bc36eafdSMike Gerdts Buffer += UserPrt->Length;
403bc36eafdSMike Gerdts UserPrt = ACPI_CAST_PTR (ACPI_PCI_ROUTING_TABLE, Buffer);
404bc36eafdSMike Gerdts
405bc36eafdSMike Gerdts /*
406bc36eafdSMike Gerdts * Fill in the Length field with the information we have at this
407bc36eafdSMike Gerdts * point. The minus four is to subtract the size of the UINT8
408bc36eafdSMike Gerdts * Source[4] member because it is added below.
409bc36eafdSMike Gerdts */
410bc36eafdSMike Gerdts UserPrt->Length = (sizeof (ACPI_PCI_ROUTING_TABLE) - 4);
411bc36eafdSMike Gerdts
412bc36eafdSMike Gerdts /* Each subpackage must be of length 4 */
413bc36eafdSMike Gerdts
414bc36eafdSMike Gerdts if ((*TopObjectList)->Package.Count != 4)
415bc36eafdSMike Gerdts {
416bc36eafdSMike Gerdts ACPI_ERROR ((AE_INFO,
417bc36eafdSMike Gerdts "(PRT[%u]) Need package of length 4, found length %u",
418bc36eafdSMike Gerdts Index, (*TopObjectList)->Package.Count));
419bc36eafdSMike Gerdts return_ACPI_STATUS (AE_AML_PACKAGE_LIMIT);
420bc36eafdSMike Gerdts }
421bc36eafdSMike Gerdts
422bc36eafdSMike Gerdts /*
423bc36eafdSMike Gerdts * Dereference the subpackage.
424bc36eafdSMike Gerdts * The SubObjectList will now point to an array of the four IRQ
425bc36eafdSMike Gerdts * elements: [Address, Pin, Source, SourceIndex]
426bc36eafdSMike Gerdts */
427bc36eafdSMike Gerdts SubObjectList = (*TopObjectList)->Package.Elements;
428bc36eafdSMike Gerdts
429bc36eafdSMike Gerdts /* 1) First subobject: Dereference the PRT.Address */
430bc36eafdSMike Gerdts
431bc36eafdSMike Gerdts ObjDesc = SubObjectList[0];
432bc36eafdSMike Gerdts if (!ObjDesc || ObjDesc->Common.Type != ACPI_TYPE_INTEGER)
433bc36eafdSMike Gerdts {
434bc36eafdSMike Gerdts ACPI_ERROR ((AE_INFO,
435bc36eafdSMike Gerdts "(PRT[%u].Address) Need Integer, found %s",
436bc36eafdSMike Gerdts Index, AcpiUtGetObjectTypeName (ObjDesc)));
437bc36eafdSMike Gerdts return_ACPI_STATUS (AE_BAD_DATA);
438bc36eafdSMike Gerdts }
439bc36eafdSMike Gerdts
440bc36eafdSMike Gerdts UserPrt->Address = ObjDesc->Integer.Value;
441bc36eafdSMike Gerdts
442bc36eafdSMike Gerdts /* 2) Second subobject: Dereference the PRT.Pin */
443bc36eafdSMike Gerdts
444bc36eafdSMike Gerdts ObjDesc = SubObjectList[1];
445bc36eafdSMike Gerdts if (!ObjDesc || ObjDesc->Common.Type != ACPI_TYPE_INTEGER)
446bc36eafdSMike Gerdts {
447bc36eafdSMike Gerdts ACPI_ERROR ((AE_INFO, "(PRT[%u].Pin) Need Integer, found %s",
448bc36eafdSMike Gerdts Index, AcpiUtGetObjectTypeName (ObjDesc)));
449bc36eafdSMike Gerdts return_ACPI_STATUS (AE_BAD_DATA);
450bc36eafdSMike Gerdts }
451bc36eafdSMike Gerdts
452bc36eafdSMike Gerdts UserPrt->Pin = (UINT32) ObjDesc->Integer.Value;
453bc36eafdSMike Gerdts
454bc36eafdSMike Gerdts /*
455bc36eafdSMike Gerdts * 3) Third subobject: Dereference the PRT.SourceName
456bc36eafdSMike Gerdts * The name may be unresolved (slack mode), so allow a null object
457bc36eafdSMike Gerdts */
458bc36eafdSMike Gerdts ObjDesc = SubObjectList[2];
459bc36eafdSMike Gerdts if (ObjDesc)
460bc36eafdSMike Gerdts {
461bc36eafdSMike Gerdts switch (ObjDesc->Common.Type)
462bc36eafdSMike Gerdts {
463bc36eafdSMike Gerdts case ACPI_TYPE_LOCAL_REFERENCE:
464bc36eafdSMike Gerdts
465bc36eafdSMike Gerdts if (ObjDesc->Reference.Class != ACPI_REFCLASS_NAME)
466bc36eafdSMike Gerdts {
467bc36eafdSMike Gerdts ACPI_ERROR ((AE_INFO,
468bc36eafdSMike Gerdts "(PRT[%u].Source) Need name, found Reference Class 0x%X",
469bc36eafdSMike Gerdts Index, ObjDesc->Reference.Class));
470bc36eafdSMike Gerdts return_ACPI_STATUS (AE_BAD_DATA);
471bc36eafdSMike Gerdts }
472bc36eafdSMike Gerdts
473bc36eafdSMike Gerdts Node = ObjDesc->Reference.Node;
474bc36eafdSMike Gerdts
475bc36eafdSMike Gerdts /* Use *remaining* length of the buffer as max for pathname */
476bc36eafdSMike Gerdts
477bc36eafdSMike Gerdts PathBuffer.Length = OutputBuffer->Length -
478bc36eafdSMike Gerdts (UINT32) ((UINT8 *) UserPrt->Source -
479bc36eafdSMike Gerdts (UINT8 *) OutputBuffer->Pointer);
480bc36eafdSMike Gerdts PathBuffer.Pointer = UserPrt->Source;
481bc36eafdSMike Gerdts
482bc36eafdSMike Gerdts Status = AcpiNsHandleToPathname (
483bc36eafdSMike Gerdts (ACPI_HANDLE) Node, &PathBuffer, FALSE);
484bc36eafdSMike Gerdts
485bc36eafdSMike Gerdts /* +1 to include null terminator */
486bc36eafdSMike Gerdts
487bc36eafdSMike Gerdts UserPrt->Length += (UINT32) strlen (UserPrt->Source) + 1;
488bc36eafdSMike Gerdts break;
489bc36eafdSMike Gerdts
490bc36eafdSMike Gerdts case ACPI_TYPE_STRING:
491bc36eafdSMike Gerdts
492bc36eafdSMike Gerdts strcpy (UserPrt->Source, ObjDesc->String.Pointer);
493bc36eafdSMike Gerdts
494bc36eafdSMike Gerdts /*
495bc36eafdSMike Gerdts * Add to the Length field the length of the string
496bc36eafdSMike Gerdts * (add 1 for terminator)
497bc36eafdSMike Gerdts */
498bc36eafdSMike Gerdts UserPrt->Length += ObjDesc->String.Length + 1;
499bc36eafdSMike Gerdts break;
500bc36eafdSMike Gerdts
501bc36eafdSMike Gerdts case ACPI_TYPE_INTEGER:
502bc36eafdSMike Gerdts /*
503bc36eafdSMike Gerdts * If this is a number, then the Source Name is NULL, since
504bc36eafdSMike Gerdts * the entire buffer was zeroed out, we can leave this alone.
505bc36eafdSMike Gerdts *
506bc36eafdSMike Gerdts * Add to the Length field the length of the UINT32 NULL
507bc36eafdSMike Gerdts */
508bc36eafdSMike Gerdts UserPrt->Length += sizeof (UINT32);
509bc36eafdSMike Gerdts break;
510bc36eafdSMike Gerdts
511bc36eafdSMike Gerdts default:
512bc36eafdSMike Gerdts
513bc36eafdSMike Gerdts ACPI_ERROR ((AE_INFO,
514bc36eafdSMike Gerdts "(PRT[%u].Source) Need Ref/String/Integer, found %s",
515bc36eafdSMike Gerdts Index, AcpiUtGetObjectTypeName (ObjDesc)));
516bc36eafdSMike Gerdts return_ACPI_STATUS (AE_BAD_DATA);
517bc36eafdSMike Gerdts }
518bc36eafdSMike Gerdts }
519bc36eafdSMike Gerdts
520bc36eafdSMike Gerdts /* Now align the current length */
521bc36eafdSMike Gerdts
522bc36eafdSMike Gerdts UserPrt->Length = (UINT32) ACPI_ROUND_UP_TO_64BIT (UserPrt->Length);
523bc36eafdSMike Gerdts
524bc36eafdSMike Gerdts /* 4) Fourth subobject: Dereference the PRT.SourceIndex */
525bc36eafdSMike Gerdts
526bc36eafdSMike Gerdts ObjDesc = SubObjectList[3];
527bc36eafdSMike Gerdts if (!ObjDesc || ObjDesc->Common.Type != ACPI_TYPE_INTEGER)
528bc36eafdSMike Gerdts {
529bc36eafdSMike Gerdts ACPI_ERROR ((AE_INFO,
530bc36eafdSMike Gerdts "(PRT[%u].SourceIndex) Need Integer, found %s",
531bc36eafdSMike Gerdts Index, AcpiUtGetObjectTypeName (ObjDesc)));
532bc36eafdSMike Gerdts return_ACPI_STATUS (AE_BAD_DATA);
533bc36eafdSMike Gerdts }
534bc36eafdSMike Gerdts
535bc36eafdSMike Gerdts UserPrt->SourceIndex = (UINT32) ObjDesc->Integer.Value;
536bc36eafdSMike Gerdts
537bc36eafdSMike Gerdts /* Point to the next ACPI_OPERAND_OBJECT in the top level package */
538bc36eafdSMike Gerdts
539bc36eafdSMike Gerdts TopObjectList++;
540bc36eafdSMike Gerdts }
541bc36eafdSMike Gerdts
542bc36eafdSMike Gerdts ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
543bc36eafdSMike Gerdts OutputBuffer->Pointer, (UINT32) OutputBuffer->Length));
544bc36eafdSMike Gerdts return_ACPI_STATUS (AE_OK);
545bc36eafdSMike Gerdts }
546bc36eafdSMike Gerdts
547bc36eafdSMike Gerdts
548bc36eafdSMike Gerdts /*******************************************************************************
549bc36eafdSMike Gerdts *
550bc36eafdSMike Gerdts * FUNCTION: AcpiRsCreateAmlResources
551bc36eafdSMike Gerdts *
552bc36eafdSMike Gerdts * PARAMETERS: ResourceList - Pointer to the resource list buffer
553bc36eafdSMike Gerdts * OutputBuffer - Where the AML buffer is returned
554bc36eafdSMike Gerdts *
555bc36eafdSMike Gerdts * RETURN: Status AE_OK if okay, else a valid ACPI_STATUS code.
556bc36eafdSMike Gerdts * If the OutputBuffer is too small, the error will be
557bc36eafdSMike Gerdts * AE_BUFFER_OVERFLOW and OutputBuffer->Length will point
558bc36eafdSMike Gerdts * to the size buffer needed.
559bc36eafdSMike Gerdts *
560bc36eafdSMike Gerdts * DESCRIPTION: Converts a list of device resources to an AML bytestream
561bc36eafdSMike Gerdts * to be used as input for the _SRS control method.
562bc36eafdSMike Gerdts *
563bc36eafdSMike Gerdts ******************************************************************************/
564bc36eafdSMike Gerdts
565bc36eafdSMike Gerdts ACPI_STATUS
AcpiRsCreateAmlResources(ACPI_BUFFER * ResourceList,ACPI_BUFFER * OutputBuffer)566bc36eafdSMike Gerdts AcpiRsCreateAmlResources (
567bc36eafdSMike Gerdts ACPI_BUFFER *ResourceList,
568bc36eafdSMike Gerdts ACPI_BUFFER *OutputBuffer)
569bc36eafdSMike Gerdts {
570bc36eafdSMike Gerdts ACPI_STATUS Status;
571bc36eafdSMike Gerdts ACPI_SIZE AmlSizeNeeded = 0;
572bc36eafdSMike Gerdts
573bc36eafdSMike Gerdts
574bc36eafdSMike Gerdts ACPI_FUNCTION_TRACE (RsCreateAmlResources);
575bc36eafdSMike Gerdts
576bc36eafdSMike Gerdts
577bc36eafdSMike Gerdts /* Params already validated, no need to re-validate here */
578bc36eafdSMike Gerdts
579bc36eafdSMike Gerdts ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "ResourceList Buffer = %p\n",
580bc36eafdSMike Gerdts ResourceList->Pointer));
581bc36eafdSMike Gerdts
582bc36eafdSMike Gerdts /* Get the buffer size needed for the AML byte stream */
583bc36eafdSMike Gerdts
584bc36eafdSMike Gerdts Status = AcpiRsGetAmlLength (
585bc36eafdSMike Gerdts ResourceList->Pointer, ResourceList->Length, &AmlSizeNeeded);
586bc36eafdSMike Gerdts
587bc36eafdSMike Gerdts ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "AmlSizeNeeded=%X, %s\n",
588bc36eafdSMike Gerdts (UINT32) AmlSizeNeeded, AcpiFormatException (Status)));
589bc36eafdSMike Gerdts if (ACPI_FAILURE (Status))
590bc36eafdSMike Gerdts {
591bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
592bc36eafdSMike Gerdts }
593bc36eafdSMike Gerdts
594bc36eafdSMike Gerdts /* Validate/Allocate/Clear caller buffer */
595bc36eafdSMike Gerdts
596bc36eafdSMike Gerdts Status = AcpiUtInitializeBuffer (OutputBuffer, AmlSizeNeeded);
597bc36eafdSMike Gerdts if (ACPI_FAILURE (Status))
598bc36eafdSMike Gerdts {
599bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
600bc36eafdSMike Gerdts }
601bc36eafdSMike Gerdts
602bc36eafdSMike Gerdts /* Do the conversion */
603bc36eafdSMike Gerdts
604bc36eafdSMike Gerdts Status = AcpiRsConvertResourcesToAml (ResourceList->Pointer,
605bc36eafdSMike Gerdts AmlSizeNeeded, OutputBuffer->Pointer);
606bc36eafdSMike Gerdts if (ACPI_FAILURE (Status))
607bc36eafdSMike Gerdts {
608bc36eafdSMike Gerdts return_ACPI_STATUS (Status);
609bc36eafdSMike Gerdts }
610bc36eafdSMike Gerdts
611bc36eafdSMike Gerdts ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
612bc36eafdSMike Gerdts OutputBuffer->Pointer, (UINT32) OutputBuffer->Length));
613bc36eafdSMike Gerdts return_ACPI_STATUS (AE_OK);
614bc36eafdSMike Gerdts }
615