EmbeddedPkg/Include/Library/AcpiLib.h

   1 /** @file
   2   Helper Library for ACPI
   3
   4   Copyright (c) 2014, ARM Ltd. All rights reserved.
   5
   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
  10
  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.
  13
  14 **/
  15
  16 #ifndef __ACPI_LIB_H__
  17 #define __ACPI_LIB_H__
  18
  19 #include <Uefi.h>
  20
  21 //
  22 // Macros for the Generic Address Space
  23 //
  24 #define NULL_GAS               { EFI_ACPI_5_0_SYSTEM_MEMORY,  0, 0, EFI_ACPI_5_0_UNDEFINED, 0L }
  25 #define ARM_GAS8(Address)      { EFI_ACPI_5_0_SYSTEM_MEMORY,  8, 0, EFI_ACPI_5_0_BYTE,      Address }
  26 #define ARM_GAS16(Address)     { EFI_ACPI_5_0_SYSTEM_MEMORY, 16, 0, EFI_ACPI_5_0_WORD,      Address }
  27 #define ARM_GAS32(Address)     { EFI_ACPI_5_0_SYSTEM_MEMORY, 32, 0, EFI_ACPI_5_0_DWORD,     Address }
  28 #define ARM_GASN(Address)      { EFI_ACPI_5_0_SYSTEM_MEMORY,  0, 0, EFI_ACPI_5_0_DWORD,     Address }
  29
  30 //
  31 // Macros for the Multiple APIC Description Table (MADT)
  32 //
  33 #define EFI_ACPI_5_0_GIC_DISTRIBUTOR_INIT(GicDistHwId, GicDistBase, GicDistVector) \
  34   { \
  35     EFI_ACPI_5_0_GICD, sizeof (EFI_ACPI_5_0_GIC_DISTRIBUTOR_STRUCTURE), EFI_ACPI_RESERVED_WORD, \
  36     GicDistHwId, GicDistBase, GicDistVector, EFI_ACPI_RESERVED_DWORD \
  37   }
  38
  39 // Note the parking protocol is configured by UEFI if required
  40 #define EFI_ACPI_5_0_GIC_STRUCTURE_INIT(GicId, AcpiCpuId, Flags, PmuIrq, GicBase) \
  41   { \
  42     EFI_ACPI_5_0_GIC, sizeof (EFI_ACPI_5_0_GIC_STRUCTURE), EFI_ACPI_RESERVED_WORD, \
  43     GicId, AcpiCpuId, Flags, 0, PmuIrq, 0, GicBase \
  44   }
  45
  46 // Note the parking protocol is configured by UEFI if required
  47 #define EFI_ACPI_5_1_GICC_STRUCTURE_INIT(GicId, AcpiCpuUid, Mpidr, Flags, PmuIrq,    \
  48     GicBase, GicVBase, GicHBase, GsivId, GicRBase)                                   \
  49   {                                                                                  \
  50     EFI_ACPI_5_1_GIC, sizeof (EFI_ACPI_5_1_GIC_STRUCTURE), EFI_ACPI_RESERVED_WORD,   \
  51     GicId, AcpiCpuUid, Flags, 0, PmuIrq, 0, GicBase, GicVBase, GicHBase,             \
  52     GsivId, GicRBase, Mpidr                                                          \
  53   }
  54
  55 #define EFI_ACPI_6_0_GIC_MSI_FRAME_INIT(GicMsiFrameId, PhysicalBaseAddress, Flags, SPICount, SPIBase) \
  56   { \
  57     EFI_ACPI_6_0_GIC_MSI_FRAME, sizeof (EFI_ACPI_6_0_GIC_MSI_FRAME_STRUCTURE), EFI_ACPI_RESERVED_WORD, \
  58     GicMsiFrameId, PhysicalBaseAddress, Flags, SPICount, SPIBase \
  59   }
  60
  61 //
  62 // SBSA Generic Watchdog
  63 //
  64 #define EFI_ACPI_5_1_SBSA_GENERIC_WATCHDOG_STRUCTURE_INIT(RefreshFramePhysicalAddress,                  \
  65     ControlFramePhysicalAddress, WatchdogTimerGSIV, WatchdogTimerFlags)                                 \
  66   {                                                                                                     \
  67     EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG, sizeof(EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_STRUCTURE), \
  68     EFI_ACPI_RESERVED_WORD, RefreshFramePhysicalAddress, ControlFramePhysicalAddress,                   \
  69     WatchdogTimerGSIV, WatchdogTimerFlags                                                               \
  70   }
  71
  72 /**
  73   Locate and Install the ACPI tables from the Firmware Volume
  74
  75   @param  AcpiFile              Guid of the ACPI file into the Firmware Volume
  76
  77   @return EFI_SUCCESS           The function completed successfully.
  78   @return EFI_NOT_FOUND         The protocol could not be located.
  79   @return EFI_OUT_OF_RESOURCES  There are not enough resources to find the protocol.
  80
  81 **/
  82 EFI_STATUS
  83 LocateAndInstallAcpiFromFv (
  84   IN CONST EFI_GUID* AcpiFile
  85   );
  86
  87 #endif // __ACPI_LIB_H__