litex/gen: Add some comments.

litex/gen/common.py

@@ -6,9 +6,10 @@
 
 from migen import *
 
-# Generic Helpers ----------------------------------------------------------------------------------
+# Coloring Helpers ---------------------------------------------------------------------------------
 
 def colorer(s, color="bright"):
+    """Apply ANSI colors to a string."""
     header  = {
         "bright": "\x1b[1m",
         "green":  "\x1b[32m",
@@ -22,9 +23,11 @@ def colorer(s, color="bright"):
 # Bit/Bytes Reversing ------------------------------------------------------------------------------
 
 def reverse_bits(s):
+    """Return a signal with reversed bit order."""
     return s[::-1]
 
 def reverse_bytes(s):
+    """Return a signal with reversed byte order."""
     n = (len(s) + 7)//8
     return Cat(*[s[i*8:min((i + 1)*8, len(s))]
         for i in reversed(range(n))])

litex/gen/context.py

@@ -8,9 +8,19 @@ from migen import *
 
 # LiteX Context ------------------------------------------------------------------------------------
 
-# FIXME: PoC to fix Efinix AsyncFIFO issue, think a bit more about it to see how to do it properly.
-
 class LiteXContext:
+    """
+    A context for LiteX-related settings.
+
+    This class serves as a container for the platform, toolchain, device,
+    and system-on-a-chip (SoC) information for a given LiteX project.
+
+    Attributes:
+        platform  : The FPGA Platform of the project.
+        toolchain : The FPGA Toolchain to be used for synthesis and place-and-route.
+        device    : The FPGA Device of the LiteX project.
+        soc       : The FPGA SoC of the LiteX project.
+    """
     platform  = None
     toolchain = None
     device    = None

litex/gen/signal.py

@@ -8,14 +8,28 @@ from migen import *
 
 # Signals ------------------------------------------------------------------------------------------
 
-class Open(Signal): pass
+class Open(Signal):
+    """A base Signal class, representing an open signal."""
+    pass
 
 class Unsigned(Signal):
+    """
+    A Signal subclass for unsigned signals.
+
+    Args:
+        bits (int): Number of bits of the signal. Defaults to 1.
+    """
     def __init__(self, bits=1, *args, **kwargs):
         assert isinstance(bits, int)
         Signal.__init__(self, bits_sign=(bits, 0), *args, **kwargs)
 
 class Signed(Signal):
+    """
+    A Signal subclass for signed signals.
+
+    Args:
+        bits (int): Number of bits of the signal. Defaults to 1.
+    """
     def __init__(self, bits=1, *args, **kwargs):
         assert isinstance(bits, int)
         Signal.__init__(self, bits_sign=(bits, 1), *args, **kwargs)