rscreate.c revision 83174
1/******************************************************************************* 2 * 3 * Module Name: rscreate - Create resource lists/tables 4 * $Revision: 36 $ 5 * 6 ******************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 118#define __RSCREATE_C__ 119 120#include "acpi.h" 121#include "acresrc.h" 122#include "amlcode.h" 123#include "acnamesp.h" 124 125#define _COMPONENT ACPI_RESOURCES 126 MODULE_NAME ("rscreate") 127 128 129/******************************************************************************* 130 * 131 * FUNCTION: AcpiRsCreateResourceList 132 * 133 * PARAMETERS: ByteStreamBuffer - Pointer to the resource byte stream 134 * OutputBuffer - Pointer to the user's buffer 135 * OutputBufferLength - Pointer to the size of OutputBuffer 136 * 137 * RETURN: Status - AE_OK if okay, else a valid ACPI_STATUS code 138 * If OutputBuffer is not large enough, OutputBufferLength 139 * indicates how large OutputBuffer should be, else it 140 * indicates how may UINT8 elements of OutputBuffer are valid. 141 * 142 * DESCRIPTION: Takes the byte stream returned from a _CRS, _PRS control method 143 * execution and parses the stream to create a linked list 144 * of device resources. 145 * 146 ******************************************************************************/ 147 148ACPI_STATUS 149AcpiRsCreateResourceList ( 150 ACPI_OPERAND_OBJECT *ByteStreamBuffer, 151 UINT8 *OutputBuffer, 152 UINT32 *OutputBufferLength) 153{ 154 155 ACPI_STATUS Status; 156 UINT8 *ByteStreamStart; 157 UINT32 ListSizeNeeded = 0; 158 UINT32 ByteStreamBufferLength; 159 160 161 FUNCTION_TRACE ("RsCreateResourceList"); 162 163 164 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "ByteStreamBuffer = %p\n", ByteStreamBuffer)); 165 166 /* 167 * Params already validated, so we don't re-validate here 168 */ 169 ByteStreamBufferLength = ByteStreamBuffer->Buffer.Length; 170 ByteStreamStart = ByteStreamBuffer->Buffer.Pointer; 171 172 /* 173 * Pass the ByteStreamBuffer into a module that can calculate 174 * the buffer size needed for the linked list 175 */ 176 Status = AcpiRsCalculateListLength (ByteStreamStart, ByteStreamBufferLength, 177 &ListSizeNeeded); 178 179 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Status=%X ListSizeNeeded=%X\n", 180 Status, ListSizeNeeded)); 181 182 /* 183 * Exit with the error passed back 184 */ 185 if (ACPI_FAILURE (Status)) 186 { 187 return_ACPI_STATUS (Status); 188 } 189 190 /* 191 * If the linked list will fit into the available buffer 192 * call to fill in the list 193 */ 194 if (ListSizeNeeded <= *OutputBufferLength) 195 { 196 /* 197 * Zero out the return buffer before proceeding 198 */ 199 MEMSET (OutputBuffer, 0x00, *OutputBufferLength); 200 201 Status = AcpiRsByteStreamToList (ByteStreamStart, ByteStreamBufferLength, 202 &OutputBuffer); 203 204 /* 205 * Exit with the error passed back 206 */ 207 if (ACPI_FAILURE (Status)) 208 { 209 return_ACPI_STATUS (Status); 210 } 211 212 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer = %p\n", OutputBuffer)); 213 } 214 215 else 216 { 217 *OutputBufferLength = ListSizeNeeded; 218 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 219 } 220 221 *OutputBufferLength = ListSizeNeeded; 222 return_ACPI_STATUS (AE_OK); 223} 224 225 226/******************************************************************************* 227 * 228 * FUNCTION: AcpiRsCreatePciRoutingTable 229 * 230 * PARAMETERS: PackageObject - Pointer to an ACPI_OPERAND_OBJECT 231 * package 232 * OutputBuffer - Pointer to the user's buffer 233 * OutputBufferLength - Size of OutputBuffer 234 * 235 * RETURN: Status AE_OK if okay, else a valid ACPI_STATUS code. 236 * If the OutputBuffer is too small, the error will be 237 * AE_BUFFER_OVERFLOW and OutputBufferLength will point 238 * to the size buffer needed. 239 * 240 * DESCRIPTION: Takes the ACPI_OPERAND_OBJECT package and creates a 241 * linked list of PCI interrupt descriptions 242 * 243 ******************************************************************************/ 244 245ACPI_STATUS 246AcpiRsCreatePciRoutingTable ( 247 ACPI_OPERAND_OBJECT *PackageObject, 248 UINT8 *OutputBuffer, 249 UINT32 *OutputBufferLength) 250{ 251 UINT8 *Buffer = OutputBuffer; 252 ACPI_OPERAND_OBJECT **TopObjectList = NULL; 253 ACPI_OPERAND_OBJECT **SubObjectList = NULL; 254 ACPI_OPERAND_OBJECT *PackageElement = NULL; 255 UINT32 BufferSizeNeeded = 0; 256 UINT32 NumberOfElements = 0; 257 UINT32 Index = 0; 258 PCI_ROUTING_TABLE *UserPrt = NULL; 259 ACPI_NAMESPACE_NODE *Node; 260 ACPI_STATUS Status; 261 262 263 FUNCTION_TRACE ("RsCreatePciRoutingTable"); 264 265 266 /* 267 * Params already validated, so we don't re-validate here 268 */ 269 Status = AcpiRsCalculatePciRoutingTableLength (PackageObject, 270 &BufferSizeNeeded); 271 272 if (!ACPI_SUCCESS(Status)) 273 { 274 return_ACPI_STATUS (Status); 275 } 276 277 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "BufferSizeNeeded = %X\n", BufferSizeNeeded)); 278 279 /* 280 * If the data will fit into the available buffer 281 * call to fill in the list 282 */ 283 if (BufferSizeNeeded <= *OutputBufferLength) 284 { 285 /* 286 * Zero out the return buffer before proceeding 287 */ 288 MEMSET (OutputBuffer, 0x00, *OutputBufferLength); 289 290 /* 291 * Loop through the ACPI_INTERNAL_OBJECTS - Each object should 292 * contain a UINT32 Address, a UINT8 Pin, a Name and a UINT8 293 * SourceIndex. 294 */ 295 TopObjectList = PackageObject->Package.Elements; 296 NumberOfElements = PackageObject->Package.Count; 297 UserPrt = (PCI_ROUTING_TABLE *) Buffer; 298 299 300 Buffer = ROUND_PTR_UP_TO_8 (Buffer, UINT8); 301 302 for (Index = 0; Index < NumberOfElements; Index++) 303 { 304 /* 305 * Point UserPrt past this current structure 306 * 307 * NOTE: On the first iteration, UserPrt->Length will 308 * be zero because we cleared the return buffer earlier 309 */ 310 Buffer += UserPrt->Length; 311 UserPrt = (PCI_ROUTING_TABLE *) Buffer; 312 313 314 /* 315 * Fill in the Length field with the information we 316 * have at this point. 317 * The minus four is to subtract the size of the 318 * UINT8 Source[4] member because it is added below. 319 */ 320 UserPrt->Length = (sizeof (PCI_ROUTING_TABLE) -4); 321 322 /* 323 * Dereference the sub-package 324 */ 325 PackageElement = *TopObjectList; 326 327 /* 328 * The SubObjectList will now point to an array of 329 * the four IRQ elements: Address, Pin, Source and 330 * SourceIndex 331 */ 332 SubObjectList = PackageElement->Package.Elements; 333 334 /* 335 * 1) First subobject: Dereference the Address 336 */ 337 if (ACPI_TYPE_INTEGER == (*SubObjectList)->Common.Type) 338 { 339 UserPrt->Address = (*SubObjectList)->Integer.Value; 340 } 341 342 else 343 { 344 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Need Integer, found %s\n", 345 AcpiUtGetTypeName ((*SubObjectList)->Common.Type))); 346 return_ACPI_STATUS (AE_BAD_DATA); 347 } 348 349 /* 350 * 2) Second subobject: Dereference the Pin 351 */ 352 SubObjectList++; 353 354 if (ACPI_TYPE_INTEGER == (*SubObjectList)->Common.Type) 355 { 356 UserPrt->Pin = (UINT32) (*SubObjectList)->Integer.Value; 357 } 358 359 else 360 { 361 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Need Integer, found %s\n", 362 AcpiUtGetTypeName ((*SubObjectList)->Common.Type))); 363 return_ACPI_STATUS (AE_BAD_DATA); 364 } 365 366 /* 367 * 3) Third subobject: Dereference the Source Name 368 */ 369 SubObjectList++; 370 371 switch ((*SubObjectList)->Common.Type) 372 { 373 case INTERNAL_TYPE_REFERENCE: 374 375 if ((*SubObjectList)->Reference.Opcode != AML_INT_NAMEPATH_OP) 376 { 377 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Need name, found reference op %X\n", 378 (*SubObjectList)->Reference.Opcode)); 379 return_ACPI_STATUS (AE_BAD_DATA); 380 } 381 382 Node = (*SubObjectList)->Reference.Node; 383 384 /* TBD: use *remaining* length of the buffer! */ 385 386 Status = AcpiNsHandleToPathname ((ACPI_HANDLE *) Node, 387 OutputBufferLength, UserPrt->Source); 388 389 UserPrt->Length += STRLEN (UserPrt->Source) + 1; /* include null terminator */ 390 break; 391 392 393 case ACPI_TYPE_STRING: 394 395 STRCPY (UserPrt->Source, 396 (*SubObjectList)->String.Pointer); 397 398 /* 399 * Add to the Length field the length of the string 400 */ 401 UserPrt->Length += (*SubObjectList)->String.Length; 402 break; 403 404 405 case ACPI_TYPE_INTEGER: 406 /* 407 * If this is a number, then the Source Name 408 * is NULL, since the entire buffer was zeroed 409 * out, we can leave this alone. 410 */ 411 /* 412 * Add to the Length field the length of 413 * the UINT32 NULL 414 */ 415 UserPrt->Length += sizeof (UINT32); 416 break; 417 418 419 default: 420 421 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Need Integer, found %s\n", 422 AcpiUtGetTypeName ((*SubObjectList)->Common.Type))); 423 return_ACPI_STATUS (AE_BAD_DATA); 424 break; 425 } 426 427 /* Now align the current length */ 428 429 UserPrt->Length = ROUND_UP_TO_64BITS (UserPrt->Length); 430 431 /* 432 * 4) Fourth subobject: Dereference the Source Index 433 */ 434 SubObjectList++; 435 436 if (ACPI_TYPE_INTEGER == (*SubObjectList)->Common.Type) 437 { 438 UserPrt->SourceIndex = (UINT32) (*SubObjectList)->Integer.Value; 439 } 440 441 else 442 { 443 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Need Integer, found %s\n", 444 AcpiUtGetTypeName ((*SubObjectList)->Common.Type))); 445 return_ACPI_STATUS (AE_BAD_DATA); 446 } 447 448 /* 449 * Point to the next ACPI_OPERAND_OBJECT 450 */ 451 TopObjectList++; 452 } 453 454 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer = %p\n", OutputBuffer)); 455 } 456 457 else 458 { 459 *OutputBufferLength = BufferSizeNeeded; 460 461 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 462 } 463 464 /* 465 * Report the amount of buffer used 466 */ 467 *OutputBufferLength = BufferSizeNeeded; 468 return_ACPI_STATUS (AE_OK); 469} 470 471 472/******************************************************************************* 473 * 474 * FUNCTION: AcpiRsCreateByteStream 475 * 476 * PARAMETERS: LinkedListBuffer - Pointer to the resource linked list 477 * OutputBuffer - Pointer to the user's buffer 478 * OutputBufferLength - Size of OutputBuffer 479 * 480 * RETURN: Status AE_OK if okay, else a valid ACPI_STATUS code. 481 * If the OutputBuffer is too small, the error will be 482 * AE_BUFFER_OVERFLOW and OutputBufferLength will point 483 * to the size buffer needed. 484 * 485 * DESCRIPTION: Takes the linked list of device resources and 486 * creates a bytestream to be used as input for the 487 * _SRS control method. 488 * 489 ******************************************************************************/ 490 491ACPI_STATUS 492AcpiRsCreateByteStream ( 493 ACPI_RESOURCE *LinkedListBuffer, 494 UINT8 *OutputBuffer, 495 UINT32 *OutputBufferLength) 496{ 497 ACPI_STATUS Status; 498 UINT32 ByteStreamSizeNeeded = 0; 499 500 501 FUNCTION_TRACE ("RsCreateByteStream"); 502 503 504 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "LinkedListBuffer = %p\n", LinkedListBuffer)); 505 506 /* 507 * Params already validated, so we don't re-validate here 508 * 509 * Pass the LinkedListBuffer into a module that can calculate 510 * the buffer size needed for the byte stream. 511 */ 512 Status = AcpiRsCalculateByteStreamLength (LinkedListBuffer, 513 &ByteStreamSizeNeeded); 514 515 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "ByteStreamSizeNeeded=%X, %s\n", 516 ByteStreamSizeNeeded, AcpiFormatException (Status))); 517 518 /* 519 * Exit with the error passed back 520 */ 521 if (ACPI_FAILURE (Status)) 522 { 523 return_ACPI_STATUS (Status); 524 } 525 526 /* 527 * If the linked list will fit into the available buffer 528 * call to fill in the list 529 */ 530 if (ByteStreamSizeNeeded <= *OutputBufferLength) 531 { 532 /* 533 * Zero out the return buffer before proceeding 534 */ 535 MEMSET (OutputBuffer, 0x00, *OutputBufferLength); 536 537 Status = AcpiRsListToByteStream (LinkedListBuffer, ByteStreamSizeNeeded, 538 &OutputBuffer); 539 540 /* 541 * Exit with the error passed back 542 */ 543 if (ACPI_FAILURE (Status)) 544 { 545 return_ACPI_STATUS (Status); 546 } 547 548 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer = %p\n", OutputBuffer)); 549 } 550 551 else 552 { 553 *OutputBufferLength = ByteStreamSizeNeeded; 554 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 555 } 556 557 return_ACPI_STATUS (AE_OK); 558} 559 560