rscreate.c revision f6a22b0bc417042e83117f52ab1a03696af185ab
1/******************************************************************************* 2 * 3 * Module Name: rscreate - Create resource lists/tables 4 * 5 ******************************************************************************/ 6 7/* 8 * Copyright (C) 2000 - 2010, 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} 445