sys/contrib/dev/acpica/rsutils.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rsutils - Utilities for the resource manager
   4  *              $Revision: 37 $
   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/rsutils.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118
 119 #define __RSUTILS_C__
 120
 121 #include "acpi.h"
 122 #include "acnamesp.h"
 123 #include "acresrc.h"
 124
 125
 126 #define _COMPONENT          ACPI_RESOURCES
 127         ACPI_MODULE_NAME    ("rsutils")
 128
 129
 130 /*******************************************************************************
 131  *
 132  * FUNCTION:    AcpiRsGetPrtMethodData
 133  *
 134  * PARAMETERS:  Handle          - a handle to the containing object
 135  *              RetBuffer       - a pointer to a buffer structure for the
 136  *                                  results
 137  *
 138  * RETURN:      Status
 139  *
 140  * DESCRIPTION: This function is called to get the _PRT value of an object
 141  *              contained in an object specified by the handle passed in
 142  *
 143  *              If the function fails an appropriate status will be returned
 144  *              and the contents of the callers buffer is undefined.
 145  *
 146  ******************************************************************************/
 147
 148 ACPI_STATUS
 149 AcpiRsGetPrtMethodData (
 150     ACPI_HANDLE             Handle,
 151     ACPI_BUFFER             *RetBuffer)
 152 {
 153     ACPI_OPERAND_OBJECT     *ObjDesc;
 154     ACPI_STATUS             Status;
 155
 156
 157     ACPI_FUNCTION_TRACE ("RsGetPrtMethodData");
 158
 159
 160     /* Parameters guaranteed valid by caller */
 161
 162     /*
 163      * Execute the method, no parameters
 164      */
 165     Status = AcpiUtEvaluateObject (Handle, "_PRT", ACPI_BTYPE_PACKAGE, &ObjDesc);
 166     if (ACPI_FAILURE (Status))
 167     {
 168         return_ACPI_STATUS (Status);
 169     }
 170
 171     /*
 172      * Create a resource linked list from the byte stream buffer that comes
 173      * back from the _CRS method execution.
 174      */
 175     Status = AcpiRsCreatePciRoutingTable (ObjDesc, RetBuffer);
 176
 177     /* On exit, we must delete the object returned by EvaluateObject */
 178
 179     AcpiUtRemoveReference (ObjDesc);
 180     return_ACPI_STATUS (Status);
 181 }
 182
 183
 184 /*******************************************************************************
 185  *
 186  * FUNCTION:    AcpiRsGetCrsMethodData
 187  *
 188  * PARAMETERS:  Handle          - a handle to the containing object
 189  *              RetBuffer       - a pointer to a buffer structure for the
 190  *                                  results
 191  *
 192  * RETURN:      Status
 193  *
 194  * DESCRIPTION: This function is called to get the _CRS value of an object
 195  *              contained in an object specified by the handle passed in
 196  *
 197  *              If the function fails an appropriate status will be returned
 198  *              and the contents of the callers buffer is undefined.
 199  *
 200  ******************************************************************************/
 201
 202 ACPI_STATUS
 203 AcpiRsGetCrsMethodData (
 204     ACPI_HANDLE             Handle,
 205     ACPI_BUFFER             *RetBuffer)
 206 {
 207     ACPI_OPERAND_OBJECT     *ObjDesc;
 208     ACPI_STATUS             Status;
 209
 210
 211     ACPI_FUNCTION_TRACE ("RsGetCrsMethodData");
 212
 213
 214     /* Parameters guaranteed valid by caller */
 215
 216     /*
 217      * Execute the method, no parameters
 218      */
 219     Status = AcpiUtEvaluateObject (Handle, "_CRS", ACPI_BTYPE_BUFFER, &ObjDesc);
 220     if (ACPI_FAILURE (Status))
 221     {
 222         return_ACPI_STATUS (Status);
 223     }
 224
 225     /*
 226      * Make the call to create a resource linked list from the
 227      * byte stream buffer that comes back from the _CRS method
 228      * execution.
 229      */
 230     Status = AcpiRsCreateResourceList (ObjDesc, RetBuffer);
 231
 232     /* On exit, we must delete the object returned by evaluateObject */
 233
 234     AcpiUtRemoveReference (ObjDesc);
 235     return_ACPI_STATUS (Status);
 236 }
 237
 238
 239 /*******************************************************************************
 240  *
 241  * FUNCTION:    AcpiRsGetPrsMethodData
 242  *
 243  * PARAMETERS:  Handle          - a handle to the containing object
 244  *              RetBuffer       - a pointer to a buffer structure for the
 245  *                                  results
 246  *
 247  * RETURN:      Status
 248  *
 249  * DESCRIPTION: This function is called to get the _PRS value of an object
 250  *              contained in an object specified by the handle passed in
 251  *
 252  *              If the function fails an appropriate status will be returned
 253  *              and the contents of the callers buffer is undefined.
 254  *
 255  ******************************************************************************/
 256
 257 ACPI_STATUS
 258 AcpiRsGetPrsMethodData (
 259     ACPI_HANDLE             Handle,
 260     ACPI_BUFFER             *RetBuffer)
 261 {
 262     ACPI_OPERAND_OBJECT     *ObjDesc;
 263     ACPI_STATUS             Status;
 264
 265
 266     ACPI_FUNCTION_TRACE ("RsGetPrsMethodData");
 267
 268
 269     /* Parameters guaranteed valid by caller */
 270
 271     /*
 272      * Execute the method, no parameters
 273      */
 274     Status = AcpiUtEvaluateObject (Handle, "_PRS", ACPI_BTYPE_BUFFER, &ObjDesc);
 275     if (ACPI_FAILURE (Status))
 276     {
 277         return_ACPI_STATUS (Status);
 278     }
 279
 280     /*
 281      * Make the call to create a resource linked list from the
 282      * byte stream buffer that comes back from the _CRS method
 283      * execution.
 284      */
 285     Status = AcpiRsCreateResourceList (ObjDesc, RetBuffer);
 286
 287     /* On exit, we must delete the object returned by evaluateObject */
 288
 289     AcpiUtRemoveReference (ObjDesc);
 290     return_ACPI_STATUS (Status);
 291 }
 292
 293
 294 /*******************************************************************************
 295  *
 296  * FUNCTION:    AcpiRsGetMethodData
 297  *
 298  * PARAMETERS:  Handle          - a handle to the containing object
 299  *              RetBuffer       - a pointer to a buffer structure for the
 300  *                                  results
 301  *
 302  * RETURN:      Status
 303  *
 304  * DESCRIPTION: This function is called to get the _CRS or _PRS value of an
 305  *              object contained in an object specified by the handle passed in
 306  *
 307  *              If the function fails an appropriate status will be returned
 308  *              and the contents of the callers buffer is undefined.
 309  *
 310  ******************************************************************************/
 311
 312 ACPI_STATUS
 313 AcpiRsGetMethodData (
 314     ACPI_HANDLE             Handle,
 315     char                    *Path,
 316     ACPI_BUFFER             *RetBuffer)
 317 {
 318     ACPI_OPERAND_OBJECT     *ObjDesc;
 319     ACPI_STATUS             Status;
 320
 321
 322     ACPI_FUNCTION_TRACE ("RsGetMethodData");
 323
 324
 325     /* Parameters guaranteed valid by caller */
 326
 327     /*
 328      * Execute the method, no parameters
 329      */
 330     Status = AcpiUtEvaluateObject (Handle, Path, ACPI_BTYPE_BUFFER, &ObjDesc);
 331     if (ACPI_FAILURE (Status)) {
 332         return_ACPI_STATUS (Status);
 333     }
 334
 335     /*
 336      * Make the call to create a resource linked list from the
 337      * byte stream buffer that comes back from the method
 338      * execution.
 339      */
 340     Status = AcpiRsCreateResourceList (ObjDesc, RetBuffer);
 341
 342     /* On exit, we must delete the object returned by EvaluateObject */
 343
 344     AcpiUtRemoveReference (ObjDesc);
 345     return_ACPI_STATUS (Status);
 346 }
 347
 348 /*******************************************************************************
 349  *
 350  * FUNCTION:    AcpiRsSetSrsMethodData
 351  *
 352  * PARAMETERS:  Handle          - a handle to the containing object
 353  *              InBuffer        - a pointer to a buffer structure of the
 354  *                                  parameter
 355  *
 356  * RETURN:      Status
 357  *
 358  * DESCRIPTION: This function is called to set the _SRS of an object contained
 359  *              in an object specified by the handle passed in
 360  *
 361  *              If the function fails an appropriate status will be returned
 362  *              and the contents of the callers buffer is undefined.
 363  *
 364  ******************************************************************************/
 365
 366 ACPI_STATUS
 367 AcpiRsSetSrsMethodData (
 368     ACPI_HANDLE             Handle,
 369     ACPI_BUFFER             *InBuffer)
 370 {
 371     ACPI_OPERAND_OBJECT     *Params[2];
 372     ACPI_STATUS             Status;
 373     ACPI_BUFFER             Buffer;
 374
 375
 376     ACPI_FUNCTION_TRACE ("RsSetSrsMethodData");
 377
 378
 379     /* Parameters guaranteed valid by caller */
 380
 381     /*
 382      * The InBuffer parameter will point to a linked list of
 383      * resource parameters.  It needs to be formatted into a
 384      * byte stream to be sent in as an input parameter to _SRS
 385      *
 386      * Convert the linked list into a byte stream
 387      */
 388     Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
 389     Status = AcpiRsCreateByteStream (InBuffer->Pointer, &Buffer);
 390     if (ACPI_FAILURE (Status))
 391     {
 392         return_ACPI_STATUS (Status);
 393     }
 394
 395     /*
 396      * Init the param object
 397      */
 398     Params[0] = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER);
 399     if (!Params[0])
 400     {
 401         AcpiOsFree (Buffer.Pointer);
 402         return_ACPI_STATUS (AE_NO_MEMORY);
 403     }
 404
 405     /*
 406      * Set up the parameter object
 407      */
 408     Params[0]->Buffer.Length  = (UINT32) Buffer.Length;
 409     Params[0]->Buffer.Pointer = Buffer.Pointer;
 410     Params[0]->Common.Flags   = AOPOBJ_DATA_VALID;
 411     Params[1] = NULL;
 412
 413     /*
 414      * Execute the method, no return value
 415      */
 416     Status = AcpiNsEvaluateRelative (Handle, "_SRS", Params, NULL);
 417
 418     /*
 419      * Clean up and return the status from AcpiNsEvaluateRelative
 420      */
 421     AcpiUtRemoveReference (Params[0]);
 422     return_ACPI_STATUS (Status);
 423 }
 424