rsxface.c revision 138287
1202878Srdivacky/******************************************************************************* 2202878Srdivacky * 3202878Srdivacky * Module Name: rsxface - Public interfaces to the resource manager 4202878Srdivacky * $Revision: 31 $ 5202878Srdivacky * 6202878Srdivacky ******************************************************************************/ 7202878Srdivacky 8202878Srdivacky/****************************************************************************** 9202878Srdivacky * 10202878Srdivacky * 1. Copyright Notice 11202878Srdivacky * 12202878Srdivacky * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp. 13202878Srdivacky * All rights reserved. 14202878Srdivacky * 15205218Srdivacky * 2. License 16205218Srdivacky * 17205218Srdivacky * 2.1. This is your license from Intel Corp. under its intellectual property 18202878Srdivacky * rights. You may have additional license terms from the party that provided 19205218Srdivacky * you this software, covering your right to use that party's intellectual 20205218Srdivacky * property rights. 21202878Srdivacky * 22202878Srdivacky * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23202878Srdivacky * copy of the source code appearing in this file ("Covered Code") an 24202878Srdivacky * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25207618Srdivacky * base code distributed originally by Intel ("Original Intel Code") to copy, 26202878Srdivacky * make derivatives, distribute, use and display any portion of the Covered 27202878Srdivacky * Code in any form, with the right to sublicense such rights; and 28202878Srdivacky * 29207618Srdivacky * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30207618Srdivacky * license (with the right to sublicense), under only those claims of Intel 31202878Srdivacky * patents that are infringed by the Original Intel Code, to make, use, sell, 32202878Srdivacky * offer to sell, and import the Covered Code and derivative works thereof 33202878Srdivacky * solely to the minimum extent necessary to exercise the above copyright 34202878Srdivacky * license, and in no event shall the patent license extend to any additions 35202878Srdivacky * to or modifications of the Original Intel Code. No other license or right 36202878Srdivacky * is granted directly or by implication, estoppel or otherwise; 37202878Srdivacky * 38202878Srdivacky * The above copyright and patent license is granted only if the following 39202878Srdivacky * conditions are met: 40202878Srdivacky * 41202878Srdivacky * 3. Conditions 42202878Srdivacky * 43202878Srdivacky * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44202878Srdivacky * Redistribution of source code of any substantial portion of the Covered 45202878Srdivacky * Code or modification with rights to further distribute source must include 46202878Srdivacky * the above Copyright Notice, the above License, this list of Conditions, 47202878Srdivacky * and the following Disclaimer and Export Compliance provision. In addition, 48202878Srdivacky * Licensee must cause all Covered Code to which Licensee contributes to 49202878Srdivacky * contain a file documenting the changes Licensee made to create that Covered 50202878Srdivacky * Code and the date of any change. Licensee must include in that file the 51202878Srdivacky * documentation of any changes made by any predecessor Licensee. Licensee 52202878Srdivacky * must include a prominent statement that the modification is derived, 53202878Srdivacky * directly or indirectly, from Original Intel Code. 54202878Srdivacky * 55202878Srdivacky * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56202878Srdivacky * Redistribution of source code of any substantial portion of the Covered 57202878Srdivacky * Code or modification without rights to further distribute source must 58207618Srdivacky * include the following Disclaimer and Export Compliance provision in the 59202878Srdivacky * documentation and/or other materials provided with distribution. In 60207618Srdivacky * addition, Licensee may not authorize further sublicense of source of any 61202878Srdivacky * portion of the Covered Code, and must include terms to the effect that the 62202878Srdivacky * license from Licensee to its licensee is limited to the intellectual 63202878Srdivacky * property embodied in the software Licensee provides to its licensee, and 64202878Srdivacky * not to intellectual property embodied in modifications its licensee may 65202878Srdivacky * make. 66202878Srdivacky * 67202878Srdivacky * 3.3. Redistribution of Executable. Redistribution in executable form of any 68205218Srdivacky * substantial portion of the Covered Code or modification must reproduce the 69202878Srdivacky * above Copyright Notice, and the following Disclaimer and Export Compliance 70202878Srdivacky * provision in the documentation and/or other materials provided with the 71205218Srdivacky * distribution. 72202878Srdivacky * 73202878Srdivacky * 3.4. Intel retains all right, title, and interest in and to the Original 74202878Srdivacky * Intel Code. 75207618Srdivacky * 76207618Srdivacky * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77202878Srdivacky * Intel shall be used in advertising or otherwise to promote the sale, use or 78207618Srdivacky * other dealings in products derived from or relating to the Covered Code 79202878Srdivacky * without prior written authorization from Intel. 80202878Srdivacky * 81202878Srdivacky * 4. Disclaimer and Export Compliance 82202878Srdivacky * 83202878Srdivacky * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84202878Srdivacky * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85202878Srdivacky * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86202878Srdivacky * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87202878Srdivacky * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88202878Srdivacky * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89202878Srdivacky * PARTICULAR PURPOSE. 90202878Srdivacky * 91202878Srdivacky * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92202878Srdivacky * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93202878Srdivacky * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94202878Srdivacky * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95202878Srdivacky * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96202878Srdivacky * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97202878Srdivacky * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98202878Srdivacky * LIMITED REMEDY. 99202878Srdivacky * 100202878Srdivacky * 4.3. Licensee shall not export, either directly or indirectly, any of this 101202878Srdivacky * software or system incorporating such software without first obtaining any 102202878Srdivacky * required license or other approval from the U. S. Department of Commerce or 103202878Srdivacky * any other agency or department of the United States Government. In the 104202878Srdivacky * event Licensee exports any such software from the United States or 105202878Srdivacky * re-exports any such software from a foreign destination, Licensee shall 106202878Srdivacky * ensure that the distribution and export/re-export of the software is in 107202878Srdivacky * compliance with all laws, regulations, orders, or other restrictions of the 108202878Srdivacky * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109205218Srdivacky * any of its subsidiaries will export/re-export any technical data, process, 110205218Srdivacky * software, or service, directly or indirectly, to any country for which the 111202878Srdivacky * United States government or any agency thereof requires an export license, 112202878Srdivacky * other governmental approval, or letter of assurance, without first obtaining 113202878Srdivacky * such license, approval or letter. 114202878Srdivacky * 115202878Srdivacky *****************************************************************************/ 116202878Srdivacky 117202878Srdivacky 118202878Srdivacky#define __RSXFACE_C__ 119202878Srdivacky 120202878Srdivacky#include "acpi.h" 121202878Srdivacky#include "acresrc.h" 122202878Srdivacky 123202878Srdivacky#define _COMPONENT ACPI_RESOURCES 124202878Srdivacky ACPI_MODULE_NAME ("rsxface") 125202878Srdivacky 126202878Srdivacky 127202878Srdivacky/******************************************************************************* 128202878Srdivacky * 129202878Srdivacky * FUNCTION: AcpiGetIrqRoutingTable 130202878Srdivacky * 131202878Srdivacky * PARAMETERS: DeviceHandle - a handle to the Bus device we are querying 132202878Srdivacky * RetBuffer - a pointer to a buffer to receive the 133202878Srdivacky * current resources for the device 134202878Srdivacky * 135202878Srdivacky * RETURN: Status 136202878Srdivacky * 137202878Srdivacky * DESCRIPTION: This function is called to get the IRQ routing table for a 138202878Srdivacky * specific bus. The caller must first acquire a handle for the 139202878Srdivacky * desired bus. The routine table is placed in the buffer pointed 140202878Srdivacky * to by the RetBuffer variable parameter. 141202878Srdivacky * 142202878Srdivacky * If the function fails an appropriate status will be returned 143202878Srdivacky * and the value of RetBuffer is undefined. 144202878Srdivacky * 145205218Srdivacky * This function attempts to execute the _PRT method contained in 146202878Srdivacky * the object indicated by the passed DeviceHandle. 147202878Srdivacky * 148202878Srdivacky ******************************************************************************/ 149202878Srdivacky 150202878SrdivackyACPI_STATUS 151202878SrdivackyAcpiGetIrqRoutingTable ( 152202878Srdivacky ACPI_HANDLE DeviceHandle, 153205218Srdivacky ACPI_BUFFER *RetBuffer) 154205218Srdivacky{ 155205218Srdivacky ACPI_STATUS Status; 156205218Srdivacky 157205218Srdivacky 158205218Srdivacky ACPI_FUNCTION_TRACE ("AcpiGetIrqRoutingTable "); 159205218Srdivacky 160205218Srdivacky 161205218Srdivacky /* 162205218Srdivacky * Must have a valid handle and buffer, So we have to have a handle 163205218Srdivacky * and a return buffer structure, and if there is a non-zero buffer length 164205218Srdivacky * we also need a valid pointer in the buffer. If it's a zero buffer length, 165205218Srdivacky * we'll be returning the needed buffer size, so keep going. 166205218Srdivacky */ 167205218Srdivacky if (!DeviceHandle) 168205218Srdivacky { 169205218Srdivacky return_ACPI_STATUS (AE_BAD_PARAMETER); 170205218Srdivacky } 171205218Srdivacky 172202878Srdivacky Status = AcpiUtValidateBuffer (RetBuffer); 173205218Srdivacky if (ACPI_FAILURE (Status)) 174202878Srdivacky { 175202878Srdivacky return_ACPI_STATUS (Status); 176202878Srdivacky } 177202878Srdivacky 178202878Srdivacky Status = AcpiRsGetPrtMethodData (DeviceHandle, RetBuffer); 179202878Srdivacky return_ACPI_STATUS (Status); 180202878Srdivacky} 181202878Srdivacky 182202878Srdivacky 183212904Sdim/******************************************************************************* 184212904Sdim * 185202878Srdivacky * FUNCTION: AcpiGetCurrentResources 186202878Srdivacky * 187202878Srdivacky * PARAMETERS: DeviceHandle - a handle to the device object for the 188205218Srdivacky * device we are querying 189205218Srdivacky * RetBuffer - a pointer to a buffer to receive the 190205218Srdivacky * current resources for the device 191205218Srdivacky * 192205218Srdivacky * RETURN: Status 193205218Srdivacky * 194205218Srdivacky * DESCRIPTION: This function is called to get the current resources for a 195202878Srdivacky * specific device. The caller must first acquire a handle for 196205218Srdivacky * the desired device. The resource data is placed in the buffer 197205218Srdivacky * pointed to by the RetBuffer variable parameter. 198205218Srdivacky * 199202878Srdivacky * If the function fails an appropriate status will be returned 200205218Srdivacky * and the value of RetBuffer is undefined. 201205218Srdivacky * 202205218Srdivacky * This function attempts to execute the _CRS method contained in 203205218Srdivacky * the object indicated by the passed DeviceHandle. 204205218Srdivacky * 205205218Srdivacky ******************************************************************************/ 206205218Srdivacky 207205218SrdivackyACPI_STATUS 208205218SrdivackyAcpiGetCurrentResources ( 209205218Srdivacky ACPI_HANDLE DeviceHandle, 210205218Srdivacky ACPI_BUFFER *RetBuffer) 211205218Srdivacky{ 212205218Srdivacky ACPI_STATUS Status; 213205218Srdivacky 214205218Srdivacky 215205218Srdivacky ACPI_FUNCTION_TRACE ("AcpiGetCurrentResources"); 216205218Srdivacky 217205218Srdivacky 218205218Srdivacky /* 219205218Srdivacky * Must have a valid handle and buffer, So we have to have a handle 220205218Srdivacky * and a return buffer structure, and if there is a non-zero buffer length 221205218Srdivacky * we also need a valid pointer in the buffer. If it's a zero buffer length, 222205218Srdivacky * we'll be returning the needed buffer size, so keep going. 223205218Srdivacky */ 224205218Srdivacky if (!DeviceHandle) 225202878Srdivacky { 226202878Srdivacky return_ACPI_STATUS (AE_BAD_PARAMETER); 227202878Srdivacky } 228202878Srdivacky 229202878Srdivacky Status = AcpiUtValidateBuffer (RetBuffer); 230202878Srdivacky if (ACPI_FAILURE (Status)) 231202878Srdivacky { 232202878Srdivacky return_ACPI_STATUS (Status); 233202878Srdivacky } 234202878Srdivacky 235202878Srdivacky Status = AcpiRsGetCrsMethodData (DeviceHandle, RetBuffer); 236205218Srdivacky return_ACPI_STATUS (Status); 237205218Srdivacky} 238205218Srdivacky 239205218Srdivacky 240205218Srdivacky/******************************************************************************* 241205218Srdivacky * 242206083Srdivacky * FUNCTION: AcpiGetPossibleResources 243205218Srdivacky * 244205218Srdivacky * PARAMETERS: DeviceHandle - a handle to the device object for the 245205218Srdivacky * device we are querying 246 * RetBuffer - a pointer to a buffer to receive the 247 * resources for the device 248 * 249 * RETURN: Status 250 * 251 * DESCRIPTION: This function is called to get a list of the possible resources 252 * for a specific device. The caller must first acquire a handle 253 * for the desired device. The resource data is placed in the 254 * buffer pointed to by the RetBuffer variable. 255 * 256 * If the function fails an appropriate status will be returned 257 * and the value of RetBuffer is undefined. 258 * 259 ******************************************************************************/ 260 261ACPI_STATUS 262AcpiGetPossibleResources ( 263 ACPI_HANDLE DeviceHandle, 264 ACPI_BUFFER *RetBuffer) 265{ 266 ACPI_STATUS Status; 267 268 269 ACPI_FUNCTION_TRACE ("AcpiGetPossibleResources"); 270 271 272 /* 273 * Must have a valid handle and buffer, So we have to have a handle 274 * and a return buffer structure, and if there is a non-zero buffer length 275 * we also need a valid pointer in the buffer. If it's a zero buffer length, 276 * we'll be returning the needed buffer size, so keep going. 277 */ 278 if (!DeviceHandle) 279 { 280 return_ACPI_STATUS (AE_BAD_PARAMETER); 281 } 282 283 Status = AcpiUtValidateBuffer (RetBuffer); 284 if (ACPI_FAILURE (Status)) 285 { 286 return_ACPI_STATUS (Status); 287 } 288 289 Status = AcpiRsGetPrsMethodData (DeviceHandle, RetBuffer); 290 return_ACPI_STATUS (Status); 291} 292 293 294/******************************************************************************* 295 * 296 * FUNCTION: AcpiWalkResources 297 * 298 * PARAMETERS: DeviceHandle - a handle to the device object for the 299 * device we are querying 300 * Path - method name of the resources we want 301 * (METHOD_NAME__CRS or METHOD_NAME__PRS) 302 * UserFunction - called for each resource 303 * Context - passed to UserFunction 304 * 305 * RETURN: Status 306 * 307 * DESCRIPTION: Retrieves the current or possible resource list for the 308 * specified device. The UserFunction is called once for 309 * each resource in the list. 310 * 311 ******************************************************************************/ 312 313ACPI_STATUS 314AcpiWalkResources ( 315 ACPI_HANDLE DeviceHandle, 316 char *Path, 317 ACPI_WALK_RESOURCE_CALLBACK UserFunction, 318 void *Context) 319{ 320 ACPI_STATUS Status; 321 ACPI_BUFFER Buffer = {ACPI_ALLOCATE_BUFFER, NULL}; 322 ACPI_RESOURCE *Resource; 323 ACPI_RESOURCE *BufferEnd; 324 325 326 ACPI_FUNCTION_TRACE ("AcpiWalkResources"); 327 328 329 if (!DeviceHandle || 330 (ACPI_STRNCMP (Path, METHOD_NAME__CRS, sizeof (METHOD_NAME__CRS)) && 331 ACPI_STRNCMP (Path, METHOD_NAME__PRS, sizeof (METHOD_NAME__PRS)))) 332 { 333 return_ACPI_STATUS (AE_BAD_PARAMETER); 334 } 335 336 Status = AcpiRsGetMethodData (DeviceHandle, Path, &Buffer); 337 if (ACPI_FAILURE (Status)) 338 { 339 return_ACPI_STATUS (Status); 340 } 341 342 /* Setup pointers */ 343 344 Resource = (ACPI_RESOURCE *) Buffer.Pointer; 345 BufferEnd = ACPI_CAST_PTR (ACPI_RESOURCE, 346 ((UINT8 *) Buffer.Pointer + Buffer.Length)); 347 348 /* Walk the resource list */ 349 350 for (;;) 351 { 352 if (!Resource || Resource->Id == ACPI_RSTYPE_END_TAG) 353 { 354 break; 355 } 356 357 Status = UserFunction (Resource, Context); 358 359 switch (Status) 360 { 361 case AE_OK: 362 case AE_CTRL_DEPTH: 363 364 /* Just keep going */ 365 366 Status = AE_OK; 367 break; 368 369 case AE_CTRL_TERMINATE: 370 371 /* Exit now, with OK stats */ 372 373 Status = AE_OK; 374 goto Cleanup; 375 376 default: 377 378 /* All others are valid exceptions */ 379 380 goto Cleanup; 381 } 382 383 /* Get the next resource descriptor */ 384 385 Resource = ACPI_NEXT_RESOURCE (Resource); 386 387 /* Check for end-of-buffer */ 388 389 if (Resource >= BufferEnd) 390 { 391 goto Cleanup; 392 } 393 } 394 395Cleanup: 396 397 AcpiOsFree (Buffer.Pointer); 398 return_ACPI_STATUS (Status); 399} 400 401 402/******************************************************************************* 403 * 404 * FUNCTION: AcpiSetCurrentResources 405 * 406 * PARAMETERS: DeviceHandle - a handle to the device object for the 407 * device we are changing the resources of 408 * InBuffer - a pointer to a buffer containing the 409 * resources to be set for the device 410 * 411 * RETURN: Status 412 * 413 * DESCRIPTION: This function is called to set the current resources for a 414 * specific device. The caller must first acquire a handle for 415 * the desired device. The resource data is passed to the routine 416 * the buffer pointed to by the InBuffer variable. 417 * 418 ******************************************************************************/ 419 420ACPI_STATUS 421AcpiSetCurrentResources ( 422 ACPI_HANDLE DeviceHandle, 423 ACPI_BUFFER *InBuffer) 424{ 425 ACPI_STATUS Status; 426 427 428 ACPI_FUNCTION_TRACE ("AcpiSetCurrentResources"); 429 430 431 /* 432 * Must have a valid handle and buffer 433 */ 434 if ((!DeviceHandle) || 435 (!InBuffer) || 436 (!InBuffer->Pointer) || 437 (!InBuffer->Length)) 438 { 439 return_ACPI_STATUS (AE_BAD_PARAMETER); 440 } 441 442 Status = AcpiRsSetSrsMethodData (DeviceHandle, InBuffer); 443 return_ACPI_STATUS (Status); 444} 445 446 447#define ACPI_COPY_FIELD(Out, In, Field) ((Out)->Field = (In)->Field) 448#define ACPI_COPY_ADDRESS(Out, In) \ 449 ACPI_COPY_FIELD(Out, In, ResourceType); \ 450 ACPI_COPY_FIELD(Out, In, ProducerConsumer); \ 451 ACPI_COPY_FIELD(Out, In, Decode); \ 452 ACPI_COPY_FIELD(Out, In, MinAddressFixed); \ 453 ACPI_COPY_FIELD(Out, In, MaxAddressFixed); \ 454 ACPI_COPY_FIELD(Out, In, Attribute); \ 455 ACPI_COPY_FIELD(Out, In, Granularity); \ 456 ACPI_COPY_FIELD(Out, In, MinAddressRange); \ 457 ACPI_COPY_FIELD(Out, In, MaxAddressRange); \ 458 ACPI_COPY_FIELD(Out, In, AddressTranslationOffset); \ 459 ACPI_COPY_FIELD(Out, In, AddressLength); \ 460 ACPI_COPY_FIELD(Out, In, ResourceSource); 461 462/****************************************************************************** 463 * 464 * FUNCTION: AcpiResourceToAddress64 465 * 466 * PARAMETERS: resource - Pointer to a resource 467 * out - Pointer to the users's return 468 * buffer (a struct 469 * acpi_resource_address64) 470 * 471 * RETURN: Status 472 * 473 * DESCRIPTION: If the resource is an address16, address32, or address64, 474 * copy it to the address64 return buffer. This saves the 475 * caller from having to duplicate code for different-sized 476 * addresses. 477 * 478 ******************************************************************************/ 479 480ACPI_STATUS 481AcpiResourceToAddress64 ( 482 ACPI_RESOURCE *Resource, 483 ACPI_RESOURCE_ADDRESS64 *Out) 484{ 485 ACPI_RESOURCE_ADDRESS16 *Address16; 486 ACPI_RESOURCE_ADDRESS32 *Address32; 487 488 489 switch (Resource->Id) { 490 case ACPI_RSTYPE_ADDRESS16: 491 492 Address16 = (ACPI_RESOURCE_ADDRESS16 *) &Resource->Data; 493 ACPI_COPY_ADDRESS(Out, Address16); 494 break; 495 496 497 case ACPI_RSTYPE_ADDRESS32: 498 499 Address32 = (ACPI_RESOURCE_ADDRESS32 *) &Resource->Data; 500 ACPI_COPY_ADDRESS(Out, Address32); 501 break; 502 503 504 case ACPI_RSTYPE_ADDRESS64: 505 506 /* Simple copy for 64 bit source */ 507 508 ACPI_MEMCPY (Out, &Resource->Data, sizeof (ACPI_RESOURCE_ADDRESS64)); 509 break; 510 511 512 default: 513 return (AE_BAD_PARAMETER); 514 } 515 516 return (AE_OK); 517} 518