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