sys/contrib/dev/acpica-unix-20040527/resources/rsutils.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: rsutils - Utilities for the resource manager
   4  *              $Revision: 39 $
   5  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2004, 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 __RSUTILS_C__
 119
 120 #include "acpi.h"
 121 #include "acnamesp.h"
 122 #include "acresrc.h"
 123
 124
 125 #define _COMPONENT          ACPI_RESOURCES
 126         ACPI_MODULE_NAME    ("rsutils")
 127
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiRsGetPrtMethodData
 132  *
 133  * PARAMETERS:  Handle          - a handle to the containing object
 134  *              RetBuffer       - a pointer to a buffer structure for the
 135  *                                  results
 136  *
 137  * RETURN:      Status
 138  *
 139  * DESCRIPTION: This function is called to get the _PRT value of an object
 140  *              contained in an object specified by the handle passed in
 141  *
 142  *              If the function fails an appropriate status will be returned
 143  *              and the contents of the callers buffer is undefined.
 144  *
 145  ******************************************************************************/
 146
 147 ACPI_STATUS
 148 AcpiRsGetPrtMethodData (
 149     ACPI_HANDLE             Handle,
 150     ACPI_BUFFER             *RetBuffer)
 151 {
 152     ACPI_OPERAND_OBJECT     *ObjDesc;
 153     ACPI_STATUS             Status;
 154
 155
 156     ACPI_FUNCTION_TRACE ("RsGetPrtMethodData");
 157
 158
 159     /* Parameters guaranteed valid by caller */
 160
 161     /*
 162      * Execute the method, no parameters
 163      */
 164     Status = AcpiUtEvaluateObject (Handle, "_PRT", ACPI_BTYPE_PACKAGE, &ObjDesc);
 165     if (ACPI_FAILURE (Status))
 166     {
 167         return_ACPI_STATUS (Status);
 168     }
 169
 170     /*
 171      * Create a resource linked list from the byte stream buffer that comes
 172      * back from the _CRS method execution.
 173      */
 174     Status = AcpiRsCreatePciRoutingTable (ObjDesc, RetBuffer);
 175
 176     /* On exit, we must delete the object returned by EvaluateObject */
 177
 178     AcpiUtRemoveReference (ObjDesc);
 179     return_ACPI_STATUS (Status);
 180 }
 181
 182
 183 /*******************************************************************************
 184  *
 185  * FUNCTION:    AcpiRsGetCrsMethodData
 186  *
 187  * PARAMETERS:  Handle          - a handle to the containing object
 188  *              RetBuffer       - a pointer to a buffer structure for the
 189  *                                  results
 190  *
 191  * RETURN:      Status
 192  *
 193  * DESCRIPTION: This function is called to get the _CRS value of an object
 194  *              contained in an object specified by the handle passed in
 195  *
 196  *              If the function fails an appropriate status will be returned
 197  *              and the contents of the callers buffer is undefined.
 198  *
 199  ******************************************************************************/
 200
 201 ACPI_STATUS
 202 AcpiRsGetCrsMethodData (
 203     ACPI_HANDLE             Handle,
 204     ACPI_BUFFER             *RetBuffer)
 205 {
 206     ACPI_OPERAND_OBJECT     *ObjDesc;
 207     ACPI_STATUS             Status;
 208
 209
 210     ACPI_FUNCTION_TRACE ("RsGetCrsMethodData");
 211
 212
 213     /* Parameters guaranteed valid by caller */
 214
 215     /*
 216      * Execute the method, no parameters
 217      */
 218     Status = AcpiUtEvaluateObject (Handle, "_CRS", ACPI_BTYPE_BUFFER, &ObjDesc);
 219     if (ACPI_FAILURE (Status))
 220     {
 221         return_ACPI_STATUS (Status);
 222     }
 223
 224     /*
 225      * Make the call to create a resource linked list from the
 226      * byte stream buffer that comes back from the _CRS method
 227      * execution.
 228      */
 229     Status = AcpiRsCreateResourceList (ObjDesc, RetBuffer);
 230
 231     /* On exit, we must delete the object returned by evaluateObject */
 232
 233     AcpiUtRemoveReference (ObjDesc);
 234     return_ACPI_STATUS (Status);
 235 }
 236
 237
 238 /*******************************************************************************
 239  *
 240  * FUNCTION:    AcpiRsGetPrsMethodData
 241  *
 242  * PARAMETERS:  Handle          - a handle to the containing object
 243  *              RetBuffer       - a pointer to a buffer structure for the
 244  *                                  results
 245  *
 246  * RETURN:      Status
 247  *
 248  * DESCRIPTION: This function is called to get the _PRS value of an object
 249  *              contained in an object specified by the handle passed in
 250  *
 251  *              If the function fails an appropriate status will be returned
 252  *              and the contents of the callers buffer is undefined.
 253  *
 254  ******************************************************************************/
 255
 256 ACPI_STATUS
 257 AcpiRsGetPrsMethodData (
 258     ACPI_HANDLE             Handle,
 259     ACPI_BUFFER             *RetBuffer)
 260 {
 261     ACPI_OPERAND_OBJECT     *ObjDesc;
 262     ACPI_STATUS             Status;
 263
 264
 265     ACPI_FUNCTION_TRACE ("RsGetPrsMethodData");
 266
 267
 268     /* Parameters guaranteed valid by caller */
 269
 270     /*
 271      * Execute the method, no parameters
 272      */
 273     Status = AcpiUtEvaluateObject (Handle, "_PRS", ACPI_BTYPE_BUFFER, &ObjDesc);
 274     if (ACPI_FAILURE (Status))
 275     {
 276         return_ACPI_STATUS (Status);
 277     }
 278
 279     /*
 280      * Make the call to create a resource linked list from the
 281      * byte stream buffer that comes back from the _CRS method
 282      * execution.
 283      */
 284     Status = AcpiRsCreateResourceList (ObjDesc, RetBuffer);
 285
 286     /* On exit, we must delete the object returned by evaluateObject */
 287
 288     AcpiUtRemoveReference (ObjDesc);
 289     return_ACPI_STATUS (Status);
 290 }
 291
 292
 293 /*******************************************************************************
 294  *
 295  * FUNCTION:    AcpiRsGetMethodData
 296  *
 297  * PARAMETERS:  Handle          - a handle to the containing object
 298  *              RetBuffer       - a pointer to a buffer structure for the
 299  *                                  results
 300  *
 301  * RETURN:      Status
 302  *
 303  * DESCRIPTION: This function is called to get the _CRS or _PRS value of an
 304  *              object contained in an object specified by the handle passed in
 305  *
 306  *              If the function fails an appropriate status will be returned
 307  *              and the contents of the callers buffer is undefined.
 308  *
 309  ******************************************************************************/
 310
 311 ACPI_STATUS
 312 AcpiRsGetMethodData (
 313     ACPI_HANDLE             Handle,
 314     char                    *Path,
 315     ACPI_BUFFER             *RetBuffer)
 316 {
 317     ACPI_OPERAND_OBJECT     *ObjDesc;
 318     ACPI_STATUS             Status;
 319
 320
 321     ACPI_FUNCTION_TRACE ("RsGetMethodData");
 322
 323
 324     /* Parameters guaranteed valid by caller */
 325
 326     /*
 327      * Execute the method, no parameters
 328      */
 329     Status = AcpiUtEvaluateObject (Handle, Path, ACPI_BTYPE_BUFFER, &ObjDesc);
 330     if (ACPI_FAILURE (Status)) {
 331         return_ACPI_STATUS (Status);
 332     }
 333
 334     /*
 335      * Make the call to create a resource linked list from the
 336      * byte stream buffer that comes back from the method
 337      * execution.
 338      */
 339     Status = AcpiRsCreateResourceList (ObjDesc, RetBuffer);
 340
 341     /* On exit, we must delete the object returned by EvaluateObject */
 342
 343     AcpiUtRemoveReference (ObjDesc);
 344     return_ACPI_STATUS (Status);
 345 }
 346
 347 /*******************************************************************************
 348  *
 349  * FUNCTION:    AcpiRsSetSrsMethodData
 350  *
 351  * PARAMETERS:  Handle          - a handle to the containing object
 352  *              InBuffer        - a pointer to a buffer structure of the
 353  *                                  parameter
 354  *
 355  * RETURN:      Status
 356  *
 357  * DESCRIPTION: This function is called to set the _SRS of an object contained
 358  *              in an object specified by the handle passed in
 359  *
 360  *              If the function fails an appropriate status will be returned
 361  *              and the contents of the callers buffer is undefined.
 362  *
 363  ******************************************************************************/
 364
 365 ACPI_STATUS
 366 AcpiRsSetSrsMethodData (
 367     ACPI_HANDLE             Handle,
 368     ACPI_BUFFER             *InBuffer)
 369 {
 370     ACPI_PARAMETER_INFO     Info;
 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     Info.Node = Handle;
 414     Info.Parameters = Params;
 415     Info.ParameterType = ACPI_PARAM_ARGS;
 416
 417     /*
 418      * Execute the method, no return value
 419      */
 420     Status = AcpiNsEvaluateRelative ("_SRS", &Info);
 421
 422     /*
 423      * Clean up and return the status from AcpiNsEvaluateRelative
 424      */
 425     AcpiUtRemoveReference (Params[0]);
 426     return_ACPI_STATUS (Status);
 427 }
 428