From: bunnie <bunnie@kosagi.com>
Date: Thu, 6 Feb 2020 09:56:21 +0000 (+0800)
Subject: add doc comment for event
X-Git-Tag: 24jan2021_ls180~688^2~2
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=416afd3109c6bb8fa42e76eb1e27ac36f521b663;p=litex.git

add doc comment for event
---

diff --git a/litex/soc/cores/spiopi.py b/litex/soc/cores/spiopi.py
index 12a05d71..937d8e5e 100644
--- a/litex/soc/cores/spiopi.py
+++ b/litex/soc/cores/spiopi.py
@@ -1019,7 +1019,7 @@ class SpiOpi(Module, AutoCSR, AutoDoc):
         self.specials += MultiReg(pads.ecs_n, ecs_n)
 
         self.submodules.ev = EventManager()
-        self.ev.ecc_error = EventSourceProcess()  # Falling edge triggered
+        self.ev.ecc_error = EventSourceProcess(description="An ECC event has happened on the current block; triggered by falling edge of ECC_N")
         self.ev.finalize()
         self.comb += self.ev.ecc_error.trigger.eq(ecs_n)
         ecc_reported = Signal()