rscreate.c revision 87031
1/******************************************************************************* 2 * 3 * Module Name: rscreate - Create resource lists/tables 4 * $Revision: 38 $ 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 if (ACPI_FAILURE (Status)) 182 { 183 return_ACPI_STATUS (Status); 184 } 185 186 /* 187 * Is caller buffer large enough? 188 */ 189 if (ListSizeNeeded > *OutputBufferLength) 190 { 191 *OutputBufferLength = ListSizeNeeded; 192 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 193 } 194 195 /* 196 * Zero out the return buffer before proceeding 197 */ 198 MEMSET (OutputBuffer, 0x00, *OutputBufferLength); 199 200 Status = AcpiRsByteStreamToList (ByteStreamStart, ByteStreamBufferLength, 201 &OutputBuffer); 202 if (ACPI_FAILURE (Status)) 203 { 204 return_ACPI_STATUS (Status); 205 } 206 207 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer = %p\n", OutputBuffer)); 208 *OutputBufferLength = ListSizeNeeded; 209 return_ACPI_STATUS (AE_OK); 210} 211 212 213/******************************************************************************* 214 * 215 * FUNCTION: AcpiRsCreatePciRoutingTable 216 * 217 * PARAMETERS: PackageObject - Pointer to an ACPI_OPERAND_OBJECT 218 * package 219 * OutputBuffer - Pointer to the user's buffer 220 * OutputBufferLength - Size of OutputBuffer 221 * 222 * RETURN: Status AE_OK if okay, else a valid ACPI_STATUS code. 223 * If the OutputBuffer is too small, the error will be 224 * AE_BUFFER_OVERFLOW and OutputBufferLength will point 225 * to the size buffer needed. 226 * 227 * DESCRIPTION: Takes the ACPI_OPERAND_OBJECT package and creates a 228 * linked list of PCI interrupt descriptions 229 * 230 ******************************************************************************/ 231 232ACPI_STATUS 233AcpiRsCreatePciRoutingTable ( 234 ACPI_OPERAND_OBJECT *PackageObject, 235 UINT8 *OutputBuffer, 236 UINT32 *OutputBufferLength) 237{ 238 UINT8 *Buffer = OutputBuffer; 239 ACPI_OPERAND_OBJECT **TopObjectList = NULL; 240 ACPI_OPERAND_OBJECT **SubObjectList = NULL; 241 ACPI_OPERAND_OBJECT *PackageElement = NULL; 242 UINT32 BufferSizeNeeded = 0; 243 UINT32 NumberOfElements = 0; 244 UINT32 Index = 0; 245 PCI_ROUTING_TABLE *UserPrt = NULL; 246 ACPI_NAMESPACE_NODE *Node; 247 ACPI_STATUS Status; 248 249 250 FUNCTION_TRACE ("RsCreatePciRoutingTable"); 251 252 253 /* 254 * Params already validated, so we don't re-validate here 255 */ 256 Status = AcpiRsCalculatePciRoutingTableLength (PackageObject, 257 &BufferSizeNeeded); 258 if (!ACPI_SUCCESS(Status)) 259 { 260 return_ACPI_STATUS (Status); 261 } 262 263 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "BufferSizeNeeded = %X\n", BufferSizeNeeded)); 264 265 /* Is caller buffer large enough? */ 266 267 if (BufferSizeNeeded > *OutputBufferLength) 268 { 269 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 270 } 271 *OutputBufferLength = BufferSizeNeeded; 272 273 /* 274 * Zero out the return buffer before proceeding 275 */ 276 MEMSET (OutputBuffer, 0x00, *OutputBufferLength); 277 278 /* 279 * Loop through the ACPI_INTERNAL_OBJECTS - Each object should 280 * contain a UINT32 Address, a UINT8 Pin, a Name and a UINT8 281 * SourceIndex. 282 */ 283 TopObjectList = PackageObject->Package.Elements; 284 NumberOfElements = PackageObject->Package.Count; 285 UserPrt = (PCI_ROUTING_TABLE *) Buffer; 286 287 288 Buffer = ROUND_PTR_UP_TO_8 (Buffer, UINT8); 289 290 for (Index = 0; Index < NumberOfElements; Index++) 291 { 292 /* 293 * Point UserPrt past this current structure 294 * 295 * NOTE: On the first iteration, UserPrt->Length will 296 * be zero because we cleared the return buffer earlier 297 */ 298 Buffer += UserPrt->Length; 299 UserPrt = (PCI_ROUTING_TABLE *) Buffer; 300 301 /* 302 * Fill in the Length field with the information we 303 * have at this point. 304 * The minus four is to subtract the size of the 305 * UINT8 Source[4] member because it is added below. 306 */ 307 UserPrt->Length = (sizeof (PCI_ROUTING_TABLE) -4); 308 309 /* 310 * Dereference the sub-package 311 */ 312 PackageElement = *TopObjectList; 313 314 /* 315 * The SubObjectList will now point to an array of 316 * the four IRQ elements: Address, Pin, Source and 317 * SourceIndex 318 */ 319 SubObjectList = PackageElement->Package.Elements; 320 321 /* 322 * 1) First subobject: Dereference the Address 323 */ 324 if (ACPI_TYPE_INTEGER == (*SubObjectList)->Common.Type) 325 { 326 UserPrt->Address = (*SubObjectList)->Integer.Value; 327 } 328 else 329 { 330 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Need Integer, found %s\n", 331 AcpiUtGetTypeName ((*SubObjectList)->Common.Type))); 332 return_ACPI_STATUS (AE_BAD_DATA); 333 } 334 335 /* 336 * 2) Second subobject: Dereference the Pin 337 */ 338 SubObjectList++; 339 340 if (ACPI_TYPE_INTEGER == (*SubObjectList)->Common.Type) 341 { 342 UserPrt->Pin = (UINT32) (*SubObjectList)->Integer.Value; 343 } 344 else 345 { 346 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Need Integer, found %s\n", 347 AcpiUtGetTypeName ((*SubObjectList)->Common.Type))); 348 return_ACPI_STATUS (AE_BAD_DATA); 349 } 350 351 /* 352 * 3) Third subobject: Dereference the Source Name 353 */ 354 SubObjectList++; 355 356 switch ((*SubObjectList)->Common.Type) 357 { 358 case INTERNAL_TYPE_REFERENCE: 359 360 if ((*SubObjectList)->Reference.Opcode != AML_INT_NAMEPATH_OP) 361 { 362 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Need name, found reference op %X\n", 363 (*SubObjectList)->Reference.Opcode)); 364 return_ACPI_STATUS (AE_BAD_DATA); 365 } 366 367 Node = (*SubObjectList)->Reference.Node; 368 369 /* Use *remaining* length of the buffer as max for pathname */ 370 371 BufferSizeNeeded = *OutputBufferLength - 372 (UINT32) ((UINT8 *) UserPrt->Source - OutputBuffer); 373 374 Status = AcpiNsHandleToPathname ((ACPI_HANDLE *) Node, 375 &BufferSizeNeeded, UserPrt->Source); 376 377 UserPrt->Length += STRLEN (UserPrt->Source) + 1; /* include null terminator */ 378 break; 379 380 381 case ACPI_TYPE_STRING: 382 383 STRCPY (UserPrt->Source, 384 (*SubObjectList)->String.Pointer); 385 386 /* 387 * Add to the Length field the length of the string 388 */ 389 UserPrt->Length += (*SubObjectList)->String.Length; 390 break; 391 392 393 case ACPI_TYPE_INTEGER: 394 /* 395 * If this is a number, then the Source Name 396 * is NULL, since the entire buffer was zeroed 397 * out, we can leave this alone. 398 */ 399 /* 400 * Add to the Length field the length of 401 * the UINT32 NULL 402 */ 403 UserPrt->Length += sizeof (UINT32); 404 break; 405 406 407 default: 408 409 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Need Integer, found %s\n", 410 AcpiUtGetTypeName ((*SubObjectList)->Common.Type))); 411 return_ACPI_STATUS (AE_BAD_DATA); 412 break; 413 } 414 415 /* Now align the current length */ 416 417 UserPrt->Length = ROUND_UP_TO_64BITS (UserPrt->Length); 418 419 /* 420 * 4) Fourth subobject: Dereference the Source Index 421 */ 422 SubObjectList++; 423 424 if (ACPI_TYPE_INTEGER == (*SubObjectList)->Common.Type) 425 { 426 UserPrt->SourceIndex = (UINT32) (*SubObjectList)->Integer.Value; 427 } 428 else 429 { 430 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Need Integer, found %s\n", 431 AcpiUtGetTypeName ((*SubObjectList)->Common.Type))); 432 return_ACPI_STATUS (AE_BAD_DATA); 433 } 434 435 /* 436 * Point to the next ACPI_OPERAND_OBJECT 437 */ 438 TopObjectList++; 439 } 440 441 /* 442 * Report the amount of buffer used 443 */ 444 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer = %p\n", OutputBuffer)); 445 return_ACPI_STATUS (AE_OK); 446} 447 448 449/******************************************************************************* 450 * 451 * FUNCTION: AcpiRsCreateByteStream 452 * 453 * PARAMETERS: LinkedListBuffer - Pointer to the resource linked list 454 * OutputBuffer - Pointer to the user's buffer 455 * OutputBufferLength - Size of OutputBuffer 456 * 457 * RETURN: Status AE_OK if okay, else a valid ACPI_STATUS code. 458 * If the OutputBuffer is too small, the error will be 459 * AE_BUFFER_OVERFLOW and OutputBufferLength will point 460 * to the size buffer needed. 461 * 462 * DESCRIPTION: Takes the linked list of device resources and 463 * creates a bytestream to be used as input for the 464 * _SRS control method. 465 * 466 ******************************************************************************/ 467 468ACPI_STATUS 469AcpiRsCreateByteStream ( 470 ACPI_RESOURCE *LinkedListBuffer, 471 UINT8 *OutputBuffer, 472 UINT32 *OutputBufferLength) 473{ 474 ACPI_STATUS Status; 475 UINT32 ByteStreamSizeNeeded = 0; 476 477 478 FUNCTION_TRACE ("RsCreateByteStream"); 479 480 481 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "LinkedListBuffer = %p\n", LinkedListBuffer)); 482 483 /* 484 * Params already validated, so we don't re-validate here 485 * 486 * Pass the LinkedListBuffer into a module that calculates 487 * the buffer size needed for the byte stream. 488 */ 489 Status = AcpiRsCalculateByteStreamLength (LinkedListBuffer, 490 &ByteStreamSizeNeeded); 491 492 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "ByteStreamSizeNeeded=%X, %s\n", 493 ByteStreamSizeNeeded, AcpiFormatException (Status))); 494 if (ACPI_FAILURE (Status)) 495 { 496 return_ACPI_STATUS (Status); 497 } 498 499 /* 500 * Is caller buffer large enough? 501 */ 502 if (ByteStreamSizeNeeded > *OutputBufferLength) 503 { 504 *OutputBufferLength = ByteStreamSizeNeeded; 505 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 506 } 507 508 /* 509 * Zero out the return buffer before proceeding 510 */ 511 MEMSET (OutputBuffer, 0x00, *OutputBufferLength); 512 513 Status = AcpiRsListToByteStream (LinkedListBuffer, ByteStreamSizeNeeded, 514 &OutputBuffer); 515 if (ACPI_FAILURE (Status)) 516 { 517 return_ACPI_STATUS (Status); 518 } 519 520 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer = %p\n", OutputBuffer)); 521 return_ACPI_STATUS (AE_OK); 522} 523 524