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