ArmPkg/ArmGic: Returned the InterruptId in ArmGicAcknowledgeInterrupt()

[mirror_edk2.git] / ArmPkg / Include / Library / ArmGicLib.h

diff --git a/ArmPkg/Include/Library/ArmGicLib.h b/ArmPkg/Include/Library/ArmGicLib.h
index f2d4c7b27ce02b982460e87941f2f14d6cd377e9..e3ef228dba2ee1e199c0d8cd6668c8a9178d3705 100644 (file)
--- a/ArmPkg/Include/Library/ArmGicLib.h
+++ b/ArmPkg/Include/Library/ArmGicLib.h
@@ -140,10 +140,24 @@ ArmGicSendSgiTo (
   IN  INTN          SgiId\r
   );\r
 \r
+/*\r
+ * Acknowledge and return the value of the Interrupt Acknowledge Register\r
+ *\r
+ * InterruptId is returned separately from the register value because in\r
+ * the GICv2 the register value contains the CpuId and InterruptId while\r
+ * 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
+ *\r
+ * @retval value returned by the Interrupt Acknowledge Register\r
+ *\r
+ */\r
 UINTN\r
 EFIAPI\r
 ArmGicAcknowledgeInterrupt (\r
-  IN  UINTN          GicInterruptInterfaceBase\r
+  IN  UINTN          GicInterruptInterfaceBase,\r
+  OUT UINTN          *InterruptId\r
   );\r
 \r
 VOID\r