1 /******************************************************************************
3 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, 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 0x20140214
57 #pragma pack(push) /* Set default struct packing */
60 * Globals that are publically available
62 extern UINT32 AcpiCurrentGpeCount;
63 extern ACPI_TABLE_FADT AcpiGbl_FADT;
64 extern BOOLEAN AcpiGbl_SystemAwakeAndRunning;
65 extern BOOLEAN AcpiGbl_ReducedHardware; /* ACPI 5.0 */
66 extern UINT8 AcpiGbl_OsiData;
68 /* Runtime configuration of debug print levels */
70 extern UINT32 AcpiDbgLevel;
71 extern UINT32 AcpiDbgLayer;
73 /* ACPICA runtime options */
75 extern UINT8 AcpiGbl_AutoSerializeMethods;
76 extern UINT8 AcpiGbl_CopyDsdtLocally;
77 extern UINT8 AcpiGbl_CreateOsiMethod;
78 extern UINT8 AcpiGbl_DisableAutoRepair;
79 extern UINT8 AcpiGbl_DisableSsdtTableLoad;
80 extern UINT8 AcpiGbl_DoNotUseXsdt;
81 extern UINT8 AcpiGbl_EnableAmlDebugObject;
82 extern UINT8 AcpiGbl_EnableInterpreterSlack;
83 extern UINT32 AcpiGbl_TraceFlags;
84 extern ACPI_NAME AcpiGbl_TraceMethodName;
85 extern UINT8 AcpiGbl_TruncateIoAddresses;
86 extern UINT8 AcpiGbl_Use32BitFadtAddresses;
87 extern UINT8 AcpiGbl_UseDefaultRegisterWidths;
91 * Hardware-reduced prototypes. All interfaces that use these macros will
92 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
95 #if (!ACPI_REDUCED_HARDWARE)
96 #define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
99 #define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
102 #define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
106 #define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
107 static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);}
109 #define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
110 static ACPI_INLINE Prototype {return(AE_OK);}
112 #define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
113 static ACPI_INLINE Prototype {return;}
115 #endif /* !ACPI_REDUCED_HARDWARE */
122 AcpiInitializeTables (
123 ACPI_TABLE_DESC *InitialStorage,
124 UINT32 InitialTableCount,
125 BOOLEAN AllowResize);
128 AcpiInitializeSubsystem (
132 AcpiEnableSubsystem (
136 AcpiInitializeObjects (
145 * Miscellaneous global interfaces
147 ACPI_HW_DEPENDENT_RETURN_STATUS (
152 ACPI_HW_DEPENDENT_RETURN_STATUS (
158 AcpiSubsystemStatus (
163 ACPI_BUFFER *RetBuffer);
167 ACPI_STATISTICS *Stats);
170 AcpiFormatException (
171 ACPI_STATUS Exception);
174 AcpiPurgeCachedObjects (
178 AcpiInstallInterface (
179 ACPI_STRING InterfaceName);
182 AcpiRemoveInterface (
183 ACPI_STRING InterfaceName);
186 AcpiUpdateInterfaces (
190 AcpiCheckAddressRange (
191 ACPI_ADR_SPACE_TYPE SpaceId,
192 ACPI_PHYSICAL_ADDRESS Address,
197 AcpiDecodePldBuffer (
200 ACPI_PLD_INFO **ReturnBuffer);
204 * ACPI table load/unload interfaces
208 ACPI_TABLE_HEADER *Table);
211 AcpiUnloadParentTable (
220 * ACPI table manipulation interfaces
223 AcpiReallocateRootTable (
227 AcpiFindRootPointer (
228 ACPI_SIZE *RsdpAddress);
232 ACPI_STRING Signature,
234 ACPI_TABLE_HEADER *OutTableHeader);
238 ACPI_STRING Signature,
240 ACPI_TABLE_HEADER **OutTable);
243 AcpiGetTableByIndex (
245 ACPI_TABLE_HEADER **OutTable);
248 AcpiInstallTableHandler (
249 ACPI_TABLE_HANDLER Handler,
253 AcpiRemoveTableHandler (
254 ACPI_TABLE_HANDLER Handler);
258 * Namespace and name interfaces
262 ACPI_OBJECT_TYPE Type,
263 ACPI_HANDLE StartObject,
265 ACPI_WALK_CALLBACK DescendingCallback,
266 ACPI_WALK_CALLBACK AscendingCallback,
273 ACPI_WALK_CALLBACK UserFunction,
281 ACPI_BUFFER *RetPathPtr);
286 ACPI_STRING Pathname,
287 ACPI_HANDLE *RetHandle);
292 ACPI_OBJECT_HANDLER Handler,
298 ACPI_OBJECT_HANDLER Handler);
303 ACPI_OBJECT_HANDLER Handler,
315 * Object manipulation and enumeration
320 ACPI_STRING Pathname,
321 ACPI_OBJECT_LIST *ParameterObjects,
322 ACPI_BUFFER *ReturnObjectBuffer);
325 AcpiEvaluateObjectTyped (
327 ACPI_STRING Pathname,
328 ACPI_OBJECT_LIST *ExternalParams,
329 ACPI_BUFFER *ReturnBuffer,
330 ACPI_OBJECT_TYPE ReturnType);
335 ACPI_DEVICE_INFO **ReturnBuffer);
343 ACPI_OBJECT_TYPE Type,
346 ACPI_HANDLE *OutHandle);
351 ACPI_OBJECT_TYPE *OutType);
356 ACPI_HANDLE *OutHandle);
363 AcpiInstallInitializationHandler (
364 ACPI_INIT_HANDLER Handler,
367 ACPI_HW_DEPENDENT_RETURN_STATUS (
369 AcpiInstallSciHandler (
370 ACPI_SCI_HANDLER Address,
373 ACPI_HW_DEPENDENT_RETURN_STATUS (
375 AcpiRemoveSciHandler (
376 ACPI_SCI_HANDLER Address))
378 ACPI_HW_DEPENDENT_RETURN_STATUS (
380 AcpiInstallGlobalEventHandler (
381 ACPI_GBL_EVENT_HANDLER Handler,
384 ACPI_HW_DEPENDENT_RETURN_STATUS (
386 AcpiInstallFixedEventHandler (
388 ACPI_EVENT_HANDLER Handler,
391 ACPI_HW_DEPENDENT_RETURN_STATUS (
393 AcpiRemoveFixedEventHandler (
395 ACPI_EVENT_HANDLER Handler))
397 ACPI_HW_DEPENDENT_RETURN_STATUS (
399 AcpiInstallGpeHandler (
400 ACPI_HANDLE GpeDevice,
403 ACPI_GPE_HANDLER Address,
406 ACPI_HW_DEPENDENT_RETURN_STATUS (
408 AcpiRemoveGpeHandler (
409 ACPI_HANDLE GpeDevice,
411 ACPI_GPE_HANDLER Address))
414 AcpiInstallNotifyHandler (
417 ACPI_NOTIFY_HANDLER Handler,
421 AcpiRemoveNotifyHandler (
424 ACPI_NOTIFY_HANDLER Handler);
427 AcpiInstallAddressSpaceHandler (
429 ACPI_ADR_SPACE_TYPE SpaceId,
430 ACPI_ADR_SPACE_HANDLER Handler,
431 ACPI_ADR_SPACE_SETUP Setup,
435 AcpiRemoveAddressSpaceHandler (
437 ACPI_ADR_SPACE_TYPE SpaceId,
438 ACPI_ADR_SPACE_HANDLER Handler);
441 AcpiInstallExceptionHandler (
442 ACPI_EXCEPTION_HANDLER Handler);
445 AcpiInstallInterfaceHandler (
446 ACPI_INTERFACE_HANDLER Handler);
450 * Global Lock interfaces
452 ACPI_HW_DEPENDENT_RETURN_STATUS (
454 AcpiAcquireGlobalLock (
458 ACPI_HW_DEPENDENT_RETURN_STATUS (
460 AcpiReleaseGlobalLock (
465 * Interfaces to AML mutex objects
470 ACPI_STRING Pathname,
476 ACPI_STRING Pathname);
480 * Fixed Event interfaces
482 ACPI_HW_DEPENDENT_RETURN_STATUS (
488 ACPI_HW_DEPENDENT_RETURN_STATUS (
494 ACPI_HW_DEPENDENT_RETURN_STATUS (
499 ACPI_HW_DEPENDENT_RETURN_STATUS (
503 ACPI_EVENT_STATUS *EventStatus))
507 * General Purpose Event (GPE) Interfaces
509 ACPI_HW_DEPENDENT_RETURN_STATUS (
514 ACPI_HW_DEPENDENT_RETURN_STATUS (
517 ACPI_HANDLE GpeDevice,
520 ACPI_HW_DEPENDENT_RETURN_STATUS (
523 ACPI_HANDLE GpeDevice,
526 ACPI_HW_DEPENDENT_RETURN_STATUS (
529 ACPI_HANDLE GpeDevice,
532 ACPI_HW_DEPENDENT_RETURN_STATUS (
535 ACPI_HANDLE GpeDevice,
539 ACPI_HW_DEPENDENT_RETURN_STATUS (
542 ACPI_HANDLE GpeDevice,
545 ACPI_HW_DEPENDENT_RETURN_STATUS (
547 AcpiSetupGpeForWake (
548 ACPI_HANDLE ParentDevice,
549 ACPI_HANDLE GpeDevice,
552 ACPI_HW_DEPENDENT_RETURN_STATUS (
555 ACPI_HANDLE GpeDevice,
559 ACPI_HW_DEPENDENT_RETURN_STATUS (
562 ACPI_HANDLE GpeDevice,
564 ACPI_EVENT_STATUS *EventStatus))
566 ACPI_HW_DEPENDENT_RETURN_STATUS (
571 ACPI_HW_DEPENDENT_RETURN_STATUS (
573 AcpiEnableAllRuntimeGpes (
576 ACPI_HW_DEPENDENT_RETURN_STATUS (
580 ACPI_HANDLE *GpeDevice))
582 ACPI_HW_DEPENDENT_RETURN_STATUS (
584 AcpiInstallGpeBlock (
585 ACPI_HANDLE GpeDevice,
586 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
587 UINT32 RegisterCount,
588 UINT32 InterruptNumber))
590 ACPI_HW_DEPENDENT_RETURN_STATUS (
593 ACPI_HANDLE GpeDevice))
597 * Resource interfaces
600 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
601 ACPI_RESOURCE *Resource,
605 AcpiGetVendorResource (
608 ACPI_VENDOR_UUID *Uuid,
609 ACPI_BUFFER *RetBuffer);
612 AcpiGetCurrentResources (
614 ACPI_BUFFER *RetBuffer);
617 AcpiGetPossibleResources (
619 ACPI_BUFFER *RetBuffer);
622 AcpiGetEventResources (
623 ACPI_HANDLE DeviceHandle,
624 ACPI_BUFFER *RetBuffer);
627 AcpiWalkResourceBuffer (
629 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
636 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
640 AcpiSetCurrentResources (
642 ACPI_BUFFER *InBuffer);
645 AcpiGetIrqRoutingTable (
647 ACPI_BUFFER *RetBuffer);
650 AcpiResourceToAddress64 (
651 ACPI_RESOURCE *Resource,
652 ACPI_RESOURCE_ADDRESS64 *Out);
655 AcpiBufferToResource (
657 UINT16 AmlBufferLength,
658 ACPI_RESOURCE **ResourcePtr);
662 * Hardware (ACPI device) interfaces
671 ACPI_GENERIC_ADDRESS *Reg);
676 ACPI_GENERIC_ADDRESS *Reg);
678 ACPI_HW_DEPENDENT_RETURN_STATUS (
680 AcpiReadBitRegister (
682 UINT32 *ReturnValue))
684 ACPI_HW_DEPENDENT_RETURN_STATUS (
686 AcpiWriteBitRegister (
692 * Sleep/Wake interfaces
695 AcpiGetSleepTypeData (
701 AcpiEnterSleepStatePrep (
705 AcpiEnterSleepState (
708 ACPI_HW_DEPENDENT_RETURN_STATUS (
710 AcpiEnterSleepStateS4bios (
714 AcpiLeaveSleepStatePrep (
718 AcpiLeaveSleepState (
721 ACPI_HW_DEPENDENT_RETURN_STATUS (
723 AcpiSetFirmwareWakingVector (
724 UINT32 PhysicalAddress))
726 #if ACPI_MACHINE_WIDTH == 64
727 ACPI_HW_DEPENDENT_RETURN_STATUS (
729 AcpiSetFirmwareWakingVector64 (
730 UINT64 PhysicalAddress))
735 * ACPI Timer interfaces
737 ACPI_HW_DEPENDENT_RETURN_STATUS (
739 AcpiGetTimerResolution (
742 ACPI_HW_DEPENDENT_RETURN_STATUS (
747 ACPI_HW_DEPENDENT_RETURN_STATUS (
749 AcpiGetTimerDuration (
752 UINT32 *TimeElapsed))
756 * Error/Warning output
759 void ACPI_INTERNAL_VAR_XFACE
761 const char *ModuleName,
767 void ACPI_INTERNAL_VAR_XFACE
769 const char *ModuleName,
776 void ACPI_INTERNAL_VAR_XFACE
778 const char *ModuleName,
784 void ACPI_INTERNAL_VAR_XFACE
786 const char *ModuleName,
792 void ACPI_INTERNAL_VAR_XFACE
794 const char *ModuleName,
800 void ACPI_INTERNAL_VAR_XFACE
802 const char *ModuleName,
811 #ifdef ACPI_DEBUG_OUTPUT
814 void ACPI_INTERNAL_VAR_XFACE
816 UINT32 RequestedDebugLevel,
818 const char *FunctionName,
819 const char *ModuleName,
825 void ACPI_INTERNAL_VAR_XFACE
827 UINT32 RequestedDebugLevel,
829 const char *FunctionName,
830 const char *ModuleName,
836 #pragma pack(pop) /* Restore original struct packing */
838 #endif /* __ACXFACE_H__ */