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 - 2008, 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 #include "actypes.h" 122 #include "actbl.h" 123 124 125 /* 126 * Global interfaces 127 */ 128 ACPI_STATUS 129 AcpiInitializeTables ( 130 ACPI_TABLE_DESC *InitialStorage, 131 UINT32 InitialTableCount, 132 BOOLEAN AllowResize); 133 134 ACPI_STATUS 135 AcpiInitializeSubsystem ( 136 void); 137 138 ACPI_STATUS 139 AcpiEnableSubsystem ( 140 UINT32 Flags); 141 142 ACPI_STATUS 143 AcpiInitializeObjects ( 144 UINT32 Flags); 145 146 ACPI_STATUS 147 AcpiTerminate ( 148 void); 149 150 ACPI_STATUS 151 AcpiSubsystemStatus ( 152 void); 153 154 ACPI_STATUS 155 AcpiEnable ( 156 void); 157 158 ACPI_STATUS 159 AcpiDisable ( 160 void); 161 162 ACPI_STATUS 163 AcpiGetSystemInfo ( 164 ACPI_BUFFER *RetBuffer); 165 166 ACPI_STATUS 167 AcpiGetStatistics ( 168 ACPI_STATISTICS *Stats); 169 170 const char * 171 AcpiFormatException ( 172 ACPI_STATUS Exception); 173 174 ACPI_STATUS 175 AcpiPurgeCachedObjects ( 176 void); 177 178 ACPI_STATUS 179 AcpiInstallInitializationHandler ( 180 ACPI_INIT_HANDLER Handler, 181 UINT32 Function); 182 183 /* 184 * ACPI Memory managment 185 */ 186 void * 187 AcpiAllocate ( 188 UINT32 Size); 189 190 void * 191 AcpiCallocate ( 192 UINT32 Size); 193 194 void 195 AcpiFree ( 196 void *Address); 197 198 199 /* 200 * ACPI table manipulation interfaces 201 */ 202 ACPI_STATUS 203 AcpiReallocateRootTable ( 204 void); 205 206 ACPI_STATUS 207 AcpiFindRootPointer ( 208 ACPI_SIZE *RsdpAddress); 209 210 ACPI_STATUS 211 AcpiLoadTables ( 212 void); 213 214 ACPI_STATUS 215 AcpiGetTableHeader ( 216 ACPI_STRING Signature, 217 UINT32 Instance, 218 ACPI_TABLE_HEADER *OutTableHeader); 219 220 ACPI_STATUS 221 AcpiGetTable ( 222 ACPI_STRING Signature, 223 UINT32 Instance, 224 ACPI_TABLE_HEADER **OutTable); 225 226 ACPI_STATUS 227 AcpiGetTableByIndex ( 228 UINT32 TableIndex, 229 ACPI_TABLE_HEADER **OutTable); 230 231 ACPI_STATUS 232 AcpiInstallTableHandler ( 233 ACPI_TABLE_HANDLER Handler, 234 void *Context); 235 236 ACPI_STATUS 237 AcpiRemoveTableHandler ( 238 ACPI_TABLE_HANDLER Handler); 239 240 241 /* 242 * Namespace and name interfaces 243 */ 244 ACPI_STATUS 245 AcpiWalkNamespace ( 246 ACPI_OBJECT_TYPE Type, 247 ACPI_HANDLE StartObject, 248 UINT32 MaxDepth, 249 ACPI_WALK_CALLBACK UserFunction, 250 void *Context, 251 void **ReturnValue); 252 253 ACPI_STATUS 254 AcpiGetDevices ( 255 char *HID, 256 ACPI_WALK_CALLBACK UserFunction, 257 void *Context, 258 void **ReturnValue); 259 260 ACPI_STATUS 261 AcpiGetName ( 262 ACPI_HANDLE Handle, 263 UINT32 NameType, 264 ACPI_BUFFER *RetPathPtr); 265 266 ACPI_STATUS 267 AcpiGetHandle ( 268 ACPI_HANDLE Parent, 269 ACPI_STRING Pathname, 270 ACPI_HANDLE *RetHandle); 271 272 ACPI_STATUS 273 AcpiAttachData ( 274 ACPI_HANDLE ObjHandle, 275 ACPI_OBJECT_HANDLER Handler, 276 void *Data); 277 278 ACPI_STATUS 279 AcpiDetachData ( 280 ACPI_HANDLE ObjHandle, 281 ACPI_OBJECT_HANDLER Handler); 282 283 ACPI_STATUS 284 AcpiGetData ( 285 ACPI_HANDLE ObjHandle, 286 ACPI_OBJECT_HANDLER Handler, 287 void **Data); 288 289 ACPI_STATUS 290 AcpiDebugTrace ( 291 char *Name, 292 UINT32 DebugLevel, 293 UINT32 DebugLayer, 294 UINT32 Flags); 295 296 297 /* 298 * Object manipulation and enumeration 299 */ 300 ACPI_STATUS 301 AcpiEvaluateObject ( 302 ACPI_HANDLE Object, 303 ACPI_STRING Pathname, 304 ACPI_OBJECT_LIST *ParameterObjects, 305 ACPI_BUFFER *ReturnObjectBuffer); 306 307 ACPI_STATUS 308 AcpiEvaluateObjectTyped ( 309 ACPI_HANDLE Object, 310 ACPI_STRING Pathname, 311 ACPI_OBJECT_LIST *ExternalParams, 312 ACPI_BUFFER *ReturnBuffer, 313 ACPI_OBJECT_TYPE ReturnType); 314 315 ACPI_STATUS 316 AcpiGetObjectInfo ( 317 ACPI_HANDLE Handle, 318 ACPI_BUFFER *ReturnBuffer); 319 320 ACPI_STATUS 321 AcpiGetNextObject ( 322 ACPI_OBJECT_TYPE Type, 323 ACPI_HANDLE Parent, 324 ACPI_HANDLE Child, 325 ACPI_HANDLE *OutHandle); 326 327 ACPI_STATUS 328 AcpiGetType ( 329 ACPI_HANDLE Object, 330 ACPI_OBJECT_TYPE *OutType); 331 332 ACPI_STATUS 333 AcpiGetParent ( 334 ACPI_HANDLE Object, 335 ACPI_HANDLE *OutHandle); 336 337 338 /* 339 * Event handler interfaces 340 */ 341 ACPI_STATUS 342 AcpiInstallFixedEventHandler ( 343 UINT32 AcpiEvent, 344 ACPI_EVENT_HANDLER Handler, 345 void *Context); 346 347 ACPI_STATUS 348 AcpiRemoveFixedEventHandler ( 349 UINT32 AcpiEvent, 350 ACPI_EVENT_HANDLER Handler); 351 352 ACPI_STATUS 353 AcpiInstallNotifyHandler ( 354 ACPI_HANDLE Device, 355 UINT32 HandlerType, 356 ACPI_NOTIFY_HANDLER Handler, 357 void *Context); 358 359 ACPI_STATUS 360 AcpiRemoveNotifyHandler ( 361 ACPI_HANDLE Device, 362 UINT32 HandlerType, 363 ACPI_NOTIFY_HANDLER Handler); 364 365 ACPI_STATUS 366 AcpiInstallAddressSpaceHandler ( 367 ACPI_HANDLE Device, 368 ACPI_ADR_SPACE_TYPE SpaceId, 369 ACPI_ADR_SPACE_HANDLER Handler, 370 ACPI_ADR_SPACE_SETUP Setup, 371 void *Context); 372 373 ACPI_STATUS 374 AcpiRemoveAddressSpaceHandler ( 375 ACPI_HANDLE Device, 376 ACPI_ADR_SPACE_TYPE SpaceId, 377 ACPI_ADR_SPACE_HANDLER Handler); 378 379 ACPI_STATUS 380 AcpiInstallGpeHandler ( 381 ACPI_HANDLE GpeDevice, 382 UINT32 GpeNumber, 383 UINT32 Type, 384 ACPI_EVENT_HANDLER Address, 385 void *Context); 386 387 ACPI_STATUS 388 AcpiInstallExceptionHandler ( 389 ACPI_EXCEPTION_HANDLER Handler); 390 391 392 /* 393 * Event interfaces 394 */ 395 ACPI_STATUS 396 AcpiAcquireGlobalLock ( 397 UINT16 Timeout, 398 UINT32 *Handle); 399 400 ACPI_STATUS 401 AcpiReleaseGlobalLock ( 402 UINT32 Handle); 403 404 ACPI_STATUS 405 AcpiRemoveGpeHandler ( 406 ACPI_HANDLE GpeDevice, 407 UINT32 GpeNumber, 408 ACPI_EVENT_HANDLER Address); 409 410 ACPI_STATUS 411 AcpiEnableEvent ( 412 UINT32 Event, 413 UINT32 Flags); 414 415 ACPI_STATUS 416 AcpiDisableEvent ( 417 UINT32 Event, 418 UINT32 Flags); 419 420 ACPI_STATUS 421 AcpiClearEvent ( 422 UINT32 Event); 423 424 ACPI_STATUS 425 AcpiGetEventStatus ( 426 UINT32 Event, 427 ACPI_EVENT_STATUS *EventStatus); 428 429 ACPI_STATUS 430 AcpiSetGpeType ( 431 ACPI_HANDLE GpeDevice, 432 UINT32 GpeNumber, 433 UINT8 Type); 434 435 ACPI_STATUS 436 AcpiEnableGpe ( 437 ACPI_HANDLE GpeDevice, 438 UINT32 GpeNumber, 439 UINT32 Flags); 440 441 ACPI_STATUS 442 AcpiDisableGpe ( 443 ACPI_HANDLE GpeDevice, 444 UINT32 GpeNumber, 445 UINT32 Flags); 446 447 ACPI_STATUS 448 AcpiClearGpe ( 449 ACPI_HANDLE GpeDevice, 450 UINT32 GpeNumber, 451 UINT32 Flags); 452 453 ACPI_STATUS 454 AcpiGetGpeStatus ( 455 ACPI_HANDLE GpeDevice, 456 UINT32 GpeNumber, 457 UINT32 Flags, 458 ACPI_EVENT_STATUS *EventStatus); 459 460 ACPI_STATUS 461 AcpiInstallGpeBlock ( 462 ACPI_HANDLE GpeDevice, 463 ACPI_GENERIC_ADDRESS *GpeBlockAddress, 464 UINT32 RegisterCount, 465 UINT32 InterruptNumber); 466 467 ACPI_STATUS 468 AcpiRemoveGpeBlock ( 469 ACPI_HANDLE GpeDevice); 470 471 472 /* 473 * Resource interfaces 474 */ 475 typedef 476 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) ( 477 ACPI_RESOURCE *Resource, 478 void *Context); 479 480 ACPI_STATUS 481 AcpiGetVendorResource ( 482 ACPI_HANDLE DeviceHandle, 483 char *Name, 484 ACPI_VENDOR_UUID *Uuid, 485 ACPI_BUFFER *RetBuffer); 486 487 ACPI_STATUS 488 AcpiGetCurrentResources( 489 ACPI_HANDLE DeviceHandle, 490 ACPI_BUFFER *RetBuffer); 491 492 ACPI_STATUS 493 AcpiGetPossibleResources( 494 ACPI_HANDLE DeviceHandle, 495 ACPI_BUFFER *RetBuffer); 496 497 ACPI_STATUS 498 AcpiWalkResources ( 499 ACPI_HANDLE DeviceHandle, 500 char *Name, 501 ACPI_WALK_RESOURCE_CALLBACK UserFunction, 502 void *Context); 503 504 ACPI_STATUS 505 AcpiSetCurrentResources ( 506 ACPI_HANDLE DeviceHandle, 507 ACPI_BUFFER *InBuffer); 508 509 ACPI_STATUS 510 AcpiGetIrqRoutingTable ( 511 ACPI_HANDLE BusDeviceHandle, 512 ACPI_BUFFER *RetBuffer); 513 514 ACPI_STATUS 515 AcpiResourceToAddress64 ( 516 ACPI_RESOURCE *Resource, 517 ACPI_RESOURCE_ADDRESS64 *Out); 518 519 /* 520 * Hardware (ACPI device) interfaces 521 */ 522 ACPI_STATUS 523 AcpiGetRegister ( 524 UINT32 RegisterId, 525 UINT32 *ReturnValue); 526 527 ACPI_STATUS 528 AcpiGetRegisterUnlocked ( 529 UINT32 RegisterId, 530 UINT32 *ReturnValue); 531 532 ACPI_STATUS 533 AcpiSetRegister ( 534 UINT32 RegisterId, 535 UINT32 Value); 536 537 ACPI_STATUS 538 AcpiSetFirmwareWakingVector ( 539 ACPI_PHYSICAL_ADDRESS PhysicalAddress); 540 541 ACPI_STATUS 542 AcpiGetFirmwareWakingVector ( 543 ACPI_PHYSICAL_ADDRESS *PhysicalAddress); 544 545 ACPI_STATUS 546 AcpiGetSleepTypeData ( 547 UINT8 SleepState, 548 UINT8 *Slp_TypA, 549 UINT8 *Slp_TypB); 550 551 ACPI_STATUS 552 AcpiEnterSleepStatePrep ( 553 UINT8 SleepState); 554 555 ACPI_STATUS 556 AcpiEnterSleepState ( 557 UINT8 SleepState); 558 559 ACPI_STATUS 560 AcpiEnterSleepStateS4bios ( 561 void); 562 563 ACPI_STATUS 564 AcpiLeaveSleepState ( 565 UINT8 SleepState); 566 567 568 #endif /* __ACXFACE_H__ */ 569