0911526b7ad883d1dda18fc1b545c0c3f847c166
[linux-2.6.git] / drivers / acpi / resources / rscreate.c
1 /*******************************************************************************
2  *
3  * Module Name: rscreate - Create resource lists/tables
4  *
5  ******************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2005, R. Byron Moore
9  * All rights reserved.
10  *
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.
25  *
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.
29  *
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.
42  */
43
44 #include <acpi/acpi.h>
45 #include <acpi/acresrc.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acnamesp.h>
48
49 #define _COMPONENT          ACPI_RESOURCES
50 ACPI_MODULE_NAME("rscreate")
51
52 /*******************************************************************************
53  *
54  * FUNCTION:    acpi_rs_create_resource_list
55  *
56  * PARAMETERS:  byte_stream_buffer      - Pointer to the resource byte stream
57  *              output_buffer           - Pointer to the user's buffer
58  *
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.
63  *
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.
67  *
68  ******************************************************************************/
69 acpi_status
70 acpi_rs_create_resource_list(union acpi_operand_object *byte_stream_buffer,
71                              struct acpi_buffer *output_buffer)
72 {
73
74         acpi_status status;
75         u8 *byte_stream_start;
76         acpi_size list_size_needed = 0;
77         u32 byte_stream_buffer_length;
78
79         ACPI_FUNCTION_TRACE("rs_create_resource_list");
80
81         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "byte_stream_buffer = %p\n",
82                           byte_stream_buffer));
83
84         /* Params already validated, so we don't re-validate here */
85
86         byte_stream_buffer_length = byte_stream_buffer->buffer.length;
87         byte_stream_start = byte_stream_buffer->buffer.pointer;
88
89         /*
90          * Pass the byte_stream_buffer into a module that can calculate
91          * the buffer size needed for the linked list
92          */
93         status =
94             acpi_rs_get_list_length(byte_stream_start,
95                                     byte_stream_buffer_length,
96                                     &list_size_needed);
97
98         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Status=%X list_size_needed=%X\n",
99                           status, (u32) list_size_needed));
100         if (ACPI_FAILURE(status)) {
101                 return_ACPI_STATUS(status);
102         }
103
104         /* Validate/Allocate/Clear caller buffer */
105
106         status = acpi_ut_initialize_buffer(output_buffer, list_size_needed);
107         if (ACPI_FAILURE(status)) {
108                 return_ACPI_STATUS(status);
109         }
110
111         /* Do the conversion */
112
113         status =
114             acpi_rs_byte_stream_to_list(byte_stream_start,
115                                         byte_stream_buffer_length,
116                                         output_buffer->pointer);
117         if (ACPI_FAILURE(status)) {
118                 return_ACPI_STATUS(status);
119         }
120
121         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "output_buffer %p Length %X\n",
122                           output_buffer->pointer, (u32) output_buffer->length));
123         return_ACPI_STATUS(AE_OK);
124 }
125
126 /*******************************************************************************
127  *
128  * FUNCTION:    acpi_rs_create_pci_routing_table
129  *
130  * PARAMETERS:  package_object          - Pointer to an union acpi_operand_object
131  *                                        package
132  *              output_buffer           - Pointer to the user's buffer
133  *
134  * RETURN:      Status  AE_OK if okay, else a valid acpi_status code.
135  *              If the output_buffer is too small, the error will be
136  *              AE_BUFFER_OVERFLOW and output_buffer->Length will point
137  *              to the size buffer needed.
138  *
139  * DESCRIPTION: Takes the union acpi_operand_object    package and creates a
140  *              linked list of PCI interrupt descriptions
141  *
142  * NOTE: It is the caller's responsibility to ensure that the start of the
143  * output buffer is aligned properly (if necessary).
144  *
145  ******************************************************************************/
146
147 acpi_status
148 acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
149                                  struct acpi_buffer *output_buffer)
150 {
151         u8 *buffer;
152         union acpi_operand_object **top_object_list;
153         union acpi_operand_object **sub_object_list;
154         union acpi_operand_object *obj_desc;
155         acpi_size buffer_size_needed = 0;
156         u32 number_of_elements;
157         u32 index;
158         struct acpi_pci_routing_table *user_prt;
159         struct acpi_namespace_node *node;
160         acpi_status status;
161         struct acpi_buffer path_buffer;
162
163         ACPI_FUNCTION_TRACE("rs_create_pci_routing_table");
164
165         /* Params already validated, so we don't re-validate here */
166
167         /* Get the required buffer length */
168
169         status = acpi_rs_get_pci_routing_table_length(package_object,
170                                                       &buffer_size_needed);
171         if (ACPI_FAILURE(status)) {
172                 return_ACPI_STATUS(status);
173         }
174
175         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "buffer_size_needed = %X\n",
176                           (u32) buffer_size_needed));
177
178         /* Validate/Allocate/Clear caller buffer */
179
180         status = acpi_ut_initialize_buffer(output_buffer, buffer_size_needed);
181         if (ACPI_FAILURE(status)) {
182                 return_ACPI_STATUS(status);
183         }
184
185         /*
186          * Loop through the ACPI_INTERNAL_OBJECTS - Each object
187          * should be a package that in turn contains an
188          * acpi_integer Address, a u8 Pin, a Name and a u8 source_index.
189          */
190         top_object_list = package_object->package.elements;
191         number_of_elements = package_object->package.count;
192         buffer = output_buffer->pointer;
193         user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
194
195         for (index = 0; index < number_of_elements; index++) {
196                 /*
197                  * Point user_prt past this current structure
198                  *
199                  * NOTE: On the first iteration, user_prt->Length will
200                  * be zero because we cleared the return buffer earlier
201                  */
202                 buffer += user_prt->length;
203                 user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
204
205                 /*
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.
209                  */
210                 user_prt->length = (sizeof(struct acpi_pci_routing_table) - 4);
211
212                 /* Each element of the top-level package must also be a package */
213
214                 if (ACPI_GET_OBJECT_TYPE(*top_object_list) != ACPI_TYPE_PACKAGE) {
215                         ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
216                                           "(PRT[%X]) Need sub-package, found %s\n",
217                                           index,
218                                           acpi_ut_get_object_type_name
219                                           (*top_object_list)));
220                         return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
221                 }
222
223                 /* Each sub-package must be of length 4 */
224
225                 if ((*top_object_list)->package.count != 4) {
226                         ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
227                                           "(PRT[%X]) Need package of length 4, found length %d\n",
228                                           index,
229                                           (*top_object_list)->package.count));
230                         return_ACPI_STATUS(AE_AML_PACKAGE_LIMIT);
231                 }
232
233                 /*
234                  * Dereference the sub-package.
235                  * The sub_object_list will now point to an array of the four IRQ
236                  * elements: [Address, Pin, Source, source_index]
237                  */
238                 sub_object_list = (*top_object_list)->package.elements;
239
240                 /* 1) First subobject: Dereference the PRT.Address */
241
242                 obj_desc = sub_object_list[0];
243                 if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_INTEGER) {
244                         user_prt->address = obj_desc->integer.value;
245                 } else {
246                         ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
247                                           "(PRT[%X].Address) Need Integer, found %s\n",
248                                           index,
249                                           acpi_ut_get_object_type_name
250                                           (obj_desc)));
251                         return_ACPI_STATUS(AE_BAD_DATA);
252                 }
253
254                 /* 2) Second subobject: Dereference the PRT.Pin */
255
256                 obj_desc = sub_object_list[1];
257                 if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_INTEGER) {
258                         user_prt->pin = (u32) obj_desc->integer.value;
259                 } else {
260                         ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
261                                           "(PRT[%X].Pin) Need Integer, found %s\n",
262                                           index,
263                                           acpi_ut_get_object_type_name
264                                           (obj_desc)));
265                         return_ACPI_STATUS(AE_BAD_DATA);
266                 }
267
268                 /* 3) Third subobject: Dereference the PRT.source_name */
269
270                 obj_desc = sub_object_list[2];
271                 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
272                 case ACPI_TYPE_LOCAL_REFERENCE:
273
274                         if (obj_desc->reference.opcode != AML_INT_NAMEPATH_OP) {
275                                 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
276                                                   "(PRT[%X].Source) Need name, found reference op %X\n",
277                                                   index,
278                                                   obj_desc->reference.opcode));
279                                 return_ACPI_STATUS(AE_BAD_DATA);
280                         }
281
282                         node = obj_desc->reference.node;
283
284                         /* Use *remaining* length of the buffer as max for pathname */
285
286                         path_buffer.length = output_buffer->length -
287                             (u32) ((u8 *) user_prt->source -
288                                    (u8 *) output_buffer->pointer);
289                         path_buffer.pointer = user_prt->source;
290
291                         status =
292                             acpi_ns_handle_to_pathname((acpi_handle) node,
293                                                        &path_buffer);
294
295                         /* +1 to include null terminator */
296
297                         user_prt->length +=
298                             (u32) ACPI_STRLEN(user_prt->source) + 1;
299                         break;
300
301                 case ACPI_TYPE_STRING:
302
303                         ACPI_STRCPY(user_prt->source, obj_desc->string.pointer);
304
305                         /*
306                          * Add to the Length field the length of the string
307                          * (add 1 for terminator)
308                          */
309                         user_prt->length += obj_desc->string.length + 1;
310                         break;
311
312                 case ACPI_TYPE_INTEGER:
313                         /*
314                          * If this is a number, then the Source Name is NULL, since the
315                          * entire buffer was zeroed out, we can leave this alone.
316                          *
317                          * Add to the Length field the length of the u32 NULL
318                          */
319                         user_prt->length += sizeof(u32);
320                         break;
321
322                 default:
323
324                         ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
325                                           "(PRT[%X].Source) Need Ref/String/Integer, found %s\n",
326                                           index,
327                                           acpi_ut_get_object_type_name
328                                           (obj_desc)));
329                         return_ACPI_STATUS(AE_BAD_DATA);
330                 }
331
332                 /* Now align the current length */
333
334                 user_prt->length =
335                     (u32) ACPI_ROUND_UP_to_64_bITS(user_prt->length);
336
337                 /* 4) Fourth subobject: Dereference the PRT.source_index */
338
339                 obj_desc = sub_object_list[3];
340                 if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_INTEGER) {
341                         user_prt->source_index = (u32) obj_desc->integer.value;
342                 } else {
343                         ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
344                                           "(PRT[%X].source_index) Need Integer, found %s\n",
345                                           index,
346                                           acpi_ut_get_object_type_name
347                                           (obj_desc)));
348                         return_ACPI_STATUS(AE_BAD_DATA);
349                 }
350
351                 /* Point to the next union acpi_operand_object in the top level package */
352
353                 top_object_list++;
354         }
355
356         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "output_buffer %p Length %X\n",
357                           output_buffer->pointer, (u32) output_buffer->length));
358         return_ACPI_STATUS(AE_OK);
359 }
360
361 /*******************************************************************************
362  *
363  * FUNCTION:    acpi_rs_create_byte_stream
364  *
365  * PARAMETERS:  linked_list_buffer      - Pointer to the resource linked list
366  *              output_buffer           - Pointer to the user's buffer
367  *
368  * RETURN:      Status  AE_OK if okay, else a valid acpi_status code.
369  *              If the output_buffer is too small, the error will be
370  *              AE_BUFFER_OVERFLOW and output_buffer->Length will point
371  *              to the size buffer needed.
372  *
373  * DESCRIPTION: Takes the linked list of device resources and
374  *              creates a bytestream to be used as input for the
375  *              _SRS control method.
376  *
377  ******************************************************************************/
378
379 acpi_status
380 acpi_rs_create_byte_stream(struct acpi_resource *linked_list_buffer,
381                            struct acpi_buffer *output_buffer)
382 {
383         acpi_status status;
384         acpi_size byte_stream_size_needed = 0;
385
386         ACPI_FUNCTION_TRACE("rs_create_byte_stream");
387
388         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "linked_list_buffer = %p\n",
389                           linked_list_buffer));
390
391         /*
392          * Params already validated, so we don't re-validate here
393          *
394          * Pass the linked_list_buffer into a module that calculates
395          * the buffer size needed for the byte stream.
396          */
397         status = acpi_rs_get_byte_stream_length(linked_list_buffer,
398                                                 &byte_stream_size_needed);
399
400         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "byte_stream_size_needed=%X, %s\n",
401                           (u32) byte_stream_size_needed,
402                           acpi_format_exception(status)));
403         if (ACPI_FAILURE(status)) {
404                 return_ACPI_STATUS(status);
405         }
406
407         /* Validate/Allocate/Clear caller buffer */
408
409         status =
410             acpi_ut_initialize_buffer(output_buffer, byte_stream_size_needed);
411         if (ACPI_FAILURE(status)) {
412                 return_ACPI_STATUS(status);
413         }
414
415         /* Do the conversion */
416
417         status =
418             acpi_rs_list_to_byte_stream(linked_list_buffer,
419                                         byte_stream_size_needed,
420                                         output_buffer->pointer);
421         if (ACPI_FAILURE(status)) {
422                 return_ACPI_STATUS(status);
423         }
424
425         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "output_buffer %p Length %X\n",
426                           output_buffer->pointer, (u32) output_buffer->length));
427         return_ACPI_STATUS(AE_OK);
428 }