interconnect/Remapper: Add docstring description.

enjoy-digital · Feb 13, 2024 · 19db80e · 19db80e
1 parent fe0363d
commit 19db80e
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/litex/soc/interconnect/axi/axi_full.py b/litex/soc/interconnect/axi/axi_full.py
@@ -143,6 +143,7 @@ def layout_flat(self):
 # AXI Remapper -------------------------------------------------------------------------------------
 
 class AXIRemapper(LiteXModule):
+    """Remaps AXI addresses by applying an origin offset and address mask."""
     def __init__(self, master, slave, origin, size):
         # Mask.
         mask = 2**int(log2(size)) - 1

diff --git a/litex/soc/interconnect/axi/axi_lite.py b/litex/soc/interconnect/axi/axi_lite.py
@@ -134,6 +134,7 @@ def read(self, addr):
 # AXI-Lite Remapper --------------------------------------------------------------------------------
 
 class AXILiteRemapper(LiteXModule):
+    """Remaps AXI Lite addresses by applying an origin offset and address mask."""
     def __init__(self, master, slave, origin, size):
         # Mask.
         mask = 2**int(log2(size)) - 1

diff --git a/litex/soc/interconnect/wishbone.py b/litex/soc/interconnect/wishbone.py
@@ -129,6 +129,7 @@ def connect_to_pads(self, pads, mode="master"):
 # Wishbone Remapper --------------------------------------------------------------------------------
 
 class Remapper(LiteXModule):
+    """Remaps Wishbone addresses by applying an origin offset and address mask."""
     def __init__(self, master, slave, origin, size):
         # Parameters.
         addressing = master.addressing