1 2 /****************************************************************************** 3 * 4 * Name: acpixf.h - External interfaces to the ACPI subsystem 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2010, 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 #ifndef __ACXFACE_H__ 119 #define __ACXFACE_H__ 120 121 /* Current ACPICA subsystem version in YYYYMMDD format */ 122 123 #define ACPI_CA_VERSION 0x20100806 124 125 #include <contrib/dev/acpica/include/actypes.h> 126 #include <contrib/dev/acpica/include/actbl.h> 127 128 /* 129 * Globals that are publically available 130 */ 131 extern UINT32 AcpiCurrentGpeCount; 132 extern ACPI_TABLE_FADT AcpiGbl_FADT; 133 134 /* Runtime configuration of debug print levels */ 135 136 extern UINT32 AcpiDbgLevel; 137 extern UINT32 AcpiDbgLayer; 138 139 /* ACPICA runtime options */ 140 141 extern UINT8 AcpiGbl_EnableInterpreterSlack; 142 extern UINT8 AcpiGbl_AllMethodsSerialized; 143 extern UINT8 AcpiGbl_CreateOsiMethod; 144 extern UINT8 AcpiGbl_LeaveWakeGpesDisabled; 145 extern UINT8 AcpiGbl_UseDefaultRegisterWidths; 146 extern ACPI_NAME AcpiGbl_TraceMethodName; 147 extern UINT32 AcpiGbl_TraceFlags; 148 extern UINT8 AcpiGbl_EnableAmlDebugObject; 149 extern UINT8 AcpiGbl_CopyDsdtLocally; 150 extern UINT8 AcpiGbl_TruncateIoAddresses; 151 152 153 /* 154 * Global interfaces 155 */ 156 ACPI_STATUS 157 AcpiInitializeTables ( 158 ACPI_TABLE_DESC *InitialStorage, 159 UINT32 InitialTableCount, 160 BOOLEAN AllowResize); 161 162 ACPI_STATUS 163 AcpiInitializeSubsystem ( 164 void); 165 166 ACPI_STATUS 167 AcpiEnableSubsystem ( 168 UINT32 Flags); 169 170 ACPI_STATUS 171 AcpiInitializeObjects ( 172 UINT32 Flags); 173 174 ACPI_STATUS 175 AcpiTerminate ( 176 void); 177 178 ACPI_STATUS 179 AcpiSubsystemStatus ( 180 void); 181 182 ACPI_STATUS 183 AcpiEnable ( 184 void); 185 186 ACPI_STATUS 187 AcpiDisable ( 188 void); 189 190 ACPI_STATUS 191 AcpiGetSystemInfo ( 192 ACPI_BUFFER *RetBuffer); 193 194 ACPI_STATUS 195 AcpiGetStatistics ( 196 ACPI_STATISTICS *Stats); 197 198 const char * 199 AcpiFormatException ( 200 ACPI_STATUS Exception); 201 202 ACPI_STATUS 203 AcpiPurgeCachedObjects ( 204 void); 205 206 ACPI_STATUS 207 AcpiInstallInterface ( 208 ACPI_STRING InterfaceName); 209 210 ACPI_STATUS 211 AcpiRemoveInterface ( 212 ACPI_STRING InterfaceName); 213 214 /* 215 * ACPI Memory management 216 */ 217 void * 218 AcpiAllocate ( 219 UINT32 Size); 220 221 void * 222 AcpiCallocate ( 223 UINT32 Size); 224 225 void 226 AcpiFree ( 227 void *Address); 228 229 230 /* 231 * ACPI table manipulation interfaces 232 */ 233 ACPI_STATUS 234 AcpiReallocateRootTable ( 235 void); 236 237 ACPI_STATUS 238 AcpiFindRootPointer ( 239 ACPI_SIZE *RsdpAddress); 240 241 ACPI_STATUS 242 AcpiLoadTables ( 243 void); 244 245 ACPI_STATUS 246 AcpiGetTableHeader ( 247 ACPI_STRING Signature, 248 UINT32 Instance, 249 ACPI_TABLE_HEADER *OutTableHeader); 250 251 ACPI_STATUS 252 AcpiGetTable ( 253 ACPI_STRING Signature, 254 UINT32 Instance, 255 ACPI_TABLE_HEADER **OutTable); 256 257 ACPI_STATUS 258 AcpiGetTableByIndex ( 259 UINT32 TableIndex, 260 ACPI_TABLE_HEADER **OutTable); 261 262 ACPI_STATUS 263 AcpiInstallTableHandler ( 264 ACPI_TABLE_HANDLER Handler, 265 void *Context); 266 267 ACPI_STATUS 268 AcpiRemoveTableHandler ( 269 ACPI_TABLE_HANDLER Handler); 270 271 272 /* 273 * Namespace and name interfaces 274 */ 275 ACPI_STATUS 276 AcpiWalkNamespace ( 277 ACPI_OBJECT_TYPE Type, 278 ACPI_HANDLE StartObject, 279 UINT32 MaxDepth, 280 ACPI_WALK_CALLBACK PreOrderVisit, 281 ACPI_WALK_CALLBACK PostOrderVisit, 282 void *Context, 283 void **ReturnValue); 284 285 ACPI_STATUS 286 AcpiGetDevices ( 287 char *HID, 288 ACPI_WALK_CALLBACK UserFunction, 289 void *Context, 290 void **ReturnValue); 291 292 ACPI_STATUS 293 AcpiGetName ( 294 ACPI_HANDLE Object, 295 UINT32 NameType, 296 ACPI_BUFFER *RetPathPtr); 297 298 ACPI_STATUS 299 AcpiGetHandle ( 300 ACPI_HANDLE Parent, 301 ACPI_STRING Pathname, 302 ACPI_HANDLE *RetHandle); 303 304 ACPI_STATUS 305 AcpiAttachData ( 306 ACPI_HANDLE Object, 307 ACPI_OBJECT_HANDLER Handler, 308 void *Data); 309 310 ACPI_STATUS 311 AcpiDetachData ( 312 ACPI_HANDLE Object, 313 ACPI_OBJECT_HANDLER Handler); 314 315 ACPI_STATUS 316 AcpiGetData ( 317 ACPI_HANDLE Object, 318 ACPI_OBJECT_HANDLER Handler, 319 void **Data); 320 321 ACPI_STATUS 322 AcpiDebugTrace ( 323 char *Name, 324 UINT32 DebugLevel, 325 UINT32 DebugLayer, 326 UINT32 Flags); 327 328 329 /* 330 * Object manipulation and enumeration 331 */ 332 ACPI_STATUS 333 AcpiEvaluateObject ( 334 ACPI_HANDLE Object, 335 ACPI_STRING Pathname, 336 ACPI_OBJECT_LIST *ParameterObjects, 337 ACPI_BUFFER *ReturnObjectBuffer); 338 339 ACPI_STATUS 340 AcpiEvaluateObjectTyped ( 341 ACPI_HANDLE Object, 342 ACPI_STRING Pathname, 343 ACPI_OBJECT_LIST *ExternalParams, 344 ACPI_BUFFER *ReturnBuffer, 345 ACPI_OBJECT_TYPE ReturnType); 346 347 ACPI_STATUS 348 AcpiGetObjectInfo ( 349 ACPI_HANDLE Object, 350 ACPI_DEVICE_INFO **ReturnBuffer); 351 352 ACPI_STATUS 353 AcpiInstallMethod ( 354 UINT8 *Buffer); 355 356 ACPI_STATUS 357 AcpiGetNextObject ( 358 ACPI_OBJECT_TYPE Type, 359 ACPI_HANDLE Parent, 360 ACPI_HANDLE Child, 361 ACPI_HANDLE *OutHandle); 362 363 ACPI_STATUS 364 AcpiGetType ( 365 ACPI_HANDLE Object, 366 ACPI_OBJECT_TYPE *OutType); 367 368 ACPI_STATUS 369 AcpiGetParent ( 370 ACPI_HANDLE Object, 371 ACPI_HANDLE *OutHandle); 372 373 374 /* 375 * Handler interfaces 376 */ 377 ACPI_STATUS 378 AcpiInstallInitializationHandler ( 379 ACPI_INIT_HANDLER Handler, 380 UINT32 Function); 381 382 ACPI_STATUS 383 AcpiInstallFixedEventHandler ( 384 UINT32 AcpiEvent, 385 ACPI_EVENT_HANDLER Handler, 386 void *Context); 387 388 ACPI_STATUS 389 AcpiRemoveFixedEventHandler ( 390 UINT32 AcpiEvent, 391 ACPI_EVENT_HANDLER Handler); 392 393 ACPI_STATUS 394 AcpiInstallNotifyHandler ( 395 ACPI_HANDLE Device, 396 UINT32 HandlerType, 397 ACPI_NOTIFY_HANDLER Handler, 398 void *Context); 399 400 ACPI_STATUS 401 AcpiRemoveNotifyHandler ( 402 ACPI_HANDLE Device, 403 UINT32 HandlerType, 404 ACPI_NOTIFY_HANDLER Handler); 405 406 ACPI_STATUS 407 AcpiInstallAddressSpaceHandler ( 408 ACPI_HANDLE Device, 409 ACPI_ADR_SPACE_TYPE SpaceId, 410 ACPI_ADR_SPACE_HANDLER Handler, 411 ACPI_ADR_SPACE_SETUP Setup, 412 void *Context); 413 414 ACPI_STATUS 415 AcpiRemoveAddressSpaceHandler ( 416 ACPI_HANDLE Device, 417 ACPI_ADR_SPACE_TYPE SpaceId, 418 ACPI_ADR_SPACE_HANDLER Handler); 419 420 ACPI_STATUS 421 AcpiInstallGpeHandler ( 422 ACPI_HANDLE GpeDevice, 423 UINT32 GpeNumber, 424 UINT32 Type, 425 ACPI_EVENT_HANDLER Address, 426 void *Context); 427 428 ACPI_STATUS 429 AcpiRemoveGpeHandler ( 430 ACPI_HANDLE GpeDevice, 431 UINT32 GpeNumber, 432 ACPI_EVENT_HANDLER Address); 433 434 ACPI_STATUS 435 AcpiInstallExceptionHandler ( 436 ACPI_EXCEPTION_HANDLER Handler); 437 438 ACPI_STATUS 439 AcpiInstallInterfaceHandler ( 440 ACPI_INTERFACE_HANDLER Handler); 441 442 443 /* 444 * Event interfaces 445 */ 446 ACPI_STATUS 447 AcpiAcquireGlobalLock ( 448 UINT16 Timeout, 449 UINT32 *Handle); 450 451 ACPI_STATUS 452 AcpiReleaseGlobalLock ( 453 UINT32 Handle); 454 455 ACPI_STATUS 456 AcpiEnableEvent ( 457 UINT32 Event, 458 UINT32 Flags); 459 460 ACPI_STATUS 461 AcpiDisableEvent ( 462 UINT32 Event, 463 UINT32 Flags); 464 465 ACPI_STATUS 466 AcpiClearEvent ( 467 UINT32 Event); 468 469 ACPI_STATUS 470 AcpiGetEventStatus ( 471 UINT32 Event, 472 ACPI_EVENT_STATUS *EventStatus); 473 474 475 /* 476 * GPE Interfaces 477 */ 478 ACPI_STATUS 479 AcpiSetGpe ( 480 ACPI_HANDLE GpeDevice, 481 UINT32 GpeNumber, 482 UINT8 Action); 483 484 ACPI_STATUS 485 AcpiEnableGpe ( 486 ACPI_HANDLE GpeDevice, 487 UINT32 GpeNumber); 488 489 ACPI_STATUS 490 AcpiDisableGpe ( 491 ACPI_HANDLE GpeDevice, 492 UINT32 GpeNumber); 493 494 ACPI_STATUS 495 AcpiClearGpe ( 496 ACPI_HANDLE GpeDevice, 497 UINT32 GpeNumber); 498 499 ACPI_STATUS 500 AcpiGpeWakeup ( 501 ACPI_HANDLE GpeDevice, 502 UINT32 GpeNumber, 503 UINT8 Action); 504 505 ACPI_STATUS 506 AcpiGetGpeStatus ( 507 ACPI_HANDLE GpeDevice, 508 UINT32 GpeNumber, 509 ACPI_EVENT_STATUS *EventStatus); 510 511 ACPI_STATUS 512 AcpiDisableAllGpes ( 513 void); 514 515 ACPI_STATUS 516 AcpiEnableAllRuntimeGpes ( 517 void); 518 519 ACPI_STATUS 520 AcpiGetGpeDevice ( 521 UINT32 GpeIndex, 522 ACPI_HANDLE *GpeDevice); 523 524 ACPI_STATUS 525 AcpiInstallGpeBlock ( 526 ACPI_HANDLE GpeDevice, 527 ACPI_GENERIC_ADDRESS *GpeBlockAddress, 528 UINT32 RegisterCount, 529 UINT32 InterruptNumber); 530 531 ACPI_STATUS 532 AcpiRemoveGpeBlock ( 533 ACPI_HANDLE GpeDevice); 534 535 536 /* 537 * Resource interfaces 538 */ 539 typedef 540 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) ( 541 ACPI_RESOURCE *Resource, 542 void *Context); 543 544 ACPI_STATUS 545 AcpiGetVendorResource ( 546 ACPI_HANDLE Device, 547 char *Name, 548 ACPI_VENDOR_UUID *Uuid, 549 ACPI_BUFFER *RetBuffer); 550 551 ACPI_STATUS 552 AcpiGetCurrentResources ( 553 ACPI_HANDLE Device, 554 ACPI_BUFFER *RetBuffer); 555 556 ACPI_STATUS 557 AcpiGetPossibleResources ( 558 ACPI_HANDLE Device, 559 ACPI_BUFFER *RetBuffer); 560 561 ACPI_STATUS 562 AcpiWalkResources ( 563 ACPI_HANDLE Device, 564 char *Name, 565 ACPI_WALK_RESOURCE_CALLBACK UserFunction, 566 void *Context); 567 568 ACPI_STATUS 569 AcpiSetCurrentResources ( 570 ACPI_HANDLE Device, 571 ACPI_BUFFER *InBuffer); 572 573 ACPI_STATUS 574 AcpiGetIrqRoutingTable ( 575 ACPI_HANDLE Device, 576 ACPI_BUFFER *RetBuffer); 577 578 ACPI_STATUS 579 AcpiResourceToAddress64 ( 580 ACPI_RESOURCE *Resource, 581 ACPI_RESOURCE_ADDRESS64 *Out); 582 583 584 /* 585 * Hardware (ACPI device) interfaces 586 */ 587 ACPI_STATUS 588 AcpiReset ( 589 void); 590 591 ACPI_STATUS 592 AcpiRead ( 593 UINT64 *Value, 594 ACPI_GENERIC_ADDRESS *Reg); 595 596 ACPI_STATUS 597 AcpiWrite ( 598 UINT64 Value, 599 ACPI_GENERIC_ADDRESS *Reg); 600 601 ACPI_STATUS 602 AcpiReadBitRegister ( 603 UINT32 RegisterId, 604 UINT32 *ReturnValue); 605 606 ACPI_STATUS 607 AcpiWriteBitRegister ( 608 UINT32 RegisterId, 609 UINT32 Value); 610 611 ACPI_STATUS 612 AcpiGetSleepTypeData ( 613 UINT8 SleepState, 614 UINT8 *Slp_TypA, 615 UINT8 *Slp_TypB); 616 617 ACPI_STATUS 618 AcpiEnterSleepStatePrep ( 619 UINT8 SleepState); 620 621 ACPI_STATUS 622 AcpiEnterSleepState ( 623 UINT8 SleepState); 624 625 ACPI_STATUS 626 AcpiEnterSleepStateS4bios ( 627 void); 628 629 ACPI_STATUS 630 AcpiLeaveSleepState ( 631 UINT8 SleepState) 632 ; 633 ACPI_STATUS 634 AcpiSetFirmwareWakingVector ( 635 UINT32 PhysicalAddress); 636 637 #if ACPI_MACHINE_WIDTH == 64 638 ACPI_STATUS 639 AcpiSetFirmwareWakingVector64 ( 640 UINT64 PhysicalAddress); 641 #endif 642 643 644 /* 645 * Error/Warning output 646 */ 647 void ACPI_INTERNAL_VAR_XFACE 648 AcpiError ( 649 const char *ModuleName, 650 UINT32 LineNumber, 651 const char *Format, 652 ...) ACPI_PRINTF_LIKE(3); 653 654 void ACPI_INTERNAL_VAR_XFACE 655 AcpiException ( 656 const char *ModuleName, 657 UINT32 LineNumber, 658 ACPI_STATUS Status, 659 const char *Format, 660 ...) ACPI_PRINTF_LIKE(4); 661 662 void ACPI_INTERNAL_VAR_XFACE 663 AcpiWarning ( 664 const char *ModuleName, 665 UINT32 LineNumber, 666 const char *Format, 667 ...) ACPI_PRINTF_LIKE(3); 668 669 void ACPI_INTERNAL_VAR_XFACE 670 AcpiInfo ( 671 const char *ModuleName, 672 UINT32 LineNumber, 673 const char *Format, 674 ...) ACPI_PRINTF_LIKE(3); 675 676 677 /* 678 * Debug output 679 */ 680 #ifdef ACPI_DEBUG_OUTPUT 681 682 void ACPI_INTERNAL_VAR_XFACE 683 AcpiDebugPrint ( 684 UINT32 RequestedDebugLevel, 685 UINT32 LineNumber, 686 const char *FunctionName, 687 const char *ModuleName, 688 UINT32 ComponentId, 689 const char *Format, 690 ...) ACPI_PRINTF_LIKE(6); 691 692 void ACPI_INTERNAL_VAR_XFACE 693 AcpiDebugPrintRaw ( 694 UINT32 RequestedDebugLevel, 695 UINT32 LineNumber, 696 const char *FunctionName, 697 const char *ModuleName, 698 UINT32 ComponentId, 699 const char *Format, 700 ...) ACPI_PRINTF_LIKE(6); 701 #endif 702 703 #endif /* __ACXFACE_H__ */ 704