2 Helper Library for ACPI
4 Copyright (c) 2014-2016, ARM Ltd. All rights reserved.
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __ACPI_LIB_H__
17 #define __ACPI_LIB_H__
21 #include <IndustryStandard/Acpi10.h>
24 // Macros for the Generic Address Space
26 #define NULL_GAS { EFI_ACPI_5_0_SYSTEM_MEMORY, 0, 0, EFI_ACPI_5_0_UNDEFINED, 0L }
27 #define ARM_GAS8(Address) { EFI_ACPI_5_0_SYSTEM_MEMORY, 8, 0, EFI_ACPI_5_0_BYTE, Address }
28 #define ARM_GAS16(Address) { EFI_ACPI_5_0_SYSTEM_MEMORY, 16, 0, EFI_ACPI_5_0_WORD, Address }
29 #define ARM_GAS32(Address) { EFI_ACPI_5_0_SYSTEM_MEMORY, 32, 0, EFI_ACPI_5_0_DWORD, Address }
30 #define ARM_GASN(Address) { EFI_ACPI_5_0_SYSTEM_MEMORY, 0, 0, EFI_ACPI_5_0_DWORD, Address }
33 // Macros for the Multiple APIC Description Table (MADT)
35 #define EFI_ACPI_5_0_GIC_DISTRIBUTOR_INIT(GicDistHwId, GicDistBase, GicDistVector) \
37 EFI_ACPI_5_0_GICD, sizeof (EFI_ACPI_5_0_GIC_DISTRIBUTOR_STRUCTURE), EFI_ACPI_RESERVED_WORD, \
38 GicDistHwId, GicDistBase, GicDistVector, EFI_ACPI_RESERVED_DWORD \
41 #define EFI_ACPI_6_0_GIC_DISTRIBUTOR_INIT(GicDistHwId, GicDistBase, GicDistVector, GicVersion) \
43 EFI_ACPI_6_0_GICD, sizeof (EFI_ACPI_6_0_GIC_DISTRIBUTOR_STRUCTURE), EFI_ACPI_RESERVED_WORD, \
44 GicDistHwId, GicDistBase, GicDistVector, GicVersion, \
45 {EFI_ACPI_RESERVED_BYTE, EFI_ACPI_RESERVED_BYTE, EFI_ACPI_RESERVED_BYTE} \
48 // Note the parking protocol is configured by UEFI if required
49 #define EFI_ACPI_5_0_GIC_STRUCTURE_INIT(GicId, AcpiCpuId, Flags, PmuIrq, GicBase) \
51 EFI_ACPI_5_0_GIC, sizeof (EFI_ACPI_5_0_GIC_STRUCTURE), EFI_ACPI_RESERVED_WORD, \
52 GicId, AcpiCpuId, Flags, 0, PmuIrq, 0, GicBase \
55 // Note the parking protocol is configured by UEFI if required
56 #define EFI_ACPI_5_1_GICC_STRUCTURE_INIT(GicId, AcpiCpuUid, Mpidr, Flags, PmuIrq, \
57 GicBase, GicVBase, GicHBase, GsivId, GicRBase) \
59 EFI_ACPI_5_1_GIC, sizeof (EFI_ACPI_5_1_GIC_STRUCTURE), EFI_ACPI_RESERVED_WORD, \
60 GicId, AcpiCpuUid, Flags, 0, PmuIrq, 0, GicBase, GicVBase, GicHBase, \
61 GsivId, GicRBase, Mpidr \
64 #define EFI_ACPI_6_0_GIC_MSI_FRAME_INIT(GicMsiFrameId, PhysicalBaseAddress, Flags, SPICount, SPIBase) \
66 EFI_ACPI_6_0_GIC_MSI_FRAME, sizeof (EFI_ACPI_6_0_GIC_MSI_FRAME_STRUCTURE), EFI_ACPI_RESERVED_WORD, \
67 GicMsiFrameId, PhysicalBaseAddress, Flags, SPICount, SPIBase \
71 // SBSA Generic Watchdog
73 #define EFI_ACPI_5_1_SBSA_GENERIC_WATCHDOG_STRUCTURE_INIT(RefreshFramePhysicalAddress, \
74 ControlFramePhysicalAddress, WatchdogTimerGSIV, WatchdogTimerFlags) \
76 EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG, sizeof(EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_STRUCTURE), \
77 EFI_ACPI_RESERVED_BYTE, RefreshFramePhysicalAddress, ControlFramePhysicalAddress, \
78 WatchdogTimerGSIV, WatchdogTimerFlags \
83 (EFIAPI
*EFI_LOCATE_ACPI_CHECK
) (
84 IN EFI_ACPI_DESCRIPTION_HEADER
*AcpiHeader
88 Locate and Install the ACPI tables from the Firmware Volume if it verifies
89 the function condition.
91 @param AcpiFile Guid of the ACPI file into the Firmware Volume
92 @param CheckAcpiTableFunction Function that checks if the ACPI table should be installed
94 @return EFI_SUCCESS The function completed successfully.
95 @return EFI_NOT_FOUND The protocol could not be located.
96 @return EFI_OUT_OF_RESOURCES There are not enough resources to find the protocol.
100 LocateAndInstallAcpiFromFvConditional (
101 IN CONST EFI_GUID
* AcpiFile
,
102 IN EFI_LOCATE_ACPI_CHECK CheckAcpiTableFunction
106 Locate and Install the ACPI tables from the Firmware Volume
108 @param AcpiFile Guid of the ACPI file into the Firmware Volume
110 @return EFI_SUCCESS The function completed successfully.
111 @return EFI_NOT_FOUND The protocol could not be located.
112 @return EFI_OUT_OF_RESOURCES There are not enough resources to find the protocol.
116 LocateAndInstallAcpiFromFv (
117 IN CONST EFI_GUID
* AcpiFile
120 #endif // __ACPI_LIB_H__