1 /*******************************************************************************
3 * Module Name: rscreate - Create resource lists/tables
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2011, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_RESOURCES
50 ACPI_MODULE_NAME("rscreate")
52 /*******************************************************************************
54 * FUNCTION: acpi_rs_create_resource_list
56 * PARAMETERS: aml_buffer - Pointer to the resource byte stream
57 * output_buffer - Pointer to the user's buffer
59 * RETURN: Status: AE_OK if okay, else a valid acpi_status code
60 * If output_buffer is not large enough, output_buffer_length
61 * indicates how large output_buffer should be, else it
62 * indicates how may u8 elements of output_buffer are valid.
64 * DESCRIPTION: Takes the byte stream returned from a _CRS, _PRS control method
65 * execution and parses the stream to create a linked list
66 * of device resources.
68 ******************************************************************************/
71 acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
72 struct acpi_buffer * output_buffer)
77 acpi_size list_size_needed = 0;
78 u32 aml_buffer_length;
81 ACPI_FUNCTION_TRACE(rs_create_resource_list);
83 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlBuffer = %p\n", aml_buffer));
85 /* Params already validated, so we don't re-validate here */
87 aml_buffer_length = aml_buffer->buffer.length;
88 aml_start = aml_buffer->buffer.pointer;
91 * Pass the aml_buffer into a module that can calculate
92 * the buffer size needed for the linked list
94 status = acpi_rs_get_list_length(aml_start, aml_buffer_length,
97 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Status=%X ListSizeNeeded=%X\n",
98 status, (u32) list_size_needed));
99 if (ACPI_FAILURE(status)) {
100 return_ACPI_STATUS(status);
103 /* Validate/Allocate/Clear caller buffer */
105 status = acpi_ut_initialize_buffer(output_buffer, list_size_needed);
106 if (ACPI_FAILURE(status)) {
107 return_ACPI_STATUS(status);
110 /* Do the conversion */
112 resource = output_buffer->pointer;
113 status = acpi_ut_walk_aml_resources(aml_start, aml_buffer_length,
114 acpi_rs_convert_aml_to_resources,
116 if (ACPI_FAILURE(status)) {
117 return_ACPI_STATUS(status);
120 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
121 output_buffer->pointer, (u32) output_buffer->length));
122 return_ACPI_STATUS(AE_OK);
125 /*******************************************************************************
127 * FUNCTION: acpi_rs_create_pci_routing_table
129 * PARAMETERS: package_object - Pointer to a union acpi_operand_object
131 * output_buffer - Pointer to the user's buffer
133 * RETURN: Status AE_OK if okay, else a valid acpi_status code.
134 * If the output_buffer is too small, the error will be
135 * AE_BUFFER_OVERFLOW and output_buffer->Length will point
136 * to the size buffer needed.
138 * DESCRIPTION: Takes the union acpi_operand_object package and creates a
139 * linked list of PCI interrupt descriptions
141 * NOTE: It is the caller's responsibility to ensure that the start of the
142 * output buffer is aligned properly (if necessary).
144 ******************************************************************************/
147 acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
148 struct acpi_buffer *output_buffer)
151 union acpi_operand_object **top_object_list;
152 union acpi_operand_object **sub_object_list;
153 union acpi_operand_object *obj_desc;
154 acpi_size buffer_size_needed = 0;
155 u32 number_of_elements;
157 struct acpi_pci_routing_table *user_prt;
158 struct acpi_namespace_node *node;
160 struct acpi_buffer path_buffer;
162 ACPI_FUNCTION_TRACE(rs_create_pci_routing_table);
164 /* Params already validated, so we don't re-validate here */
166 /* Get the required buffer length */
168 status = acpi_rs_get_pci_routing_table_length(package_object,
169 &buffer_size_needed);
170 if (ACPI_FAILURE(status)) {
171 return_ACPI_STATUS(status);
174 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "BufferSizeNeeded = %X\n",
175 (u32) buffer_size_needed));
177 /* Validate/Allocate/Clear caller buffer */
179 status = acpi_ut_initialize_buffer(output_buffer, buffer_size_needed);
180 if (ACPI_FAILURE(status)) {
181 return_ACPI_STATUS(status);
185 * Loop through the ACPI_INTERNAL_OBJECTS - Each object should be a
186 * package that in turn contains an u64 Address, a u8 Pin,
187 * a Name, and a u8 source_index.
189 top_object_list = package_object->package.elements;
190 number_of_elements = package_object->package.count;
191 buffer = output_buffer->pointer;
192 user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
194 for (index = 0; index < number_of_elements; index++) {
197 * Point user_prt past this current structure
199 * NOTE: On the first iteration, user_prt->Length will
200 * be zero because we cleared the return buffer earlier
202 buffer += user_prt->length;
203 user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
206 * Fill in the Length field with the information we have at this point.
207 * The minus four is to subtract the size of the u8 Source[4] member
208 * because it is added below.
210 user_prt->length = (sizeof(struct acpi_pci_routing_table) - 4);
212 /* Each element of the top-level package must also be a package */
214 if ((*top_object_list)->common.type != ACPI_TYPE_PACKAGE) {
216 "(PRT[%u]) Need sub-package, found %s",
218 acpi_ut_get_object_type_name
219 (*top_object_list)));
220 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
223 /* Each sub-package must be of length 4 */
225 if ((*top_object_list)->package.count != 4) {
227 "(PRT[%u]) Need package of length 4, found length %u",
228 index, (*top_object_list)->package.count));
229 return_ACPI_STATUS(AE_AML_PACKAGE_LIMIT);
233 * Dereference the sub-package.
234 * The sub_object_list will now point to an array of the four IRQ
235 * elements: [Address, Pin, Source, source_index]
237 sub_object_list = (*top_object_list)->package.elements;
239 /* 1) First subobject: Dereference the PRT.Address */
241 obj_desc = sub_object_list[0];
242 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
244 "(PRT[%u].Address) Need Integer, found %s",
246 acpi_ut_get_object_type_name(obj_desc)));
247 return_ACPI_STATUS(AE_BAD_DATA);
250 user_prt->address = obj_desc->integer.value;
252 /* 2) Second subobject: Dereference the PRT.Pin */
254 obj_desc = sub_object_list[1];
255 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
257 "(PRT[%u].Pin) Need Integer, found %s",
259 acpi_ut_get_object_type_name(obj_desc)));
260 return_ACPI_STATUS(AE_BAD_DATA);
263 user_prt->pin = (u32) obj_desc->integer.value;
266 * If the BIOS has erroneously reversed the _PRT source_name (index 2)
267 * and the source_index (index 3), fix it. _PRT is important enough to
268 * workaround this BIOS error. This also provides compatibility with
269 * other ACPI implementations.
271 obj_desc = sub_object_list[3];
272 if (!obj_desc || (obj_desc->common.type != ACPI_TYPE_INTEGER)) {
273 sub_object_list[3] = sub_object_list[2];
274 sub_object_list[2] = obj_desc;
276 ACPI_WARNING((AE_INFO,
277 "(PRT[%X].Source) SourceName and SourceIndex are reversed, fixed",
282 * 3) Third subobject: Dereference the PRT.source_name
283 * The name may be unresolved (slack mode), so allow a null object
285 obj_desc = sub_object_list[2];
287 switch (obj_desc->common.type) {
288 case ACPI_TYPE_LOCAL_REFERENCE:
290 if (obj_desc->reference.class !=
291 ACPI_REFCLASS_NAME) {
293 "(PRT[%u].Source) Need name, found Reference Class 0x%X",
295 obj_desc->reference.class));
296 return_ACPI_STATUS(AE_BAD_DATA);
299 node = obj_desc->reference.node;
301 /* Use *remaining* length of the buffer as max for pathname */
303 path_buffer.length = output_buffer->length -
304 (u32) ((u8 *) user_prt->source -
305 (u8 *) output_buffer->pointer);
306 path_buffer.pointer = user_prt->source;
309 acpi_ns_handle_to_pathname((acpi_handle)
313 /* +1 to include null terminator */
316 (u32) ACPI_STRLEN(user_prt->source) + 1;
319 case ACPI_TYPE_STRING:
321 ACPI_STRCPY(user_prt->source,
322 obj_desc->string.pointer);
325 * Add to the Length field the length of the string
326 * (add 1 for terminator)
328 user_prt->length += obj_desc->string.length + 1;
331 case ACPI_TYPE_INTEGER:
333 * If this is a number, then the Source Name is NULL, since the
334 * entire buffer was zeroed out, we can leave this alone.
336 * Add to the Length field the length of the u32 NULL
338 user_prt->length += sizeof(u32);
344 "(PRT[%u].Source) Need Ref/String/Integer, found %s",
346 acpi_ut_get_object_type_name
348 return_ACPI_STATUS(AE_BAD_DATA);
352 /* Now align the current length */
355 (u32) ACPI_ROUND_UP_TO_64BIT(user_prt->length);
357 /* 4) Fourth subobject: Dereference the PRT.source_index */
359 obj_desc = sub_object_list[3];
360 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
362 "(PRT[%u].SourceIndex) Need Integer, found %s",
364 acpi_ut_get_object_type_name(obj_desc)));
365 return_ACPI_STATUS(AE_BAD_DATA);
368 user_prt->source_index = (u32) obj_desc->integer.value;
370 /* Point to the next union acpi_operand_object in the top level package */
375 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
376 output_buffer->pointer, (u32) output_buffer->length));
377 return_ACPI_STATUS(AE_OK);
380 /*******************************************************************************
382 * FUNCTION: acpi_rs_create_aml_resources
384 * PARAMETERS: linked_list_buffer - Pointer to the resource linked list
385 * output_buffer - Pointer to the user's buffer
387 * RETURN: Status AE_OK if okay, else a valid acpi_status code.
388 * If the output_buffer is too small, the error will be
389 * AE_BUFFER_OVERFLOW and output_buffer->Length will point
390 * to the size buffer needed.
392 * DESCRIPTION: Takes the linked list of device resources and
393 * creates a bytestream to be used as input for the
394 * _SRS control method.
396 ******************************************************************************/
399 acpi_rs_create_aml_resources(struct acpi_resource *linked_list_buffer,
400 struct acpi_buffer *output_buffer)
403 acpi_size aml_size_needed = 0;
405 ACPI_FUNCTION_TRACE(rs_create_aml_resources);
407 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "LinkedListBuffer = %p\n",
408 linked_list_buffer));
411 * Params already validated, so we don't re-validate here
413 * Pass the linked_list_buffer into a module that calculates
414 * the buffer size needed for the byte stream.
416 status = acpi_rs_get_aml_length(linked_list_buffer, &aml_size_needed);
418 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlSizeNeeded=%X, %s\n",
419 (u32) aml_size_needed,
420 acpi_format_exception(status)));
421 if (ACPI_FAILURE(status)) {
422 return_ACPI_STATUS(status);
425 /* Validate/Allocate/Clear caller buffer */
427 status = acpi_ut_initialize_buffer(output_buffer, aml_size_needed);
428 if (ACPI_FAILURE(status)) {
429 return_ACPI_STATUS(status);
432 /* Do the conversion */
435 acpi_rs_convert_resources_to_aml(linked_list_buffer,
437 output_buffer->pointer);
438 if (ACPI_FAILURE(status)) {
439 return_ACPI_STATUS(status);
442 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
443 output_buffer->pointer, (u32) output_buffer->length));
444 return_ACPI_STATUS(AE_OK);