]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ArmPkg/Drivers/ArmGic/ArmGicLib.c
ArmPkg: Apply uncrustify changes
[mirror_edk2.git] / ArmPkg / Drivers / ArmGic / ArmGicLib.c
index 41e970bc4968bcd2558fd68d9b2c14ebb9d5b7b3..58ab45f812b337dc1e607ed50c93f17c49b66305 100644 (file)
 /** @file\r
 *\r
-*  Copyright (c) 2011-2014, ARM Limited. All rights reserved.\r
+*  Copyright (c) 2011-2021, Arm Limited. All rights reserved.\r
 *\r
-*  This program and the accompanying materials\r
-*  are licensed and made available under the terms and conditions of the BSD License\r
-*  which accompanies this distribution.  The full text of the license may be found at\r
-*  http://opensource.org/licenses/bsd-license.php\r
-*\r
-*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-*  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+*  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 *\r
 **/\r
 \r
 #include <Base.h>\r
 #include <Library/ArmGicLib.h>\r
+#include <Library/ArmLib.h>\r
 #include <Library/DebugLib.h>\r
 #include <Library/IoLib.h>\r
+#include <Library/PcdLib.h>\r
+\r
+// In GICv3, there are 2 x 64KB frames:\r
+// Redistributor control frame + SGI Control & Generation frame\r
+#define GIC_V3_REDISTRIBUTOR_GRANULARITY  (ARM_GICR_CTLR_FRAME_SIZE           \\r
+                                           + ARM_GICR_SGI_PPI_FRAME_SIZE)\r
+\r
+// In GICv4, there are 2 additional 64KB frames:\r
+// VLPI frame + Reserved page frame\r
+#define GIC_V4_REDISTRIBUTOR_GRANULARITY  (GIC_V3_REDISTRIBUTOR_GRANULARITY   \\r
+                                           + ARM_GICR_SGI_VLPI_FRAME_SIZE     \\r
+                                           + ARM_GICR_SGI_RESERVED_FRAME_SIZE)\r
+\r
+#define ISENABLER_ADDRESS(base, offset)  ((base) +\\r
+          ARM_GICR_CTLR_FRAME_SIZE + ARM_GICR_ISENABLER + 4 * (offset))\r
+\r
+#define ICENABLER_ADDRESS(base, offset)  ((base) +\\r
+          ARM_GICR_CTLR_FRAME_SIZE + ARM_GICR_ICENABLER + 4 * (offset))\r
+\r
+#define IPRIORITY_ADDRESS(base, offset)  ((base) +\\r
+          ARM_GICR_CTLR_FRAME_SIZE + ARM_GIC_ICDIPR + 4 * (offset))\r
+\r
+/**\r
+ *\r
+ * Return whether the Source interrupt index refers to a shared interrupt (SPI)\r
+ */\r
+STATIC\r
+BOOLEAN\r
+SourceIsSpi (\r
+  IN UINTN  Source\r
+  )\r
+{\r
+  return Source >= 32 && Source < 1020;\r
+}\r
+\r
+/**\r
+ * Return the base address of the GIC redistributor for the current CPU\r
+ *\r
+ * @param Revision  GIC Revision. The GIC redistributor might have a different\r
+ *                  granularity following the GIC revision.\r
+ *\r
+ * @retval Base address of the associated GIC Redistributor\r
+ */\r
+STATIC\r
+UINTN\r
+GicGetCpuRedistributorBase (\r
+  IN UINTN                  GicRedistributorBase,\r
+  IN ARM_GIC_ARCH_REVISION  Revision\r
+  )\r
+{\r
+  UINTN   MpId;\r
+  UINTN   CpuAffinity;\r
+  UINTN   Affinity;\r
+  UINTN   GicCpuRedistributorBase;\r
+  UINT64  TypeRegister;\r
+\r
+  MpId = ArmReadMpidr ();\r
+  // Define CPU affinity as:\r
+  // Affinity0[0:8], Affinity1[9:15], Affinity2[16:23], Affinity3[24:32]\r
+  // whereas Affinity3 is defined at [32:39] in MPIDR\r
+  CpuAffinity = (MpId & (ARM_CORE_AFF0 | ARM_CORE_AFF1 | ARM_CORE_AFF2)) |\r
+                ((MpId & ARM_CORE_AFF3) >> 8);\r
 \r
-#include "GicV2/ArmGicV2Lib.h"\r
+  if (Revision < ARM_GIC_ARCH_REVISION_3) {\r
+    ASSERT_EFI_ERROR (EFI_UNSUPPORTED);\r
+    return 0;\r
+  }\r
+\r
+  GicCpuRedistributorBase = GicRedistributorBase;\r
+\r
+  do {\r
+    TypeRegister = MmioRead64 (GicCpuRedistributorBase + ARM_GICR_TYPER);\r
+    Affinity     = ARM_GICR_TYPER_GET_AFFINITY (TypeRegister);\r
+    if (Affinity == CpuAffinity) {\r
+      return GicCpuRedistributorBase;\r
+    }\r
+\r
+    // Move to the next GIC Redistributor frame.\r
+    // The GIC specification does not forbid a mixture of redistributors\r
+    // with or without support for virtual LPIs, so we test Virtual LPIs\r
+    // Support (VLPIS) bit for each frame to decide the granularity.\r
+    // Note: The assumption here is that the redistributors are adjacent\r
+    // for all CPUs. However this may not be the case for NUMA systems.\r
+    GicCpuRedistributorBase += (((ARM_GICR_TYPER_VLPIS & TypeRegister) != 0)\r
+                                ? GIC_V4_REDISTRIBUTOR_GRANULARITY\r
+                                : GIC_V3_REDISTRIBUTOR_GRANULARITY);\r
+  } while ((TypeRegister & ARM_GICR_TYPER_LAST) == 0);\r
+\r
+  // The Redistributor has not been found for the current CPU\r
+  ASSERT_EFI_ERROR (EFI_NOT_FOUND);\r
+  return 0;\r
+}\r
 \r
 UINTN\r
 EFIAPI\r
 ArmGicGetInterfaceIdentification (\r
-  IN  INTN          GicInterruptInterfaceBase\r
+  IN  INTN  GicInterruptInterfaceBase\r
   )\r
 {\r
   // Read the GIC Identification Register\r
@@ -32,22 +117,32 @@ ArmGicGetInterfaceIdentification (
 UINTN\r
 EFIAPI\r
 ArmGicGetMaxNumInterrupts (\r
-  IN  INTN          GicDistributorBase\r
+  IN  INTN  GicDistributorBase\r
   )\r
 {\r
-  return 32 * ((MmioRead32 (GicDistributorBase + ARM_GIC_ICDICTR) & 0x1F) + 1);\r
+  UINTN  ItLines;\r
+\r
+  ItLines = MmioRead32 (GicDistributorBase + ARM_GIC_ICDICTR) & 0x1F;\r
+\r
+  //\r
+  // Interrupt ID 1020-1023 are reserved.\r
+  //\r
+  return (ItLines == 0x1f) ? 1020 : 32 * (ItLines + 1);\r
 }\r
 \r
 VOID\r
 EFIAPI\r
 ArmGicSendSgiTo (\r
-  IN  INTN          GicDistributorBase,\r
-  IN  INTN          TargetListFilter,\r
-  IN  INTN          CPUTargetList,\r
-  IN  INTN          SgiId\r
+  IN  INTN  GicDistributorBase,\r
+  IN  INTN  TargetListFilter,\r
+  IN  INTN  CPUTargetList,\r
+  IN  INTN  SgiId\r
   )\r
 {\r
-  MmioWrite32 (GicDistributorBase + ARM_GIC_ICDSGIR, ((TargetListFilter & 0x3) << 24) | ((CPUTargetList & 0xFF) << 16) | SgiId);\r
+  MmioWrite32 (\r
+    GicDistributorBase + ARM_GIC_ICDSGIR,\r
+    ((TargetListFilter & 0x3) << 24) | ((CPUTargetList & 0xFF) << 16) | SgiId\r
+    );\r
 }\r
 \r
 /*\r
@@ -58,7 +153,8 @@ ArmGicSendSgiTo (
  * in the GICv3 the register value is only the InterruptId.\r
  *\r
  * @param GicInterruptInterfaceBase   Base Address of the GIC CPU Interface\r
- * @param InterruptId                 InterruptId read from the Interrupt Acknowledge Register\r
+ * @param InterruptId                 InterruptId read from the Interrupt\r
+ *                                    Acknowledge Register\r
  *\r
  * @retval value returned by the Interrupt Acknowledge Register\r
  *\r
@@ -66,20 +162,29 @@ ArmGicSendSgiTo (
 UINTN\r
 EFIAPI\r
 ArmGicAcknowledgeInterrupt (\r
-  IN  UINTN          GicInterruptInterfaceBase,\r
-  OUT UINTN          *InterruptId\r
+  IN  UINTN  GicInterruptInterfaceBase,\r
+  OUT UINTN  *InterruptId\r
   )\r
 {\r
-  UINTN Value;\r
-\r
-  Value = ArmGicV2AcknowledgeInterrupt (GicInterruptInterfaceBase);\r
+  UINTN                  Value;\r
+  ARM_GIC_ARCH_REVISION  Revision;\r
 \r
-  // InterruptId is required for the caller to know if a valid or spurious\r
-  // interrupt has been read\r
-  ASSERT (InterruptId != NULL);\r
-\r
-  if (InterruptId != NULL) {\r
-    *InterruptId = Value & ARM_GIC_ICCIAR_ACKINTID;\r
+  Revision = ArmGicGetSupportedArchRevision ();\r
+  if (Revision == ARM_GIC_ARCH_REVISION_2) {\r
+    Value = ArmGicV2AcknowledgeInterrupt (GicInterruptInterfaceBase);\r
+    // InterruptId is required for the caller to know if a valid or spurious\r
+    // interrupt has been read\r
+    ASSERT (InterruptId != NULL);\r
+    if (InterruptId != NULL) {\r
+      *InterruptId = Value & ARM_GIC_ICCIAR_ACKINTID;\r
+    }\r
+  } else if (Revision == ARM_GIC_ARCH_REVISION_3) {\r
+    Value = ArmGicV3AcknowledgeInterrupt ();\r
+  } else {\r
+    ASSERT_EFI_ERROR (EFI_UNSUPPORTED);\r
+    // Report Spurious interrupt which is what the above controllers would\r
+    // return if no interrupt was available\r
+    Value = 1023;\r
   }\r
 \r
   return Value;\r
@@ -88,90 +193,243 @@ ArmGicAcknowledgeInterrupt (
 VOID\r
 EFIAPI\r
 ArmGicEndOfInterrupt (\r
-  IN  UINTN                 GicInterruptInterfaceBase,\r
-  IN UINTN                  Source\r
+  IN  UINTN  GicInterruptInterfaceBase,\r
+  IN UINTN   Source\r
   )\r
 {\r
-  ArmGicV2EndOfInterrupt (GicInterruptInterfaceBase, Source);\r
+  ARM_GIC_ARCH_REVISION  Revision;\r
+\r
+  Revision = ArmGicGetSupportedArchRevision ();\r
+  if (Revision == ARM_GIC_ARCH_REVISION_2) {\r
+    ArmGicV2EndOfInterrupt (GicInterruptInterfaceBase, Source);\r
+  } else if (Revision == ARM_GIC_ARCH_REVISION_3) {\r
+    ArmGicV3EndOfInterrupt (Source);\r
+  } else {\r
+    ASSERT_EFI_ERROR (EFI_UNSUPPORTED);\r
+  }\r
+}\r
+\r
+VOID\r
+EFIAPI\r
+ArmGicSetInterruptPriority (\r
+  IN UINTN  GicDistributorBase,\r
+  IN UINTN  GicRedistributorBase,\r
+  IN UINTN  Source,\r
+  IN UINTN  Priority\r
+  )\r
+{\r
+  UINT32                 RegOffset;\r
+  UINTN                  RegShift;\r
+  ARM_GIC_ARCH_REVISION  Revision;\r
+  UINTN                  GicCpuRedistributorBase;\r
+\r
+  // Calculate register offset and bit position\r
+  RegOffset = Source / 4;\r
+  RegShift  = (Source % 4) * 8;\r
+\r
+  Revision = ArmGicGetSupportedArchRevision ();\r
+  if ((Revision == ARM_GIC_ARCH_REVISION_2) ||\r
+      FeaturePcdGet (PcdArmGicV3WithV2Legacy) ||\r
+      SourceIsSpi (Source))\r
+  {\r
+    MmioAndThenOr32 (\r
+      GicDistributorBase + ARM_GIC_ICDIPR + (4 * RegOffset),\r
+      ~(0xff << RegShift),\r
+      Priority << RegShift\r
+      );\r
+  } else {\r
+    GicCpuRedistributorBase = GicGetCpuRedistributorBase (\r
+                                GicRedistributorBase,\r
+                                Revision\r
+                                );\r
+    if (GicCpuRedistributorBase == 0) {\r
+      return;\r
+    }\r
+\r
+    MmioAndThenOr32 (\r
+      IPRIORITY_ADDRESS (GicCpuRedistributorBase, RegOffset),\r
+      ~(0xff << RegShift),\r
+      Priority << RegShift\r
+      );\r
+  }\r
 }\r
 \r
 VOID\r
 EFIAPI\r
 ArmGicEnableInterrupt (\r
-  IN UINTN                  GicDistributorBase,\r
-  IN UINTN                  Source\r
+  IN UINTN  GicDistributorBase,\r
+  IN UINTN  GicRedistributorBase,\r
+  IN UINTN  Source\r
   )\r
 {\r
-  UINT32    RegOffset;\r
-  UINTN     RegShift;\r
+  UINT32                 RegOffset;\r
+  UINTN                  RegShift;\r
+  ARM_GIC_ARCH_REVISION  Revision;\r
+  UINTN                  GicCpuRedistributorBase;\r
 \r
   // Calculate enable register offset and bit position\r
   RegOffset = Source / 32;\r
-  RegShift = Source % 32;\r
+  RegShift  = Source % 32;\r
+\r
+  Revision = ArmGicGetSupportedArchRevision ();\r
+  if ((Revision == ARM_GIC_ARCH_REVISION_2) ||\r
+      FeaturePcdGet (PcdArmGicV3WithV2Legacy) ||\r
+      SourceIsSpi (Source))\r
+  {\r
+    // Write set-enable register\r
+    MmioWrite32 (\r
+      GicDistributorBase + ARM_GIC_ICDISER + (4 * RegOffset),\r
+      1 << RegShift\r
+      );\r
+  } else {\r
+    GicCpuRedistributorBase = GicGetCpuRedistributorBase (\r
+                                GicRedistributorBase,\r
+                                Revision\r
+                                );\r
+    if (GicCpuRedistributorBase == 0) {\r
+      ASSERT_EFI_ERROR (EFI_NOT_FOUND);\r
+      return;\r
+    }\r
 \r
-  // Write set-enable register\r
-  MmioWrite32 (GicDistributorBase + ARM_GIC_ICDISER + (4 * RegOffset), 1 << RegShift);\r
+    // Write set-enable register\r
+    MmioWrite32 (\r
+      ISENABLER_ADDRESS (GicCpuRedistributorBase, RegOffset),\r
+      1 << RegShift\r
+      );\r
+  }\r
 }\r
 \r
 VOID\r
 EFIAPI\r
 ArmGicDisableInterrupt (\r
-  IN UINTN                  GicDistributorBase,\r
-  IN UINTN                  Source\r
+  IN UINTN  GicDistributorBase,\r
+  IN UINTN  GicRedistributorBase,\r
+  IN UINTN  Source\r
   )\r
 {\r
-  UINT32    RegOffset;\r
-  UINTN     RegShift;\r
+  UINT32                 RegOffset;\r
+  UINTN                  RegShift;\r
+  ARM_GIC_ARCH_REVISION  Revision;\r
+  UINTN                  GicCpuRedistributorBase;\r
 \r
   // Calculate enable register offset and bit position\r
   RegOffset = Source / 32;\r
-  RegShift = Source % 32;\r
+  RegShift  = Source % 32;\r
+\r
+  Revision = ArmGicGetSupportedArchRevision ();\r
+  if ((Revision == ARM_GIC_ARCH_REVISION_2) ||\r
+      FeaturePcdGet (PcdArmGicV3WithV2Legacy) ||\r
+      SourceIsSpi (Source))\r
+  {\r
+    // Write clear-enable register\r
+    MmioWrite32 (\r
+      GicDistributorBase + ARM_GIC_ICDICER + (4 * RegOffset),\r
+      1 << RegShift\r
+      );\r
+  } else {\r
+    GicCpuRedistributorBase = GicGetCpuRedistributorBase (\r
+                                GicRedistributorBase,\r
+                                Revision\r
+                                );\r
+    if (GicCpuRedistributorBase == 0) {\r
+      return;\r
+    }\r
 \r
-  // Write clear-enable register\r
-  MmioWrite32 (GicDistributorBase + ARM_GIC_ICDICER + (4 * RegOffset), 1 << RegShift);\r
+    // Write clear-enable register\r
+    MmioWrite32 (\r
+      ICENABLER_ADDRESS (GicCpuRedistributorBase, RegOffset),\r
+      1 << RegShift\r
+      );\r
+  }\r
 }\r
 \r
 BOOLEAN\r
 EFIAPI\r
 ArmGicIsInterruptEnabled (\r
-  IN UINTN                  GicDistributorBase,\r
-  IN UINTN                  Source\r
+  IN UINTN  GicDistributorBase,\r
+  IN UINTN  GicRedistributorBase,\r
+  IN UINTN  Source\r
   )\r
 {\r
-  UINT32    RegOffset;\r
-  UINTN     RegShift;\r
+  UINT32                 RegOffset;\r
+  UINTN                  RegShift;\r
+  ARM_GIC_ARCH_REVISION  Revision;\r
+  UINTN                  GicCpuRedistributorBase;\r
+  UINT32                 Interrupts;\r
 \r
   // Calculate enable register offset and bit position\r
   RegOffset = Source / 32;\r
-  RegShift = Source % 32;\r
+  RegShift  = Source % 32;\r
+\r
+  Revision = ArmGicGetSupportedArchRevision ();\r
+  if ((Revision == ARM_GIC_ARCH_REVISION_2) ||\r
+      FeaturePcdGet (PcdArmGicV3WithV2Legacy) ||\r
+      SourceIsSpi (Source))\r
+  {\r
+    Interrupts = ((MmioRead32 (\r
+                     GicDistributorBase + ARM_GIC_ICDISER + (4 * RegOffset)\r
+                     )\r
+                   & (1 << RegShift)) != 0);\r
+  } else {\r
+    GicCpuRedistributorBase = GicGetCpuRedistributorBase (\r
+                                GicRedistributorBase,\r
+                                Revision\r
+                                );\r
+    if (GicCpuRedistributorBase == 0) {\r
+      return 0;\r
+    }\r
 \r
-  return ((MmioRead32 (GicDistributorBase + ARM_GIC_ICDISER + (4 * RegOffset)) & (1 << RegShift)) != 0);\r
+    // Read set-enable register\r
+    Interrupts = MmioRead32 (\r
+                   ISENABLER_ADDRESS (GicCpuRedistributorBase, RegOffset)\r
+                   );\r
+  }\r
+\r
+  return ((Interrupts & (1 << RegShift)) != 0);\r
 }\r
 \r
 VOID\r
 EFIAPI\r
 ArmGicDisableDistributor (\r
-  IN  INTN          GicDistributorBase\r
+  IN  INTN  GicDistributorBase\r
   )\r
 {\r
   // Disable Gic Distributor\r
   MmioWrite32 (GicDistributorBase + ARM_GIC_ICDDCR, 0x0);\r
 }\r
-
+\r
 VOID\r
 EFIAPI\r
 ArmGicEnableInterruptInterface (\r
-  IN  INTN          GicInterruptInterfaceBase\r
+  IN  INTN  GicInterruptInterfaceBase\r
   )\r
 {\r
-  return ArmGicV2EnableInterruptInterface (GicInterruptInterfaceBase);\r
+  ARM_GIC_ARCH_REVISION  Revision;\r
+\r
+  Revision = ArmGicGetSupportedArchRevision ();\r
+  if (Revision == ARM_GIC_ARCH_REVISION_2) {\r
+    ArmGicV2EnableInterruptInterface (GicInterruptInterfaceBase);\r
+  } else if (Revision == ARM_GIC_ARCH_REVISION_3) {\r
+    ArmGicV3EnableInterruptInterface ();\r
+  } else {\r
+    ASSERT_EFI_ERROR (EFI_UNSUPPORTED);\r
+  }\r
 }\r
 \r
 VOID\r
 EFIAPI\r
 ArmGicDisableInterruptInterface (\r
-  IN  INTN          GicInterruptInterfaceBase\r
+  IN  INTN  GicInterruptInterfaceBase\r
   )\r
 {\r
-  return ArmGicV2DisableInterruptInterface (GicInterruptInterfaceBase);\r
+  ARM_GIC_ARCH_REVISION  Revision;\r
+\r
+  Revision = ArmGicGetSupportedArchRevision ();\r
+  if (Revision == ARM_GIC_ARCH_REVISION_2) {\r
+    ArmGicV2DisableInterruptInterface (GicInterruptInterfaceBase);\r
+  } else if (Revision == ARM_GIC_ARCH_REVISION_3) {\r
+    ArmGicV3DisableInterruptInterface ();\r
+  } else {\r
+    ASSERT_EFI_ERROR (EFI_UNSUPPORTED);\r
+  }\r
 }\r