memory: fix iteration order of MemoryMap resources and windows.

Fixes #74.

Author: jfng

amaranth_soc/memory.py

@@ -403,7 +403,11 @@ def resources(self):
         A tuple ``resource, name, (start, end)`` describing the address range assigned to the
         resource.
         """
-        for resource, resource_name, resource_range in self._resources.values():
+        def is_resource(item):
+            addr_range, assignment = item
+            return id(assignment) in self._resources
+        for resource_range, resource in filter(is_resource, self._ranges.items()):
+            _, resource_name, _ = self._resources[id(resource)]
             yield resource, resource_name, (resource_range.start, resource_range.stop)
 
     def add_window(self, window, *, addr=None, sparse=None):
@@ -537,7 +541,10 @@ def windows(self):
         contiguous addresses on the narrower bus that are accessed for each transaction on
         the wider bus. Otherwise, it is always 1.
         """
-        for window, window_range in self._windows.values():
+        def is_window(item):
+            addr_range, assignment = item
+            return id(assignment) in self._windows
+        for window_range, window in filter(is_window, self._ranges.items()):
             yield window, (window_range.start, window_range.stop, window_range.step)
 
     def window_patterns(self):
@@ -554,14 +561,14 @@ def window_patterns(self):
         the narrower bus that are accessed for each transaction on the wider bus. Otherwise,
         it is always 1.
         """
-        for window, window_range in self._windows.values():
+        for window, (window_start, window_stop, window_ratio) in self.windows():
             const_bits = self.addr_width - window.addr_width
             if const_bits > 0:
-                const_pat = "{:0{}b}".format(window_range.start >> window.addr_width, const_bits)
+                const_pat = "{:0{}b}".format(window_start >> window.addr_width, const_bits)
             else:
                 const_pat = ""
             pattern = "{}{}".format(const_pat, "-" * window.addr_width)
-            yield window, (pattern, window_range.step)
+            yield window, (pattern, window_ratio)
 
     @staticmethod
     def _translate(resource_info, window, window_range):

tests/test_csr_reg.py

@@ -837,17 +837,17 @@ def test_memory_map(self):
         self.assertEqual(results[0][1], ("a",))
         self.assertEqual(results[0][2], (0, 1))
 
-        self.assertIs(results[1][0], rc)
-        self.assertEqual(results[1][1], ("b", "c"))
-        self.assertEqual(results[1][2], (3, 4))
+        self.assertIs(results[1][0], rd)
+        self.assertEqual(results[1][1], ("b", "d"))
+        self.assertEqual(results[1][2], (1, 2))
 
-        self.assertIs(results[2][0], rd)
-        self.assertEqual(results[2][1], ("b", "d"))
-        self.assertEqual(results[2][2], (1, 2))
+        self.assertIs(results[2][0], re)
+        self.assertEqual(results[2][1], ("b", "e"))
+        self.assertEqual(results[2][2], (2, 3))
 
-        self.assertIs(results[3][0], re)
-        self.assertEqual(results[3][1], ("b", "e"))
-        self.assertEqual(results[3][2], (2, 3))
+        self.assertIs(results[3][0], rc)
+        self.assertEqual(results[3][1], ("b", "c"))
+        self.assertEqual(results[3][2], (3, 4))
 
         self.assertIs(results[4][0], rf)
         self.assertEqual(results[4][1], ("b", "0", "f"))

tests/test_memory.py

@@ -372,11 +372,14 @@ def test_iter_resources(self):
         memory_map = MemoryMap(addr_width=16, data_width=8)
         res1 = _MockResource("res1")
         res2 = _MockResource("res2")
-        memory_map.add_resource(res1, name=("foo",), size=1)
-        memory_map.add_resource(res2, name=("bar",), size=2)
+        res3 = _MockResource("res3")
+        memory_map.add_resource(res1, name=("a",), size=1)
+        memory_map.add_resource(res2, name=("b",), size=2, addr=2)
+        memory_map.add_resource(res3, name=("c",), size=1, addr=1)
         self.assertEqual(list(memory_map.resources()), [
-            (res1, ("foo",), (0, 1)),
-            (res2, ("bar",), (1, 3)),
+            (res1, ("a",), (0, 1)),
+            (res3, ("c",), (1, 2)),
+            (res2, ("b",), (2, 4)),
         ])
 
     def test_add_window(self):
@@ -487,22 +490,28 @@ def test_add_window_wrong_name_conflict_subordinate(self):
     def test_iter_windows(self):
         memory_map = MemoryMap(addr_width=16, data_width=16)
         window_1 = MemoryMap(addr_width=10, data_width=8)
-        memory_map.add_window(window_1, sparse=False)
         window_2 = MemoryMap(addr_width=12, data_width=16)
+        window_3 = MemoryMap(addr_width=10, data_width=8)
+        memory_map.add_window(window_1, sparse=False)
         memory_map.add_window(window_2)
+        memory_map.add_window(window_3, sparse=False, addr=0x400)
         self.assertEqual(list(memory_map.windows()), [
-            (window_1, (0, 0x200, 2)),
+            (window_1, (0x0000, 0x0200, 2)),
+            (window_3, (0x0400, 0x0600, 2)),
             (window_2, (0x1000, 0x2000, 1)),
         ])
 
     def test_iter_window_patterns(self):
         memory_map = MemoryMap(addr_width=16, data_width=16)
         window_1 = MemoryMap(addr_width=10, data_width=8)
-        memory_map.add_window(window_1, sparse=False)
         window_2 = MemoryMap(addr_width=12, data_width=16)
+        window_3 = MemoryMap(addr_width=10, data_width=8)
+        memory_map.add_window(window_1, sparse=False)
         memory_map.add_window(window_2)
+        memory_map.add_window(window_3, sparse=False, addr=0x400)
         self.assertEqual(list(memory_map.window_patterns()), [
             (window_1, ("000000----------", 2)),
+            (window_3, ("000001----------", 2)),
             (window_2, ("0001------------", 1)),
         ])