ArmPlatformPkg/ArmJunoPkg: ACPI PCI Support
[mirror_edk2.git] / EmbeddedPkg / Include / Library / AcpiLib.h
CommitLineData
3356211b
OM
1/** @file\r
2 Helper Library for ACPI\r
3\r
4 Copyright (c) 2014, ARM Ltd. All rights reserved.\r
5\r
6 This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef __ACPI_LIB_H__\r
17#define __ACPI_LIB_H__\r
18\r
19#include <Uefi.h>\r
20\r
21//\r
22// Macros for the Generic Address Space\r
23//\r
24#define NULL_GAS { EFI_ACPI_5_0_SYSTEM_MEMORY, 0, 0, EFI_ACPI_5_0_UNDEFINED, 0L }\r
25#define ARM_GAS8(Address) { EFI_ACPI_5_0_SYSTEM_MEMORY, 8, 0, EFI_ACPI_5_0_BYTE, Address }\r
26#define ARM_GAS16(Address) { EFI_ACPI_5_0_SYSTEM_MEMORY, 16, 0, EFI_ACPI_5_0_WORD, Address }\r
27#define ARM_GAS32(Address) { EFI_ACPI_5_0_SYSTEM_MEMORY, 32, 0, EFI_ACPI_5_0_DWORD, Address }\r
28#define ARM_GASN(Address) { EFI_ACPI_5_0_SYSTEM_MEMORY, 0, 0, EFI_ACPI_5_0_DWORD, Address }\r
29\r
30//\r
31// Macros for the Multiple APIC Description Table (MADT)\r
32//\r
33#define EFI_ACPI_5_0_GIC_DISTRIBUTOR_INIT(GicDistHwId, GicDistBase, GicDistVector) \\r
34 { \\r
35 EFI_ACPI_5_0_GICD, sizeof (EFI_ACPI_5_0_GIC_DISTRIBUTOR_STRUCTURE), EFI_ACPI_RESERVED_WORD, \\r
36 GicDistHwId, GicDistBase, GicDistVector, EFI_ACPI_RESERVED_DWORD \\r
37 }\r
38\r
39// Note the parking protocol is configured by UEFI if required\r
40#define EFI_ACPI_5_0_GIC_STRUCTURE_INIT(GicId, AcpiCpuId, Flags, PmuIrq, GicBase) \\r
41 { \\r
42 EFI_ACPI_5_0_GIC, sizeof (EFI_ACPI_5_0_GIC_STRUCTURE), EFI_ACPI_RESERVED_WORD, \\r
43 GicId, AcpiCpuId, Flags, 0, PmuIrq, 0, GicBase \\r
44 }\r
45\r
7c1712f0
OM
46// Note the parking protocol is configured by UEFI if required\r
47#define EFI_ACPI_5_1_GICC_STRUCTURE_INIT(GicId, AcpiCpuUid, Mpidr, Flags, PmuIrq, \\r
48 GicBase, GicVBase, GicHBase, GsivId, GicRBase) \\r
49 { \\r
50 EFI_ACPI_5_1_GIC, sizeof (EFI_ACPI_5_1_GIC_STRUCTURE), EFI_ACPI_RESERVED_WORD, \\r
51 GicId, AcpiCpuUid, Flags, 0, PmuIrq, 0, GicBase, GicVBase, GicHBase, \\r
52 GsivId, GicRBase, Mpidr \\r
53 }\r
54\r
55//\r
56// SBSA Generic Watchdog\r
57//\r
58#define EFI_ACPI_5_1_SBSA_GENERIC_WATCHDOG_STRUCTURE_INIT(RefreshFramePhysicalAddress, \\r
59 ControlFramePhysicalAddress, WatchdogTimerGSIV, WatchdogTimerFlags) \\r
60 { \\r
61 EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG, sizeof(EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_STRUCTURE), \\r
62 EFI_ACPI_RESERVED_WORD, RefreshFramePhysicalAddress, ControlFramePhysicalAddress, \\r
63 WatchdogTimerGSIV, WatchdogTimerFlags \\r
64 }\r
3356211b
OM
65\r
66/**\r
67 Locate and Install the ACPI tables from the Firmware Volume\r
68\r
69 @param AcpiFile Guid of the ACPI file into the Firmware Volume\r
70\r
71 @return EFI_SUCCESS The function completed successfully.\r
72 @return EFI_NOT_FOUND The protocol could not be located.\r
73 @return EFI_OUT_OF_RESOURCES There are not enough resources to find the protocol.\r
74\r
75**/\r
76EFI_STATUS\r
77LocateAndInstallAcpiFromFv (\r
78 IN CONST EFI_GUID* AcpiFile\r
79 );\r
80\r
81#endif // __ACPI_LIB_H__\r