From d2b394a9be3e4e118b73954ccae5bcbc4cbf072d Mon Sep 17 00:00:00 2001 From: bunnie Date: Thu, 6 Feb 2020 17:58:02 +0800 Subject: [PATCH] update doc comments on events for i2s --- litex/soc/cores/i2s.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) 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() -- 2.30.2