acpixf.h revision 69450
1226031Sstas 2226031Sstas/****************************************************************************** 3226031Sstas * 4226031Sstas * Name: acxface.h - External interfaces to the ACPI subsystem 5226031Sstas * 6226031Sstas *****************************************************************************/ 7226031Sstas 8226031Sstas/****************************************************************************** 9226031Sstas * 10226031Sstas * 1. Copyright Notice 11226031Sstas * 12226031Sstas * Some or all of this work - Copyright (c) 1999, Intel Corp. All rights 13226031Sstas * reserved. 14226031Sstas * 15226031Sstas * 2. License 16226031Sstas * 17226031Sstas * 2.1. This is your license from Intel Corp. under its intellectual property 18226031Sstas * rights. You may have additional license terms from the party that provided 19226031Sstas * you this software, covering your right to use that party's intellectual 20226031Sstas * property rights. 21226031Sstas * 22226031Sstas * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23226031Sstas * copy of the source code appearing in this file ("Covered Code") an 24226031Sstas * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25226031Sstas * base code distributed originally by Intel ("Original Intel Code") to copy, 26226031Sstas * make derivatives, distribute, use and display any portion of the Covered 27226031Sstas * Code in any form, with the right to sublicense such rights; and 28226031Sstas * 29226031Sstas * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30226031Sstas * license (with the right to sublicense), under only those claims of Intel 31226031Sstas * patents that are infringed by the Original Intel Code, to make, use, sell, 32226031Sstas * offer to sell, and import the Covered Code and derivative works thereof 33226031Sstas * solely to the minimum extent necessary to exercise the above copyright 34226031Sstas * license, and in no event shall the patent license extend to any additions 35226031Sstas * to or modifications of the Original Intel Code. No other license or right 36226031Sstas * is granted directly or by implication, estoppel or otherwise; 37226031Sstas * 38226031Sstas * The above copyright and patent license is granted only if the following 39226031Sstas * conditions are met: 40226031Sstas * 41226031Sstas * 3. Conditions 42226031Sstas * 43226031Sstas * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44226031Sstas * Redistribution of source code of any substantial portion of the Covered 45226031Sstas * Code or modification with rights to further distribute source must include 46226031Sstas * the above Copyright Notice, the above License, this list of Conditions, 47226031Sstas * and the following Disclaimer and Export Compliance provision. In addition, 48226031Sstas * Licensee must cause all Covered Code to which Licensee contributes to 49226031Sstas * contain a file documenting the changes Licensee made to create that Covered 50226031Sstas * Code and the date of any change. Licensee must include in that file the 51226031Sstas * documentation of any changes made by any predecessor Licensee. Licensee 52226031Sstas * must include a prominent statement that the modification is derived, 53226031Sstas * directly or indirectly, from Original Intel Code. 54226031Sstas * 55226031Sstas * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56226031Sstas * Redistribution of source code of any substantial portion of the Covered 57226031Sstas * Code or modification without rights to further distribute source must 58226031Sstas * include the following Disclaimer and Export Compliance provision in the 59226031Sstas * documentation and/or other materials provided with distribution. In 60226031Sstas * addition, Licensee may not authorize further sublicense of source of any 61226031Sstas * portion of the Covered Code, and must include terms to the effect that the 62226031Sstas * license from Licensee to its licensee is limited to the intellectual 63226031Sstas * property embodied in the software Licensee provides to its licensee, and 64226031Sstas * not to intellectual property embodied in modifications its licensee may 65226031Sstas * make. 66226031Sstas * 67226031Sstas * 3.3. Redistribution of Executable. Redistribution in executable form of any 68226031Sstas * substantial portion of the Covered Code or modification must reproduce the 69226031Sstas * above Copyright Notice, and the following Disclaimer and Export Compliance 70226031Sstas * provision in the documentation and/or other materials provided with the 71226031Sstas * distribution. 72226031Sstas * 73226031Sstas * 3.4. Intel retains all right, title, and interest in and to the Original 74226031Sstas * Intel Code. 75226031Sstas * 76226031Sstas * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77226031Sstas * Intel shall be used in advertising or otherwise to promote the sale, use or 78226031Sstas * other dealings in products derived from or relating to the Covered Code 79226031Sstas * without prior written authorization from Intel. 80226031Sstas * 81226031Sstas * 4. Disclaimer and Export Compliance 82226031Sstas * 83226031Sstas * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84226031Sstas * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85226031Sstas * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86226031Sstas * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87226031Sstas * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88226031Sstas * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89226031Sstas * PARTICULAR PURPOSE. 90226031Sstas * 91226031Sstas * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92226031Sstas * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93226031Sstas * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94226031Sstas * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95226031Sstas * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96226031Sstas * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97226031Sstas * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98226031Sstas * LIMITED REMEDY. 99226031Sstas * 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 * Global interfaces 126 */ 127 128ACPI_STATUS 129AcpiInitializeSubsystem ( 130 void); 131 132ACPI_STATUS 133AcpiEnableSubsystem ( 134 UINT32 Flags); 135 136ACPI_STATUS 137AcpiTerminate ( 138 void); 139 140ACPI_STATUS 141AcpiEnable ( 142 void); 143 144ACPI_STATUS 145AcpiDisable ( 146 void); 147 148ACPI_STATUS 149AcpiGetSystemInfo( 150 ACPI_BUFFER *RetBuffer); 151 152ACPI_STATUS 153AcpiFormatException ( 154 ACPI_STATUS Exception, 155 ACPI_BUFFER *OutBuffer); 156 157 158/* 159 * ACPI table manipulation interfaces 160 */ 161 162ACPI_STATUS 163AcpiFindRootPointer ( 164 ACPI_PHYSICAL_ADDRESS *RsdpPhysicalAddress); 165 166ACPI_STATUS 167AcpiLoadTables ( 168 ACPI_PHYSICAL_ADDRESS RsdpPhysicalAddress); 169 170ACPI_STATUS 171AcpiLoadTable ( 172 ACPI_TABLE_HEADER *TablePtr); 173 174ACPI_STATUS 175AcpiUnloadTable ( 176 ACPI_TABLE_TYPE TableType); 177 178ACPI_STATUS 179AcpiGetTableHeader ( 180 ACPI_TABLE_TYPE TableType, 181 UINT32 Instance, 182 ACPI_TABLE_HEADER *OutTableHeader); 183 184ACPI_STATUS 185AcpiGetTable ( 186 ACPI_TABLE_TYPE TableType, 187 UINT32 Instance, 188 ACPI_BUFFER *RetBuffer); 189 190 191/* 192 * Namespace and name interfaces 193 */ 194 195ACPI_STATUS 196AcpiWalkNamespace ( 197 ACPI_OBJECT_TYPE Type, 198 ACPI_HANDLE StartObject, 199 UINT32 MaxDepth, 200 WALK_CALLBACK UserFunction, 201 void *Context, 202 void * *ReturnValue); 203 204ACPI_STATUS 205AcpiGetDevices ( 206 NATIVE_CHAR *HID, 207 WALK_CALLBACK UserFunction, 208 void *Context, 209 void **ReturnValue); 210 211ACPI_STATUS 212AcpiGetName ( 213 ACPI_HANDLE Handle, 214 UINT32 NameType, 215 ACPI_BUFFER *RetPathPtr); 216 217ACPI_STATUS 218AcpiGetHandle ( 219 ACPI_HANDLE Parent, 220 ACPI_STRING Pathname, 221 ACPI_HANDLE *RetHandle); 222 223 224/* 225 * Object manipulation and enumeration 226 */ 227 228ACPI_STATUS 229AcpiEvaluateObject ( 230 ACPI_HANDLE Object, 231 ACPI_STRING Pathname, 232 ACPI_OBJECT_LIST *ParameterObjects, 233 ACPI_BUFFER *ReturnObjectBuffer); 234 235ACPI_STATUS 236AcpiGetObjectInfo ( 237 ACPI_HANDLE Device, 238 ACPI_DEVICE_INFO *Info); 239 240ACPI_STATUS 241AcpiGetNextObject ( 242 ACPI_OBJECT_TYPE Type, 243 ACPI_HANDLE Parent, 244 ACPI_HANDLE Child, 245 ACPI_HANDLE *OutHandle); 246 247ACPI_STATUS 248AcpiGetType ( 249 ACPI_HANDLE Object, 250 ACPI_OBJECT_TYPE *OutType); 251 252ACPI_STATUS 253AcpiGetParent ( 254 ACPI_HANDLE Object, 255 ACPI_HANDLE *OutHandle); 256 257 258/* 259 * AcpiEvent handler interfaces 260 */ 261 262ACPI_STATUS 263AcpiInstallFixedEventHandler ( 264 UINT32 AcpiEvent, 265 FIXED_EVENT_HANDLER Handler, 266 void *Context); 267 268ACPI_STATUS 269AcpiRemoveFixedEventHandler ( 270 UINT32 AcpiEvent, 271 FIXED_EVENT_HANDLER Handler); 272 273ACPI_STATUS 274AcpiInstallNotifyHandler ( 275 ACPI_HANDLE Device, 276 UINT32 HandlerType, 277 NOTIFY_HANDLER Handler, 278 void *Context); 279 280ACPI_STATUS 281AcpiRemoveNotifyHandler ( 282 ACPI_HANDLE Device, 283 UINT32 HandlerType, 284 NOTIFY_HANDLER Handler); 285 286ACPI_STATUS 287AcpiInstallAddressSpaceHandler ( 288 ACPI_HANDLE Device, 289 ACPI_ADDRESS_SPACE_TYPE SpaceId, 290 ADDRESS_SPACE_HANDLER Handler, 291 ADDRESS_SPACE_SETUP Setup, 292 void *Context); 293 294ACPI_STATUS 295AcpiRemoveAddressSpaceHandler ( 296 ACPI_HANDLE Device, 297 ACPI_ADDRESS_SPACE_TYPE SpaceId, 298 ADDRESS_SPACE_HANDLER Handler); 299 300ACPI_STATUS 301AcpiInstallGpeHandler ( 302 UINT32 GpeNumber, 303 UINT32 Type, 304 GPE_HANDLER Handler, 305 void *Context); 306 307ACPI_STATUS 308AcpiAcquireGlobalLock ( 309 void); 310 311ACPI_STATUS 312AcpiReleaseGlobalLock ( 313 void); 314 315ACPI_STATUS 316AcpiRemoveGpeHandler ( 317 UINT32 GpeNumber, 318 GPE_HANDLER Handler); 319 320ACPI_STATUS 321AcpiEnableEvent ( 322 UINT32 AcpiEvent, 323 UINT32 Type); 324 325ACPI_STATUS 326AcpiDisableEvent ( 327 UINT32 AcpiEvent, 328 UINT32 Type); 329 330ACPI_STATUS 331AcpiClearEvent ( 332 UINT32 AcpiEvent, 333 UINT32 Type); 334 335ACPI_STATUS 336AcpiGetEventStatus ( 337 UINT32 AcpiEvent, 338 UINT32 Type, 339 ACPI_EVENT_STATUS *EventStatus); 340 341/* 342 * Resource interfaces 343 */ 344 345ACPI_STATUS 346AcpiGetCurrentResources( 347 ACPI_HANDLE DeviceHandle, 348 ACPI_BUFFER *RetBuffer); 349 350ACPI_STATUS 351AcpiGetPossibleResources( 352 ACPI_HANDLE DeviceHandle, 353 ACPI_BUFFER *RetBuffer); 354 355ACPI_STATUS 356AcpiSetCurrentResources ( 357 ACPI_HANDLE DeviceHandle, 358 ACPI_BUFFER *InBuffer); 359 360ACPI_STATUS 361AcpiGetIrqRoutingTable ( 362 ACPI_HANDLE BusDeviceHandle, 363 ACPI_BUFFER *RetBuffer); 364 365 366/* 367 * Hardware (ACPI device) interfaces 368 */ 369 370ACPI_STATUS 371AcpiSetFirmwareWakingVector ( 372 ACPI_PHYSICAL_ADDRESS PhysicalAddress); 373 374ACPI_STATUS 375AcpiGetFirmwareWakingVector ( 376 ACPI_PHYSICAL_ADDRESS *PhysicalAddress); 377 378ACPI_STATUS 379AcpiGetProcessorThrottlingInfo ( 380 ACPI_HANDLE ProcessorHandle, 381 ACPI_BUFFER *UserBuffer); 382 383ACPI_STATUS 384AcpiSetProcessorThrottlingState ( 385 ACPI_HANDLE ProcessorHandle, 386 UINT32 ThrottleState); 387 388ACPI_STATUS 389AcpiGetProcessorThrottlingState ( 390 ACPI_HANDLE ProcessorHandle, 391 UINT32 *ThrottleState); 392 393ACPI_STATUS 394AcpiGetProcessorCxInfo ( 395 ACPI_HANDLE ProcessorHandle, 396 ACPI_BUFFER *UserBuffer); 397 398ACPI_STATUS 399AcpiSetProcessorSleepState ( 400 ACPI_HANDLE ProcessorHandle, 401 UINT32 CxState); 402 403ACPI_STATUS 404AcpiProcessorSleep ( 405 ACPI_HANDLE ProcessorHandle, 406 UINT32 *PmTimerTicks); 407 408 409#endif /* __ACXFACE_H__ */ 410