rsutils.c revision 71867
1/******************************************************************************* 2 * 3 * Module Name: rsutils - Utilities for the resource manager 4 * $Revision: 14 $ 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 __RSUTILS_C__ 119 120#include "acpi.h" 121#include "acnamesp.h" 122#include "acresrc.h" 123 124 125#define _COMPONENT RESOURCE_MANAGER 126 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 - the status of the call 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 UINT32 BufferSpaceNeeded; 155 156 157 FUNCTION_TRACE ("RsGetPrtMethodData"); 158 159 160 /* already validated params, so we won't repeat here */ 161 162 BufferSpaceNeeded = RetBuffer->Length; 163 164 /* 165 * Execute the method, no parameters 166 */ 167 Status = AcpiNsEvaluateRelative (Handle, "_PRT", NULL, &RetObj); 168 if (ACPI_FAILURE (Status)) 169 { 170 return_ACPI_STATUS (Status); 171 } 172 173 if (!RetObj) 174 { 175 /* Return object is required */ 176 177 DEBUG_PRINT (ACPI_ERROR, ("No object was returned from _PRT\n")); 178 return_ACPI_STATUS (AE_TYPE); 179 } 180 181 182 /* 183 * The return object will be a package, so check the 184 * parameters. If the return object is not a package, 185 * then the underlying AML code is corrupt or improperly 186 * written. 187 */ 188 if (ACPI_TYPE_PACKAGE != RetObj->Common.Type) 189 { 190 Status = AE_AML_OPERAND_TYPE; 191 goto Cleanup; 192 } 193 194 /* 195 * Make the call to create a resource linked list from the 196 * byte stream buffer that comes back from the _CRS method 197 * execution. 198 */ 199 Status = AcpiRsCreatePciRoutingTable (RetObj, 200 RetBuffer->Pointer, 201 &BufferSpaceNeeded); 202 203 /* 204 * Tell the user how much of the buffer we have used or is needed 205 * and return the final status. 206 */ 207 RetBuffer->Length = BufferSpaceNeeded; 208 209 210 /* On exit, we must delete the object returned by evaluateObject */ 211 212Cleanup: 213 214 AcpiCmRemoveReference (RetObj); 215 216 return_ACPI_STATUS (Status); 217} 218 219 220/******************************************************************************* 221 * 222 * FUNCTION: AcpiRsGetCrsMethodData 223 * 224 * PARAMETERS: Handle - a handle to the containing object 225 * RetBuffer - a pointer to a buffer structure for the 226 * results 227 * 228 * RETURN: Status - the status of the call 229 * 230 * DESCRIPTION: This function is called to get the _CRS value of an object 231 * contained in an object specified by the handle passed in 232 * 233 * If the function fails an appropriate status will be returned 234 * and the contents of the callers buffer is undefined. 235 * 236 ******************************************************************************/ 237 238ACPI_STATUS 239AcpiRsGetCrsMethodData ( 240 ACPI_HANDLE Handle, 241 ACPI_BUFFER *RetBuffer) 242{ 243 ACPI_OPERAND_OBJECT *RetObj; 244 ACPI_STATUS Status; 245 UINT32 BufferSpaceNeeded = RetBuffer->Length; 246 247 248 FUNCTION_TRACE ("RsGetCrsMethodData"); 249 250 251 /* already validated params, so we won't repeat here */ 252 253 /* 254 * Execute the method, no parameters 255 */ 256 Status = AcpiNsEvaluateRelative (Handle, "_CRS", NULL, &RetObj); 257 if (ACPI_FAILURE (Status)) 258 { 259 return_ACPI_STATUS (Status); 260 } 261 262 if (!RetObj) 263 { 264 /* Return object is required */ 265 266 DEBUG_PRINT (ACPI_ERROR, ("No object was returned from _CRS\n")); 267 return_ACPI_STATUS (AE_TYPE); 268 } 269 270 /* 271 * The return object will be a buffer, but check the 272 * parameters. If the return object is not a buffer, 273 * then the underlying AML code is corrupt or improperly 274 * written. 275 */ 276 if (ACPI_TYPE_BUFFER != RetObj->Common.Type) 277 { 278 Status = AE_AML_OPERAND_TYPE; 279 goto Cleanup; 280 } 281 282 /* 283 * Make the call to create a resource linked list from the 284 * byte stream buffer that comes back from the _CRS method 285 * execution. 286 */ 287 Status = AcpiRsCreateResourceList (RetObj, 288 RetBuffer->Pointer, 289 &BufferSpaceNeeded); 290 291 292 if (ACPI_SUCCESS (Status)) 293 { 294 DUMP_RESOURCE_LIST(RetBuffer->Pointer); 295 } 296 297 /* 298 * Tell the user how much of the buffer we have used or is needed 299 * and return the final status. 300 */ 301 RetBuffer->Length = BufferSpaceNeeded; 302 303 304 /* On exit, we must delete the object returned by evaluateObject */ 305 306Cleanup: 307 308 AcpiCmRemoveReference (RetObj); 309 310 return_ACPI_STATUS (Status); 311} 312 313 314/******************************************************************************* 315 * 316 * FUNCTION: AcpiRsGetPrsMethodData 317 * 318 * PARAMETERS: Handle - a handle to the containing object 319 * RetBuffer - a pointer to a buffer structure for the 320 * results 321 * 322 * RETURN: Status - the status of the call 323 * 324 * DESCRIPTION: This function is called to get the _PRS value of an object 325 * contained in an object specified by the handle passed in 326 * 327 * If the function fails an appropriate status will be returned 328 * and the contents of the callers buffer is undefined. 329 * 330 ******************************************************************************/ 331 332ACPI_STATUS 333AcpiRsGetPrsMethodData ( 334 ACPI_HANDLE Handle, 335 ACPI_BUFFER *RetBuffer) 336{ 337 ACPI_OPERAND_OBJECT *RetObj; 338 ACPI_STATUS Status; 339 UINT32 BufferSpaceNeeded = RetBuffer->Length; 340 341 342 FUNCTION_TRACE ("RsGetPrsMethodData"); 343 344 345 /* already validated params, so we won't repeat here */ 346 347 /* 348 * Execute the method, no parameters 349 */ 350 Status = AcpiNsEvaluateRelative (Handle, "_PRS", NULL, &RetObj); 351 if (ACPI_FAILURE (Status)) 352 { 353 return_ACPI_STATUS (Status); 354 } 355 356 if (!RetObj) 357 { 358 /* Return object is required */ 359 360 DEBUG_PRINT (ACPI_ERROR, ("No object was returned from _PRS\n")); 361 return_ACPI_STATUS (AE_TYPE); 362 } 363 364 /* 365 * The return object will be a buffer, but check the 366 * parameters. If the return object is not a buffer, 367 * then the underlying AML code is corrupt or improperly 368 * written.. 369 */ 370 if (ACPI_TYPE_BUFFER != RetObj->Common.Type) 371 { 372 Status = AE_AML_OPERAND_TYPE; 373 goto Cleanup; 374 } 375 376 /* 377 * Make the call to create a resource linked list from the 378 * byte stream buffer that comes back from the _CRS method 379 * execution. 380 */ 381 Status = AcpiRsCreateResourceList (RetObj, 382 RetBuffer->Pointer, 383 &BufferSpaceNeeded); 384 385 /* 386 * Tell the user how much of the buffer we have used or is needed 387 * and return the final status. 388 */ 389 RetBuffer->Length = BufferSpaceNeeded; 390 391 392 /* On exit, we must delete the object returned by evaluateObject */ 393 394Cleanup: 395 396 AcpiCmRemoveReference (RetObj); 397 398 return_ACPI_STATUS (Status); 399} 400 401 402/******************************************************************************* 403 * 404 * FUNCTION: AcpiRsSetSrsMethodData 405 * 406 * PARAMETERS: Handle - a handle to the containing object 407 * InBuffer - a pointer to a buffer structure of the 408 * parameter 409 * 410 * RETURN: Status - the status of the call 411 * 412 * DESCRIPTION: This function is called to set the _SRS of an object contained 413 * in an object specified by the handle passed in 414 * 415 * If the function fails an appropriate status will be returned 416 * and the contents of the callers buffer is undefined. 417 * 418 ******************************************************************************/ 419 420ACPI_STATUS 421AcpiRsSetSrsMethodData ( 422 ACPI_HANDLE Handle, 423 ACPI_BUFFER *InBuffer) 424{ 425 ACPI_OPERAND_OBJECT *Params[2]; 426 ACPI_OPERAND_OBJECT ParamObj; 427 ACPI_STATUS Status; 428 UINT8 *ByteStream = NULL; 429 UINT32 BufferSizeNeeded = 0; 430 431 432 FUNCTION_TRACE ("RsSetSrsMethodData"); 433 434 435 /* already validated params, so we won't repeat here */ 436 437 /* 438 * The InBuffer parameter will point to a linked list of 439 * resource parameters. It needs to be formatted into a 440 * byte stream to be sent in as an input parameter. 441 */ 442 BufferSizeNeeded = 0; 443 444 /* 445 * First call is to get the buffer size needed 446 */ 447 Status = AcpiRsCreateByteStream (InBuffer->Pointer, 448 ByteStream, 449 &BufferSizeNeeded); 450 /* 451 * We expect a return of AE_BUFFER_OVERFLOW 452 * if not, exit with the error 453 */ 454 if (AE_BUFFER_OVERFLOW != Status) 455 { 456 return_ACPI_STATUS (Status); 457 } 458 459 /* 460 * Allocate the buffer needed 461 */ 462 ByteStream = AcpiCmCallocate(BufferSizeNeeded); 463 if (NULL == ByteStream) 464 { 465 return_ACPI_STATUS (AE_NO_MEMORY); 466 } 467 468 /* 469 * Now call to convert the linked list into a byte stream 470 */ 471 Status = AcpiRsCreateByteStream (InBuffer->Pointer, 472 ByteStream, 473 &BufferSizeNeeded); 474 if (ACPI_FAILURE (Status)) 475 { 476 goto Cleanup; 477 } 478 479 /* 480 * Init the param object 481 */ 482 AcpiCmInitStaticObject (&ParamObj); 483 484 /* 485 * Method requires one parameter. Set it up 486 */ 487 Params [0] = &ParamObj; 488 Params [1] = NULL; 489 490 /* 491 * Set up the parameter object 492 */ 493 ParamObj.Common.Type = ACPI_TYPE_BUFFER; 494 ParamObj.Buffer.Length = BufferSizeNeeded; 495 ParamObj.Buffer.Pointer = ByteStream; 496 497 /* 498 * Execute the method, no return value 499 */ 500 Status = AcpiNsEvaluateRelative (Handle, "_SRS", Params, NULL); 501 502 /* 503 * Clean up and return the status from AcpiNsEvaluateRelative 504 */ 505 506Cleanup: 507 508 AcpiCmFree (ByteStream); 509 return_ACPI_STATUS (Status); 510} 511 512