rsutils.c revision 91116
1/******************************************************************************* 2 * 3 * Module Name: rsutils - Utilities for the resource manager 4 * $Revision: 29 $ 5 * 6 ******************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2002, 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 147ACPI_STATUS 148AcpiRsGetPrtMethodData ( 149 ACPI_HANDLE Handle, 150 ACPI_BUFFER *RetBuffer) 151{ 152 ACPI_OPERAND_OBJECT *RetObj; 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 = AcpiNsEvaluateRelative (Handle, "_PRT", NULL, &RetObj); 165 if (ACPI_FAILURE (Status)) 166 { 167 return_ACPI_STATUS (Status); 168 } 169 170 if (!RetObj) 171 { 172 /* Return object is required */ 173 174 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "No object was returned from _PRT\n")); 175 return_ACPI_STATUS (AE_TYPE); 176 } 177 178 /* 179 * The return object will be a package, so check the parameters. If the 180 * return object is not a package, then the underlying AML code is corrupt 181 * or improperly written. 182 */ 183 if (ACPI_TYPE_PACKAGE != RetObj->Common.Type) 184 { 185 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "_PRT did not return a Package, returned %s\n", 186 AcpiUtGetTypeName (RetObj->Common.Type))); 187 Status = AE_AML_OPERAND_TYPE; 188 goto Cleanup; 189 } 190 191 /* 192 * Create a resource linked list from the byte stream buffer that comes 193 * back from the _CRS method execution. 194 */ 195 Status = AcpiRsCreatePciRoutingTable (RetObj, RetBuffer); 196 197 /* On exit, we must delete the object returned by EvaluateObject */ 198 199Cleanup: 200 201 AcpiUtRemoveReference (RetObj); 202 return_ACPI_STATUS (Status); 203} 204 205 206/******************************************************************************* 207 * 208 * FUNCTION: AcpiRsGetCrsMethodData 209 * 210 * PARAMETERS: Handle - a handle to the containing object 211 * RetBuffer - a pointer to a buffer structure for the 212 * results 213 * 214 * RETURN: Status 215 * 216 * DESCRIPTION: This function is called to get the _CRS value of an object 217 * contained in an object specified by the handle passed in 218 * 219 * If the function fails an appropriate status will be returned 220 * and the contents of the callers buffer is undefined. 221 * 222 ******************************************************************************/ 223 224ACPI_STATUS 225AcpiRsGetCrsMethodData ( 226 ACPI_HANDLE Handle, 227 ACPI_BUFFER *RetBuffer) 228{ 229 ACPI_OPERAND_OBJECT *RetObj; 230 ACPI_STATUS Status; 231 232 233 ACPI_FUNCTION_TRACE ("RsGetCrsMethodData"); 234 235 236 /* Parameters guaranteed valid by caller */ 237 238 /* 239 * Execute the method, no parameters 240 */ 241 Status = AcpiNsEvaluateRelative (Handle, "_CRS", NULL, &RetObj); 242 if (ACPI_FAILURE (Status)) 243 { 244 return_ACPI_STATUS (Status); 245 } 246 247 if (!RetObj) 248 { 249 /* Return object is required */ 250 251 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "No object was returned from _CRS\n")); 252 return_ACPI_STATUS (AE_TYPE); 253 } 254 255 /* 256 * The return object will be a buffer, but check the 257 * parameters. If the return object is not a buffer, 258 * then the underlying AML code is corrupt or improperly 259 * written. 260 */ 261 if (ACPI_TYPE_BUFFER != RetObj->Common.Type) 262 { 263 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "_CRS did not return a Buffer, returned %s\n", 264 AcpiUtGetTypeName (RetObj->Common.Type))); 265 Status = AE_AML_OPERAND_TYPE; 266 goto Cleanup; 267 } 268 269 /* 270 * Make the call to create a resource linked list from the 271 * byte stream buffer that comes back from the _CRS method 272 * execution. 273 */ 274 Status = AcpiRsCreateResourceList (RetObj, RetBuffer); 275 276 /* On exit, we must delete the object returned by evaluateObject */ 277 278Cleanup: 279 280 AcpiUtRemoveReference (RetObj); 281 return_ACPI_STATUS (Status); 282} 283 284 285/******************************************************************************* 286 * 287 * FUNCTION: AcpiRsGetPrsMethodData 288 * 289 * PARAMETERS: Handle - a handle to the containing object 290 * RetBuffer - a pointer to a buffer structure for the 291 * results 292 * 293 * RETURN: Status 294 * 295 * DESCRIPTION: This function is called to get the _PRS value of an object 296 * contained in an object specified by the handle passed in 297 * 298 * If the function fails an appropriate status will be returned 299 * and the contents of the callers buffer is undefined. 300 * 301 ******************************************************************************/ 302 303ACPI_STATUS 304AcpiRsGetPrsMethodData ( 305 ACPI_HANDLE Handle, 306 ACPI_BUFFER *RetBuffer) 307{ 308 ACPI_OPERAND_OBJECT *RetObj; 309 ACPI_STATUS Status; 310 311 312 ACPI_FUNCTION_TRACE ("RsGetPrsMethodData"); 313 314 315 /* Parameters guaranteed valid by caller */ 316 317 /* 318 * Execute the method, no parameters 319 */ 320 Status = AcpiNsEvaluateRelative (Handle, "_PRS", NULL, &RetObj); 321 if (ACPI_FAILURE (Status)) 322 { 323 return_ACPI_STATUS (Status); 324 } 325 326 if (!RetObj) 327 { 328 /* Return object is required */ 329 330 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "No object was returned from _PRS\n")); 331 return_ACPI_STATUS (AE_TYPE); 332 } 333 334 /* 335 * The return object will be a buffer, but check the 336 * parameters. If the return object is not a buffer, 337 * then the underlying AML code is corrupt or improperly 338 * written.. 339 */ 340 if (ACPI_TYPE_BUFFER != RetObj->Common.Type) 341 { 342 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "_PRS did not return a Buffer, returned %s\n", 343 AcpiUtGetTypeName (RetObj->Common.Type))); 344 Status = AE_AML_OPERAND_TYPE; 345 goto Cleanup; 346 } 347 348 /* 349 * Make the call to create a resource linked list from the 350 * byte stream buffer that comes back from the _CRS method 351 * execution. 352 */ 353 Status = AcpiRsCreateResourceList (RetObj, RetBuffer); 354 355 /* On exit, we must delete the object returned by evaluateObject */ 356 357Cleanup: 358 359 AcpiUtRemoveReference (RetObj); 360 return_ACPI_STATUS (Status); 361} 362 363 364/******************************************************************************* 365 * 366 * FUNCTION: AcpiRsSetSrsMethodData 367 * 368 * PARAMETERS: Handle - a handle to the containing object 369 * InBuffer - a pointer to a buffer structure of the 370 * parameter 371 * 372 * RETURN: Status 373 * 374 * DESCRIPTION: This function is called to set the _SRS of an object contained 375 * in an object specified by the handle passed in 376 * 377 * If the function fails an appropriate status will be returned 378 * and the contents of the callers buffer is undefined. 379 * 380 ******************************************************************************/ 381 382ACPI_STATUS 383AcpiRsSetSrsMethodData ( 384 ACPI_HANDLE Handle, 385 ACPI_BUFFER *InBuffer) 386{ 387 ACPI_OPERAND_OBJECT *Params[2]; 388 ACPI_STATUS Status; 389 ACPI_BUFFER Buffer; 390 391 392 ACPI_FUNCTION_TRACE ("RsSetSrsMethodData"); 393 394 395 /* Parameters guaranteed valid by caller */ 396 397 /* 398 * The InBuffer parameter will point to a linked list of 399 * resource parameters. It needs to be formatted into a 400 * byte stream to be sent in as an input parameter to _SRS 401 * 402 * Convert the linked list into a byte stream 403 */ 404 Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER; 405 Status = AcpiRsCreateByteStream (InBuffer->Pointer, &Buffer); 406 if (ACPI_FAILURE (Status)) 407 { 408 return_ACPI_STATUS (Status); 409 } 410 411 /* 412 * Init the param object 413 */ 414 Params[0] = AcpiUtCreateInternalObject (ACPI_TYPE_BUFFER); 415 if (!Params[0]) 416 { 417 AcpiOsFree (Buffer.Pointer); 418 return_ACPI_STATUS (AE_NO_MEMORY); 419 } 420 421 /* 422 * Set up the parameter object 423 */ 424 Params[0]->Buffer.Length = Buffer.Length; 425 Params[0]->Buffer.Pointer = Buffer.Pointer; 426 Params[1] = NULL; 427 428 /* 429 * Execute the method, no return value 430 */ 431 Status = AcpiNsEvaluateRelative (Handle, "_SRS", Params, NULL); 432 433 /* 434 * Clean up and return the status from AcpiNsEvaluateRelative 435 */ 436 AcpiUtRemoveReference (Params[0]); 437 return_ACPI_STATUS (Status); 438} 439 440