diff --git a/docs/changes.rst b/docs/changes.rst index 81c7ab2e3..5cea41833 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -26,8 +26,10 @@ Version 0.6.0 (unreleased) Implemented RFCs ---------------- +.. _RFC 66: https://amaranth-lang.org/rfcs/0066-simulation-time.html .. _RFC 71: https://amaranth-lang.org/rfcs/0071-enumview-matches.html +* `RFC 66`_: Simulation time * `RFC 71`_: ``EnumView.matches`` @@ -36,6 +38,7 @@ Language changes .. 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`. @@ -58,6 +61,24 @@ Standard library changes * Removed: (deprecated in 0.5.0) :mod:`amaranth.lib.coding`. (`RFC 63`_) +Toolchain changes +----------------- + +* Added: :meth:`SimulatorContext.elapsed_time ` for getting elapsed simulation time. (`RFC 66`_) +* Added: :meth:`Platform.default_clk_period `. (`RFC 66`_) +* Changed: :meth:`Simulator.add_clock ` now accepts a :class:`Period ` for :py:`period` and :py:`phase`. (`RFC 66`_) +* Changed: :meth:`Simulator.run_until ` now accepts a :class:`Period ` for :py:`deadline`. (`RFC 66`_) +* Changed: :meth:`SimulatorContext.delay ` now accepts a :class:`Period ` for :py:`interval`. (`RFC 66`_) +* Changed: :meth:`ResourceManager.add_clock_constraint ` now accepts a :class:`Period ` for :py:`period`. (`RFC 66`_) +* Changed: :class:`Clock ` now accepts a :class:`Period ` for :py:`period`. (`RFC 66`_) +* Changed: :attr:`Clock.period ` now returns a :class:`Period `. (`RFC 66`_) +* Deprecated: Passing a :class:`float` of seconds or hertz to any of the methods/arguments now accepting a :class:`Period `. (`RFC 66`_) +* Deprecated: Passing :py:`frequency=` to :meth:`ResourceManager.add_clock_constraint `. (`RFC 66`_) +* Deprecated: Passing :py:`frequency=` to :class:`Clock `. (`RFC 66`_) +* Deprecated: :attr:`Clock.frequency `. (`RFC 66`_) +* Deprecated: :meth:`Platform.default_clk_frequency `. (`RFC 66`_) + + Platform integration changes ----------------------------