sys/contrib/dev/acpica/rscreate.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rscreate - Create resource lists/tables
   4  *              $Revision: 64 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, 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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/rscreate.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118
 119 #define __RSCREATE_C__
 120
 121 #include "acpi.h"
 122 #include "acresrc.h"
 123 #include "amlcode.h"
 124 #include "acnamesp.h"
 125
 126 #define _COMPONENT          ACPI_RESOURCES
 127         ACPI_MODULE_NAME    ("rscreate")
 128
 129
 130 /*******************************************************************************
 131  *
 132  * FUNCTION:    AcpiRsCreateResourceList
 133  *
 134  * PARAMETERS:  ByteStreamBuffer        - Pointer to the resource byte stream
 135  *              OutputBuffer            - Pointer to the user's buffer
 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
 148 ACPI_STATUS
 149 AcpiRsCreateResourceList (
 150     ACPI_OPERAND_OBJECT     *ByteStreamBuffer,
 151     ACPI_BUFFER             *OutputBuffer)
 152 {
 153
 154     ACPI_STATUS             Status;
 155     UINT8                   *ByteStreamStart;
 156     ACPI_SIZE               ListSizeNeeded = 0;
 157     UINT32                  ByteStreamBufferLength;
 158
 159
 160     ACPI_FUNCTION_TRACE ("RsCreateResourceList");
 161
 162
 163     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "ByteStreamBuffer = %p\n",
 164         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 = AcpiRsGetListLength (ByteStreamStart, ByteStreamBufferLength,
 177                 &ListSizeNeeded);
 178
 179     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Status=%X ListSizeNeeded=%X\n",
 180         Status, (UINT32) ListSizeNeeded));
 181     if (ACPI_FAILURE (Status))
 182     {
 183         return_ACPI_STATUS (Status);
 184     }
 185
 186     /* Validate/Allocate/Clear caller buffer */
 187
 188     Status = AcpiUtInitializeBuffer (OutputBuffer, ListSizeNeeded);
 189     if (ACPI_FAILURE (Status))
 190     {
 191         return_ACPI_STATUS (Status);
 192     }
 193
 194     /* Do the conversion */
 195
 196     Status = AcpiRsByteStreamToList (ByteStreamStart, ByteStreamBufferLength,
 197                     OutputBuffer->Pointer);
 198     if (ACPI_FAILURE (Status))
 199     {
 200         return_ACPI_STATUS (Status);
 201     }
 202
 203     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
 204             OutputBuffer->Pointer, (UINT32) OutputBuffer->Length));
 205     return_ACPI_STATUS (AE_OK);
 206 }
 207
 208
 209 /*******************************************************************************
 210  *
 211  * FUNCTION:    AcpiRsCreatePciRoutingTable
 212  *
 213  * PARAMETERS:  PackageObject           - Pointer to an ACPI_OPERAND_OBJECT
 214  *                                        package
 215  *              OutputBuffer            - Pointer to the user's buffer
 216  *
 217  * RETURN:      Status  AE_OK if okay, else a valid ACPI_STATUS code.
 218  *              If the OutputBuffer is too small, the error will be
 219  *              AE_BUFFER_OVERFLOW and OutputBuffer->Length will point
 220  *              to the size buffer needed.
 221  *
 222  * DESCRIPTION: Takes the ACPI_OPERAND_OBJECT  package and creates a
 223  *              linked list of PCI interrupt descriptions
 224  *
 225  * NOTE: It is the caller's responsibility to ensure that the start of the
 226  * output buffer is aligned properly (if necessary).
 227  *
 228  ******************************************************************************/
 229
 230 ACPI_STATUS
 231 AcpiRsCreatePciRoutingTable (
 232     ACPI_OPERAND_OBJECT     *PackageObject,
 233     ACPI_BUFFER             *OutputBuffer)
 234 {
 235     UINT8                   *Buffer;
 236     ACPI_OPERAND_OBJECT     **TopObjectList;
 237     ACPI_OPERAND_OBJECT     **SubObjectList;
 238     ACPI_OPERAND_OBJECT     *ObjDesc;
 239     ACPI_SIZE               BufferSizeNeeded = 0;
 240     UINT32                  NumberOfElements;
 241     UINT32                  Index;
 242     ACPI_PCI_ROUTING_TABLE  *UserPrt;
 243     ACPI_NAMESPACE_NODE     *Node;
 244     ACPI_STATUS             Status;
 245     ACPI_BUFFER             PathBuffer;
 246
 247
 248     ACPI_FUNCTION_TRACE ("RsCreatePciRoutingTable");
 249
 250
 251     /* Params already validated, so we don't re-validate here */
 252
 253     /*
 254      * Get the required buffer length
 255      */
 256     Status = AcpiRsGetPciRoutingTableLength (PackageObject,
 257                 &BufferSizeNeeded);
 258     if (ACPI_FAILURE (Status))
 259     {
 260         return_ACPI_STATUS (Status);
 261     }
 262
 263     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "BufferSizeNeeded = %X\n",
 264         (UINT32) BufferSizeNeeded));
 265
 266     /* Validate/Allocate/Clear caller buffer */
 267
 268     Status = AcpiUtInitializeBuffer (OutputBuffer, BufferSizeNeeded);
 269     if (ACPI_FAILURE (Status))
 270     {
 271         return_ACPI_STATUS (Status);
 272     }
 273
 274     /*
 275      * Loop through the ACPI_INTERNAL_OBJECTS - Each object
 276      * should be a package that in turn contains an
 277      * ACPI_INTEGER Address, a UINT8 Pin, a Name and a UINT8 SourceIndex.
 278      */
 279     TopObjectList    = PackageObject->Package.Elements;
 280     NumberOfElements = PackageObject->Package.Count;
 281     Buffer           = OutputBuffer->Pointer;
 282     UserPrt          = ACPI_CAST_PTR (ACPI_PCI_ROUTING_TABLE, Buffer);
 283
 284     for (Index = 0; Index < NumberOfElements; Index++)
 285     {
 286         /*
 287          * Point UserPrt past this current structure
 288          *
 289          * NOTE: On the first iteration, UserPrt->Length will
 290          * be zero because we cleared the return buffer earlier
 291          */
 292         Buffer += UserPrt->Length;
 293         UserPrt = ACPI_CAST_PTR (ACPI_PCI_ROUTING_TABLE, Buffer);
 294
 295         /*
 296          * Fill in the Length field with the information we have at this point.
 297          * The minus four is to subtract the size of the UINT8 Source[4] member
 298          * because it is added below.
 299          */
 300         UserPrt->Length = (sizeof (ACPI_PCI_ROUTING_TABLE) - 4);
 301
 302         /*
 303          * Each element of the top-level package must also be a package
 304          */
 305         if (ACPI_GET_OBJECT_TYPE (*TopObjectList) != ACPI_TYPE_PACKAGE)
 306         {
 307             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 308                 "(PRT[%X]) Need sub-package, found %s\n",
 309                 Index, AcpiUtGetObjectTypeName (*TopObjectList)));
 310             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 311         }
 312
 313         /* Each sub-package must be of length 4 */
 314
 315         if ((*TopObjectList)->Package.Count != 4)
 316         {
 317             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 318                 "(PRT[%X]) Need package of length 4, found length %d\n",
 319                 Index, (*TopObjectList)->Package.Count));
 320             return_ACPI_STATUS (AE_AML_PACKAGE_LIMIT);
 321         }
 322
 323         /*
 324          * Dereference the sub-package.
 325          * The SubObjectList will now point to an array of the four IRQ
 326          * elements: [Address, Pin, Source, SourceIndex]
 327          */
 328         SubObjectList = (*TopObjectList)->Package.Elements;
 329
 330         /*
 331          * 1) First subobject: Dereference the PRT.Address
 332          */
 333         ObjDesc = SubObjectList[0];
 334         if (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_INTEGER)
 335         {
 336             UserPrt->Address = ObjDesc->Integer.Value;
 337         }
 338         else
 339         {
 340             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 341                 "(PRT[%X].Address) Need Integer, found %s\n",
 342                 Index, AcpiUtGetObjectTypeName (ObjDesc)));
 343             return_ACPI_STATUS (AE_BAD_DATA);
 344         }
 345
 346         /*
 347          * 2) Second subobject: Dereference the PRT.Pin
 348          */
 349         ObjDesc = SubObjectList[1];
 350         if (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_INTEGER)
 351         {
 352             UserPrt->Pin = (UINT32) ObjDesc->Integer.Value;
 353         }
 354         else
 355         {
 356             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 357                 "(PRT[%X].Pin) Need Integer, found %s\n",
 358                 Index, AcpiUtGetObjectTypeName (ObjDesc)));
 359             return_ACPI_STATUS (AE_BAD_DATA);
 360         }
 361
 362         /*
 363          * 3) Third subobject: Dereference the PRT.SourceName
 364          */
 365         ObjDesc = SubObjectList[2];
 366         switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
 367         {
 368         case ACPI_TYPE_LOCAL_REFERENCE:
 369
 370             if (ObjDesc->Reference.Opcode != AML_INT_NAMEPATH_OP)
 371             {
 372                 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 373                     "(PRT[%X].Source) Need name, found reference op %X\n",
 374                     Index, ObjDesc->Reference.Opcode));
 375                 return_ACPI_STATUS (AE_BAD_DATA);
 376             }
 377
 378             Node = ObjDesc->Reference.Node;
 379
 380             /* Use *remaining* length of the buffer as max for pathname */
 381
 382             PathBuffer.Length = OutputBuffer->Length -
 383                                 (UINT32) ((UINT8 *) UserPrt->Source -
 384                                 (UINT8 *) OutputBuffer->Pointer);
 385             PathBuffer.Pointer = UserPrt->Source;
 386
 387             Status = AcpiNsHandleToPathname ((ACPI_HANDLE) Node, &PathBuffer);
 388
 389             UserPrt->Length += (UINT32) ACPI_STRLEN (UserPrt->Source) + 1; /* include null terminator */
 390             break;
 391
 392
 393         case ACPI_TYPE_STRING:
 394
 395             ACPI_STRCPY (UserPrt->Source, ObjDesc->String.Pointer);
 396
 397             /* Add to the Length field the length of the string (add 1 for terminator) */
 398
 399             UserPrt->Length += ObjDesc->String.Length + 1;
 400             break;
 401
 402
 403         case ACPI_TYPE_INTEGER:
 404             /*
 405              * If this is a number, then the Source Name is NULL, since the
 406              * entire buffer was zeroed out, we can leave this alone.
 407              *
 408              * Add to the Length field the length of the UINT32 NULL
 409              */
 410             UserPrt->Length += sizeof (UINT32);
 411             break;
 412
 413
 414         default:
 415
 416            ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 417                "(PRT[%X].Source) Need Ref/String/Integer, found %s\n",
 418                 Index, AcpiUtGetObjectTypeName (ObjDesc)));
 419            return_ACPI_STATUS (AE_BAD_DATA);
 420         }
 421
 422         /* Now align the current length */
 423
 424         UserPrt->Length = ACPI_ROUND_UP_TO_64BITS (UserPrt->Length);
 425
 426         /*
 427          * 4) Fourth subobject: Dereference the PRT.SourceIndex
 428          */
 429         ObjDesc = SubObjectList[3];
 430         if (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_INTEGER)
 431         {
 432             UserPrt->SourceIndex = (UINT32) ObjDesc->Integer.Value;
 433         }
 434         else
 435         {
 436             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 437                 "(PRT[%X].SourceIndex) Need Integer, found %s\n",
 438                 Index, AcpiUtGetObjectTypeName (ObjDesc)));
 439             return_ACPI_STATUS (AE_BAD_DATA);
 440         }
 441
 442         /* Point to the next ACPI_OPERAND_OBJECT in the top level package */
 443
 444         TopObjectList++;
 445     }
 446
 447     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
 448             OutputBuffer->Pointer, (UINT32) OutputBuffer->Length));
 449     return_ACPI_STATUS (AE_OK);
 450 }
 451
 452
 453 /*******************************************************************************
 454  *
 455  * FUNCTION:    AcpiRsCreateByteStream
 456  *
 457  * PARAMETERS:  LinkedListBuffer        - Pointer to the resource linked list
 458  *              OutputBuffer            - Pointer to the user's buffer
 459  *
 460  * RETURN:      Status  AE_OK if okay, else a valid ACPI_STATUS code.
 461  *              If the OutputBuffer is too small, the error will be
 462  *              AE_BUFFER_OVERFLOW and OutputBuffer->Length will point
 463  *              to the size buffer needed.
 464  *
 465  * DESCRIPTION: Takes the linked list of device resources and
 466  *              creates a bytestream to be used as input for the
 467  *              _SRS control method.
 468  *
 469  ******************************************************************************/
 470
 471 ACPI_STATUS
 472 AcpiRsCreateByteStream (
 473     ACPI_RESOURCE           *LinkedListBuffer,
 474     ACPI_BUFFER             *OutputBuffer)
 475 {
 476     ACPI_STATUS             Status;
 477     ACPI_SIZE               ByteStreamSizeNeeded = 0;
 478
 479
 480     ACPI_FUNCTION_TRACE ("RsCreateByteStream");
 481
 482
 483     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "LinkedListBuffer = %p\n",
 484         LinkedListBuffer));
 485
 486     /*
 487      * Params already validated, so we don't re-validate here
 488      *
 489      * Pass the LinkedListBuffer into a module that calculates
 490      * the buffer size needed for the byte stream.
 491      */
 492     Status = AcpiRsGetByteStreamLength (LinkedListBuffer,
 493                 &ByteStreamSizeNeeded);
 494
 495     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "ByteStreamSizeNeeded=%X, %s\n",
 496         (UINT32) ByteStreamSizeNeeded, AcpiFormatException (Status)));
 497     if (ACPI_FAILURE (Status))
 498     {
 499         return_ACPI_STATUS (Status);
 500     }
 501
 502     /* Validate/Allocate/Clear caller buffer */
 503
 504     Status = AcpiUtInitializeBuffer (OutputBuffer, ByteStreamSizeNeeded);
 505     if (ACPI_FAILURE (Status))
 506     {
 507         return_ACPI_STATUS (Status);
 508     }
 509
 510     /* Do the conversion */
 511
 512     Status = AcpiRsListToByteStream (LinkedListBuffer, ByteStreamSizeNeeded,
 513                     OutputBuffer->Pointer);
 514     if (ACPI_FAILURE (Status))
 515     {
 516         return_ACPI_STATUS (Status);
 517     }
 518
 519     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
 520             OutputBuffer->Pointer, (UINT32) OutputBuffer->Length));
 521     return_ACPI_STATUS (AE_OK);
 522 }
 523