From 963233aefb76aa4e9368522410f213a20e61f4a0 Mon Sep 17 00:00:00 2001
From: Florent Kermarrec <florent@enjoy-digital.fr>
Date: Wed, 16 Feb 2022 11:33:27 +0100
Subject: [PATCH] litedram_gen: Add ECC support on ports and add example on
 kcu105.

---
 examples/kcu105.yml |  6 ++++--
 litedram/gen.py     | 35 +++++++++++++++++++++++------------
 2 files changed, 27 insertions(+), 14 deletions(-)

diff --git a/examples/kcu105.yml b/examples/kcu105.yml
index cde9af5..86242c9 100644
--- a/examples/kcu105.yml
+++ b/examples/kcu105.yml
@@ -34,8 +34,10 @@
     # User Ports ---------------------------------------------------------------
     "user_ports": {
         "axi_0" : {
-            "type": "axi",
-            "id_width": 32,
+            "type"       : "axi",
+            "ecc"        : True,
+            "data_width" : 256,
+            "id_width"   : 32,
         },
         "wishbone_0" : {
             "type": "wishbone",
diff --git a/litedram/gen.py b/litedram/gen.py
index ff0640c..a9bb794 100755
--- a/litedram/gen.py
+++ b/litedram/gen.py
@@ -55,12 +55,15 @@ from litedram import phy as litedram_phys
 from litedram.phy.ecp5ddrphy import ECP5DDRPHY
 from litedram.phy.s7ddrphy import S7DDRPHY
 from litedram.phy.model import SDRAMPHYModel
+
 from litedram.core.controller import ControllerSettings
+
 from litedram.frontend.axi import *
 from litedram.frontend.wishbone import *
 from litedram.frontend.bist import LiteDRAMBISTGenerator
 from litedram.frontend.bist import LiteDRAMBISTChecker
 from litedram.frontend.fifo import LiteDRAMFIFO
+from litedram.frontend.ecc import LiteDRAMNativePortECC
 
 # IOs/Interfaces -----------------------------------------------------------------------------------
 
@@ -271,11 +274,6 @@ def get_fifo_user_port_ios(_id, dw):
         ),
     ]
 
-
-class Platform(XilinxPlatform):
-    def __init__(self):
-        XilinxPlatform.__init__(self, "", io=[], toolchain="vivado")
-
 # CRG ----------------------------------------------------------------------------------------------
 
 class LiteDRAMGENSDRPHYCRG(Module):
@@ -654,10 +652,9 @@ class LiteDRAMCore(SoCCore):
             self.comb += wb_bus.connect_to_pads(wb_pads, mode="slave")
 
         # User ports -------------------------------------------------------------------------------
-        self.comb += [
-            platform.request("user_clk").eq(ClockSignal()),
-            platform.request("user_rst").eq(ResetSignal()),
-        ]
+        self.comb += platform.request("user_clk").eq(ClockSignal())
+        self.comb += platform.request("user_rst").eq(ResetSignal())
+
         for name, port in core_config["user_ports"].items():
 
             # Common -------------------------------------------------------------------------------
@@ -669,9 +666,25 @@ class LiteDRAMCore(SoCCore):
             else:
                 self.comb += user_enable.eq(1)
 
+            # Request user port on crossbar and add optional ECC.
+            if port["type"] in ["native", "wishbone", "axi"]:
+                # With ECC.
+                if port.get("ecc", False):
+                    assert port.get("data_width", None) is not None
+                    ecc_port  = self.sdram.crossbar.get_port()
+                    user_port = LiteDRAMNativePort(
+                        mode = ecc_port.mode,
+                        address_width = ecc_port.address_width,
+                        data_width = port.get("data_width")
+                    )
+                    ecc = LiteDRAMNativePortECC(user_port, ecc_port, with_error_injection=False)
+                    setattr(self.submodules, f"ecc_{name}", ecc)
+                # Without ECC.
+                else:
+                    user_port = self.sdram.crossbar.get_port(data_width=port.get("data_width", None))
+
             # Native -------------------------------------------------------------------------------
             if port["type"] == "native":
-                user_port = self.sdram.crossbar.get_port(data_width=port.get("data_width", None))
                 platform.add_extension(get_native_user_port_ios(name,
                     user_port.address_width,
                     user_port.data_width))
@@ -696,7 +709,6 @@ class LiteDRAMCore(SoCCore):
                 ]
             # Wishbone -----------------------------------------------------------------------------
             elif port["type"] == "wishbone":
-                user_port = self.sdram.crossbar.get_port(data_width=port.get("data_width", None))
                 wb_port = wishbone.Interface(
                     user_port.data_width,
                     user_port.address_width)
@@ -719,7 +731,6 @@ class LiteDRAMCore(SoCCore):
                 ]
             # AXI ----------------------------------------------------------------------------------
             elif port["type"] == "axi":
-                user_port = self.sdram.crossbar.get_port(data_width=port.get("data_width", None))
                 axi_port  = LiteDRAMAXIPort(
                     data_width    = user_port.data_width,
                     address_width = user_port.address_width + log2_int(user_port.data_width//8),