A step towards amaranth v0.5.0 (#577)

constants/ecp5_platforms.py

@@ -2,7 +2,7 @@
 from itertools import chain
 from typing import TypeAlias
 from amaranth.build.dsl import Subsignal
-from amaranth.vendor.lattice_ecp5 import LatticeECP5Platform
+from amaranth.vendor import LatticeECP5Platform
 from amaranth.build import Resource, Attrs, Pins, Clock, PinsN
 
 from constants.ecp5_pinout import ecp5_bg756_pins, ecp5_bg756_pclk

coreblocks/cache/icache.py

@@ -2,7 +2,7 @@
 import operator
 
 from amaranth import *
-from amaranth.utils import log2_int
+from amaranth.utils import exact_log2
 
 from transactron.core import def_method, Priority, TModule
 from transactron import Method, Transaction
@@ -52,7 +52,7 @@ def _(addr: Value) -> None:
             m.d.sync += req_addr.eq(addr)
             self.bus_master.request_read(
                 m,
-                addr=addr >> log2_int(self.params.word_width_bytes),
+                addr=addr >> exact_log2(self.params.word_width_bytes),
                 sel=C(1).replicate(self.bus_master.params.data_width // self.bus_master.params.granularity),
             )
 
@@ -350,7 +350,7 @@ def elaborate(self, platform):
 
             # We address the data RAM using machine words, so we have to
             # discard a few least significant bits from the address.
-            redundant_offset_bits = log2_int(self.params.word_width_bytes)
+            redundant_offset_bits = exact_log2(self.params.word_width_bytes)
             rd_addr = Cat(self.data_rd_addr.offset, self.data_rd_addr.index)[redundant_offset_bits:]
             wr_addr = Cat(self.data_wr_addr.offset, self.data_wr_addr.index)[redundant_offset_bits:]
 

coreblocks/cache/refiller.py

@@ -1,10 +1,11 @@
+from amaranth import *
 from coreblocks.cache.icache import CacheRefillerInterface
 from coreblocks.params import ICacheLayouts, ICacheParameters
 from coreblocks.peripherals.bus_adapter import BusMasterInterface
 from transactron.core import Transaction
-from transactron.lib import C, Cat, Elaboratable, Forwarder, Method, Signal, TModule, def_method
+from transactron.lib import Forwarder, Method, TModule, def_method
 
-from amaranth.utils import log2_int
+from amaranth.utils import exact_log2
 
 
 __all__ = ["SimpleCommonBusCacheRefiller"]
@@ -62,7 +63,7 @@ def _():
                 address_fwd.write(m, word_counter=next_word_counter, refill_address=refill_address)
 
             return {
-                "addr": Cat(C(0, log2_int(self.params.word_width_bytes)), word_counter, refill_address),
+                "addr": Cat(C(0, exact_log2(self.params.word_width_bytes)), word_counter, refill_address),
                 "data": fetched.data,
                 "error": fetched.err,
                 "last": last,

coreblocks/lsu/dummyLsu.py

@@ -73,7 +73,7 @@ def postprocess_load_data(self, m: ModuleLike, funct3: Value, raw_data: Value, a
                     m.d.av_comb += data.eq(tmp.as_signed())
                 with m.Else():
                     m.d.av_comb += data.eq(tmp)
-            with m.Case():
+            with m.Default():
                 m.d.av_comb += data.eq(raw_data)
         return data
 
@@ -84,7 +84,7 @@ def prepare_data_to_save(self, m: ModuleLike, funct3: Value, raw_data: Value, ad
                 m.d.av_comb += data.eq(raw_data[0:8] << (addr[0:2] << 3))
             with m.Case(Funct3.H):
                 m.d.av_comb += data.eq(raw_data[0:16] << (addr[1] << 4))
-            with m.Case():
+            with m.Default():
                 m.d.av_comb += data.eq(raw_data)
         return data
 
@@ -95,7 +95,7 @@ def check_align(self, m: TModule, funct3: Value, addr: Value):
                 m.d.av_comb += aligned.eq(addr[0:2] == 0)
             with m.Case(Funct3.H, Funct3.HU):
                 m.d.av_comb += aligned.eq(addr[0] == 0)
-            with m.Case():
+            with m.Default():
                 m.d.av_comb += aligned.eq(1)
         return aligned
 

coreblocks/params/genparams.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from amaranth.utils import log2_int
+from amaranth.utils import exact_log2
 
 from .isa import ISA, gen_isa_string
 from .icache_params import ICacheParameters
@@ -36,7 +36,7 @@ def __init__(self, cfg: CoreConfiguration):
 
         bytes_in_word = self.isa.xlen // 8
         self.wb_params = WishboneParameters(
-            data_width=self.isa.xlen, addr_width=self.isa.xlen - log2_int(bytes_in_word)
+            data_width=self.isa.xlen, addr_width=self.isa.xlen - exact_log2(bytes_in_word)
         )
 
         self.icache_params = ICacheParameters(

coreblocks/params/instr.py

@@ -1,6 +1,6 @@
 from abc import abstractmethod, ABC
 
-from amaranth.hdl.ast import ValueCastable
+from amaranth.hdl import ValueCastable
 from amaranth import *
 
 from transactron.utils import ValueLike

requirements.txt

@@ -1,3 +1,3 @@
 amaranth-yosys==0.35.0.0.post81
-git+https://github.com/amaranth-lang/amaranth@94c504afc7d81738ecdc9523a2615ef43ecbf51a
+git+https://github.com/amaranth-lang/amaranth@115954b4d957b4ba642ad056ab1670bf5d185fb6
 dataclasses-json==0.6.3

stubs/amaranth/_unused.pyi

@@ -0,0 +1,13 @@
+import sys
+import warnings
+
+__all__ = ["UnusedMustUse", "MustUse"]
+
+
+class UnusedMustUse(Warning):
+    pass
+
+
+class MustUse:
+    _MustUse__silence : bool
+    _MustUse__warning : UnusedMustUse

stubs/amaranth/build/res.pyi

@@ -3,7 +3,7 @@ This type stub file was generated by pyright.
 """
 
 from typing import Any
-from ..hdl.ast import *
+from ..hdl._ast import *
 from ..hdl.rec import *
 from ..lib.io import *
 from .dsl import *

stubs/amaranth/hdl/__init__.pyi

@@ -1,13 +1,29 @@
-"""
-This type stub file was generated by pyright.
-"""
-
-from .ast import Array, C, Cat, ClockSignal, Const, Mux, Repl, ResetSignal, Shape, Signal, Value, signed, unsigned
-from .dsl import Module
-from .cd import ClockDomain
-from .ir import Elaboratable, Fragment, Instance
-from .mem import Memory
+from ._ast import Shape, unsigned, signed, ShapeCastable, ShapeLike
+from ._ast import Value, ValueCastable, ValueLike
+from ._ast import Const, C, Mux, Cat, Array, Signal, ClockSignal, ResetSignal
+from ._dsl import SyntaxError, SyntaxWarning, Module
+from ._cd import DomainError, ClockDomain
+from ._ir import UnusedElaboratable, Elaboratable, DriverConflict, Fragment, Instance
+from ._mem import Memory, ReadPort, WritePort, DummyPort
 from .rec import Record
-from .xfrm import DomainRenamer, EnableInserter, ResetInserter
+from ._xfrm import DomainRenamer, ResetInserter, EnableInserter
+
 
-__all__ = ["Shape", "unsigned", "signed", "Value", "Const", "C", "Mux", "Cat", "Repl", "Array", "Signal", "ClockSignal", "ResetSignal", "Module", "ClockDomain", "Elaboratable", "Fragment", "Instance", "Memory", "Record", "DomainRenamer", "ResetInserter", "EnableInserter"]
+__all__ = [
+    # _ast
+    "Shape", "unsigned", "signed", "ShapeCastable", "ShapeLike",
+    "Value", "ValueCastable", "ValueLike",
+    "Const", "C", "Mux", "Cat", "Array", "Signal", "ClockSignal", "ResetSignal",
+    # _dsl
+    "SyntaxError", "SyntaxWarning", "Module",
+    # _cd
+    "DomainError", "ClockDomain",
+    # _ir
+    "UnusedElaboratable", "Elaboratable", "DriverConflict", "Fragment", "Instance",
+    # _mem
+    "Memory", "ReadPort", "WritePort", "DummyPort",
+    # _rec
+    "Record",
+    # _xfrm
+    "DomainRenamer", "ResetInserter", "EnableInserter",
+]

stubs/amaranth/hdl/ir.pyi → stubs/amaranth/hdl/_ir.pyi

@@ -3,13 +3,17 @@ This type stub file was generated by pyright.
 """
 
 from abc import abstractmethod
-from .ast import *
-from .cd import *
+from ._ast import *
+from ._cd import *
+from .. import _unused
 from transactron.utils import HasElaborate
 
-__all__ = ["Elaboratable", "DriverConflict", "Fragment", "Instance"]
+__all__ = ["UnusedElaboratable", "Elaboratable", "DriverConflict", "Fragment", "Instance"]
 
 
+class UnusedElaboratable(_unused.UnusedMustUse):
+    ...
+
 class Elaboratable():
     @abstractmethod
     def elaborate(self, platform) -> HasElaborate:

stubs/amaranth/hdl/mem.pyi → stubs/amaranth/hdl/_mem.pyi

@@ -4,13 +4,33 @@ This type stub file was generated by pyright.
 
 from typing import Optional
 from .ast import *
-from .ir import Elaboratable
+from .ir import Elaboratable, Fragment
 
-__all__ = ["Memory", "ReadPort", "WritePort", "DummyPort"]
+__all__ = ["Memory", "ReadPort", "WritePort", "DummyPort", "MemoryInstance"]
 class Memory:
     """A word addressable storage.
-
-   """
+    Parameters
+    ----------
+    width : int
+        Access granularity. Each storage element of this memory is ``width`` bits in size.
+    depth : int
+        Word count. This memory contains ``depth`` storage elements.
+    init : list of int
+        Initial values. At power on, each storage element in this memory is initialized to
+        the corresponding element of ``init``, if any, or to zero otherwise.
+        Uninitialized memories are not currently supported.
+    name : str
+        Name hint for this memory. If ``None`` (default) the name is inferred from the variable
+        name this ``Signal`` is assigned to.
+    attrs : dict
+        Dictionary of synthesis attributes.
+    Attributes
+    ----------
+    width : int
+    depth : int
+    init : list of int
+    attrs : dict
+    """
     width: int
     depth: int
     attrs: dict
@@ -90,4 +110,10 @@ class DummyPort:
         ...
 
 
-
+class MemoryInstance(Fragment):
+    memory: Memory
+    read_ports: list[ReadPort]
+    write_ports: list[WritePort]
+    attrs: dict
+    def __init__(self, memory: Memory, read_ports: list[ReadPort], write_ports: list[WritePort]) -> None:
+        ...

stubs/amaranth/lib/data.pyi

@@ -6,7 +6,7 @@ from abc import ABCMeta, abstractmethod
 from collections.abc import Iterator, Mapping
 from typing import TypeVar, Generic, Self
 from amaranth.hdl import *
-from amaranth.hdl.ast import Assign, ShapeCastable, ValueCastable
+from amaranth.hdl._ast import Assign, ShapeCastable, ValueCastable
 from transactron.utils._typing import ShapeLike, ValueLike
 
 __all__ = ["Field", "Layout", "StructLayout", "UnionLayout", "ArrayLayout", "FlexibleLayout", "View", "Struct", "Union"]

stubs/amaranth/lib/enum.pyi

@@ -5,7 +5,7 @@ This type stub file was generated by pyright.
 import enum as py_enum
 from typing import Generic, Optional, TypeVar, Self, overload
 from amaranth import *
-from ..hdl.ast import Assign, ValueCastable, ShapeCastable, ValueLike
+from ..hdl._ast import Assign, ValueCastable, ShapeCastable, ValueLike
 
 __all__ = ['EnumMeta', 'Enum', 'IntEnum', 'Flag', 'IntFlag', 'EnumView', 'FlagView', 'auto', 'unique']
 

stubs/amaranth/lib/fifo.pyi

@@ -11,7 +11,6 @@ __all__ = ["FIFOInterface", "SyncFIFO", "SyncFIFOBuffered", "AsyncFIFO", "AsyncF
 class FIFOInterface:
     width: int
     depth: int
-    fwft: bool
     w_data: Signal
     w_rdy: Signal
     w_en: Signal
@@ -20,13 +19,13 @@ class FIFOInterface:
     r_rdy: Signal
     r_en: Signal
     r_level: Signal
-    def __init__(self, *, width: int, depth: int, fwft: bool) -> None:
+    def __init__(self, *, width: int, depth: int) -> None:
         ...
 
 
 
 class SyncFIFO(Elaboratable, FIFOInterface):
-    def __init__(self, *, width: int, depth: int, fwft: bool = ...) -> None:
+    def __init__(self, *, width: int, depth: int) -> None:
         ...
 
     def elaborate(self, platform) -> HasElaborate:

stubs/amaranth/sim/core.pyi

@@ -3,8 +3,8 @@ This type stub file was generated by pyright.
 """
 
 from .._utils import deprecated
-from ..hdl.cd import *
-from ..hdl.ir import *
+from ..hdl._cd import *
+from ..hdl._ir import *
 
 __all__ = ["Settle", "Delay", "Tick", "Passive", "Active", "Simulator"]
 class Command:

stubs/amaranth/utils.pyi

@@ -2,10 +2,22 @@
 This type stub file was generated by pyright.
 """
 
-__all__ = ["log2_int", "bits_for"]
-def log2_int(n:int, need_pow2:bool=...) -> int:
-    ...
+__all__ = ["ceil_log2", "exact_log2", "bits_for"]
 
 def bits_for(n:int, require_sign_bit:bool=...) -> int:
     ...
 
+
+def ceil_log2(n : int) -> int:
+    """Returns the integer log2 of the smallest power-of-2 greater than or equal to ``n``.
+
+    Raises a ``ValueError`` for negative inputs.
+    """
+    ...
+
+def exact_log2(n : int) -> int:
+    """Returns the integer log2 of ``n``, which must be an exact power of two.
+
+    Raises a ``ValueError`` if ``n`` is not a power of two.
+    """
+    ...

stubs/amaranth/vendor/__init__.pyi

@@ -0,0 +1,8 @@
+"""
+This type stub file was generated by pyright.
+"""
+
+from ._lattice_ecp5 import LatticeECP5Platform
+from ._lattice_ice40 import LatticeICE40Platform
+
+__all__ = ["LatticeECP5Platform", "LatticeICE40Platform"]