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 0x20140325
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_AutoSerializeMethods;
74 extern UINT8 AcpiGbl_CopyDsdtLocally;
75 extern UINT8 AcpiGbl_CreateOsiMethod;
76 extern UINT8 AcpiGbl_DisableAutoRepair;
77 extern UINT8 AcpiGbl_DisableSsdtTableInstall;
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_PHYSICAL_ADDRESS Address,
211 ACPI_TABLE_HEADER *Table);
214 AcpiUnloadParentTable (
223 * ACPI table manipulation interfaces
226 AcpiReallocateRootTable (
230 AcpiFindRootPointer (
231 ACPI_SIZE *RsdpAddress);
235 ACPI_STRING Signature,
237 ACPI_TABLE_HEADER *OutTableHeader);
241 ACPI_STRING Signature,
243 ACPI_TABLE_HEADER **OutTable);
246 AcpiGetTableByIndex (
248 ACPI_TABLE_HEADER **OutTable);
251 AcpiInstallTableHandler (
252 ACPI_TABLE_HANDLER Handler,
256 AcpiRemoveTableHandler (
257 ACPI_TABLE_HANDLER Handler);
261 * Namespace and name interfaces
265 ACPI_OBJECT_TYPE Type,
266 ACPI_HANDLE StartObject,
268 ACPI_WALK_CALLBACK DescendingCallback,
269 ACPI_WALK_CALLBACK AscendingCallback,
276 ACPI_WALK_CALLBACK UserFunction,
284 ACPI_BUFFER *RetPathPtr);
289 ACPI_STRING Pathname,
290 ACPI_HANDLE *RetHandle);
295 ACPI_OBJECT_HANDLER Handler,
301 ACPI_OBJECT_HANDLER Handler);
306 ACPI_OBJECT_HANDLER Handler,
318 * Object manipulation and enumeration
323 ACPI_STRING Pathname,
324 ACPI_OBJECT_LIST *ParameterObjects,
325 ACPI_BUFFER *ReturnObjectBuffer);
328 AcpiEvaluateObjectTyped (
330 ACPI_STRING Pathname,
331 ACPI_OBJECT_LIST *ExternalParams,
332 ACPI_BUFFER *ReturnBuffer,
333 ACPI_OBJECT_TYPE ReturnType);
338 ACPI_DEVICE_INFO **ReturnBuffer);
346 ACPI_OBJECT_TYPE Type,
349 ACPI_HANDLE *OutHandle);
354 ACPI_OBJECT_TYPE *OutType);
359 ACPI_HANDLE *OutHandle);
366 AcpiInstallInitializationHandler (
367 ACPI_INIT_HANDLER Handler,
370 ACPI_HW_DEPENDENT_RETURN_STATUS (
372 AcpiInstallSciHandler (
373 ACPI_SCI_HANDLER Address,
376 ACPI_HW_DEPENDENT_RETURN_STATUS (
378 AcpiRemoveSciHandler (
379 ACPI_SCI_HANDLER Address))
381 ACPI_HW_DEPENDENT_RETURN_STATUS (
383 AcpiInstallGlobalEventHandler (
384 ACPI_GBL_EVENT_HANDLER Handler,
387 ACPI_HW_DEPENDENT_RETURN_STATUS (
389 AcpiInstallFixedEventHandler (
391 ACPI_EVENT_HANDLER Handler,
394 ACPI_HW_DEPENDENT_RETURN_STATUS (
396 AcpiRemoveFixedEventHandler (
398 ACPI_EVENT_HANDLER Handler))
400 ACPI_HW_DEPENDENT_RETURN_STATUS (
402 AcpiInstallGpeHandler (
403 ACPI_HANDLE GpeDevice,
406 ACPI_GPE_HANDLER Address,
409 ACPI_HW_DEPENDENT_RETURN_STATUS (
411 AcpiRemoveGpeHandler (
412 ACPI_HANDLE GpeDevice,
414 ACPI_GPE_HANDLER Address))
417 AcpiInstallNotifyHandler (
420 ACPI_NOTIFY_HANDLER Handler,
424 AcpiRemoveNotifyHandler (
427 ACPI_NOTIFY_HANDLER Handler);
430 AcpiInstallAddressSpaceHandler (
432 ACPI_ADR_SPACE_TYPE SpaceId,
433 ACPI_ADR_SPACE_HANDLER Handler,
434 ACPI_ADR_SPACE_SETUP Setup,
438 AcpiRemoveAddressSpaceHandler (
440 ACPI_ADR_SPACE_TYPE SpaceId,
441 ACPI_ADR_SPACE_HANDLER Handler);
444 AcpiInstallExceptionHandler (
445 ACPI_EXCEPTION_HANDLER Handler);
448 AcpiInstallInterfaceHandler (
449 ACPI_INTERFACE_HANDLER Handler);
453 * Global Lock interfaces
455 ACPI_HW_DEPENDENT_RETURN_STATUS (
457 AcpiAcquireGlobalLock (
461 ACPI_HW_DEPENDENT_RETURN_STATUS (
463 AcpiReleaseGlobalLock (
468 * Interfaces to AML mutex objects
473 ACPI_STRING Pathname,
479 ACPI_STRING Pathname);
483 * Fixed Event interfaces
485 ACPI_HW_DEPENDENT_RETURN_STATUS (
491 ACPI_HW_DEPENDENT_RETURN_STATUS (
497 ACPI_HW_DEPENDENT_RETURN_STATUS (
502 ACPI_HW_DEPENDENT_RETURN_STATUS (
506 ACPI_EVENT_STATUS *EventStatus))
510 * General Purpose Event (GPE) Interfaces
512 ACPI_HW_DEPENDENT_RETURN_STATUS (
517 ACPI_HW_DEPENDENT_RETURN_STATUS (
520 ACPI_HANDLE GpeDevice,
523 ACPI_HW_DEPENDENT_RETURN_STATUS (
526 ACPI_HANDLE GpeDevice,
529 ACPI_HW_DEPENDENT_RETURN_STATUS (
532 ACPI_HANDLE GpeDevice,
535 ACPI_HW_DEPENDENT_RETURN_STATUS (
538 ACPI_HANDLE GpeDevice,
542 ACPI_HW_DEPENDENT_RETURN_STATUS (
545 ACPI_HANDLE GpeDevice,
548 ACPI_HW_DEPENDENT_RETURN_STATUS (
550 AcpiSetupGpeForWake (
551 ACPI_HANDLE ParentDevice,
552 ACPI_HANDLE GpeDevice,
555 ACPI_HW_DEPENDENT_RETURN_STATUS (
558 ACPI_HANDLE GpeDevice,
562 ACPI_HW_DEPENDENT_RETURN_STATUS (
565 ACPI_HANDLE GpeDevice,
567 ACPI_EVENT_STATUS *EventStatus))
569 ACPI_HW_DEPENDENT_RETURN_STATUS (
574 ACPI_HW_DEPENDENT_RETURN_STATUS (
576 AcpiEnableAllRuntimeGpes (
579 ACPI_HW_DEPENDENT_RETURN_STATUS (
583 ACPI_HANDLE *GpeDevice))
585 ACPI_HW_DEPENDENT_RETURN_STATUS (
587 AcpiInstallGpeBlock (
588 ACPI_HANDLE GpeDevice,
589 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
590 UINT32 RegisterCount,
591 UINT32 InterruptNumber))
593 ACPI_HW_DEPENDENT_RETURN_STATUS (
596 ACPI_HANDLE GpeDevice))
600 * Resource interfaces
603 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
604 ACPI_RESOURCE *Resource,
608 AcpiGetVendorResource (
611 ACPI_VENDOR_UUID *Uuid,
612 ACPI_BUFFER *RetBuffer);
615 AcpiGetCurrentResources (
617 ACPI_BUFFER *RetBuffer);
620 AcpiGetPossibleResources (
622 ACPI_BUFFER *RetBuffer);
625 AcpiGetEventResources (
626 ACPI_HANDLE DeviceHandle,
627 ACPI_BUFFER *RetBuffer);
630 AcpiWalkResourceBuffer (
632 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
639 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
643 AcpiSetCurrentResources (
645 ACPI_BUFFER *InBuffer);
648 AcpiGetIrqRoutingTable (
650 ACPI_BUFFER *RetBuffer);
653 AcpiResourceToAddress64 (
654 ACPI_RESOURCE *Resource,
655 ACPI_RESOURCE_ADDRESS64 *Out);
658 AcpiBufferToResource (
660 UINT16 AmlBufferLength,
661 ACPI_RESOURCE **ResourcePtr);
665 * Hardware (ACPI device) interfaces
674 ACPI_GENERIC_ADDRESS *Reg);
679 ACPI_GENERIC_ADDRESS *Reg);
681 ACPI_HW_DEPENDENT_RETURN_STATUS (
683 AcpiReadBitRegister (
685 UINT32 *ReturnValue))
687 ACPI_HW_DEPENDENT_RETURN_STATUS (
689 AcpiWriteBitRegister (
695 * Sleep/Wake interfaces
698 AcpiGetSleepTypeData (
704 AcpiEnterSleepStatePrep (
708 AcpiEnterSleepState (
711 ACPI_HW_DEPENDENT_RETURN_STATUS (
713 AcpiEnterSleepStateS4bios (
717 AcpiLeaveSleepStatePrep (
721 AcpiLeaveSleepState (
724 ACPI_HW_DEPENDENT_RETURN_STATUS (
726 AcpiSetFirmwareWakingVector (
727 UINT32 PhysicalAddress))
729 #if ACPI_MACHINE_WIDTH == 64
730 ACPI_HW_DEPENDENT_RETURN_STATUS (
732 AcpiSetFirmwareWakingVector64 (
733 UINT64 PhysicalAddress))
738 * ACPI Timer interfaces
740 ACPI_HW_DEPENDENT_RETURN_STATUS (
742 AcpiGetTimerResolution (
745 ACPI_HW_DEPENDENT_RETURN_STATUS (
750 ACPI_HW_DEPENDENT_RETURN_STATUS (
752 AcpiGetTimerDuration (
755 UINT32 *TimeElapsed))
759 * Error/Warning output
762 void ACPI_INTERNAL_VAR_XFACE
764 const char *ModuleName,
770 void ACPI_INTERNAL_VAR_XFACE
772 const char *ModuleName,
779 void ACPI_INTERNAL_VAR_XFACE
781 const char *ModuleName,
787 void ACPI_INTERNAL_VAR_XFACE
789 const char *ModuleName,
795 void ACPI_INTERNAL_VAR_XFACE
797 const char *ModuleName,
803 void ACPI_INTERNAL_VAR_XFACE
805 const char *ModuleName,
814 #ifdef ACPI_DEBUG_OUTPUT
817 void ACPI_INTERNAL_VAR_XFACE
819 UINT32 RequestedDebugLevel,
821 const char *FunctionName,
822 const char *ModuleName,
828 void ACPI_INTERNAL_VAR_XFACE
830 UINT32 RequestedDebugLevel,
832 const char *FunctionName,
833 const char *ModuleName,
839 #endif /* __ACXFACE_H__ */