1 /******************************************************************************
3 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
48 /* Current ACPICA subsystem version in YYYYMMDD format */
50 #define ACPI_CA_VERSION 0x20131218
58 * Globals that are publically available
60 extern UINT32 AcpiCurrentGpeCount;
61 extern ACPI_TABLE_FADT AcpiGbl_FADT;
62 extern BOOLEAN AcpiGbl_SystemAwakeAndRunning;
63 extern BOOLEAN AcpiGbl_ReducedHardware; /* ACPI 5.0 */
64 extern UINT8 AcpiGbl_OsiData;
66 /* Runtime configuration of debug print levels */
68 extern UINT32 AcpiDbgLevel;
69 extern UINT32 AcpiDbgLayer;
71 /* ACPICA runtime options */
73 extern UINT8 AcpiGbl_AllMethodsSerialized;
74 extern UINT8 AcpiGbl_CopyDsdtLocally;
75 extern UINT8 AcpiGbl_CreateOsiMethod;
76 extern UINT8 AcpiGbl_DisableAutoRepair;
77 extern UINT8 AcpiGbl_DisableSsdtTableLoad;
78 extern UINT8 AcpiGbl_DoNotUseXsdt;
79 extern UINT8 AcpiGbl_EnableAmlDebugObject;
80 extern UINT8 AcpiGbl_EnableInterpreterSlack;
81 extern UINT32 AcpiGbl_TraceFlags;
82 extern ACPI_NAME AcpiGbl_TraceMethodName;
83 extern UINT8 AcpiGbl_TruncateIoAddresses;
84 extern UINT8 AcpiGbl_Use32BitFadtAddresses;
85 extern UINT8 AcpiGbl_UseDefaultRegisterWidths;
89 * Hardware-reduced prototypes. All interfaces that use these macros will
90 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
93 #if (!ACPI_REDUCED_HARDWARE)
94 #define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
97 #define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
100 #define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
104 #define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
105 static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);}
107 #define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
108 static ACPI_INLINE Prototype {return(AE_OK);}
110 #define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
111 static ACPI_INLINE Prototype {return;}
113 #endif /* !ACPI_REDUCED_HARDWARE */
120 AcpiInitializeTables (
121 ACPI_TABLE_DESC *InitialStorage,
122 UINT32 InitialTableCount,
123 BOOLEAN AllowResize);
126 AcpiInitializeSubsystem (
130 AcpiEnableSubsystem (
134 AcpiInitializeObjects (
143 * Miscellaneous global interfaces
145 ACPI_HW_DEPENDENT_RETURN_STATUS (
150 ACPI_HW_DEPENDENT_RETURN_STATUS (
156 AcpiSubsystemStatus (
161 ACPI_BUFFER *RetBuffer);
165 ACPI_STATISTICS *Stats);
168 AcpiFormatException (
169 ACPI_STATUS Exception);
172 AcpiPurgeCachedObjects (
176 AcpiInstallInterface (
177 ACPI_STRING InterfaceName);
180 AcpiRemoveInterface (
181 ACPI_STRING InterfaceName);
184 AcpiUpdateInterfaces (
188 AcpiCheckAddressRange (
189 ACPI_ADR_SPACE_TYPE SpaceId,
190 ACPI_PHYSICAL_ADDRESS Address,
195 AcpiDecodePldBuffer (
198 ACPI_PLD_INFO **ReturnBuffer);
202 * ACPI table load/unload interfaces
206 ACPI_TABLE_HEADER *Table);
209 AcpiUnloadParentTable (
218 * ACPI table manipulation interfaces
221 AcpiReallocateRootTable (
225 AcpiFindRootPointer (
226 ACPI_SIZE *RsdpAddress);
230 ACPI_STRING Signature,
232 ACPI_TABLE_HEADER *OutTableHeader);
236 ACPI_STRING Signature,
238 ACPI_TABLE_HEADER **OutTable);
241 AcpiGetTableByIndex (
243 ACPI_TABLE_HEADER **OutTable);
246 AcpiInstallTableHandler (
247 ACPI_TABLE_HANDLER Handler,
251 AcpiRemoveTableHandler (
252 ACPI_TABLE_HANDLER Handler);
256 * Namespace and name interfaces
260 ACPI_OBJECT_TYPE Type,
261 ACPI_HANDLE StartObject,
263 ACPI_WALK_CALLBACK DescendingCallback,
264 ACPI_WALK_CALLBACK AscendingCallback,
271 ACPI_WALK_CALLBACK UserFunction,
279 ACPI_BUFFER *RetPathPtr);
284 ACPI_STRING Pathname,
285 ACPI_HANDLE *RetHandle);
290 ACPI_OBJECT_HANDLER Handler,
296 ACPI_OBJECT_HANDLER Handler);
301 ACPI_OBJECT_HANDLER Handler,
313 * Object manipulation and enumeration
318 ACPI_STRING Pathname,
319 ACPI_OBJECT_LIST *ParameterObjects,
320 ACPI_BUFFER *ReturnObjectBuffer);
323 AcpiEvaluateObjectTyped (
325 ACPI_STRING Pathname,
326 ACPI_OBJECT_LIST *ExternalParams,
327 ACPI_BUFFER *ReturnBuffer,
328 ACPI_OBJECT_TYPE ReturnType);
333 ACPI_DEVICE_INFO **ReturnBuffer);
341 ACPI_OBJECT_TYPE Type,
344 ACPI_HANDLE *OutHandle);
349 ACPI_OBJECT_TYPE *OutType);
354 ACPI_HANDLE *OutHandle);
361 AcpiInstallInitializationHandler (
362 ACPI_INIT_HANDLER Handler,
365 ACPI_HW_DEPENDENT_RETURN_STATUS (
367 AcpiInstallSciHandler (
368 ACPI_SCI_HANDLER Address,
371 ACPI_HW_DEPENDENT_RETURN_STATUS (
373 AcpiRemoveSciHandler (
374 ACPI_SCI_HANDLER Address))
376 ACPI_HW_DEPENDENT_RETURN_STATUS (
378 AcpiInstallGlobalEventHandler (
379 ACPI_GBL_EVENT_HANDLER Handler,
382 ACPI_HW_DEPENDENT_RETURN_STATUS (
384 AcpiInstallFixedEventHandler (
386 ACPI_EVENT_HANDLER Handler,
389 ACPI_HW_DEPENDENT_RETURN_STATUS (
391 AcpiRemoveFixedEventHandler (
393 ACPI_EVENT_HANDLER Handler))
395 ACPI_HW_DEPENDENT_RETURN_STATUS (
397 AcpiInstallGpeHandler (
398 ACPI_HANDLE GpeDevice,
401 ACPI_GPE_HANDLER Address,
404 ACPI_HW_DEPENDENT_RETURN_STATUS (
406 AcpiRemoveGpeHandler (
407 ACPI_HANDLE GpeDevice,
409 ACPI_GPE_HANDLER Address))
412 AcpiInstallNotifyHandler (
415 ACPI_NOTIFY_HANDLER Handler,
419 AcpiRemoveNotifyHandler (
422 ACPI_NOTIFY_HANDLER Handler);
425 AcpiInstallAddressSpaceHandler (
427 ACPI_ADR_SPACE_TYPE SpaceId,
428 ACPI_ADR_SPACE_HANDLER Handler,
429 ACPI_ADR_SPACE_SETUP Setup,
433 AcpiRemoveAddressSpaceHandler (
435 ACPI_ADR_SPACE_TYPE SpaceId,
436 ACPI_ADR_SPACE_HANDLER Handler);
439 AcpiInstallExceptionHandler (
440 ACPI_EXCEPTION_HANDLER Handler);
443 AcpiInstallInterfaceHandler (
444 ACPI_INTERFACE_HANDLER Handler);
448 * Global Lock interfaces
450 ACPI_HW_DEPENDENT_RETURN_STATUS (
452 AcpiAcquireGlobalLock (
456 ACPI_HW_DEPENDENT_RETURN_STATUS (
458 AcpiReleaseGlobalLock (
463 * Interfaces to AML mutex objects
468 ACPI_STRING Pathname,
474 ACPI_STRING Pathname);
478 * Fixed Event interfaces
480 ACPI_HW_DEPENDENT_RETURN_STATUS (
486 ACPI_HW_DEPENDENT_RETURN_STATUS (
492 ACPI_HW_DEPENDENT_RETURN_STATUS (
497 ACPI_HW_DEPENDENT_RETURN_STATUS (
501 ACPI_EVENT_STATUS *EventStatus))
505 * General Purpose Event (GPE) Interfaces
507 ACPI_HW_DEPENDENT_RETURN_STATUS (
512 ACPI_HW_DEPENDENT_RETURN_STATUS (
515 ACPI_HANDLE GpeDevice,
518 ACPI_HW_DEPENDENT_RETURN_STATUS (
521 ACPI_HANDLE GpeDevice,
524 ACPI_HW_DEPENDENT_RETURN_STATUS (
527 ACPI_HANDLE GpeDevice,
530 ACPI_HW_DEPENDENT_RETURN_STATUS (
533 ACPI_HANDLE GpeDevice,
537 ACPI_HW_DEPENDENT_RETURN_STATUS (
540 ACPI_HANDLE GpeDevice,
543 ACPI_HW_DEPENDENT_RETURN_STATUS (
545 AcpiSetupGpeForWake (
546 ACPI_HANDLE ParentDevice,
547 ACPI_HANDLE GpeDevice,
550 ACPI_HW_DEPENDENT_RETURN_STATUS (
553 ACPI_HANDLE GpeDevice,
557 ACPI_HW_DEPENDENT_RETURN_STATUS (
560 ACPI_HANDLE GpeDevice,
562 ACPI_EVENT_STATUS *EventStatus))
564 ACPI_HW_DEPENDENT_RETURN_STATUS (
569 ACPI_HW_DEPENDENT_RETURN_STATUS (
571 AcpiEnableAllRuntimeGpes (
574 ACPI_HW_DEPENDENT_RETURN_STATUS (
578 ACPI_HANDLE *GpeDevice))
580 ACPI_HW_DEPENDENT_RETURN_STATUS (
582 AcpiInstallGpeBlock (
583 ACPI_HANDLE GpeDevice,
584 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
585 UINT32 RegisterCount,
586 UINT32 InterruptNumber))
588 ACPI_HW_DEPENDENT_RETURN_STATUS (
591 ACPI_HANDLE GpeDevice))
595 * Resource interfaces
598 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
599 ACPI_RESOURCE *Resource,
603 AcpiGetVendorResource (
606 ACPI_VENDOR_UUID *Uuid,
607 ACPI_BUFFER *RetBuffer);
610 AcpiGetCurrentResources (
612 ACPI_BUFFER *RetBuffer);
615 AcpiGetPossibleResources (
617 ACPI_BUFFER *RetBuffer);
620 AcpiGetEventResources (
621 ACPI_HANDLE DeviceHandle,
622 ACPI_BUFFER *RetBuffer);
625 AcpiWalkResourceBuffer (
627 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
634 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
638 AcpiSetCurrentResources (
640 ACPI_BUFFER *InBuffer);
643 AcpiGetIrqRoutingTable (
645 ACPI_BUFFER *RetBuffer);
648 AcpiResourceToAddress64 (
649 ACPI_RESOURCE *Resource,
650 ACPI_RESOURCE_ADDRESS64 *Out);
653 AcpiBufferToResource (
655 UINT16 AmlBufferLength,
656 ACPI_RESOURCE **ResourcePtr);
660 * Hardware (ACPI device) interfaces
669 ACPI_GENERIC_ADDRESS *Reg);
674 ACPI_GENERIC_ADDRESS *Reg);
676 ACPI_HW_DEPENDENT_RETURN_STATUS (
678 AcpiReadBitRegister (
680 UINT32 *ReturnValue))
682 ACPI_HW_DEPENDENT_RETURN_STATUS (
684 AcpiWriteBitRegister (
690 * Sleep/Wake interfaces
693 AcpiGetSleepTypeData (
699 AcpiEnterSleepStatePrep (
703 AcpiEnterSleepState (
706 ACPI_HW_DEPENDENT_RETURN_STATUS (
708 AcpiEnterSleepStateS4bios (
712 AcpiLeaveSleepStatePrep (
716 AcpiLeaveSleepState (
719 ACPI_HW_DEPENDENT_RETURN_STATUS (
721 AcpiSetFirmwareWakingVector (
722 UINT32 PhysicalAddress))
724 #if ACPI_MACHINE_WIDTH == 64
725 ACPI_HW_DEPENDENT_RETURN_STATUS (
727 AcpiSetFirmwareWakingVector64 (
728 UINT64 PhysicalAddress))
733 * ACPI Timer interfaces
735 ACPI_HW_DEPENDENT_RETURN_STATUS (
737 AcpiGetTimerResolution (
740 ACPI_HW_DEPENDENT_RETURN_STATUS (
745 ACPI_HW_DEPENDENT_RETURN_STATUS (
747 AcpiGetTimerDuration (
750 UINT32 *TimeElapsed))
754 * Error/Warning output
757 void ACPI_INTERNAL_VAR_XFACE
759 const char *ModuleName,
765 void ACPI_INTERNAL_VAR_XFACE
767 const char *ModuleName,
774 void ACPI_INTERNAL_VAR_XFACE
776 const char *ModuleName,
782 void ACPI_INTERNAL_VAR_XFACE
784 const char *ModuleName,
790 void ACPI_INTERNAL_VAR_XFACE
792 const char *ModuleName,
798 void ACPI_INTERNAL_VAR_XFACE
800 const char *ModuleName,
809 #ifdef ACPI_DEBUG_OUTPUT
812 void ACPI_INTERNAL_VAR_XFACE
814 UINT32 RequestedDebugLevel,
816 const char *FunctionName,
817 const char *ModuleName,
823 void ACPI_INTERNAL_VAR_XFACE
825 UINT32 RequestedDebugLevel,
827 const char *FunctionName,
828 const char *ModuleName,
834 #endif /* __ACXFACE_H__ */