ArmPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ArmPkg / Drivers / ArmGic / GicV3 / ArmGicV3Dxe.c

/** @file\r
*\r
*  Copyright (c) 2011-2018, ARM Limited. All rights reserved.\r
*\r
*  SPDX-License-Identifier: BSD-2-Clause-Patent\r
*\r
**/\r
\r
#include <Library/ArmGicLib.h>\r
\r
#include "ArmGicDxe.h"\r
\r
#define ARM_GIC_DEFAULT_PRIORITY  0x80\r
\r
extern EFI_HARDWARE_INTERRUPT_PROTOCOL gHardwareInterruptV3Protocol;\r
extern EFI_HARDWARE_INTERRUPT2_PROTOCOL gHardwareInterrupt2V3Protocol;\r
\r
STATIC UINTN mGicDistributorBase;\r
STATIC UINTN mGicRedistributorsBase;\r
\r
/**\r
  Enable interrupt source Source.\r
\r
  @param This     Instance pointer for this protocol\r
  @param Source   Hardware source of the interrupt\r
\r
  @retval EFI_SUCCESS       Source interrupt enabled.\r
  @retval EFI_DEVICE_ERROR  Hardware could not be programmed.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GicV3EnableInterruptSource (\r
  IN EFI_HARDWARE_INTERRUPT_PROTOCOL    *This,\r
  IN HARDWARE_INTERRUPT_SOURCE          Source\r
  )\r
{\r
  if (Source >= mGicNumInterrupts) {\r
    ASSERT(FALSE);\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  ArmGicEnableInterrupt (mGicDistributorBase, mGicRedistributorsBase, Source);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Disable interrupt source Source.\r
\r
  @param This     Instance pointer for this protocol\r
  @param Source   Hardware source of the interrupt\r
\r
  @retval EFI_SUCCESS       Source interrupt disabled.\r
  @retval EFI_DEVICE_ERROR  Hardware could not be programmed.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GicV3DisableInterruptSource (\r
  IN EFI_HARDWARE_INTERRUPT_PROTOCOL    *This,\r
  IN HARDWARE_INTERRUPT_SOURCE          Source\r
  )\r
{\r
  if (Source >= mGicNumInterrupts) {\r
    ASSERT(FALSE);\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  ArmGicDisableInterrupt (mGicDistributorBase, mGicRedistributorsBase, Source);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Return current state of interrupt source Source.\r
\r
  @param This     Instance pointer for this protocol\r
  @param Source   Hardware source of the interrupt\r
  @param InterruptState  TRUE: source enabled, FALSE: source disabled.\r
\r
  @retval EFI_SUCCESS       InterruptState is valid\r
  @retval EFI_DEVICE_ERROR  InterruptState is not valid\r
\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GicV3GetInterruptSourceState (\r
  IN EFI_HARDWARE_INTERRUPT_PROTOCOL    *This,\r
  IN HARDWARE_INTERRUPT_SOURCE          Source,\r
  IN BOOLEAN                            *InterruptState\r
  )\r
{\r
  if (Source >= mGicNumInterrupts) {\r
    ASSERT(FALSE);\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  *InterruptState = ArmGicIsInterruptEnabled (\r
                      mGicDistributorBase,\r
                      mGicRedistributorsBase,\r
                      Source\r
                      );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Signal to the hardware that the End Of Interrupt state\r
  has been reached.\r
\r
  @param This     Instance pointer for this protocol\r
  @param Source   Hardware source of the interrupt\r
\r
  @retval EFI_SUCCESS       Source interrupt EOI'ed.\r
  @retval EFI_DEVICE_ERROR  Hardware could not be programmed.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GicV3EndOfInterrupt (\r
  IN EFI_HARDWARE_INTERRUPT_PROTOCOL    *This,\r
  IN HARDWARE_INTERRUPT_SOURCE          Source\r
  )\r
{\r
  if (Source >= mGicNumInterrupts) {\r
    ASSERT(FALSE);\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  ArmGicV3EndOfInterrupt (Source);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  EFI_CPU_INTERRUPT_HANDLER that is called when a processor interrupt occurs.\r
\r
  @param  InterruptType    Defines the type of interrupt or exception that\r
                           occurred on the processor. This parameter is\r
                           processor architecture specific.\r
  @param  SystemContext    A pointer to the processor context when\r
                           the interrupt occurred on the processor.\r
\r
  @return None\r
\r
**/\r
STATIC\r
VOID\r
EFIAPI\r
GicV3IrqInterruptHandler (\r
  IN EFI_EXCEPTION_TYPE           InterruptType,\r
  IN EFI_SYSTEM_CONTEXT           SystemContext\r
  )\r
{\r
  UINT32                      GicInterrupt;\r
  HARDWARE_INTERRUPT_HANDLER  InterruptHandler;\r
\r
  GicInterrupt = ArmGicV3AcknowledgeInterrupt ();\r
\r
  // Special Interrupts (ID1020-ID1023) have an Interrupt ID greater than the\r
  // number of interrupt (ie: Spurious interrupt).\r
  if ((GicInterrupt & ARM_GIC_ICCIAR_ACKINTID) >= mGicNumInterrupts) {\r
    // The special interrupt do not need to be acknowledge\r
    return;\r
  }\r
\r
  InterruptHandler = gRegisteredInterruptHandlers[GicInterrupt];\r
  if (InterruptHandler != NULL) {\r
    // Call the registered interrupt handler.\r
    InterruptHandler (GicInterrupt, SystemContext);\r
  } else {\r
    DEBUG ((DEBUG_ERROR, "Spurious GIC interrupt: 0x%x\n", GicInterrupt));\r
    GicV3EndOfInterrupt (&gHardwareInterruptV3Protocol, GicInterrupt);\r
  }\r
}\r
\r
// The protocol instance produced by this driver\r
EFI_HARDWARE_INTERRUPT_PROTOCOL gHardwareInterruptV3Protocol = {\r
  RegisterInterruptSource,\r
  GicV3EnableInterruptSource,\r
  GicV3DisableInterruptSource,\r
  GicV3GetInterruptSourceState,\r
  GicV3EndOfInterrupt\r
};\r
\r
/**\r
  Get interrupt trigger type of an interrupt\r
\r
  @param This          Instance pointer for this protocol\r
  @param Source        Hardware source of the interrupt.\r
  @param TriggerType   Returns interrupt trigger type.\r
\r
  @retval EFI_SUCCESS       Source interrupt supported.\r
  @retval EFI_UNSUPPORTED   Source interrupt is not supported.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GicV3GetTriggerType (\r
  IN  EFI_HARDWARE_INTERRUPT2_PROTOCOL      *This,\r
  IN  HARDWARE_INTERRUPT_SOURCE             Source,\r
  OUT EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE  *TriggerType\r
  )\r
{\r
  UINTN                   RegAddress;\r
  UINTN                   Config1Bit;\r
  EFI_STATUS              Status;\r
\r
  Status = GicGetDistributorIcfgBaseAndBit (\r
             Source,\r
             &RegAddress,\r
             &Config1Bit\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if ((MmioRead32 (RegAddress) & (1 << Config1Bit)) == 0) {\r
     *TriggerType = EFI_HARDWARE_INTERRUPT2_TRIGGER_LEVEL_HIGH;\r
  } else {\r
     *TriggerType = EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_RISING;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Set interrupt trigger type of an interrupt\r
\r
  @param This          Instance pointer for this protocol\r
  @param Source        Hardware source of the interrupt.\r
  @param TriggerType   Interrupt trigger type.\r
\r
  @retval EFI_SUCCESS       Source interrupt supported.\r
  @retval EFI_UNSUPPORTED   Source interrupt is not supported.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GicV3SetTriggerType (\r
  IN  EFI_HARDWARE_INTERRUPT2_PROTOCOL      *This,\r
  IN  HARDWARE_INTERRUPT_SOURCE             Source,\r
  IN  EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE  TriggerType\r
  )\r
{\r
  UINTN                   RegAddress;\r
  UINTN                   Config1Bit;\r
  UINT32                  Value;\r
  EFI_STATUS              Status;\r
  BOOLEAN                 SourceEnabled;\r
\r
  if (   (TriggerType != EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_RISING)\r
      && (TriggerType != EFI_HARDWARE_INTERRUPT2_TRIGGER_LEVEL_HIGH)) {\r
          DEBUG ((DEBUG_ERROR, "Invalid interrupt trigger type: %d\n", \\r
                 TriggerType));\r
          ASSERT (FALSE);\r
          return EFI_UNSUPPORTED;\r
  }\r
\r
  Status = GicGetDistributorIcfgBaseAndBit (\r
             Source,\r
             &RegAddress,\r
             &Config1Bit\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = GicV3GetInterruptSourceState (\r
             (EFI_HARDWARE_INTERRUPT_PROTOCOL*)This,\r
             Source,\r
             &SourceEnabled\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Value = (TriggerType == EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_RISING)\r
          ?  ARM_GIC_ICDICFR_EDGE_TRIGGERED\r
          :  ARM_GIC_ICDICFR_LEVEL_TRIGGERED;\r
\r
  // Before changing the value, we must disable the interrupt,\r
  // otherwise GIC behavior is UNPREDICTABLE.\r
  if (SourceEnabled) {\r
    GicV3DisableInterruptSource (\r
      (EFI_HARDWARE_INTERRUPT_PROTOCOL*)This,\r
      Source\r
      );\r
  }\r
\r
  MmioAndThenOr32 (\r
    RegAddress,\r
    ~(0x1 << Config1Bit),\r
    Value << Config1Bit\r
    );\r
  // Restore interrupt state\r
  if (SourceEnabled) {\r
    GicV3EnableInterruptSource (\r
      (EFI_HARDWARE_INTERRUPT_PROTOCOL*)This,\r
      Source\r
      );\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_HARDWARE_INTERRUPT2_PROTOCOL gHardwareInterrupt2V3Protocol = {\r
  (HARDWARE_INTERRUPT2_REGISTER)RegisterInterruptSource,\r
  (HARDWARE_INTERRUPT2_ENABLE)GicV3EnableInterruptSource,\r
  (HARDWARE_INTERRUPT2_DISABLE)GicV3DisableInterruptSource,\r
  (HARDWARE_INTERRUPT2_INTERRUPT_STATE)GicV3GetInterruptSourceState,\r
  (HARDWARE_INTERRUPT2_END_OF_INTERRUPT)GicV3EndOfInterrupt,\r
  GicV3GetTriggerType,\r
  GicV3SetTriggerType\r
};\r
\r
/**\r
  Shutdown our hardware\r
\r
  DXE Core will disable interrupts and turn off the timer and disable interrupts\r
  after all the event handlers have run.\r
\r
  @param[in]  Event   The Event that is being processed\r
  @param[in]  Context Event Context\r
**/\r
VOID\r
EFIAPI\r
GicV3ExitBootServicesEvent (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
{\r
  UINTN    Index;\r
\r
  // Acknowledge all pending interrupts\r
  for (Index = 0; Index < mGicNumInterrupts; Index++) {\r
    GicV3DisableInterruptSource (&gHardwareInterruptV3Protocol, Index);\r
  }\r
\r
  for (Index = 0; Index < mGicNumInterrupts; Index++) {\r
    GicV3EndOfInterrupt (&gHardwareInterruptV3Protocol, Index);\r
  }\r
\r
  // Disable Gic Interface\r
  ArmGicV3DisableInterruptInterface ();\r
\r
  // Disable Gic Distributor\r
  ArmGicDisableDistributor (mGicDistributorBase);\r
}\r
\r
/**\r
  Initialize the state information for the CPU Architectural Protocol\r
\r
  @param  ImageHandle   of the loaded driver\r
  @param  SystemTable   Pointer to the System Table\r
\r
  @retval EFI_SUCCESS           Protocol registered\r
  @retval EFI_OUT_OF_RESOURCES  Cannot allocate protocol data structure\r
  @retval EFI_DEVICE_ERROR      Hardware problems\r
\r
**/\r
EFI_STATUS\r
GicV3DxeInitialize (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  EFI_STATUS              Status;\r
  UINTN                   Index;\r
  UINT32                  RegOffset;\r
  UINTN                   RegShift;\r
  UINT64                  CpuTarget;\r
  UINT64                  MpId;\r
\r
  // Make sure the Interrupt Controller Protocol is not already installed in\r
  // the system.\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gHardwareInterruptProtocolGuid);\r
\r
  mGicDistributorBase    = PcdGet64 (PcdGicDistributorBase);\r
  mGicRedistributorsBase = PcdGet64 (PcdGicRedistributorsBase);\r
  mGicNumInterrupts      = ArmGicGetMaxNumInterrupts (mGicDistributorBase);\r
\r
  // We will be driving this GIC in native v3 mode, i.e., with Affinity\r
  // Routing enabled. So ensure that the ARE bit is set.\r
  if (!FeaturePcdGet (PcdArmGicV3WithV2Legacy)) {\r
    MmioOr32 (mGicDistributorBase + ARM_GIC_ICDDCR, ARM_GIC_ICDDCR_ARE);\r
  }\r
\r
  for (Index = 0; Index < mGicNumInterrupts; Index++) {\r
    GicV3DisableInterruptSource (&gHardwareInterruptV3Protocol, Index);\r
\r
    // Set Priority\r
    RegOffset = Index / 4;\r
    RegShift = (Index % 4) * 8;\r
    MmioAndThenOr32 (\r
      mGicDistributorBase + ARM_GIC_ICDIPR + (4 * RegOffset),\r
      ~(0xff << RegShift),\r
      ARM_GIC_DEFAULT_PRIORITY << RegShift\r
      );\r
  }\r
\r
  // Targets the interrupts to the Primary Cpu\r
\r
  if (FeaturePcdGet (PcdArmGicV3WithV2Legacy)) {\r
    // Only Primary CPU will run this code. We can identify our GIC CPU ID by\r
    // reading the GIC Distributor Target register. The 8 first\r
    // GICD_ITARGETSRn are banked to each connected CPU. These 8 registers\r
    // hold the CPU targets fields for interrupts 0-31. More Info in the GIC\r
    // Specification about "Interrupt Processor Targets Registers"\r
\r
    // Read the first Interrupt Processor Targets Register (that corresponds\r
    // to the 4 first SGIs)\r
    CpuTarget = MmioRead32 (mGicDistributorBase + ARM_GIC_ICDIPTR);\r
\r
    // The CPU target is a bit field mapping each CPU to a GIC CPU Interface.\r
    // This value is 0 when we run on a uniprocessor platform.\r
    if (CpuTarget != 0) {\r
      // The 8 first Interrupt Processor Targets Registers are read-only\r
      for (Index = 8; Index < (mGicNumInterrupts / 4); Index++) {\r
        MmioWrite32 (\r
          mGicDistributorBase + ARM_GIC_ICDIPTR + (Index * 4),\r
          CpuTarget\r
          );\r
      }\r
    }\r
  } else {\r
    MpId = ArmReadMpidr ();\r
    CpuTarget = MpId &\r
      (ARM_CORE_AFF0 | ARM_CORE_AFF1 | ARM_CORE_AFF2 | ARM_CORE_AFF3);\r
\r
    if ((MmioRead32 (\r
           mGicDistributorBase + ARM_GIC_ICDDCR\r
         ) & ARM_GIC_ICDDCR_DS) != 0) {\r
\r
      // If the Disable Security (DS) control bit is set, we are dealing with a\r
      // GIC that has only one security state. In this case, let's assume we are\r
      // executing in non-secure state (which is appropriate for DXE modules)\r
      // and that no other firmware has performed any configuration on the GIC.\r
      // This means we need to reconfigure all interrupts to non-secure Group 1\r
      // first.\r
\r
      MmioWrite32 (\r
        mGicRedistributorsBase + ARM_GICR_CTLR_FRAME_SIZE + ARM_GIC_ICDISR,\r
        0xffffffff\r
        );\r
\r
      for (Index = 32; Index < mGicNumInterrupts; Index += 32) {\r
        MmioWrite32 (\r
          mGicDistributorBase + ARM_GIC_ICDISR + Index / 8,\r
          0xffffffff\r
          );\r
      }\r
    }\r
\r
    // Route the SPIs to the primary CPU. SPIs start at the INTID 32\r
    for (Index = 0; Index < (mGicNumInterrupts - 32); Index++) {\r
      MmioWrite64 (\r
        mGicDistributorBase + ARM_GICD_IROUTER + (Index * 8),\r
        CpuTarget\r
        );\r
    }\r
  }\r
\r
  // Set binary point reg to 0x7 (no preemption)\r
  ArmGicV3SetBinaryPointer (0x7);\r
\r
  // Set priority mask reg to 0xff to allow all priorities through\r
  ArmGicV3SetPriorityMask (0xff);\r
\r
  // Enable gic cpu interface\r
  ArmGicV3EnableInterruptInterface ();\r
\r
  // Enable gic distributor\r
  ArmGicEnableDistributor (mGicDistributorBase);\r
\r
  Status = InstallAndRegisterInterruptService (\r
             &gHardwareInterruptV3Protocol,\r
             &gHardwareInterrupt2V3Protocol,\r
             GicV3IrqInterruptHandler,\r
             GicV3ExitBootServicesEvent\r
             );\r
\r
  return Status;\r
}\r