Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /******************************************************************************* |
2 | * | |
3 | * Module Name: rscreate - Create resource lists/tables | |
4 | * | |
5 | ******************************************************************************/ | |
6 | ||
7 | /* | |
75a44ce0 | 8 | * Copyright (C) 2000 - 2008, Intel Corp. |
1da177e4 LT |
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 | ||
1da177e4 LT |
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 | |
4be44fcd | 50 | ACPI_MODULE_NAME("rscreate") |
1da177e4 LT |
51 | |
52 | /******************************************************************************* | |
53 | * | |
54 | * FUNCTION: acpi_rs_create_resource_list | |
55 | * | |
50eca3eb BM |
56 | * PARAMETERS: aml_buffer - Pointer to the resource byte stream |
57 | * output_buffer - Pointer to the user's buffer | |
1da177e4 | 58 | * |
50eca3eb | 59 | * RETURN: Status: AE_OK if okay, else a valid acpi_status code |
1da177e4 LT |
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 | ******************************************************************************/ | |
1da177e4 | 69 | acpi_status |
50eca3eb | 70 | acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer, |
4be44fcd | 71 | struct acpi_buffer *output_buffer) |
1da177e4 LT |
72 | { |
73 | ||
4be44fcd | 74 | acpi_status status; |
50eca3eb | 75 | u8 *aml_start; |
4be44fcd | 76 | acpi_size list_size_needed = 0; |
50eca3eb | 77 | u32 aml_buffer_length; |
61686124 | 78 | void *resource; |
1da177e4 | 79 | |
b229cf92 | 80 | ACPI_FUNCTION_TRACE(rs_create_resource_list); |
1da177e4 | 81 | |
b229cf92 | 82 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlBuffer = %p\n", aml_buffer)); |
1da177e4 | 83 | |
44f6c012 RM |
84 | /* Params already validated, so we don't re-validate here */ |
85 | ||
50eca3eb BM |
86 | aml_buffer_length = aml_buffer->buffer.length; |
87 | aml_start = aml_buffer->buffer.pointer; | |
1da177e4 LT |
88 | |
89 | /* | |
50eca3eb | 90 | * Pass the aml_buffer into a module that can calculate |
1da177e4 LT |
91 | * the buffer size needed for the linked list |
92 | */ | |
50eca3eb BM |
93 | status = acpi_rs_get_list_length(aml_start, aml_buffer_length, |
94 | &list_size_needed); | |
4be44fcd | 95 | |
b229cf92 | 96 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Status=%X ListSizeNeeded=%X\n", |
4be44fcd LB |
97 | status, (u32) list_size_needed)); |
98 | if (ACPI_FAILURE(status)) { | |
99 | return_ACPI_STATUS(status); | |
1da177e4 LT |
100 | } |
101 | ||
102 | /* Validate/Allocate/Clear caller buffer */ | |
103 | ||
4be44fcd LB |
104 | status = acpi_ut_initialize_buffer(output_buffer, list_size_needed); |
105 | if (ACPI_FAILURE(status)) { | |
106 | return_ACPI_STATUS(status); | |
1da177e4 LT |
107 | } |
108 | ||
109 | /* Do the conversion */ | |
110 | ||
61686124 BM |
111 | resource = output_buffer->pointer; |
112 | status = acpi_ut_walk_aml_resources(aml_start, aml_buffer_length, | |
113 | acpi_rs_convert_aml_to_resources, | |
114 | &resource); | |
4be44fcd LB |
115 | if (ACPI_FAILURE(status)) { |
116 | return_ACPI_STATUS(status); | |
1da177e4 LT |
117 | } |
118 | ||
b229cf92 | 119 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n", |
4be44fcd LB |
120 | output_buffer->pointer, (u32) output_buffer->length)); |
121 | return_ACPI_STATUS(AE_OK); | |
1da177e4 LT |
122 | } |
123 | ||
1da177e4 LT |
124 | /******************************************************************************* |
125 | * | |
126 | * FUNCTION: acpi_rs_create_pci_routing_table | |
127 | * | |
128 | * PARAMETERS: package_object - Pointer to an union acpi_operand_object | |
129 | * package | |
130 | * output_buffer - Pointer to the user's buffer | |
131 | * | |
132 | * RETURN: Status AE_OK if okay, else a valid acpi_status code. | |
133 | * If the output_buffer is too small, the error will be | |
134 | * AE_BUFFER_OVERFLOW and output_buffer->Length will point | |
135 | * to the size buffer needed. | |
136 | * | |
137 | * DESCRIPTION: Takes the union acpi_operand_object package and creates a | |
138 | * linked list of PCI interrupt descriptions | |
139 | * | |
140 | * NOTE: It is the caller's responsibility to ensure that the start of the | |
141 | * output buffer is aligned properly (if necessary). | |
142 | * | |
143 | ******************************************************************************/ | |
144 | ||
145 | acpi_status | |
4be44fcd LB |
146 | acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object, |
147 | struct acpi_buffer *output_buffer) | |
1da177e4 | 148 | { |
4be44fcd LB |
149 | u8 *buffer; |
150 | union acpi_operand_object **top_object_list; | |
151 | union acpi_operand_object **sub_object_list; | |
152 | union acpi_operand_object *obj_desc; | |
153 | acpi_size buffer_size_needed = 0; | |
154 | u32 number_of_elements; | |
155 | u32 index; | |
156 | struct acpi_pci_routing_table *user_prt; | |
157 | struct acpi_namespace_node *node; | |
158 | acpi_status status; | |
159 | struct acpi_buffer path_buffer; | |
160 | ||
b229cf92 | 161 | ACPI_FUNCTION_TRACE(rs_create_pci_routing_table); |
1da177e4 LT |
162 | |
163 | /* Params already validated, so we don't re-validate here */ | |
164 | ||
44f6c012 RM |
165 | /* Get the required buffer length */ |
166 | ||
4be44fcd LB |
167 | status = acpi_rs_get_pci_routing_table_length(package_object, |
168 | &buffer_size_needed); | |
169 | if (ACPI_FAILURE(status)) { | |
170 | return_ACPI_STATUS(status); | |
1da177e4 LT |
171 | } |
172 | ||
b229cf92 | 173 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "BufferSizeNeeded = %X\n", |
4be44fcd | 174 | (u32) buffer_size_needed)); |
1da177e4 LT |
175 | |
176 | /* Validate/Allocate/Clear caller buffer */ | |
177 | ||
4be44fcd LB |
178 | status = acpi_ut_initialize_buffer(output_buffer, buffer_size_needed); |
179 | if (ACPI_FAILURE(status)) { | |
180 | return_ACPI_STATUS(status); | |
1da177e4 LT |
181 | } |
182 | ||
183 | /* | |
fd0a4327 BM |
184 | * Loop through the ACPI_INTERNAL_OBJECTS - Each object should be a |
185 | * package that in turn contains an acpi_integer Address, a u8 Pin, | |
186 | * a Name, and a u8 source_index. | |
1da177e4 | 187 | */ |
4be44fcd | 188 | top_object_list = package_object->package.elements; |
1da177e4 | 189 | number_of_elements = package_object->package.count; |
4be44fcd LB |
190 | buffer = output_buffer->pointer; |
191 | user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer); | |
1da177e4 LT |
192 | |
193 | for (index = 0; index < number_of_elements; index++) { | |
2f894ef9 SL |
194 | int source_name_index = 2; |
195 | int source_index_index = 3; | |
196 | ||
1da177e4 LT |
197 | /* |
198 | * Point user_prt past this current structure | |
199 | * | |
200 | * NOTE: On the first iteration, user_prt->Length will | |
201 | * be zero because we cleared the return buffer earlier | |
202 | */ | |
203 | buffer += user_prt->length; | |
4be44fcd | 204 | user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer); |
1da177e4 LT |
205 | |
206 | /* | |
207 | * Fill in the Length field with the information we have at this point. | |
208 | * The minus four is to subtract the size of the u8 Source[4] member | |
209 | * because it is added below. | |
210 | */ | |
4be44fcd | 211 | user_prt->length = (sizeof(struct acpi_pci_routing_table) - 4); |
1da177e4 | 212 | |
44f6c012 RM |
213 | /* Each element of the top-level package must also be a package */ |
214 | ||
4be44fcd | 215 | if (ACPI_GET_OBJECT_TYPE(*top_object_list) != ACPI_TYPE_PACKAGE) { |
b8e4d893 BM |
216 | ACPI_ERROR((AE_INFO, |
217 | "(PRT[%X]) Need sub-package, found %s", | |
218 | index, | |
219 | acpi_ut_get_object_type_name | |
220 | (*top_object_list))); | |
4be44fcd | 221 | return_ACPI_STATUS(AE_AML_OPERAND_TYPE); |
1da177e4 LT |
222 | } |
223 | ||
224 | /* Each sub-package must be of length 4 */ | |
225 | ||
226 | if ((*top_object_list)->package.count != 4) { | |
b8e4d893 BM |
227 | ACPI_ERROR((AE_INFO, |
228 | "(PRT[%X]) Need package of length 4, found length %d", | |
229 | index, (*top_object_list)->package.count)); | |
4be44fcd | 230 | return_ACPI_STATUS(AE_AML_PACKAGE_LIMIT); |
1da177e4 LT |
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 | ||
44f6c012 RM |
240 | /* 1) First subobject: Dereference the PRT.Address */ |
241 | ||
1da177e4 | 242 | obj_desc = sub_object_list[0]; |
fd0a4327 | 243 | if (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_INTEGER) { |
b8e4d893 BM |
244 | ACPI_ERROR((AE_INFO, |
245 | "(PRT[%X].Address) Need Integer, found %s", | |
246 | index, | |
247 | acpi_ut_get_object_type_name(obj_desc))); | |
4be44fcd | 248 | return_ACPI_STATUS(AE_BAD_DATA); |
1da177e4 LT |
249 | } |
250 | ||
fd0a4327 BM |
251 | user_prt->address = obj_desc->integer.value; |
252 | ||
44f6c012 RM |
253 | /* 2) Second subobject: Dereference the PRT.Pin */ |
254 | ||
1da177e4 | 255 | obj_desc = sub_object_list[1]; |
fd0a4327 | 256 | if (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_INTEGER) { |
b8e4d893 BM |
257 | ACPI_ERROR((AE_INFO, |
258 | "(PRT[%X].Pin) Need Integer, found %s", | |
259 | index, | |
260 | acpi_ut_get_object_type_name(obj_desc))); | |
4be44fcd | 261 | return_ACPI_STATUS(AE_BAD_DATA); |
1da177e4 LT |
262 | } |
263 | ||
2f894ef9 SL |
264 | /* |
265 | * If BIOS erroneously reversed the _PRT source_name and source_index, | |
266 | * then reverse them back. | |
267 | */ | |
fd350943 LB |
268 | if (ACPI_GET_OBJECT_TYPE(sub_object_list[3]) != |
269 | ACPI_TYPE_INTEGER) { | |
2f894ef9 SL |
270 | if (acpi_gbl_enable_interpreter_slack) { |
271 | source_name_index = 3; | |
272 | source_index_index = 2; | |
fd350943 LB |
273 | printk(KERN_WARNING |
274 | "ACPI: Handling Garbled _PRT entry\n"); | |
2f894ef9 SL |
275 | } else { |
276 | ACPI_ERROR((AE_INFO, | |
fd350943 LB |
277 | "(PRT[%X].source_index) Need Integer, found %s", |
278 | index, | |
279 | acpi_ut_get_object_type_name | |
280 | (sub_object_list[3]))); | |
2f894ef9 SL |
281 | return_ACPI_STATUS(AE_BAD_DATA); |
282 | } | |
283 | } | |
284 | ||
fd0a4327 BM |
285 | user_prt->pin = (u32) obj_desc->integer.value; |
286 | ||
d0e184ab BM |
287 | /* |
288 | * If the BIOS has erroneously reversed the _PRT source_name (index 2) | |
289 | * and the source_index (index 3), fix it. _PRT is important enough to | |
290 | * workaround this BIOS error. This also provides compatibility with | |
291 | * other ACPI implementations. | |
292 | */ | |
293 | obj_desc = sub_object_list[3]; | |
294 | if (!obj_desc | |
295 | || (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_INTEGER)) { | |
296 | sub_object_list[3] = sub_object_list[2]; | |
297 | sub_object_list[2] = obj_desc; | |
298 | ||
299 | ACPI_WARNING((AE_INFO, | |
300 | "(PRT[%X].Source) SourceName and SourceIndex are reversed, fixed", | |
301 | index)); | |
302 | } | |
303 | ||
b8e4d893 BM |
304 | /* |
305 | * 3) Third subobject: Dereference the PRT.source_name | |
306 | * The name may be unresolved (slack mode), so allow a null object | |
307 | */ | |
2f894ef9 | 308 | obj_desc = sub_object_list[source_name_index]; |
b8e4d893 BM |
309 | if (obj_desc) { |
310 | switch (ACPI_GET_OBJECT_TYPE(obj_desc)) { | |
311 | case ACPI_TYPE_LOCAL_REFERENCE: | |
312 | ||
313 | if (obj_desc->reference.opcode != | |
314 | AML_INT_NAMEPATH_OP) { | |
315 | ACPI_ERROR((AE_INFO, | |
316 | "(PRT[%X].Source) Need name, found reference op %X", | |
317 | index, | |
318 | obj_desc->reference. | |
319 | opcode)); | |
320 | return_ACPI_STATUS(AE_BAD_DATA); | |
321 | } | |
322 | ||
323 | node = obj_desc->reference.node; | |
324 | ||
325 | /* Use *remaining* length of the buffer as max for pathname */ | |
326 | ||
327 | path_buffer.length = output_buffer->length - | |
328 | (u32) ((u8 *) user_prt->source - | |
329 | (u8 *) output_buffer->pointer); | |
330 | path_buffer.pointer = user_prt->source; | |
331 | ||
332 | status = | |
333 | acpi_ns_handle_to_pathname((acpi_handle) | |
334 | node, | |
335 | &path_buffer); | |
336 | ||
337 | /* +1 to include null terminator */ | |
338 | ||
339 | user_prt->length += | |
340 | (u32) ACPI_STRLEN(user_prt->source) + 1; | |
341 | break; | |
342 | ||
343 | case ACPI_TYPE_STRING: | |
344 | ||
345 | ACPI_STRCPY(user_prt->source, | |
346 | obj_desc->string.pointer); | |
347 | ||
348 | /* | |
349 | * Add to the Length field the length of the string | |
350 | * (add 1 for terminator) | |
351 | */ | |
352 | user_prt->length += obj_desc->string.length + 1; | |
353 | break; | |
354 | ||
355 | case ACPI_TYPE_INTEGER: | |
356 | /* | |
357 | * If this is a number, then the Source Name is NULL, since the | |
358 | * entire buffer was zeroed out, we can leave this alone. | |
359 | * | |
360 | * Add to the Length field the length of the u32 NULL | |
361 | */ | |
362 | user_prt->length += sizeof(u32); | |
363 | break; | |
364 | ||
365 | default: | |
366 | ||
367 | ACPI_ERROR((AE_INFO, | |
368 | "(PRT[%X].Source) Need Ref/String/Integer, found %s", | |
369 | index, | |
370 | acpi_ut_get_object_type_name | |
371 | (obj_desc))); | |
4be44fcd | 372 | return_ACPI_STATUS(AE_BAD_DATA); |
1da177e4 | 373 | } |
1da177e4 LT |
374 | } |
375 | ||
376 | /* Now align the current length */ | |
377 | ||
4be44fcd | 378 | user_prt->length = |
958dd242 | 379 | (u32) ACPI_ROUND_UP_TO_64BIT(user_prt->length); |
1da177e4 | 380 | |
44f6c012 RM |
381 | /* 4) Fourth subobject: Dereference the PRT.source_index */ |
382 | ||
2f894ef9 | 383 | obj_desc = sub_object_list[source_index_index]; |
fd0a4327 | 384 | if (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_INTEGER) { |
b8e4d893 | 385 | ACPI_ERROR((AE_INFO, |
b229cf92 | 386 | "(PRT[%X].SourceIndex) Need Integer, found %s", |
b8e4d893 BM |
387 | index, |
388 | acpi_ut_get_object_type_name(obj_desc))); | |
4be44fcd | 389 | return_ACPI_STATUS(AE_BAD_DATA); |
1da177e4 LT |
390 | } |
391 | ||
fd0a4327 BM |
392 | user_prt->source_index = (u32) obj_desc->integer.value; |
393 | ||
1da177e4 LT |
394 | /* Point to the next union acpi_operand_object in the top level package */ |
395 | ||
396 | top_object_list++; | |
397 | } | |
398 | ||
b229cf92 | 399 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n", |
4be44fcd LB |
400 | output_buffer->pointer, (u32) output_buffer->length)); |
401 | return_ACPI_STATUS(AE_OK); | |
1da177e4 LT |
402 | } |
403 | ||
1da177e4 LT |
404 | /******************************************************************************* |
405 | * | |
50eca3eb | 406 | * FUNCTION: acpi_rs_create_aml_resources |
1da177e4 LT |
407 | * |
408 | * PARAMETERS: linked_list_buffer - Pointer to the resource linked list | |
409 | * output_buffer - Pointer to the user's buffer | |
410 | * | |
411 | * RETURN: Status AE_OK if okay, else a valid acpi_status code. | |
412 | * If the output_buffer is too small, the error will be | |
413 | * AE_BUFFER_OVERFLOW and output_buffer->Length will point | |
414 | * to the size buffer needed. | |
415 | * | |
416 | * DESCRIPTION: Takes the linked list of device resources and | |
417 | * creates a bytestream to be used as input for the | |
418 | * _SRS control method. | |
419 | * | |
420 | ******************************************************************************/ | |
421 | ||
422 | acpi_status | |
50eca3eb BM |
423 | acpi_rs_create_aml_resources(struct acpi_resource *linked_list_buffer, |
424 | struct acpi_buffer *output_buffer) | |
1da177e4 | 425 | { |
4be44fcd | 426 | acpi_status status; |
50eca3eb | 427 | acpi_size aml_size_needed = 0; |
1da177e4 | 428 | |
b229cf92 | 429 | ACPI_FUNCTION_TRACE(rs_create_aml_resources); |
1da177e4 | 430 | |
b229cf92 | 431 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "LinkedListBuffer = %p\n", |
4be44fcd | 432 | linked_list_buffer)); |
1da177e4 LT |
433 | |
434 | /* | |
435 | * Params already validated, so we don't re-validate here | |
436 | * | |
437 | * Pass the linked_list_buffer into a module that calculates | |
438 | * the buffer size needed for the byte stream. | |
439 | */ | |
50eca3eb | 440 | status = acpi_rs_get_aml_length(linked_list_buffer, &aml_size_needed); |
4be44fcd | 441 | |
b229cf92 | 442 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlSizeNeeded=%X, %s\n", |
50eca3eb | 443 | (u32) aml_size_needed, |
4be44fcd LB |
444 | acpi_format_exception(status))); |
445 | if (ACPI_FAILURE(status)) { | |
446 | return_ACPI_STATUS(status); | |
1da177e4 LT |
447 | } |
448 | ||
449 | /* Validate/Allocate/Clear caller buffer */ | |
450 | ||
50eca3eb | 451 | status = acpi_ut_initialize_buffer(output_buffer, aml_size_needed); |
4be44fcd LB |
452 | if (ACPI_FAILURE(status)) { |
453 | return_ACPI_STATUS(status); | |
1da177e4 LT |
454 | } |
455 | ||
456 | /* Do the conversion */ | |
457 | ||
4be44fcd | 458 | status = |
50eca3eb BM |
459 | acpi_rs_convert_resources_to_aml(linked_list_buffer, |
460 | aml_size_needed, | |
461 | output_buffer->pointer); | |
4be44fcd LB |
462 | if (ACPI_FAILURE(status)) { |
463 | return_ACPI_STATUS(status); | |
1da177e4 LT |
464 | } |
465 | ||
b229cf92 | 466 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n", |
4be44fcd LB |
467 | output_buffer->pointer, (u32) output_buffer->length)); |
468 | return_ACPI_STATUS(AE_OK); | |
1da177e4 | 469 | } |