csr.bus: drop CSR prefix from class names.

Application code should use Python imports similar to:

    from nmigen_soc import csr
    ...
    decoder = csr.Decoder(...)

thus achieving the same effect with less namespace pollution.

Author: whitequark

nmigen_soc/csr/__init__.py

@@ -0,0 +1 @@
+from .bus import *

nmigen_soc/csr/bus.py

@@ -3,10 +3,10 @@
 from nmigen import tracer
 
 
-__all__ = ["CSRElement", "CSRInterface", "CSRDecoder"]
+__all__ = ["Element", "Interface", "Decoder"]
 
 
-class CSRElement(Record):
+class Element(Record):
     """Peripheral-side CSR interface.
 
     A low-level interface to a single atomically readable and writable register in a peripheral.
@@ -57,7 +57,7 @@ def __init__(self, width, access, *, name=None, src_loc_at=0):
         super().__init__(layout, name=name, src_loc_at=1)
 
 
-class CSRInterface(Record):
+class Interface(Record):
     """CPU-side CSR interface.
 
     A low-level interface to a set of atomically readable and writable peripheral CSR registers.
@@ -123,7 +123,7 @@ def __init__(self, *, addr_width, data_width, name=None):
         ], name=name, src_loc_at=1)
 
 
-class CSRDecoder(Elaboratable):
+class Decoder(Elaboratable):
     """CSR bus decoder.
 
     An address-based multiplexer for CSR registers implementing atomic updates.
@@ -159,20 +159,20 @@ class CSRDecoder(Elaboratable):
     Parameters
     ----------
     addr_width : int
-        Address width. See :class:`CSRInterface`.
+        Address width. See :class:`Interface`.
     data_width : int
-        Data width. See :class:`CSRInterface`.
+        Data width. See :class:`Interface`.
     alignment : int
         Register alignment. The address assigned to each register will be a multiple of
         ``2 ** alignment``.
 
     Attributes
     ----------
-    bus : :class:`CSRInterface`
+    bus : :class:`Interface`
         CSR bus providing access to registers.
     """
     def __init__(self, *, addr_width, data_width, alignment=0):
-        self.bus = CSRInterface(addr_width=addr_width, data_width=data_width)
+        self.bus = Interface(addr_width=addr_width, data_width=data_width)
 
         if not isinstance(alignment, int) or alignment < 0:
             raise ValueError("Alignment must be a non-negative integer, not {!r}"
@@ -187,7 +187,7 @@ def add(self, element):
 
         Arguments
         ---------
-        element : CSRElement
+        element : :class:`Element`
             Interface of the register.
 
         Return value
@@ -196,8 +196,8 @@ def add(self, element):
         the register, and ``size`` is the amount of chunks it takes, which may be greater than
         ``element.size // self.data_width`` due to alignment.
         """
-        if not isinstance(element, CSRElement):
-            raise TypeError("Element must be an instance of CSRElement, not {!r}"
+        if not isinstance(element, Element):
+            raise TypeError("Element must be an instance of csr.Element, not {!r}"
                             .format(element))
 
         addr = self.align_to(self.alignment)

nmigen_soc/test/test_csr_bus.py

@@ -6,9 +6,9 @@
 from ..csr.bus import *
 
 
-class CSRElementTestCase(unittest.TestCase):
+class ElementTestCase(unittest.TestCase):
     def test_layout_1_ro(self):
-        elem = CSRElement(1, "r")
+        elem = Element(1, "r")
         self.assertEqual(elem.width, 1)
         self.assertEqual(elem.access, "r")
         self.assertEqual(elem.layout, Layout.cast([
@@ -17,7 +17,7 @@ def test_layout_1_ro(self):
         ]))
 
     def test_layout_8_rw(self):
-        elem = CSRElement(8, access="rw")
+        elem = Element(8, access="rw")
         self.assertEqual(elem.width, 8)
         self.assertEqual(elem.access, "rw")
         self.assertEqual(elem.layout, Layout.cast([
@@ -28,7 +28,7 @@ def test_layout_8_rw(self):
         ]))
 
     def test_layout_10_wo(self):
-        elem = CSRElement(10, "w")
+        elem = Element(10, "w")
         self.assertEqual(elem.width, 10)
         self.assertEqual(elem.access, "w")
         self.assertEqual(elem.layout, Layout.cast([
@@ -37,7 +37,7 @@ def test_layout_10_wo(self):
         ]))
 
     def test_layout_0_rw(self): # degenerate but legal case
-        elem = CSRElement(0, access="rw")
+        elem = Element(0, access="rw")
         self.assertEqual(elem.width, 0)
         self.assertEqual(elem.access, "rw")
         self.assertEqual(elem.layout, Layout.cast([
@@ -50,17 +50,17 @@ def test_layout_0_rw(self): # degenerate but legal case
     def test_width_wrong(self):
         with self.assertRaisesRegex(ValueError,
                 r"Width must be a non-negative integer, not -1"):
-            CSRElement(-1, "rw")
+            Element(-1, "rw")
 
     def test_access_wrong(self):
         with self.assertRaisesRegex(ValueError,
                 r"Access mode must be one of \"r\", \"w\", or \"rw\", not 'wo'"):
-            CSRElement(1, "wo")
+            Element(1, "wo")
 
 
-class CSRInterfaceTestCase(unittest.TestCase):
+class InterfaceTestCase(unittest.TestCase):
     def test_layout(self):
-        iface = CSRInterface(addr_width=12, data_width=8)
+        iface = Interface(addr_width=12, data_width=8)
         self.assertEqual(iface.addr_width, 12)
         self.assertEqual(iface.data_width, 8)
         self.assertEqual(iface.layout, Layout.cast([
@@ -74,68 +74,68 @@ def test_layout(self):
     def test_addr_width_wrong(self):
         with self.assertRaisesRegex(ValueError,
                 r"Address width must be a positive integer, not -1"):
-            CSRInterface(addr_width=-1, data_width=8)
+            Interface(addr_width=-1, data_width=8)
 
     def test_data_width_wrong(self):
         with self.assertRaisesRegex(ValueError,
                 r"Data width must be a positive integer, not -1"):
-            CSRInterface(addr_width=16, data_width=-1)
+            Interface(addr_width=16, data_width=-1)
 
 
-class CSRDecoderTestCase(unittest.TestCase):
+class DecoderTestCase(unittest.TestCase):
     def setUp(self):
-        self.dut = CSRDecoder(addr_width=16, data_width=8)
+        self.dut = Decoder(addr_width=16, data_width=8)
 
     def test_alignment_wrong(self):
         with self.assertRaisesRegex(ValueError,
                 r"Alignment must be a non-negative integer, not -1"):
-            CSRDecoder(addr_width=16, data_width=8, alignment=-1)
+            Decoder(addr_width=16, data_width=8, alignment=-1)
 
     def test_attrs(self):
         self.assertEqual(self.dut.alignment, 0)
 
     def test_add_4b(self):
-        self.assertEqual(self.dut.add(CSRElement(4, "rw")),
+        self.assertEqual(self.dut.add(Element(4, "rw")),
                          (0, 1))
 
     def test_add_8b(self):
-        self.assertEqual(self.dut.add(CSRElement(8, "rw")),
+        self.assertEqual(self.dut.add(Element(8, "rw")),
                          (0, 1))
 
     def test_add_12b(self):
-        self.assertEqual(self.dut.add(CSRElement(12, "rw")),
+        self.assertEqual(self.dut.add(Element(12, "rw")),
                          (0, 2))
 
     def test_add_16b(self):
-        self.assertEqual(self.dut.add(CSRElement(16, "rw")),
+        self.assertEqual(self.dut.add(Element(16, "rw")),
                          (0, 2))
 
     def test_add_two(self):
-        self.assertEqual(self.dut.add(CSRElement(16, "rw")),
+        self.assertEqual(self.dut.add(Element(16, "rw")),
                          (0, 2))
-        self.assertEqual(self.dut.add(CSRElement(8, "rw")),
+        self.assertEqual(self.dut.add(Element(8, "rw")),
                          (2, 1))
 
     def test_add_wrong(self):
         with self.assertRaisesRegex(ValueError,
                 r"Width must be a non-negative integer, not -1"):
-            CSRElement(-1, "rw")
+            Element(-1, "rw")
 
     def test_align_to(self):
-        self.assertEqual(self.dut.add(CSRElement(8, "rw")),
+        self.assertEqual(self.dut.add(Element(8, "rw")),
                          (0, 1))
         self.assertEqual(self.dut.align_to(2), 4)
-        self.assertEqual(self.dut.add(CSRElement(8, "rw")),
+        self.assertEqual(self.dut.add(Element(8, "rw")),
                          (4, 1))
 
     def test_sim(self):
         bus = self.dut.bus
 
-        elem_4_r = CSRElement(4, "r")
+        elem_4_r = Element(4, "r")
         self.dut.add(elem_4_r)
-        elem_8_w = CSRElement(8, "w")
+        elem_8_w = Element(8, "w")
         self.dut.add(elem_8_w)
-        elem_16_rw = CSRElement(16, "rw")
+        elem_16_rw = Element(16, "rw")
         self.dut.add(elem_16_rw)
 
         def sim_test():
@@ -202,37 +202,37 @@ def sim_test():
             sim.run()
 
 
-class CSRDecoderAlignedTestCase(unittest.TestCase):
+class DecoderAlignedTestCase(unittest.TestCase):
     def setUp(self):
-        self.dut = CSRDecoder(addr_width=16, data_width=8, alignment=2)
+        self.dut = Decoder(addr_width=16, data_width=8, alignment=2)
 
     def test_attrs(self):
         self.assertEqual(self.dut.alignment, 2)
 
     def test_add_two(self):
-        self.assertEqual(self.dut.add(CSRElement(8, "rw")),
+        self.assertEqual(self.dut.add(Element(8, "rw")),
                          (0, 4))
-        self.assertEqual(self.dut.add(CSRElement(16, "rw")),
+        self.assertEqual(self.dut.add(Element(16, "rw")),
                          (4, 4))
 
     def test_over_align_to(self):
-        self.assertEqual(self.dut.add(CSRElement(8, "rw")),
+        self.assertEqual(self.dut.add(Element(8, "rw")),
                          (0, 4))
         self.assertEqual(self.dut.align_to(3), 8)
-        self.assertEqual(self.dut.add(CSRElement(8, "rw")),
+        self.assertEqual(self.dut.add(Element(8, "rw")),
                          (8, 4))
 
     def test_under_align_to(self):
-        self.assertEqual(self.dut.add(CSRElement(8, "rw")),
+        self.assertEqual(self.dut.add(Element(8, "rw")),
                          (0, 4))
         self.assertEqual(self.dut.align_to(1), 4)
-        self.assertEqual(self.dut.add(CSRElement(8, "rw")),
+        self.assertEqual(self.dut.add(Element(8, "rw")),
                          (4, 4))
 
     def test_sim(self):
         bus = self.dut.bus
 
-        elem_20_rw = CSRElement(20, "rw")
+        elem_20_rw = Element(20, "rw")
         self.dut.add(elem_20_rw)
 
         def sim_test():