wishbone: restrict addr_width to positive integers.

Author: jfng

amaranth_soc/wishbone/bus.py

@@ -155,7 +155,7 @@ def check_parameters(cls, *, addr_width, data_width, granularity, features):
         Raises
         ------
         :exc:`TypeError`
-            If ``addr_width`` is not an integer greater than or equal to 0.
+            If ``addr_width`` is not an integer greater than to 0.
         :exc:`ValueError`
             If ``data_width`` is not 8, 16, 32 or 64.
         :exc:`ValueError`
@@ -165,8 +165,8 @@ def check_parameters(cls, *, addr_width, data_width, granularity, features):
         :exc:`ValueError`
             If ``features`` contains other values than :class:`Feature` members.
         """
-        if not isinstance(addr_width, int) or addr_width < 0:
-            raise TypeError(f"Address width must be a non-negative integer, not {addr_width!r}")
+        if not isinstance(addr_width, int) or addr_width <= 0:
+            raise TypeError(f"Address width must be a positive integer, not {addr_width!r}")
         if data_width not in (8, 16, 32, 64):
             raise ValueError(f"Data width must be one of 8, 16, 32, 64, not {data_width!r}")
         if granularity not in (8, 16, 32, 64):

tests/test_wishbone_bus.py

@@ -105,45 +105,45 @@ def test_eq(self):
 
     def test_wrong_addr_width(self):
         with self.assertRaisesRegex(TypeError,
-                r"Address width must be a non-negative integer, not -1"):
-            wishbone.Signature(addr_width=-1, data_width=8)
+                r"Address width must be a positive integer, not 0"):
+            wishbone.Signature(addr_width=0, data_width=8)
         with self.assertRaisesRegex(TypeError,
-                r"Address width must be a non-negative integer, not -1"):
-            wishbone.Signature.check_parameters(addr_width=-1, data_width=8, granularity=8,
+                r"Address width must be a positive integer, not 0"):
+            wishbone.Signature.check_parameters(addr_width=0, data_width=8, granularity=8,
                                                 features=())
 
     def test_wrong_data_width(self):
         with self.assertRaisesRegex(ValueError,
                 r"Data width must be one of 8, 16, 32, 64, not 7"):
-            wishbone.Signature(addr_width=0, data_width=7)
+            wishbone.Signature(addr_width=1, data_width=7)
         with self.assertRaisesRegex(ValueError,
                 r"Data width must be one of 8, 16, 32, 64, not 7"):
-            wishbone.Signature.check_parameters(addr_width=0, data_width=7, granularity=7,
+            wishbone.Signature.check_parameters(addr_width=1, data_width=7, granularity=7,
                                                 features=())
 
     def test_wrong_granularity(self):
         with self.assertRaisesRegex(ValueError,
                 r"Granularity must be one of 8, 16, 32, 64, not 7"):
-            wishbone.Signature(addr_width=0, data_width=32, granularity=7)
+            wishbone.Signature(addr_width=1, data_width=32, granularity=7)
         with self.assertRaisesRegex(ValueError,
                 r"Granularity must be one of 8, 16, 32, 64, not 7"):
-            wishbone.Signature.check_parameters(addr_width=0, data_width=32, granularity=7,
+            wishbone.Signature.check_parameters(addr_width=1, data_width=32, granularity=7,
                                                 features=())
 
     def test_wrong_granularity_wide(self):
         with self.assertRaisesRegex(ValueError,
                 r"Granularity 32 may not be greater than data width 8"):
-            wishbone.Signature(addr_width=0, data_width=8, granularity=32)
+            wishbone.Signature(addr_width=1, data_width=8, granularity=32)
         with self.assertRaisesRegex(ValueError,
                 r"Granularity 32 may not be greater than data width 8"):
-            wishbone.Signature.check_parameters(addr_width=0, data_width=8, granularity=32,
+            wishbone.Signature.check_parameters(addr_width=1, data_width=8, granularity=32,
                                                 features=())
 
     def test_wrong_features(self):
         with self.assertRaisesRegex(ValueError, r"'foo' is not a valid Feature"):
-            wishbone.Signature(addr_width=0, data_width=8, features={"foo"})
+            wishbone.Signature(addr_width=1, data_width=8, features={"foo"})
         with self.assertRaisesRegex(ValueError, r"'foo' is not a valid Feature"):
-            wishbone.Signature.check_parameters(addr_width=0, data_width=8, granularity=8,
+            wishbone.Signature.check_parameters(addr_width=1, data_width=8, granularity=8,
                                                 features={"foo"})
 
 
@@ -158,7 +158,7 @@ def test_simple(self):
         self.assertEqual(iface.cyc.name, "foo__bar__cyc")
 
     def test_get_map_wrong(self):
-        iface = wishbone.Interface(addr_width=0, data_width=8, path=("iface",))
+        iface = wishbone.Interface(addr_width=1, data_width=8, path=("iface",))
         with self.assertRaisesRegex(NotImplementedError,
                 r"wishbone.Interface\(.*\) does not have a memory map"):
             iface.memory_map
@@ -171,7 +171,7 @@ def test_get_map_frozen(self):
             iface.memory_map.add_resource("foo", name="foo", size=1)
 
     def test_set_map_wrong(self):
-        iface = wishbone.Interface(addr_width=0, data_width=8, path=("iface",))
+        iface = wishbone.Interface(addr_width=1, data_width=8, path=("iface",))
         with self.assertRaisesRegex(TypeError,
                 r"Memory map must be an instance of MemoryMap, not 'foo'"):
             iface.memory_map = "foo"