From: Jean THOMAS <git0@pub.jeanthomas.me>
Date: Thu, 6 Aug 2020 10:43:10 +0000 (+0200)
Subject: gram.phy.ecp5ddrphy: Add documentation for _DQSBUFMSettingManager
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=e1081af30b1e494c6c95bc4d914246539a5790aa;p=gram.git

gram.phy.ecp5ddrphy: Add documentation for _DQSBUFMSettingManager
---

diff --git a/gram/phy/ecp5ddrphy.py b/gram/phy/ecp5ddrphy.py
index c1c2f17..1abc943 100644
--- a/gram/phy/ecp5ddrphy.py
+++ b/gram/phy/ecp5ddrphy.py
@@ -76,6 +76,24 @@ class ECP5DDRPHYInit(Elaboratable):
 
 
 class _DQSBUFMSettingManager(Elaboratable):
+    """DQSBUFM setting manager.
+
+    The DQSBUFM primitive requires a very basic sequence when updating
+    read delay or other parameters. This elaboratable generates this
+    sequence from CSR events.
+
+    Parameters
+    ----------
+    rdly_slr : CSR
+        CSR storing the rdly value.
+
+    Attributes
+    ----------
+    pause : Signal(), out
+        Pause signal for DQSBUFM.
+    readclksel : Signal(3), out
+        Readclksel signal for DQSBUFM.
+    """
     def __init__(self, rdly_csr):
         self.rdly_csr = rdly_csr