From a9cbb16785db134c333056d83916179bcc7177d6 Mon Sep 17 00:00:00 2001
From: Florent Kermarrec <florent@enjoy-digital.fr>
Date: Mon, 19 Jun 2023 09:44:37 +0200
Subject: [PATCH] soc/add_pcie: Add msi_type parameter to select MSI,
 MSI-Multi-Vector or MSI-X.

---
 CHANGES.md                   |  1 +
 litex/soc/integration/soc.py | 27 +++++++++++++++++----------
 2 files changed, 18 insertions(+), 10 deletions(-)

diff --git a/CHANGES.md b/CHANGES.md
index cfb636247..b708359e5 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -29,6 +29,7 @@
 	- software/liblitespi          : Added read_id support.
 	- litex_boards                 : Added QMtech XC7K325T, VCU128, SITLINV_STVL7325_V2, Enclustra XU8/PE3 support.
 	- liteeth                      : Added Ultrascale+ GTY/GTH SGMII/1000BaseX PHYs.
+	- soc/add_pcie                 : Added msi_type parameter to select MSI, MSI-Multi-Vector or MSI-X.
 
 	[> Changed
 	----------
diff --git a/litex/soc/integration/soc.py b/litex/soc/integration/soc.py
index c0fd216fa..b33edf8b8 100644
--- a/litex/soc/integration/soc.py
+++ b/litex/soc/integration/soc.py
@@ -1976,12 +1976,12 @@ class LiteXSoC(SoC):
         with_dma_synchronizer = False,
         with_dma_monitor      = False,
         with_dma_status       = False,
-        with_msi              = True,
+        with_msi              = True, msi_type="msi",
 ):
         # Imports
         from litepcie.phy.uspciephy import USPCIEPHY
         from litepcie.phy.usppciephy import USPPCIEPHY
-        from litepcie.core import LitePCIeEndpoint, LitePCIeMSI
+        from litepcie.core import LitePCIeEndpoint, LitePCIeMSI, LitePCIeMSIMultiVector, LitePCIeMSIX
         from litepcie.frontend.dma import LitePCIeDMA
         from litepcie.frontend.wishbone import LitePCIeWishboneMaster
 
@@ -2005,18 +2005,25 @@ class LiteXSoC(SoC):
 
         # MSI.
         if with_msi:
+            assert msi_type in ["msi", "msi-multi-vector", "msi-x"]
             self.check_if_exists(f"{name}_msi")
-            msi = LitePCIeMSI()
+            if msi_type == "msi":
+                msi = LitePCIeMSI()
+            if msi_type == "msi-multi-vector":
+                msi = LitePCIeMSIMultiVector()
+            if msi_type == "msi-x":
+                msi = LitePCIeMSIX(endpoint=self.pcie_endpoint)
             self.add_module(name=f"{name}_msi", module=msi)
             # FIXME: On Ultrascale/Ultrascale+ limit rate of IRQs to 1MHz (to prevent issue with
             # IRQs stalled).
-            if isinstance(phy, (USPCIEPHY, USPPCIEPHY)):
-                msi_timer = WaitTimer(int(self.sys_clk_freq/1e6))
-                self.add_module(name=f"{name}_msi_timer", module=msi_timer)
-                self.comb += msi_timer.wait.eq(~msi_timer.done)
-                self.comb += If(msi_timer.done, msi.source.connect(phy.msi))
-            else:
-                self.comb += msi.source.connect(phy.msi)
+            if msi_type in ["msi", "msi-multi-vector"]:
+                if isinstance(phy, (USPCIEPHY, USPPCIEPHY)):
+                    msi_timer = WaitTimer(int(self.sys_clk_freq/1e6))
+                    self.add_module(name=f"{name}_msi_timer", module=msi_timer)
+                    self.comb += msi_timer.wait.eq(~msi_timer.done)
+                    self.comb += If(msi_timer.done, msi.source.connect(phy.msi))
+                else:
+                    self.comb += msi.source.connect(phy.msi)
             self.msis = {}
 
         # DMAs.