acpixf.h revision 99679
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 - 2002, 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 129ACPI_STATUS 130AcpiInitializeSubsystem ( 131 void); 132 133ACPI_STATUS 134AcpiEnableSubsystem ( 135 UINT32 Flags); 136 137ACPI_STATUS 138AcpiTerminate ( 139 void); 140 141ACPI_STATUS 142AcpiSubsystemStatus ( 143 void); 144 145ACPI_STATUS 146AcpiEnable ( 147 void); 148 149ACPI_STATUS 150AcpiDisable ( 151 void); 152 153ACPI_STATUS 154AcpiGetSystemInfo ( 155 ACPI_BUFFER *RetBuffer); 156 157const char * 158AcpiFormatException ( 159 ACPI_STATUS Exception); 160 161ACPI_STATUS 162AcpiPurgeCachedObjects ( 163 void); 164 165ACPI_STATUS 166AcpiInstallInitializationHandler ( 167 ACPI_INIT_HANDLER Handler, 168 UINT32 Function); 169 170/* 171 * ACPI Memory manager 172 */ 173 174void * 175AcpiAllocate ( 176 UINT32 Size); 177 178void * 179AcpiCallocate ( 180 UINT32 Size); 181 182void 183AcpiFree ( 184 void *Address); 185 186 187/* 188 * ACPI table manipulation interfaces 189 */ 190 191ACPI_STATUS 192AcpiFindRootPointer ( 193 UINT32 Flags, 194 ACPI_POINTER *RsdpAddress); 195 196ACPI_STATUS 197AcpiLoadTables ( 198 void); 199 200ACPI_STATUS 201AcpiLoadTable ( 202 ACPI_TABLE_HEADER *TablePtr); 203 204ACPI_STATUS 205AcpiUnloadTable ( 206 ACPI_TABLE_TYPE TableType); 207 208ACPI_STATUS 209AcpiGetTableHeader ( 210 ACPI_TABLE_TYPE TableType, 211 UINT32 Instance, 212 ACPI_TABLE_HEADER *OutTableHeader); 213 214ACPI_STATUS 215AcpiGetTable ( 216 ACPI_TABLE_TYPE TableType, 217 UINT32 Instance, 218 ACPI_BUFFER *RetBuffer); 219 220ACPI_STATUS 221AcpiGetFirmwareTable ( 222 ACPI_STRING Signature, 223 UINT32 Instance, 224 UINT32 Flags, 225 ACPI_TABLE_HEADER **TablePointer); 226 227 228/* 229 * Namespace and name interfaces 230 */ 231 232ACPI_STATUS 233AcpiWalkNamespace ( 234 ACPI_OBJECT_TYPE Type, 235 ACPI_HANDLE StartObject, 236 UINT32 MaxDepth, 237 ACPI_WALK_CALLBACK UserFunction, 238 void *Context, 239 void * *ReturnValue); 240 241ACPI_STATUS 242AcpiGetDevices ( 243 NATIVE_CHAR *HID, 244 ACPI_WALK_CALLBACK UserFunction, 245 void *Context, 246 void **ReturnValue); 247 248ACPI_STATUS 249AcpiGetName ( 250 ACPI_HANDLE Handle, 251 UINT32 NameType, 252 ACPI_BUFFER *RetPathPtr); 253 254ACPI_STATUS 255AcpiGetHandle ( 256 ACPI_HANDLE Parent, 257 ACPI_STRING Pathname, 258 ACPI_HANDLE *RetHandle); 259 260ACPI_STATUS 261AcpiAttachData ( 262 ACPI_HANDLE ObjHandle, 263 ACPI_OBJECT_HANDLER Handler, 264 void *Data); 265 266ACPI_STATUS 267AcpiDetachData ( 268 ACPI_HANDLE ObjHandle, 269 ACPI_OBJECT_HANDLER Handler); 270 271ACPI_STATUS 272AcpiGetData ( 273 ACPI_HANDLE ObjHandle, 274 ACPI_OBJECT_HANDLER Handler, 275 void **Data); 276 277 278/* 279 * Object manipulation and enumeration 280 */ 281 282ACPI_STATUS 283AcpiEvaluateObject ( 284 ACPI_HANDLE Object, 285 ACPI_STRING Pathname, 286 ACPI_OBJECT_LIST *ParameterObjects, 287 ACPI_BUFFER *ReturnObjectBuffer); 288 289ACPI_STATUS 290AcpiEvaluateObjectTyped ( 291 ACPI_HANDLE Object, 292 ACPI_STRING Pathname, 293 ACPI_OBJECT_LIST *ExternalParams, 294 ACPI_BUFFER *ReturnBuffer, 295 ACPI_OBJECT_TYPE ReturnType); 296 297ACPI_STATUS 298AcpiGetObjectInfo ( 299 ACPI_HANDLE Device, 300 ACPI_DEVICE_INFO *Info); 301 302ACPI_STATUS 303AcpiGetNextObject ( 304 ACPI_OBJECT_TYPE Type, 305 ACPI_HANDLE Parent, 306 ACPI_HANDLE Child, 307 ACPI_HANDLE *OutHandle); 308 309ACPI_STATUS 310AcpiGetType ( 311 ACPI_HANDLE Object, 312 ACPI_OBJECT_TYPE *OutType); 313 314ACPI_STATUS 315AcpiGetParent ( 316 ACPI_HANDLE Object, 317 ACPI_HANDLE *OutHandle); 318 319 320/* 321 * Event handler interfaces 322 */ 323 324ACPI_STATUS 325AcpiInstallFixedEventHandler ( 326 UINT32 AcpiEvent, 327 ACPI_EVENT_HANDLER Handler, 328 void *Context); 329 330ACPI_STATUS 331AcpiRemoveFixedEventHandler ( 332 UINT32 AcpiEvent, 333 ACPI_EVENT_HANDLER Handler); 334 335ACPI_STATUS 336AcpiInstallNotifyHandler ( 337 ACPI_HANDLE Device, 338 UINT32 HandlerType, 339 ACPI_NOTIFY_HANDLER Handler, 340 void *Context); 341 342ACPI_STATUS 343AcpiRemoveNotifyHandler ( 344 ACPI_HANDLE Device, 345 UINT32 HandlerType, 346 ACPI_NOTIFY_HANDLER Handler); 347 348ACPI_STATUS 349AcpiInstallAddressSpaceHandler ( 350 ACPI_HANDLE Device, 351 ACPI_ADR_SPACE_TYPE SpaceId, 352 ACPI_ADR_SPACE_HANDLER Handler, 353 ACPI_ADR_SPACE_SETUP Setup, 354 void *Context); 355 356ACPI_STATUS 357AcpiRemoveAddressSpaceHandler ( 358 ACPI_HANDLE Device, 359 ACPI_ADR_SPACE_TYPE SpaceId, 360 ACPI_ADR_SPACE_HANDLER Handler); 361 362ACPI_STATUS 363AcpiInstallGpeHandler ( 364 UINT32 GpeNumber, 365 UINT32 Type, 366 ACPI_GPE_HANDLER Handler, 367 void *Context); 368 369ACPI_STATUS 370AcpiAcquireGlobalLock ( 371 UINT32 Timeout, 372 UINT32 *Handle); 373 374ACPI_STATUS 375AcpiReleaseGlobalLock ( 376 UINT32 Handle); 377 378ACPI_STATUS 379AcpiRemoveGpeHandler ( 380 UINT32 GpeNumber, 381 ACPI_GPE_HANDLER Handler); 382 383ACPI_STATUS 384AcpiEnableEvent ( 385 UINT32 AcpiEvent, 386 UINT32 Type, 387 UINT32 Flags); 388 389ACPI_STATUS 390AcpiDisableEvent ( 391 UINT32 AcpiEvent, 392 UINT32 Type, 393 UINT32 Flags); 394 395ACPI_STATUS 396AcpiClearEvent ( 397 UINT32 AcpiEvent, 398 UINT32 Type); 399 400ACPI_STATUS 401AcpiGetEventStatus ( 402 UINT32 AcpiEvent, 403 UINT32 Type, 404 ACPI_EVENT_STATUS *EventStatus); 405 406/* 407 * Resource interfaces 408 */ 409 410ACPI_STATUS 411AcpiGetCurrentResources( 412 ACPI_HANDLE DeviceHandle, 413 ACPI_BUFFER *RetBuffer); 414 415ACPI_STATUS 416AcpiGetPossibleResources( 417 ACPI_HANDLE DeviceHandle, 418 ACPI_BUFFER *RetBuffer); 419 420ACPI_STATUS 421AcpiSetCurrentResources ( 422 ACPI_HANDLE DeviceHandle, 423 ACPI_BUFFER *InBuffer); 424 425ACPI_STATUS 426AcpiGetIrqRoutingTable ( 427 ACPI_HANDLE BusDeviceHandle, 428 ACPI_BUFFER *RetBuffer); 429 430 431/* 432 * Hardware (ACPI device) interfaces 433 */ 434 435ACPI_STATUS 436AcpiGetRegister ( 437 UINT32 RegisterId, 438 UINT32 *ReturnValue, 439 UINT32 Flags); 440 441ACPI_STATUS 442AcpiSetRegister ( 443 UINT32 RegisterId, 444 UINT32 Value, 445 UINT32 Flags); 446 447ACPI_STATUS 448AcpiSetFirmwareWakingVector ( 449 ACPI_PHYSICAL_ADDRESS PhysicalAddress); 450 451ACPI_STATUS 452AcpiGetFirmwareWakingVector ( 453 ACPI_PHYSICAL_ADDRESS *PhysicalAddress); 454 455ACPI_STATUS 456AcpiGetSleepTypeData ( 457 UINT8 SleepState, 458 UINT8 *Slp_TypA, 459 UINT8 *Slp_TypB); 460 461ACPI_STATUS 462AcpiEnterSleepStatePrep ( 463 UINT8 SleepState); 464 465ACPI_STATUS 466AcpiEnterSleepState ( 467 UINT8 SleepState); 468 469ACPI_STATUS 470AcpiLeaveSleepState ( 471 UINT8 SleepState); 472 473 474#endif /* __ACXFACE_H__ */ 475