This document describes changes to the public interfaces in the Amaranth language and standard library. It does not include most bug fixes or implementation changes; versions which do not include notable changes are not listed here.
Documentation for past releases of the Amaranth language and toolchain is available online:
- Amaranth 0.5.0
- Amaranth 0.4.5
- Amaranth 0.4.4
- Amaranth 0.4.3
- Amaranth 0.4.2
- Amaranth 0.4.1
- Amaranth 0.4.0
- Amaranth 0.3
.. currentmodule:: amaranth.hdl
- Added: :class:`Period` for representing time periods. (RFC 66)
- Changed: overriding :meth:`ValueCastable.from_bits` is now mandatory. (RFC 51)
- Deprecated: the :py:`local=` argument to :class:`ClockDomain`. (RFC 59)
- Removed: (deprecated in 0.4.0) :class:`Record`.
- Removed: (deprecated in 0.5.0) :class:`Memory` (RFC 45)
- Removed: (deprecated in 0.5.0) public submodules of :mod:`amaranth.hdl`.
- Removed: (deprecated in 0.5.0) :meth:`Value.implies`.
- Removed: (deprecated in 0.5.0) :meth:`Const.width`, :meth:`Const.signed`, :meth:`Signal.width`, :meth:`Signal.signed`.
- Removed: (deprecated in 0.5.0) upwards propagation of clock domains. (RFC 59)
- Removed: (deprecated in 0.5.0) :func:`amaranth.utils.log2_int`. (RFC 17)
.. currentmodule:: amaranth.lib
- Added: :py:`payload_init=` argument in :class:`amaranth.lib.stream.Signature`.
- Added: :meth:`enum.EnumView.matches`. (RFC 71)
- Changed: (deprecated in 0.5.1) providing :meth:`io.PortLike.__add__` is now mandatory. (RFC 69)
- Removed: (deprecated in 0.5.0) :mod:`amaranth.lib.coding`. (RFC 63)
- Added: :meth:`SimulatorContext.elapsed_time <amaranth.sim._async.SimulatorContext.elapsed_time>` for getting elapsed simulation time. (RFC 66)
- Added: :meth:`Platform.default_clk_period <amaranth.build.plat.Platform.default_clk_period>`. (RFC 66)
- Changed: :meth:`Simulator.add_clock <amaranth.sim.Simulator.add_clock>` now accepts a :class:`Period <amaranth.hdl.Period>` for :py:`period` and :py:`phase`. (RFC 66)
- Changed: :meth:`Simulator.run_until <amaranth.sim.Simulator.run_until>` now accepts a :class:`Period <amaranth.hdl.Period>` for :py:`deadline`. (RFC 66)
- Changed: :meth:`SimulatorContext.delay <amaranth.sim._async.SimulatorContext.delay>` now accepts a :class:`Period <amaranth.hdl.Period>` for :py:`interval`. (RFC 66)
- Changed: :meth:`ResourceManager.add_clock_constraint <amaranth.build.res.ResourceManager.add_clock_constraint>` now accepts a :class:`Period <amaranth.hdl.Period>` for :py:`period`. (RFC 66)
- Changed: :class:`Clock <amaranth.build.dsl.Clock>` now accepts a :class:`Period <amaranth.hdl.Period>` for :py:`period`. (RFC 66)
- Changed: :attr:`Clock.period <amaranth.build.dsl.Clock.period>` now returns a :class:`Period <amaranth.hdl.Period>`. (RFC 66)
- Deprecated: Passing a :class:`float` of seconds or hertz to any of the methods/arguments now accepting a :class:`Period <amaranth.hdl.Period>`. (RFC 66)
- Deprecated: Passing :py:`frequency=` to :meth:`ResourceManager.add_clock_constraint <amaranth.build.res.ResourceManager.add_clock_constraint>`. (RFC 66)
- Deprecated: Passing :py:`frequency=` to :class:`Clock <amaranth.build.dsl.Clock>`. (RFC 66)
- Deprecated: :attr:`Clock.frequency <amaranth.build.dsl.Clock.frequency>`. (RFC 66)
- Deprecated: :meth:`Platform.default_clk_frequency <amaranth.build.plat.Platform.default_clk_frequency>`. (RFC 66)
.. currentmodule:: amaranth.vendor
- Changed: the Gowin platform now uses
nextpnr-himbaechelrather thannextpnr-gowin.
- Added: individual bits of the same signal can now be assigned from different modules or domains.
.. currentmodule:: amaranth.lib
- Added: constants of :class:`amaranth.lib.data.ArrayLayout` can be indexed with negative integers or slices.
- Added: :py:`len()` works on constants of :class:`amaranth.lib.data.ArrayLayout`.
- Added: constants of :class:`amaranth.lib.data.ArrayLayout` are iterable.
.. currentmodule:: amaranth.vendor
- Added: :meth:`Platform.request` accepts :py:`dir="-"` for resources with subsignals.
- RFC 69: Add a
lib.io.PortLikeobject usable in simulation
.. currentmodule:: amaranth.lib
- Added: views of :class:`amaranth.lib.data.ArrayLayout` can be indexed with negative integers or slices.
- Added: :py:`len()` works on views of :class:`amaranth.lib.data.ArrayLayout`.
- Added: views of :class:`amaranth.lib.data.ArrayLayout` are iterable.
- Added: :class:`io.SimulationPort`. (RFC 69)
The Migen compatibility layer has been removed.
Apply the following changes to code written against Amaranth 0.4 to migrate it to version 0.5:
- Update uses of :py:`reset=` keyword argument to :py:`init=`.
- Ensure all elaboratables are subclasses of :class:`Elaboratable`.
- Replace uses of :py:`m.Case()` with no patterns with :py:`m.Default()`.
- Replace uses of :py:`Value.matches()` with no patterns with :py:`Const(1)`.
- Ensure clock domains aren't used outside the module that defines them, or its submodules; move clock domain definitions upwards in the hierarchy as necessary
- Replace imports of :py:`amaranth.asserts.Assert`, :py:`Assume`, and :py:`Cover` with imports from :py:`amaranth.hdl`.
- Remove uses of :py:`name=` keyword argument of :py:`Assert`, :py:`Assume`, and :py:`Cover`; a message can be used instead.
- Replace uses of :py:`amaranth.hdl.Memory` with :class:`amaranth.lib.memory.Memory`.
- Update uses of :py:`platform.request` to pass :py:`dir="-"` and use :mod:`amaranth.lib.io` buffers.
- Remove uses of :py:`amaranth.lib.coding.*` by inlining or copying the implementation of the modules.
- Convert uses of :py:`Simulator.add_sync_process` used as testbenches to :meth:`Simulator.add_testbench <amaranth.sim.Simulator.add_testbench>`.
- Convert other uses of :py:`Simulator.add_sync_process` to :meth:`Simulator.add_process <amaranth.sim.Simulator.add_process>`.
- Convert simulator processes and testbenches to use the new async API.
- Update uses of :meth:`Simulator.add_clock <amaranth.sim.Simulator.add_clock>` with explicit :py:`phase` to take into account simulator no longer adding implicit :py:`period / 2`. (Previously, :meth:`Simulator.add_clock <amaranth.sim.Simulator.add_clock>` was documented to first toggle the clock at the time :py:`phase`, but actually first toggled the clock at :py:`period / 2 + phase`.)
- Update uses of :meth:`Simulator.run_until <amaranth.sim.Simulator.run_until>` to remove the :py:`run_passive=True` argument. If the code uses :py:`run_passive=False`, ensure it still works with the new behavior.
- Update uses of :py:`amaranth.utils.log2_int(need_pow2=False)` to :func:`amaranth.utils.ceil_log2`.
- Update uses of :py:`amaranth.utils.log2_int(need_pow2=True)` to :func:`amaranth.utils.exact_log2`.
- Replace uses of :py:`a.implies(b)` with ~a | b.
- RFC 17: Remove
log2_int - RFC 27: Testbench processes for the simulator
- RFC 30: Component metadata
- RFC 36: Async testbench functions
- RFC 39: Change semantics of no-argument
m.Case() - RFC 42:
Constfrom shape-castable - RFC 43: Rename
reset=toinit= - RFC 45: Move
hdl.Memorytolib.Memory - RFC 46: Change
Shape.cast(range(1))tounsigned(0) - RFC 50:
Printstatement and string formatting - RFC 51: Add
ShapeCastable.from_bitsandamaranth.lib.data.Const - RFC 53: Low-level I/O primitives
- RFC 55: New
lib.iocomponents - RFC 58: Core support for
ValueCastableformatting - RFC 59: Get rid of upwards propagation of clock domains
- RFC 61: Minimal streams
- RFC 62: The
MemoryDataclass - RFC 63: Remove
amaranth.lib.coding - RFC 65: Special formatting for structures and enums
.. currentmodule:: amaranth.hdl
- Added: :class:`Slice` objects have been made const-castable.
- Added: :func:`amaranth.utils.ceil_log2`, :func:`amaranth.utils.exact_log2`. (RFC 17)
- Added: :class:`Format` objects, :class:`Print` statements, messages in :class:`Assert`, :class:`Assume` and :class:`Cover`. (RFC 50)
- Added: :meth:`ShapeCastable.from_bits` method. (RFC 51)
- Added: IO values, :class:`IOPort` objects, :class:`IOBufferInstance` objects. (RFC 53)
- Added: :class:`MemoryData` objects. (RFC 62)
- Changed: :py:`m.Case()` with no patterns is never active instead of always active. (RFC 39)
- Changed: :py:`Value.matches()` with no patterns is :py:`Const(0)` instead of :py:`Const(1)`. (RFC 39)
- Changed: :py:`Signal(range(stop), init=stop)` warning has been changed into a hard error and made to trigger on any out-of range value.
- Changed: :py:`Signal(range(0))` is now valid without a warning.
- Changed: :py:`Const(value, shape)` now accepts shape-castable objects as :py:`shape`. (RFC 42)
- Changed: :py:`Shape.cast(range(1))` is now :py:`unsigned(0)`. (RFC 46)
- Changed: the :py:`reset=` argument of :class:`Signal`, :meth:`Signal.like`, :class:`amaranth.lib.wiring.Member`, :class:`amaranth.lib.cdc.FFSynchronizer`, and :py:`m.FSM()` has been renamed to :py:`init=`. (RFC 43)
- Changed: :class:`Shape` has been made immutable and hashable.
- Changed: :class:`Assert`, :class:`Assume`, :class:`Cover` have been moved to :mod:`amaranth.hdl` from :mod:`amaranth.asserts`. (RFC 50)
- Changed: :class:`Instance` IO ports now accept only IO values, not plain values. (RFC 53)
- Deprecated: :func:`amaranth.utils.log2_int`. (RFC 17)
- Deprecated: :class:`amaranth.hdl.Memory`. (RFC 45)
- Deprecated: upwards propagation of clock domains. (RFC 59)
- Deprecated: :meth:`Value.implies`.
- Removed: (deprecated in 0.4.0) :meth:`Const.normalize`. (RFC 5)
- Removed: (deprecated in 0.4.0) :class:`Repl`. (RFC 10)
- Removed: (deprecated in 0.4.0) :class:`ast.Sample`, :class:`ast.Past`, :class:`ast.Stable`, :class:`ast.Rose`, :class:`ast.Fell`.
- Removed: assertion names in :class:`Assert`, :class:`Assume` and :class:`Cover`. (RFC 50)
- Removed: accepting non-subclasses of :class:`Elaboratable` as elaboratables.
.. currentmodule:: amaranth.lib
- Added: :mod:`amaranth.lib.memory`. (RFC 45)
- Added: :class:`amaranth.lib.data.Const` class. (RFC 51)
- Changed: :meth:`amaranth.lib.data.Layout.const` returns a :class:`amaranth.lib.data.Const`, not a view (RFC 51)
- Changed: :meth:`amaranth.lib.wiring.Signature.is_compliant` no longer rejects reset-less signals.
- Added: :class:`amaranth.lib.io.SingleEndedPort`, :class:`amaranth.lib.io.DifferentialPort`. (RFC 55)
- Added: :class:`amaranth.lib.io.Buffer`, :class:`amaranth.lib.io.FFBuffer`, :class:`amaranth.lib.io.DDRBuffer`. (RFC 55)
- Added: :mod:`amaranth.lib.meta`, :class:`amaranth.lib.wiring.ComponentMetadata`. (RFC 30)
- Added: :mod:`amaranth.lib.stream`. (RFC 61)
- Deprecated: :mod:`amaranth.lib.coding`. (RFC 63)
- Removed: (deprecated in 0.4.0) :mod:`amaranth.lib.scheduler`. (RFC 19)
- Removed: (deprecated in 0.4.0) :class:`amaranth.lib.fifo.FIFOInterface` with :py:`fwft=False`. (RFC 20)
- Removed: (deprecated in 0.4.0) :class:`amaranth.lib.fifo.SyncFIFO` with :py:`fwft=False`. (RFC 20)
- Added: :meth:`Simulator.add_testbench <amaranth.sim.Simulator.add_testbench>`. (RFC 27)
- Added: async function support in :meth:`Simulator.add_testbench <amaranth.sim.Simulator.add_testbench>` and :meth:`Simulator.add_process <amaranth.sim.Simulator.add_process>`. (RFC 36)
- Added: support for :class:`amaranth.hdl.Assert` in simulation. (RFC 50)
- Changed: :meth:`Simulator.add_clock <amaranth.sim.Simulator.add_clock>` no longer implicitly adds :py:`period / 2` when :py:`phase` is specified, actually matching the documentation.
- Changed: :meth:`Simulator.run_until <amaranth.sim.Simulator.run_until>` always runs the simulation until the given deadline, even when no critical processes or testbenches are present.
- Deprecated: :py:`Settle` simulation command. (RFC 27)
- Deprecated: :py:`Simulator.add_sync_process`. (RFC 27)
- Deprecated: generator-based simulation processes and testbenches. (RFC 36)
- Deprecated: the :py:`run_passive` argument to :meth:`Simulator.run_until <amaranth.sim.Simulator.run_until>` has been deprecated, and does nothing.
- Removed: (deprecated in 0.4.0) use of mixed-case toolchain environment variable names, such as
NMIGEN_ENV_DiamondorAMARANTH_ENV_Diamond; use upper-case environment variable names, such asAMARANTH_ENV_DIAMOND.
.. currentmodule:: amaranth.vendor
- Added: :meth:`BuildPlan.execute_local_docker`.
- Added: :meth:`BuildPlan.extract`.
- Added:
build.shbegins with#!/bin/sh. - Changed:
IntelPlatformrenamed toAlteraPlatform. - Deprecated: argument :py:`run_script=` in :meth:`BuildPlan.execute_local`.
- Removed: (deprecated in 0.4.0) :mod:`vendor.intel`, :mod:`vendor.lattice_ecp5`, :mod:`vendor.lattice_ice40`, :mod:`vendor.lattice_machxo2_3l`, :mod:`vendor.quicklogic`, :mod:`vendor.xilinx`. (RFC 18)
Support has been added for a new and improved way of defining data structures in :mod:`amaranth.lib.data` and component interfaces in :mod:`amaranth.lib.wiring`, as defined in RFC 1 and RFC 2. :class:`Record` has been deprecated. In a departure from the usual policy, to give designers additional time to migrate, :class:`Record` will be removed in Amaranth 0.6 (one release later than normal).
Support for enumerations has been extended. A shape for enumeration members can be provided for an enumeration class, as defined in RFC 3.
The language includes several new extension points for integration with :class:`Value` based data structures defined outside of the core language. In particular, Signal(shape) may now return a :class:`Signal` object wrapped in another if shape implements the call protocol, as defined in RFC 15.
Several issues with shape inference have been resolved. Notably, a - b where both a and b are unsigned now returns a signed value.
Support for Python 3.6 and 3.7 has been removed, and support for Python 3.11 and 3.12 has been added.
Features deprecated in version 0.3 have been removed. In particular, the nmigen.* namespace is not provided, # nmigen: annotations are not recognized, and NMIGEN_* envronment variables are not used.
The Migen compatibility layer remains deprecated (as it had been since Amaranth 0.1), and is now scheduled to be removed in version 0.5.
Apply the following changes to code written against Amaranth 0.3 to migrate it to version 0.4:
- Update shell environment to use
AMARANTH_*environment variables instead ofNMIGEN_*environment variables. - Update shell environment to use
AMARANTH_ENV_<TOOLCHAIN>(with all-uppercase<TOOLCHAIN>name) environment variable names instead ofAMARANTH_ENV_<Toolchain>orNMIGEN_ENV_<Toolchain>(with mixed-case<Toolchain>name). - Update imports of the form
from amaranth.vendor.some_vendor import SomeVendorPlatformtofrom amaranth.vendor import SomeVendorPlatform. This change will reduce future churn. - Replace uses of
Const.normalize(value, shape)withConst(value, shape).value. - Replace uses of
Repl(value, count)withvalue.replicate(count). - Replace uses of
Recordwith :mod:`amaranth.lib.data` and :mod:`amaranth.lib.wiring`. The appropriate replacement depends on the use case. IfRecordwas being used for data storage and accessing the bit-level representation, use :mod:`amaranth.lib.data`. IfRecordwas being used for connecting design components together, use :mod:`amaranth.lib.wiring`. - Replace uses of
Sample,Past,Stable,Rose,Fellwith a manually instantiated register, e.g.past_x = Signal.like(x); m.d.sync += past_x.eq(x). - Remove uses of
amaranth.compatby migrating to native Amaranth syntax. - Ensure the
Pininstance returned byplatform.requestis not cast to value directly, but used for its fields. Replace code likeleds = Cat(platform.request(led, n) for n in range(4))withleds = Cat(platform.request(led, n).o for n in range(4))(note the.o). - Remove uses of
amaranth.lib.scheduler.RoundRobinby inlining or copying the implementation of that class. - Remove uses of
amaranth.lib.fifo.SyncFIFO(fwft=False)andamaranth.lib.fifo.FIFOInterface(fwft=False)by converting code to usefwft=TrueFIFOs or copying the implementation of those classes.
While code that uses the features listed as deprecated below will work in Amaranth 0.4, they will be removed in the next version.
- RFC 1: Aggregate data structure library
- RFC 2: Interface definition library
- RFC 3: Enumeration shapes
- RFC 4: Constant-castable expressions
- RFC 5: Remove
Const.normalize - RFC 6: CRC generator
- RFC 8: Aggregate extensibility
- RFC 9: Constant initialization for shape-castable objects
- RFC 10: Move
RepltoValue.replicate - RFC 18: Reorganize vendor platforms
- RFC 19: Remove
amaranth.lib.scheduler - RFC 15: Lifting shape-castable objects
- RFC 20: Deprecate non-FWFT FIFOs
- RFC 22: Define
ValueCastable.shape() - RFC 28: Allow overriding
Valueoperators - RFC 31: Enumeration type safety
- RFC 34: Rename
amaranth.lib.wiring.InterfacetoPureInterface - RFC 35: Add
ShapeLike,ValueLike - RFC 37: Make
Signatureimmutable - RFC 38:
Component.signatureimmutability
.. currentmodule:: amaranth.hdl
- Added: :class:`ShapeCastable`, similar to :class:`ValueCastable`.
- Added: :class:`ShapeLike` and :class:`ValueLike`. (RFC 35)
- Added: :meth:`Value.as_signed` and :meth:`Value.as_unsigned` can be used on left-hand side of assignment (with no difference in behavior).
- Added: :meth:`Const.cast`. (RFC 4)
- Added:
Signal(reset=), :meth:`Value.matches`,with m.Case():accept any constant-castable objects. (RFC 4) - Added: :meth:`Value.replicate`, superseding :class:`Repl`. (RFC 10)
- Added: :class:`Memory` supports transparent read ports with read enable.
- Changed: creating a :class:`Signal` with a shape that is a :class:`ShapeCastable` implementing :meth:`ShapeCastable.__call__` wraps the returned object using that method. (RFC 15)
- Changed: :meth:`Value.cast` casts :class:`ValueCastable` objects recursively.
- Changed: :meth:`Value.cast` treats instances of classes derived from both :class:`enum.Enum` and :class:`int` (including :class:`enum.IntEnum`) as enumerations rather than integers.
- Changed: :meth:`Value.matches` with an empty list of patterns returns
Const(1)rather thanConst(0), to match the behavior ofwith m.Case():. - Changed: :func:`Cat` warns if an enumeration without an explicitly specified shape is used. (RFC 3)
- Changed:
signed(0)is no longer constructible. (The semantics of this shape were never defined.) - Changed: :meth:`Value.__abs__` returns an unsigned value.
- Deprecated: :class:`ast.Sample`, :class:`ast.Past`, :class:`ast.Stable`, :class:`ast.Rose`, :class:`ast.Fell`. (Predating the RFC process.)
- Deprecated: :meth:`Const.normalize`; use
Const(value, shape).valueinstead ofConst.normalize(value, shape). (RFC 5) - Deprecated: :class:`Repl`; use :meth:`Value.replicate` instead. (RFC 10)
- Deprecated: :class:`Record`; use :mod:`amaranth.lib.data` and :mod:`amaranth.lib.wiring` instead. (RFC 1, RFC 2)
- Removed: (deprecated in 0.1) casting of :class:`Shape` to and from a
(width, signed)tuple. - Removed: (deprecated in 0.3) :class:`ast.UserValue`.
- Removed: (deprecated in 0.3) support for
# nmigen:linter instructions at the beginning of file.
.. currentmodule:: amaranth.lib
- Added: :mod:`amaranth.lib.enum`. (RFC 3)
- Added: :mod:`amaranth.lib.data`. (RFC 1)
- Added: :mod:`amaranth.lib.wiring`. (RFC 2)
- Added: :mod:`amaranth.lib.crc`. (RFC 6)
- Deprecated: :mod:`amaranth.lib.scheduler`. (RFC 19)
- Deprecated: :class:`amaranth.lib.fifo.FIFOInterface` with
fwft=False. (RFC 20) - Deprecated: :class:`amaranth.lib.fifo.SyncFIFO` with
fwft=False. (RFC 20)
.. currentmodule:: amaranth
- Changed: text files are written with LF line endings on Windows, like on other platforms.
- Added:
debug_verilogoverride in :class:`build.TemplatedPlatform`. - Added:
env=argument to :meth:`build.run.BuildPlan.execute_local`. - Changed: :meth:`build.run.BuildPlan.add_file` rejects absolute paths.
- Deprecated: use of mixed-case toolchain environment variable names, such as
NMIGEN_ENV_DiamondorAMARANTH_ENV_Diamond; use upper-case environment variable names, such asAMARANTH_ENV_DIAMOND. - Removed: (deprecated in 0.3) :meth:`sim.Simulator.step`.
- Removed: (deprecated in 0.3) :mod:`back.pysim`.
- Removed: (deprecated in 0.3) support for invoking :func:`back.rtlil.convert()` and :func:`back.verilog.convert()` without an explicit ports= argument.
- Removed: (deprecated in 0.3) :mod:`test`.
.. currentmodule:: amaranth.vendor
- Added:
icepack_optsoverride in :class:`vendor.LatticeICE40Platform`. - Added:
OSCHasdefault_clkclock source in :class:`vendor.LatticeMachXO2Platform`, :class:`vendor.LatticeMachXO3LPlatform`. - Added: Xray toolchain support in :class:`vendor.XilinxPlatform`.
- Added: Artix UltraScale+ part support in :class:`vendor.XilinxPlatform`.
- Added: :class:`vendor.GowinPlatform`.
- Deprecated: :mod:`vendor.intel`, :mod:`vendor.lattice_ecp5`, :mod:`vendor.lattice_ice40`, :mod:`vendor.lattice_machxo2_3l`, :mod:`vendor.quicklogic`, :mod:`vendor.xilinx`; import platforms directly from :mod:`vendor` instead. (RFC 18)
- Removed: (deprecated in 0.3) :mod:`lattice_machxo2`
- Removed: (deprecated in 0.3) :class:`lattice_machxo_2_3l.LatticeMachXO2Or3LPlatform` SVF programming vector
{{name}}.svf. - Removed: (deprecated in 0.3) :class:`xilinx_spartan_3_6.XilinxSpartan3APlatform`, :class:`xilinx_spartan_3_6.XilinxSpartan6Platform`, :class:`xilinx_7series.Xilinx7SeriesPlatform`, :class:`xilinx_ultrascale.XilinxUltrascalePlatform`.
The project has been renamed from nMigen to Amaranth.
Features deprecated in version 0.2 have been removed.
.. currentmodule:: amaranth
Apply the following changes to code written against nMigen 0.2 to migrate it to Amaranth 0.3:
- Update
import nmigen as nm:ref:`explicit prelude imports <lang-prelude>` to beimport amaranth as am, and adjust the code to use theam.*namespace. - Update
import nmigen.*imports to beimport amaranth.*. - Update
import nmigen_boards.*imports to beimport amaranth_boards.*. - Update board definitions using :class:`vendor.lattice_machxo2.LatticeMachXO2Platform` to use :class:`vendor.lattice_machxo_2_3l.LatticeMachXO2Platform`.
- Update board definitions using :class:`vendor.xilinx_spartan_3_6.XilinxSpartan3APlatform`, :class:`vendor.xilinx_spartan_3_6.XilinxSpartan6Platform`, :class:`vendor.xilinx_7series.Xilinx7SeriesPlatform`, :class:`vendor.xilinx_ultrascale.XilinxUltrascalePlatform` to use :class:`vendor.xilinx.XilinxPlatform`.
- Switch uses of :class:`hdl.ast.UserValue` to :class:`ValueCastable`; note that :class:`ValueCastable` does not inherit from :class:`Value`, and inheriting from :class:`Value` is not supported.
- Switch uses of :mod:`back.pysim` to :mod:`sim`.
- Add an explicit
ports=argument to uses of :func:`back.rtlil.convert` and :func:`back.verilog.convert` if missing. - Remove uses of :class:`test.utils.FHDLTestCase` and vendor the implementation of :class:`test.utils.FHDLTestCase.assertFormal` if necessary.
While code that uses the features listed as deprecated below will work in Amaranth 0.3, they will be removed in the next version.
.. currentmodule:: amaranth.hdl
- Added: :class:`Value` can be used with :func:`abs`.
- Added: :meth:`Value.rotate_left` and :meth:`Value.rotate_right`.
- Added: :meth:`Value.shift_left` and :meth:`Value.shift_right`.
- Added: :class:`ValueCastable`.
- Deprecated: :class:`ast.UserValue`; use :class:`ValueCastable` instead.
- Added: Division and modulo operators can be used with a negative divisor.
- Deprecated:
# nmigen:linter instructions at the beginning of file; use# amaranth:instead.
.. currentmodule:: amaranth.lib
- Added: :class:`cdc.PulseSynchronizer`.
- Added: :class:`cdc.AsyncFFSynchronizer`.
- Changed: :class:`fifo.AsyncFIFO` is reset when the write domain is reset.
- Added: :attr:`fifo.AsyncFIFO.r_rst` is asserted when the write domain is reset.
- Added: :attr:`fifo.FIFOInterface.r_level` and :attr:`fifo.FIFOInterface.w_level`.
.. currentmodule:: amaranth
- Changed: Backend and simulator reject wires larger than 65536 bits.
- Added: Backend emits Yosys enumeration attributes for :ref:`enumeration-shaped <lang-shapeenum>` signals.
- Added: If a compatible Yosys version is not installed, :mod:`back.verilog` will fall back to the amaranth-yosys PyPI package. The package can be :ref:`installed <install>` as
amaranth[builtin-yosys]to ensure this dependency is available. - Added: :mod:`back.cxxrtl`.
- Added: :mod:`sim`, a simulator interface with support for multiple simulation backends.
- Deprecated: :mod:`back.pysim`; use :mod:`sim` instead.
- Removed: The
with Simulator(fragment, ...) as sim:form. - Removed: :meth:`sim.Simulator.add_process` with a generator argument.
- Deprecated: :meth:`sim.Simulator.step`; use :meth:`sim.Simulator.advance` instead.
- Added: :meth:`build.BuildPlan.execute_remote_ssh`.
- Deprecated: :class:`test.utils.FHDLTestCase`, with no replacement.
- Deprecated: :func:`back.rtlil.convert()` and :func:`back.verilog.convert()` without an explicit ports= argument.
- Changed: VCD output now uses a top-level "bench" module that contains testbench only signals.
- Deprecated:
NMIGEN_*environment variables; useAMARANTH_*environment variables instead.
.. currentmodule:: amaranth.vendor
- Added:
SB_LFOSCandSB_HFOSCasdefault_clkclock sources in :class:`lattice_ice40.LatticeICE40Platform`. - Added: :class:`lattice_machxo2.LatticeMachXO2Platform` generates binary (
.bit) bitstreams. - Added: :class:`lattice_machxo_2_3l.LatticeMachXO3LPlatform`.
- Deprecated: :mod:`lattice_machxo2`; use :class:`lattice_machxo_2_3l.LatticeMachXO2Platform` instead.
- Removed: :class:`xilinx_7series.Xilinx7SeriesPlatform.grade`; this family has no temperature grades.
- Removed: :class:`xilinx_ultrascale.XilinxUltrascalePlatform.grade`; this family has temperature grade as part of speed grade.
- Added: Symbiflow toolchain support for :class:`xilinx_7series.Xilinx7SeriesPlatform`.
- Added: :class:`lattice_machxo_2_3l.LatticeMachXO2Or3LPlatform` generates separate Flash and SRAM SVF programming vectors,
{{name}}_flash.svfand{{name}}_sram.svf. - Deprecated: :class:`lattice_machxo_2_3l.LatticeMachXO2Or3LPlatform` SVF programming vector
{{name}}.svf; use{{name}}_flash.svfinstead. - Added: :class:`quicklogic.QuicklogicPlatform`.
- Added:
cyclonev_oscillatorasdefault_clkclock source in :class:`intel.IntelPlatform`. - Added:
add_settingsandadd_constraintsoverrides in :class:`intel.IntelPlatform`. - Added: :class:`xilinx.XilinxPlatform`.
- Deprecated: :class:`xilinx_spartan_3_6.XilinxSpartan3APlatform`, :class:`xilinx_spartan_3_6.XilinxSpartan6Platform`, :class:`xilinx_7series.Xilinx7SeriesPlatform`, :class:`xilinx_ultrascale.XilinxUltrascalePlatform`; use :class:`xilinx.XilinxPlatform` instead.
- Added: Mistral toolchain support for :class:`intel.IntelPlatform`.
- Added:
synth_design_optsoverride in :class:`xilinx.XilinxPlatform`.
No changelog is provided for these versions.
The PyPI packages were published under the nmigen namespace, rather than amaranth.