ARM: dts: sirf: add missed chhifbg node in prima2 and atlas6 dts
[linux-2.6.git] / drivers / acpi / acpica / rscreate.c
blob65f3e1c5b5989f61bdcb03e6620cdd1a7371dba9
1 /*******************************************************************************
3 * Module Name: rscreate - Create resource lists/tables
5 ******************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2013, Intel Corp.
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
30 * NO WARRANTY
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 "accommon.h"
46 #include "acresrc.h"
47 #include "acnamesp.h"
49 #define _COMPONENT ACPI_RESOURCES
50 ACPI_MODULE_NAME("rscreate")
52 /*******************************************************************************
54 * FUNCTION: acpi_buffer_to_resource
56 * PARAMETERS: aml_buffer - Pointer to the resource byte stream
57 * aml_buffer_length - Length of the aml_buffer
58 * resource_ptr - Where the converted resource is returned
60 * RETURN: Status
62 * DESCRIPTION: Convert a raw AML buffer to a resource list
64 ******************************************************************************/
65 acpi_status
66 acpi_buffer_to_resource(u8 *aml_buffer,
67 u16 aml_buffer_length,
68 struct acpi_resource **resource_ptr)
70 acpi_status status;
71 acpi_size list_size_needed;
72 void *resource;
73 void *current_resource_ptr;
76 * Note: we allow AE_AML_NO_RESOURCE_END_TAG, since an end tag
77 * is not required here.
80 /* Get the required length for the converted resource */
82 status = acpi_rs_get_list_length(aml_buffer, aml_buffer_length,
83 &list_size_needed);
84 if (status == AE_AML_NO_RESOURCE_END_TAG) {
85 status = AE_OK;
87 if (ACPI_FAILURE(status)) {
88 return (status);
91 /* Allocate a buffer for the converted resource */
93 resource = ACPI_ALLOCATE_ZEROED(list_size_needed);
94 current_resource_ptr = resource;
95 if (!resource) {
96 return (AE_NO_MEMORY);
99 /* Perform the AML-to-Resource conversion */
101 status = acpi_ut_walk_aml_resources(NULL, aml_buffer, aml_buffer_length,
102 acpi_rs_convert_aml_to_resources,
103 &current_resource_ptr);
104 if (status == AE_AML_NO_RESOURCE_END_TAG) {
105 status = AE_OK;
107 if (ACPI_FAILURE(status)) {
108 ACPI_FREE(resource);
109 } else {
110 *resource_ptr = resource;
113 return (status);
116 /*******************************************************************************
118 * FUNCTION: acpi_rs_create_resource_list
120 * PARAMETERS: aml_buffer - Pointer to the resource byte stream
121 * output_buffer - Pointer to the user's buffer
123 * RETURN: Status: AE_OK if okay, else a valid acpi_status code
124 * If output_buffer is not large enough, output_buffer_length
125 * indicates how large output_buffer should be, else it
126 * indicates how may u8 elements of output_buffer are valid.
128 * DESCRIPTION: Takes the byte stream returned from a _CRS, _PRS control method
129 * execution and parses the stream to create a linked list
130 * of device resources.
132 ******************************************************************************/
134 acpi_status
135 acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
136 struct acpi_buffer * output_buffer)
139 acpi_status status;
140 u8 *aml_start;
141 acpi_size list_size_needed = 0;
142 u32 aml_buffer_length;
143 void *resource;
145 ACPI_FUNCTION_TRACE(rs_create_resource_list);
147 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlBuffer = %p\n", aml_buffer));
149 /* Params already validated, so we don't re-validate here */
151 aml_buffer_length = aml_buffer->buffer.length;
152 aml_start = aml_buffer->buffer.pointer;
155 * Pass the aml_buffer into a module that can calculate
156 * the buffer size needed for the linked list
158 status = acpi_rs_get_list_length(aml_start, aml_buffer_length,
159 &list_size_needed);
161 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Status=%X ListSizeNeeded=%X\n",
162 status, (u32) list_size_needed));
163 if (ACPI_FAILURE(status)) {
164 return_ACPI_STATUS(status);
167 /* Validate/Allocate/Clear caller buffer */
169 status = acpi_ut_initialize_buffer(output_buffer, list_size_needed);
170 if (ACPI_FAILURE(status)) {
171 return_ACPI_STATUS(status);
174 /* Do the conversion */
176 resource = output_buffer->pointer;
177 status = acpi_ut_walk_aml_resources(NULL, aml_start, aml_buffer_length,
178 acpi_rs_convert_aml_to_resources,
179 &resource);
180 if (ACPI_FAILURE(status)) {
181 return_ACPI_STATUS(status);
184 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
185 output_buffer->pointer, (u32) output_buffer->length));
186 return_ACPI_STATUS(AE_OK);
189 /*******************************************************************************
191 * FUNCTION: acpi_rs_create_pci_routing_table
193 * PARAMETERS: package_object - Pointer to a package containing one
194 * of more ACPI_OPERAND_OBJECTs
195 * output_buffer - Pointer to the user's buffer
197 * RETURN: Status AE_OK if okay, else a valid acpi_status code.
198 * If the output_buffer is too small, the error will be
199 * AE_BUFFER_OVERFLOW and output_buffer->Length will point
200 * to the size buffer needed.
202 * DESCRIPTION: Takes the union acpi_operand_object package and creates a
203 * linked list of PCI interrupt descriptions
205 * NOTE: It is the caller's responsibility to ensure that the start of the
206 * output buffer is aligned properly (if necessary).
208 ******************************************************************************/
210 acpi_status
211 acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
212 struct acpi_buffer *output_buffer)
214 u8 *buffer;
215 union acpi_operand_object **top_object_list;
216 union acpi_operand_object **sub_object_list;
217 union acpi_operand_object *obj_desc;
218 acpi_size buffer_size_needed = 0;
219 u32 number_of_elements;
220 u32 index;
221 struct acpi_pci_routing_table *user_prt;
222 struct acpi_namespace_node *node;
223 acpi_status status;
224 struct acpi_buffer path_buffer;
226 ACPI_FUNCTION_TRACE(rs_create_pci_routing_table);
228 /* Params already validated, so we don't re-validate here */
230 /* Get the required buffer length */
232 status = acpi_rs_get_pci_routing_table_length(package_object,
233 &buffer_size_needed);
234 if (ACPI_FAILURE(status)) {
235 return_ACPI_STATUS(status);
238 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "BufferSizeNeeded = %X\n",
239 (u32) buffer_size_needed));
241 /* Validate/Allocate/Clear caller buffer */
243 status = acpi_ut_initialize_buffer(output_buffer, buffer_size_needed);
244 if (ACPI_FAILURE(status)) {
245 return_ACPI_STATUS(status);
249 * Loop through the ACPI_INTERNAL_OBJECTS - Each object should be a
250 * package that in turn contains an u64 Address, a u8 Pin,
251 * a Name, and a u8 source_index.
253 top_object_list = package_object->package.elements;
254 number_of_elements = package_object->package.count;
255 buffer = output_buffer->pointer;
256 user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
258 for (index = 0; index < number_of_elements; index++) {
261 * Point user_prt past this current structure
263 * NOTE: On the first iteration, user_prt->Length will
264 * be zero because we cleared the return buffer earlier
266 buffer += user_prt->length;
267 user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
270 * Fill in the Length field with the information we have at this point.
271 * The minus four is to subtract the size of the u8 Source[4] member
272 * because it is added below.
274 user_prt->length = (sizeof(struct acpi_pci_routing_table) - 4);
276 /* Each sub-package must be of length 4 */
278 if ((*top_object_list)->package.count != 4) {
279 ACPI_ERROR((AE_INFO,
280 "(PRT[%u]) Need package of length 4, found length %u",
281 index, (*top_object_list)->package.count));
282 return_ACPI_STATUS(AE_AML_PACKAGE_LIMIT);
286 * Dereference the sub-package.
287 * The sub_object_list will now point to an array of the four IRQ
288 * elements: [Address, Pin, Source, source_index]
290 sub_object_list = (*top_object_list)->package.elements;
292 /* 1) First subobject: Dereference the PRT.Address */
294 obj_desc = sub_object_list[0];
295 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
296 ACPI_ERROR((AE_INFO,
297 "(PRT[%u].Address) Need Integer, found %s",
298 index,
299 acpi_ut_get_object_type_name(obj_desc)));
300 return_ACPI_STATUS(AE_BAD_DATA);
303 user_prt->address = obj_desc->integer.value;
305 /* 2) Second subobject: Dereference the PRT.Pin */
307 obj_desc = sub_object_list[1];
308 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
309 ACPI_ERROR((AE_INFO,
310 "(PRT[%u].Pin) Need Integer, found %s",
311 index,
312 acpi_ut_get_object_type_name(obj_desc)));
313 return_ACPI_STATUS(AE_BAD_DATA);
316 user_prt->pin = (u32) obj_desc->integer.value;
319 * 3) Third subobject: Dereference the PRT.source_name
320 * The name may be unresolved (slack mode), so allow a null object
322 obj_desc = sub_object_list[2];
323 if (obj_desc) {
324 switch (obj_desc->common.type) {
325 case ACPI_TYPE_LOCAL_REFERENCE:
327 if (obj_desc->reference.class !=
328 ACPI_REFCLASS_NAME) {
329 ACPI_ERROR((AE_INFO,
330 "(PRT[%u].Source) Need name, found Reference Class 0x%X",
331 index,
332 obj_desc->reference.class));
333 return_ACPI_STATUS(AE_BAD_DATA);
336 node = obj_desc->reference.node;
338 /* Use *remaining* length of the buffer as max for pathname */
340 path_buffer.length = output_buffer->length -
341 (u32) ((u8 *) user_prt->source -
342 (u8 *) output_buffer->pointer);
343 path_buffer.pointer = user_prt->source;
345 status =
346 acpi_ns_handle_to_pathname((acpi_handle)
347 node,
348 &path_buffer);
350 /* +1 to include null terminator */
352 user_prt->length +=
353 (u32) ACPI_STRLEN(user_prt->source) + 1;
354 break;
356 case ACPI_TYPE_STRING:
358 ACPI_STRCPY(user_prt->source,
359 obj_desc->string.pointer);
362 * Add to the Length field the length of the string
363 * (add 1 for terminator)
365 user_prt->length += obj_desc->string.length + 1;
366 break;
368 case ACPI_TYPE_INTEGER:
370 * If this is a number, then the Source Name is NULL, since the
371 * entire buffer was zeroed out, we can leave this alone.
373 * Add to the Length field the length of the u32 NULL
375 user_prt->length += sizeof(u32);
376 break;
378 default:
380 ACPI_ERROR((AE_INFO,
381 "(PRT[%u].Source) Need Ref/String/Integer, found %s",
382 index,
383 acpi_ut_get_object_type_name
384 (obj_desc)));
385 return_ACPI_STATUS(AE_BAD_DATA);
389 /* Now align the current length */
391 user_prt->length =
392 (u32) ACPI_ROUND_UP_TO_64BIT(user_prt->length);
394 /* 4) Fourth subobject: Dereference the PRT.source_index */
396 obj_desc = sub_object_list[3];
397 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
398 ACPI_ERROR((AE_INFO,
399 "(PRT[%u].SourceIndex) Need Integer, found %s",
400 index,
401 acpi_ut_get_object_type_name(obj_desc)));
402 return_ACPI_STATUS(AE_BAD_DATA);
405 user_prt->source_index = (u32) obj_desc->integer.value;
407 /* Point to the next union acpi_operand_object in the top level package */
409 top_object_list++;
412 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
413 output_buffer->pointer, (u32) output_buffer->length));
414 return_ACPI_STATUS(AE_OK);
417 /*******************************************************************************
419 * FUNCTION: acpi_rs_create_aml_resources
421 * PARAMETERS: linked_list_buffer - Pointer to the resource linked list
422 * output_buffer - Pointer to the user's buffer
424 * RETURN: Status AE_OK if okay, else a valid acpi_status code.
425 * If the output_buffer is too small, the error will be
426 * AE_BUFFER_OVERFLOW and output_buffer->Length will point
427 * to the size buffer needed.
429 * DESCRIPTION: Takes the linked list of device resources and
430 * creates a bytestream to be used as input for the
431 * _SRS control method.
433 ******************************************************************************/
435 acpi_status
436 acpi_rs_create_aml_resources(struct acpi_resource *linked_list_buffer,
437 struct acpi_buffer *output_buffer)
439 acpi_status status;
440 acpi_size aml_size_needed = 0;
442 ACPI_FUNCTION_TRACE(rs_create_aml_resources);
444 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "LinkedListBuffer = %p\n",
445 linked_list_buffer));
448 * Params already validated, so we don't re-validate here
450 * Pass the linked_list_buffer into a module that calculates
451 * the buffer size needed for the byte stream.
453 status = acpi_rs_get_aml_length(linked_list_buffer, &aml_size_needed);
455 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlSizeNeeded=%X, %s\n",
456 (u32)aml_size_needed, acpi_format_exception(status)));
457 if (ACPI_FAILURE(status)) {
458 return_ACPI_STATUS(status);
461 /* Validate/Allocate/Clear caller buffer */
463 status = acpi_ut_initialize_buffer(output_buffer, aml_size_needed);
464 if (ACPI_FAILURE(status)) {
465 return_ACPI_STATUS(status);
468 /* Do the conversion */
470 status =
471 acpi_rs_convert_resources_to_aml(linked_list_buffer,
472 aml_size_needed,
473 output_buffer->pointer);
474 if (ACPI_FAILURE(status)) {
475 return_ACPI_STATUS(status);
478 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
479 output_buffer->pointer, (u32) output_buffer->length));
480 return_ACPI_STATUS(AE_OK);