1 /*******************************************************************************
3 * Module Name: rscreate - Create resource lists/tables
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
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>
45 #include <acpi/acresrc.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acnamesp.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 ******************************************************************************/
70 acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
71 struct acpi_buffer *output_buffer)
76 acpi_size list_size_needed = 0;
77 u32 aml_buffer_length;
79 ACPI_FUNCTION_TRACE("rs_create_resource_list");
81 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "aml_buffer = %p\n", aml_buffer));
83 /* Params already validated, so we don't re-validate here */
85 aml_buffer_length = aml_buffer->buffer.length;
86 aml_start = aml_buffer->buffer.pointer;
89 * Pass the aml_buffer into a module that can calculate
90 * the buffer size needed for the linked list
92 status = acpi_rs_get_list_length(aml_start, aml_buffer_length,
95 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Status=%X list_size_needed=%X\n",
96 status, (u32) list_size_needed));
97 if (ACPI_FAILURE(status)) {
98 return_ACPI_STATUS(status);
101 /* Validate/Allocate/Clear caller buffer */
103 status = acpi_ut_initialize_buffer(output_buffer, list_size_needed);
104 if (ACPI_FAILURE(status)) {
105 return_ACPI_STATUS(status);
108 /* Do the conversion */
110 status = acpi_rs_convert_aml_to_resources(aml_start, aml_buffer_length,
111 output_buffer->pointer);
112 if (ACPI_FAILURE(status)) {
113 return_ACPI_STATUS(status);
116 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "output_buffer %p Length %X\n",
117 output_buffer->pointer, (u32) output_buffer->length));
118 return_ACPI_STATUS(AE_OK);
121 /*******************************************************************************
123 * FUNCTION: acpi_rs_create_pci_routing_table
125 * PARAMETERS: package_object - Pointer to an union acpi_operand_object
127 * output_buffer - Pointer to the user's buffer
129 * RETURN: Status AE_OK if okay, else a valid acpi_status code.
130 * If the output_buffer is too small, the error will be
131 * AE_BUFFER_OVERFLOW and output_buffer->Length will point
132 * to the size buffer needed.
134 * DESCRIPTION: Takes the union acpi_operand_object package and creates a
135 * linked list of PCI interrupt descriptions
137 * NOTE: It is the caller's responsibility to ensure that the start of the
138 * output buffer is aligned properly (if necessary).
140 ******************************************************************************/
143 acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
144 struct acpi_buffer *output_buffer)
147 union acpi_operand_object **top_object_list;
148 union acpi_operand_object **sub_object_list;
149 union acpi_operand_object *obj_desc;
150 acpi_size buffer_size_needed = 0;
151 u32 number_of_elements;
153 struct acpi_pci_routing_table *user_prt;
154 struct acpi_namespace_node *node;
156 struct acpi_buffer path_buffer;
158 ACPI_FUNCTION_TRACE("rs_create_pci_routing_table");
160 /* Params already validated, so we don't re-validate here */
162 /* Get the required buffer length */
164 status = acpi_rs_get_pci_routing_table_length(package_object,
165 &buffer_size_needed);
166 if (ACPI_FAILURE(status)) {
167 return_ACPI_STATUS(status);
170 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "buffer_size_needed = %X\n",
171 (u32) buffer_size_needed));
173 /* Validate/Allocate/Clear caller buffer */
175 status = acpi_ut_initialize_buffer(output_buffer, buffer_size_needed);
176 if (ACPI_FAILURE(status)) {
177 return_ACPI_STATUS(status);
181 * Loop through the ACPI_INTERNAL_OBJECTS - Each object
182 * should be a package that in turn contains an
183 * acpi_integer Address, a u8 Pin, a Name and a u8 source_index.
185 top_object_list = package_object->package.elements;
186 number_of_elements = package_object->package.count;
187 buffer = output_buffer->pointer;
188 user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
190 for (index = 0; index < number_of_elements; index++) {
192 * Point user_prt past this current structure
194 * NOTE: On the first iteration, user_prt->Length will
195 * be zero because we cleared the return buffer earlier
197 buffer += user_prt->length;
198 user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
201 * Fill in the Length field with the information we have at this point.
202 * The minus four is to subtract the size of the u8 Source[4] member
203 * because it is added below.
205 user_prt->length = (sizeof(struct acpi_pci_routing_table) - 4);
207 /* Each element of the top-level package must also be a package */
209 if (ACPI_GET_OBJECT_TYPE(*top_object_list) != ACPI_TYPE_PACKAGE) {
210 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
211 "(PRT[%X]) Need sub-package, found %s\n",
213 acpi_ut_get_object_type_name
214 (*top_object_list)));
215 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
218 /* Each sub-package must be of length 4 */
220 if ((*top_object_list)->package.count != 4) {
221 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
222 "(PRT[%X]) Need package of length 4, found length %d\n",
224 (*top_object_list)->package.count));
225 return_ACPI_STATUS(AE_AML_PACKAGE_LIMIT);
229 * Dereference the sub-package.
230 * The sub_object_list will now point to an array of the four IRQ
231 * elements: [Address, Pin, Source, source_index]
233 sub_object_list = (*top_object_list)->package.elements;
235 /* 1) First subobject: Dereference the PRT.Address */
237 obj_desc = sub_object_list[0];
238 if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_INTEGER) {
239 user_prt->address = obj_desc->integer.value;
241 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
242 "(PRT[%X].Address) Need Integer, found %s\n",
244 acpi_ut_get_object_type_name
246 return_ACPI_STATUS(AE_BAD_DATA);
249 /* 2) Second subobject: Dereference the PRT.Pin */
251 obj_desc = sub_object_list[1];
252 if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_INTEGER) {
253 user_prt->pin = (u32) obj_desc->integer.value;
255 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
256 "(PRT[%X].Pin) Need Integer, found %s\n",
258 acpi_ut_get_object_type_name
260 return_ACPI_STATUS(AE_BAD_DATA);
263 /* 3) Third subobject: Dereference the PRT.source_name */
265 obj_desc = sub_object_list[2];
266 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
267 case ACPI_TYPE_LOCAL_REFERENCE:
269 if (obj_desc->reference.opcode != AML_INT_NAMEPATH_OP) {
270 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
271 "(PRT[%X].Source) Need name, found reference op %X\n",
273 obj_desc->reference.opcode));
274 return_ACPI_STATUS(AE_BAD_DATA);
277 node = obj_desc->reference.node;
279 /* Use *remaining* length of the buffer as max for pathname */
281 path_buffer.length = output_buffer->length -
282 (u32) ((u8 *) user_prt->source -
283 (u8 *) output_buffer->pointer);
284 path_buffer.pointer = user_prt->source;
287 acpi_ns_handle_to_pathname((acpi_handle) node,
290 /* +1 to include null terminator */
293 (u32) ACPI_STRLEN(user_prt->source) + 1;
296 case ACPI_TYPE_STRING:
298 ACPI_STRCPY(user_prt->source, obj_desc->string.pointer);
301 * Add to the Length field the length of the string
302 * (add 1 for terminator)
304 user_prt->length += obj_desc->string.length + 1;
307 case ACPI_TYPE_INTEGER:
309 * If this is a number, then the Source Name is NULL, since the
310 * entire buffer was zeroed out, we can leave this alone.
312 * Add to the Length field the length of the u32 NULL
314 user_prt->length += sizeof(u32);
319 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
320 "(PRT[%X].Source) Need Ref/String/Integer, found %s\n",
322 acpi_ut_get_object_type_name
324 return_ACPI_STATUS(AE_BAD_DATA);
327 /* Now align the current length */
330 (u32) ACPI_ROUND_UP_to_64_bITS(user_prt->length);
332 /* 4) Fourth subobject: Dereference the PRT.source_index */
334 obj_desc = sub_object_list[3];
335 if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_INTEGER) {
336 user_prt->source_index = (u32) obj_desc->integer.value;
338 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
339 "(PRT[%X].source_index) Need Integer, found %s\n",
341 acpi_ut_get_object_type_name
343 return_ACPI_STATUS(AE_BAD_DATA);
346 /* Point to the next union acpi_operand_object in the top level package */
351 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "output_buffer %p Length %X\n",
352 output_buffer->pointer, (u32) output_buffer->length));
353 return_ACPI_STATUS(AE_OK);
356 /*******************************************************************************
358 * FUNCTION: acpi_rs_create_aml_resources
360 * PARAMETERS: linked_list_buffer - Pointer to the resource linked list
361 * output_buffer - Pointer to the user's buffer
363 * RETURN: Status AE_OK if okay, else a valid acpi_status code.
364 * If the output_buffer is too small, the error will be
365 * AE_BUFFER_OVERFLOW and output_buffer->Length will point
366 * to the size buffer needed.
368 * DESCRIPTION: Takes the linked list of device resources and
369 * creates a bytestream to be used as input for the
370 * _SRS control method.
372 ******************************************************************************/
375 acpi_rs_create_aml_resources(struct acpi_resource *linked_list_buffer,
376 struct acpi_buffer *output_buffer)
379 acpi_size aml_size_needed = 0;
381 ACPI_FUNCTION_TRACE("rs_create_aml_resources");
383 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "linked_list_buffer = %p\n",
384 linked_list_buffer));
387 * Params already validated, so we don't re-validate here
389 * Pass the linked_list_buffer into a module that calculates
390 * the buffer size needed for the byte stream.
392 status = acpi_rs_get_aml_length(linked_list_buffer, &aml_size_needed);
394 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "aml_size_needed=%X, %s\n",
395 (u32) aml_size_needed,
396 acpi_format_exception(status)));
397 if (ACPI_FAILURE(status)) {
398 return_ACPI_STATUS(status);
401 /* Validate/Allocate/Clear caller buffer */
403 status = acpi_ut_initialize_buffer(output_buffer, aml_size_needed);
404 if (ACPI_FAILURE(status)) {
405 return_ACPI_STATUS(status);
408 /* Do the conversion */
411 acpi_rs_convert_resources_to_aml(linked_list_buffer,
413 output_buffer->pointer);
414 if (ACPI_FAILURE(status)) {
415 return_ACPI_STATUS(status);
418 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "output_buffer %p Length %X\n",
419 output_buffer->pointer, (u32) output_buffer->length));
420 return_ACPI_STATUS(AE_OK);