usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

lib.memory: Memory.{r,w}_ports→.{read,write}_ports.

Browse source 
The abbreviated form was initially added to match `lib.fifo`, but it
looks very out of place on `lib.memory`, and we may be moving away from
such heavy use of abbreviations anyway.

While technically a breaking change, these attributes have very narrow
usefulness and so this change qualifies as "minor".
This commit is contained in:
Catherine 2024-03-22 21:19:27 +00:00
parent 2333c5f0af
commit 6ce82848d9
3 changed files with 10 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
amaranth/lib/memory.py
View file

@ -207,18 +207,16 @@ class Memory(wiring.Component):
return WritePort(signature, memory=self, domain=domain, return WritePort(signature, memory=self, domain=domain,
src_loc_at=1 + src_loc_at) src_loc_at=1 + src_loc_at)
# TODO: rename to read_ports
@property @property
def r_ports(self): def read_ports(self):
"""All read ports defined so far. """All read ports defined so far.
This property is provided for the :py:`platform.get_memory()` override. This property is provided for the :py:`platform.get_memory()` override.
""" """
return tuple(self._read_ports) return tuple(self._read_ports)
# TODO: rename to write_ports
@property @property
def w_ports(self): def write_ports(self):
"""All write ports defined so far. """All write ports defined so far.
This property is provided for the :py:`platform.get_memory()` override. This property is provided for the :py:`platform.get_memory()` override.

4
docs/stdlib/memory.rst
View file

@ -131,9 +131,9 @@ Memories
.. automethod:: write_port .. automethod:: write_port
.. autoproperty:: r_ports .. autoproperty:: read_ports
.. autoproperty:: w_ports .. autoproperty:: write_ports
Memory ports Memory ports

12
tests/test_lib_memory.py
View file

@ -121,7 +121,7 @@ class WritePortTestCase(FHDLTestCase):
m = memory.Memory(depth=16, shape=8, init=[]) m = memory.Memory(depth=16, shape=8, init=[])
port = memory.WritePort(signature, memory=m, domain="sync") port = memory.WritePort(signature, memory=m, domain="sync")
self.assertIs(port.memory, m) self.assertIs(port.memory, m)
self.assertEqual(m.w_ports, (port,)) self.assertEqual(m.write_ports, (port,))
signature = memory.WritePort.Signature(shape=MyStruct, addr_width=4) signature = memory.WritePort.Signature(shape=MyStruct, addr_width=4)
port = signature.create() port = signature.create()
@ -228,7 +228,7 @@ class ReadPortTestCase(FHDLTestCase):
m = memory.Memory(depth=16, shape=8, init=[]) m = memory.Memory(depth=16, shape=8, init=[])
port = memory.ReadPort(signature, memory=m, domain="sync") port = memory.ReadPort(signature, memory=m, domain="sync")
self.assertIs(port.memory, m) self.assertIs(port.memory, m)
self.assertEqual(m.r_ports, (port,)) self.assertEqual(m.read_ports, (port,))
write_port = m.write_port() write_port = m.write_port()
port = memory.ReadPort(signature, memory=m, domain="sync", transparent_for=[write_port]) port = memory.ReadPort(signature, memory=m, domain="sync", transparent_for=[write_port])
self.assertIs(port.memory, m) self.assertIs(port.memory, m)
@ -291,8 +291,8 @@ class MemoryTestCase(FHDLTestCase):
self.assertEqual(list(m.init), [1, 2, 3, 0]) self.assertEqual(list(m.init), [1, 2, 3, 0])
self.assertEqual(m.init._raw, [1, 2, 3, 0]) self.assertEqual(m.init._raw, [1, 2, 3, 0])
self.assertRepr(m.init, "Memory.Init([1, 2, 3, 0], shape=8, depth=4)") self.assertRepr(m.init, "Memory.Init([1, 2, 3, 0], shape=8, depth=4)")
self.assertEqual(m.r_ports, ()) self.assertEqual(m.read_ports, ())
self.assertEqual(m.w_ports, ()) self.assertEqual(m.write_ports, ())
def test_constructor_shapecastable(self): def test_constructor_shapecastable(self):
init = [ init = [
@ -375,8 +375,8 @@ class MemoryTestCase(FHDLTestCase):
wp = m.write_port() wp = m.write_port()
self.assertEqual(wp.signature.addr_width, addr_width) self.assertEqual(wp.signature.addr_width, addr_width)
self.assertEqual(wp.signature.shape, 8) self.assertEqual(wp.signature.shape, 8)
self.assertEqual(m.r_ports, (rp,)) self.assertEqual(m.read_ports, (rp,))
self.assertEqual(m.w_ports, (wp,)) self.assertEqual(m.write_ports, (wp,))
def test_elaborate(self): def test_elaborate(self):
m = memory.Memory(shape=MyStruct, depth=4, init=[{"a": 1, "b": 2}]) m = memory.Memory(shape=MyStruct, depth=4, init=[{"a": 1, "b": 2}])