From: bunnie <bunnie@kosagi.com>
Date: Thu, 6 Feb 2020 09:58:02 +0000 (+0800)
Subject: update doc comments on events for i2s
X-Git-Tag: 24jan2021_ls180~688^2~1
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=d2b394a9be3e4e118b73954ccae5bcbc4cbf072d;p=litex.git

update doc comments on events for i2s
---

diff --git a/litex/soc/cores/i2s.py b/litex/soc/cores/i2s.py
index 1125f792..512b2164 100644
--- a/litex/soc/cores/i2s.py
+++ b/litex/soc/cores/i2s.py
@@ -131,11 +131,11 @@ class i2s_slave(Module, AutoCSR, AutoDoc):
         # interrupts
         self.submodules.ev = EventManager()
         if hasattr(pads, 'rx'):
-            self.ev.rx_ready = EventSourcePulse()  # rising edge triggered, indicates FIFO is ready to read
-            self.ev.rx_error = EventSourcePulse()  # indicates a rx error has happened
+            self.ev.rx_ready = EventSourcePulse(description="Indicates FIFO is ready to read")  # rising edge triggered
+            self.ev.rx_error = EventSourcePulse(description="Indicates an Rx error has happened (over/underflow)")
         if hasattr(pads, 'tx'):
-            self.ev.tx_ready = EventSourcePulse()  # indicates space available in Tx buffer for next quantum
-            self.ev.tx_error = EventSourcePulse()  # indicates a tx error has happened
+            self.ev.tx_ready = EventSourcePulse(description="Indicates enough space available for next Tx quanta of {} words".format(fifodepth))
+            self.ev.tx_error = EventSourcePulse(description="Indicates a Tx error has happened (over/underflow")
         self.ev.finalize()