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 0x20130823
52 #include <contrib/dev/acpica/include/acconfig.h>
53 #include <contrib/dev/acpica/include/actypes.h>
54 #include <contrib/dev/acpica/include/actbl.h>
55 #include <contrib/dev/acpica/include/acbuffer.h>
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_EnableInterpreterSlack;
74 extern UINT8 AcpiGbl_AllMethodsSerialized;
75 extern UINT8 AcpiGbl_CreateOsiMethod;
76 extern UINT8 AcpiGbl_UseDefaultRegisterWidths;
77 extern ACPI_NAME AcpiGbl_TraceMethodName;
78 extern UINT32 AcpiGbl_TraceFlags;
79 extern UINT8 AcpiGbl_EnableAmlDebugObject;
80 extern UINT8 AcpiGbl_CopyDsdtLocally;
81 extern UINT8 AcpiGbl_TruncateIoAddresses;
82 extern UINT8 AcpiGbl_DisableAutoRepair;
83 extern UINT8 AcpiGbl_DisableSsdtTableLoad;
87 * Hardware-reduced prototypes. All interfaces that use these macros will
88 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
91 #if (!ACPI_REDUCED_HARDWARE)
92 #define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
95 #define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
98 #define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
102 #define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
103 static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);}
105 #define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
106 static ACPI_INLINE Prototype {return(AE_OK);}
108 #define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
109 static ACPI_INLINE Prototype {}
111 #endif /* !ACPI_REDUCED_HARDWARE */
118 AcpiInitializeTables (
119 ACPI_TABLE_DESC *InitialStorage,
120 UINT32 InitialTableCount,
121 BOOLEAN AllowResize);
124 AcpiInitializeSubsystem (
128 AcpiEnableSubsystem (
132 AcpiInitializeObjects (
141 * Miscellaneous global interfaces
143 ACPI_HW_DEPENDENT_RETURN_STATUS (
148 ACPI_HW_DEPENDENT_RETURN_STATUS (
154 AcpiSubsystemStatus (
159 ACPI_BUFFER *RetBuffer);
163 ACPI_STATISTICS *Stats);
166 AcpiFormatException (
167 ACPI_STATUS Exception);
170 AcpiPurgeCachedObjects (
174 AcpiInstallInterface (
175 ACPI_STRING InterfaceName);
178 AcpiRemoveInterface (
179 ACPI_STRING InterfaceName);
182 AcpiUpdateInterfaces (
186 AcpiCheckAddressRange (
187 ACPI_ADR_SPACE_TYPE SpaceId,
188 ACPI_PHYSICAL_ADDRESS Address,
193 AcpiDecodePldBuffer (
196 ACPI_PLD_INFO **ReturnBuffer);
199 * ACPI Memory management
215 * ACPI table load/unload interfaces
219 ACPI_TABLE_HEADER *Table);
222 AcpiUnloadParentTable (
231 * ACPI table manipulation interfaces
234 AcpiReallocateRootTable (
238 AcpiFindRootPointer (
239 ACPI_SIZE *RsdpAddress);
243 ACPI_STRING Signature,
245 ACPI_TABLE_HEADER *OutTableHeader);
249 ACPI_STRING Signature,
251 ACPI_TABLE_HEADER **OutTable);
254 AcpiGetTableByIndex (
256 ACPI_TABLE_HEADER **OutTable);
259 AcpiInstallTableHandler (
260 ACPI_TABLE_HANDLER Handler,
264 AcpiRemoveTableHandler (
265 ACPI_TABLE_HANDLER Handler);
269 * Namespace and name interfaces
273 ACPI_OBJECT_TYPE Type,
274 ACPI_HANDLE StartObject,
276 ACPI_WALK_CALLBACK DescendingCallback,
277 ACPI_WALK_CALLBACK AscendingCallback,
284 ACPI_WALK_CALLBACK UserFunction,
292 ACPI_BUFFER *RetPathPtr);
297 ACPI_STRING Pathname,
298 ACPI_HANDLE *RetHandle);
303 ACPI_OBJECT_HANDLER Handler,
309 ACPI_OBJECT_HANDLER Handler);
314 ACPI_OBJECT_HANDLER Handler,
326 * Object manipulation and enumeration
331 ACPI_STRING Pathname,
332 ACPI_OBJECT_LIST *ParameterObjects,
333 ACPI_BUFFER *ReturnObjectBuffer);
336 AcpiEvaluateObjectTyped (
338 ACPI_STRING Pathname,
339 ACPI_OBJECT_LIST *ExternalParams,
340 ACPI_BUFFER *ReturnBuffer,
341 ACPI_OBJECT_TYPE ReturnType);
346 ACPI_DEVICE_INFO **ReturnBuffer);
354 ACPI_OBJECT_TYPE Type,
357 ACPI_HANDLE *OutHandle);
362 ACPI_OBJECT_TYPE *OutType);
367 ACPI_HANDLE *OutHandle);
374 AcpiInstallInitializationHandler (
375 ACPI_INIT_HANDLER Handler,
378 ACPI_HW_DEPENDENT_RETURN_STATUS (
380 AcpiInstallSciHandler (
381 ACPI_SCI_HANDLER Address,
384 ACPI_HW_DEPENDENT_RETURN_STATUS (
386 AcpiRemoveSciHandler (
387 ACPI_SCI_HANDLER Address))
389 ACPI_HW_DEPENDENT_RETURN_STATUS (
391 AcpiInstallGlobalEventHandler (
392 ACPI_GBL_EVENT_HANDLER Handler,
395 ACPI_HW_DEPENDENT_RETURN_STATUS (
397 AcpiInstallFixedEventHandler (
399 ACPI_EVENT_HANDLER Handler,
402 ACPI_HW_DEPENDENT_RETURN_STATUS (
404 AcpiRemoveFixedEventHandler (
406 ACPI_EVENT_HANDLER Handler))
408 ACPI_HW_DEPENDENT_RETURN_STATUS (
410 AcpiInstallGpeHandler (
411 ACPI_HANDLE GpeDevice,
414 ACPI_GPE_HANDLER Address,
417 ACPI_HW_DEPENDENT_RETURN_STATUS (
419 AcpiRemoveGpeHandler (
420 ACPI_HANDLE GpeDevice,
422 ACPI_GPE_HANDLER Address))
425 AcpiInstallNotifyHandler (
428 ACPI_NOTIFY_HANDLER Handler,
432 AcpiRemoveNotifyHandler (
435 ACPI_NOTIFY_HANDLER Handler);
438 AcpiInstallAddressSpaceHandler (
440 ACPI_ADR_SPACE_TYPE SpaceId,
441 ACPI_ADR_SPACE_HANDLER Handler,
442 ACPI_ADR_SPACE_SETUP Setup,
446 AcpiRemoveAddressSpaceHandler (
448 ACPI_ADR_SPACE_TYPE SpaceId,
449 ACPI_ADR_SPACE_HANDLER Handler);
452 AcpiInstallExceptionHandler (
453 ACPI_EXCEPTION_HANDLER Handler);
456 AcpiInstallInterfaceHandler (
457 ACPI_INTERFACE_HANDLER Handler);
461 * Global Lock interfaces
463 ACPI_HW_DEPENDENT_RETURN_STATUS (
465 AcpiAcquireGlobalLock (
469 ACPI_HW_DEPENDENT_RETURN_STATUS (
471 AcpiReleaseGlobalLock (
476 * Interfaces to AML mutex objects
481 ACPI_STRING Pathname,
487 ACPI_STRING Pathname);
491 * Fixed Event interfaces
493 ACPI_HW_DEPENDENT_RETURN_STATUS (
499 ACPI_HW_DEPENDENT_RETURN_STATUS (
505 ACPI_HW_DEPENDENT_RETURN_STATUS (
510 ACPI_HW_DEPENDENT_RETURN_STATUS (
514 ACPI_EVENT_STATUS *EventStatus))
518 * General Purpose Event (GPE) Interfaces
520 ACPI_HW_DEPENDENT_RETURN_STATUS (
525 ACPI_HW_DEPENDENT_RETURN_STATUS (
528 ACPI_HANDLE GpeDevice,
531 ACPI_HW_DEPENDENT_RETURN_STATUS (
534 ACPI_HANDLE GpeDevice,
537 ACPI_HW_DEPENDENT_RETURN_STATUS (
540 ACPI_HANDLE GpeDevice,
543 ACPI_HW_DEPENDENT_RETURN_STATUS (
546 ACPI_HANDLE GpeDevice,
550 ACPI_HW_DEPENDENT_RETURN_STATUS (
553 ACPI_HANDLE GpeDevice,
556 ACPI_HW_DEPENDENT_RETURN_STATUS (
558 AcpiSetupGpeForWake (
559 ACPI_HANDLE ParentDevice,
560 ACPI_HANDLE GpeDevice,
563 ACPI_HW_DEPENDENT_RETURN_STATUS (
566 ACPI_HANDLE GpeDevice,
570 ACPI_HW_DEPENDENT_RETURN_STATUS (
573 ACPI_HANDLE GpeDevice,
575 ACPI_EVENT_STATUS *EventStatus))
577 ACPI_HW_DEPENDENT_RETURN_STATUS (
582 ACPI_HW_DEPENDENT_RETURN_STATUS (
584 AcpiEnableAllRuntimeGpes (
587 ACPI_HW_DEPENDENT_RETURN_STATUS (
591 ACPI_HANDLE *GpeDevice))
593 ACPI_HW_DEPENDENT_RETURN_STATUS (
595 AcpiInstallGpeBlock (
596 ACPI_HANDLE GpeDevice,
597 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
598 UINT32 RegisterCount,
599 UINT32 InterruptNumber))
601 ACPI_HW_DEPENDENT_RETURN_STATUS (
604 ACPI_HANDLE GpeDevice))
608 * Resource interfaces
611 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
612 ACPI_RESOURCE *Resource,
616 AcpiGetVendorResource (
619 ACPI_VENDOR_UUID *Uuid,
620 ACPI_BUFFER *RetBuffer);
623 AcpiGetCurrentResources (
625 ACPI_BUFFER *RetBuffer);
628 AcpiGetPossibleResources (
630 ACPI_BUFFER *RetBuffer);
633 AcpiGetEventResources (
634 ACPI_HANDLE DeviceHandle,
635 ACPI_BUFFER *RetBuffer);
638 AcpiWalkResourceBuffer (
640 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
647 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
651 AcpiSetCurrentResources (
653 ACPI_BUFFER *InBuffer);
656 AcpiGetIrqRoutingTable (
658 ACPI_BUFFER *RetBuffer);
661 AcpiResourceToAddress64 (
662 ACPI_RESOURCE *Resource,
663 ACPI_RESOURCE_ADDRESS64 *Out);
666 AcpiBufferToResource (
668 UINT16 AmlBufferLength,
669 ACPI_RESOURCE **ResourcePtr);
673 * Hardware (ACPI device) interfaces
682 ACPI_GENERIC_ADDRESS *Reg);
687 ACPI_GENERIC_ADDRESS *Reg);
689 ACPI_HW_DEPENDENT_RETURN_STATUS (
691 AcpiReadBitRegister (
693 UINT32 *ReturnValue))
695 ACPI_HW_DEPENDENT_RETURN_STATUS (
697 AcpiWriteBitRegister (
703 * Sleep/Wake interfaces
706 AcpiGetSleepTypeData (
712 AcpiEnterSleepStatePrep (
716 AcpiEnterSleepState (
719 ACPI_HW_DEPENDENT_RETURN_STATUS (
721 AcpiEnterSleepStateS4bios (
725 AcpiLeaveSleepStatePrep (
729 AcpiLeaveSleepState (
732 ACPI_HW_DEPENDENT_RETURN_STATUS (
734 AcpiSetFirmwareWakingVector (
735 UINT32 PhysicalAddress))
737 #if ACPI_MACHINE_WIDTH == 64
738 ACPI_HW_DEPENDENT_RETURN_STATUS (
740 AcpiSetFirmwareWakingVector64 (
741 UINT64 PhysicalAddress))
746 * ACPI Timer interfaces
748 ACPI_HW_DEPENDENT_RETURN_STATUS (
750 AcpiGetTimerResolution (
753 ACPI_HW_DEPENDENT_RETURN_STATUS (
758 ACPI_HW_DEPENDENT_RETURN_STATUS (
760 AcpiGetTimerDuration (
763 UINT32 *TimeElapsed))
767 * Error/Warning output
769 void ACPI_INTERNAL_VAR_XFACE
771 const char *ModuleName,
774 ...) ACPI_PRINTF_LIKE(3);
776 void ACPI_INTERNAL_VAR_XFACE
778 const char *ModuleName,
782 ...) ACPI_PRINTF_LIKE(4);
784 void ACPI_INTERNAL_VAR_XFACE
786 const char *ModuleName,
789 ...) ACPI_PRINTF_LIKE(3);
791 void ACPI_INTERNAL_VAR_XFACE
793 const char *ModuleName,
796 ...) ACPI_PRINTF_LIKE(3);
798 void ACPI_INTERNAL_VAR_XFACE
800 const char *ModuleName,
803 ...) ACPI_PRINTF_LIKE(3);
805 void ACPI_INTERNAL_VAR_XFACE
807 const char *ModuleName,
810 ...) ACPI_PRINTF_LIKE(3);
816 #ifdef ACPI_DEBUG_OUTPUT
818 void ACPI_INTERNAL_VAR_XFACE
820 UINT32 RequestedDebugLevel,
822 const char *FunctionName,
823 const char *ModuleName,
826 ...) ACPI_PRINTF_LIKE(6);
828 void ACPI_INTERNAL_VAR_XFACE
830 UINT32 RequestedDebugLevel,
832 const char *FunctionName,
833 const char *ModuleName,
836 ...) ACPI_PRINTF_LIKE(6);
839 #endif /* __ACXFACE_H__ */