Skip to content

Commit c609025

Browse files
zypwhitequark
authored andcommitted
docs/changes: Add RFC 66 changes.
1 parent 804b00c commit c609025

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/changes.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ Version 0.6.0 (unreleased)
2626
Implemented RFCs
2727
----------------
2828

29+
.. _RFC 66: https://amaranth-lang.org/rfcs/0066-simulation-time.html
2930
.. _RFC 71: https://amaranth-lang.org/rfcs/0071-enumview-matches.html
3031

32+
* `RFC 66`_: Simulation time
3133
* `RFC 71`_: ``EnumView.matches``
3234

3335

@@ -36,6 +38,7 @@ Language changes
3638

3739
.. currentmodule:: amaranth.hdl
3840

41+
* Added: :class:`Period` for representing time periods. (`RFC 66`_)
3942
* Changed: overriding :meth:`ValueCastable.from_bits` is now mandatory. (`RFC 51`_)
4043
* Deprecated: the :py:`local=` argument to :class:`ClockDomain`. (`RFC 59`_)
4144
* Removed: (deprecated in 0.4.0) :class:`Record`.
@@ -58,6 +61,24 @@ Standard library changes
5861
* Removed: (deprecated in 0.5.0) :mod:`amaranth.lib.coding`. (`RFC 63`_)
5962

6063

64+
Toolchain changes
65+
-----------------
66+
67+
* Added: :meth:`SimulatorContext.elapsed_time <amaranth.sim._async.SimulatorContext.elapsed_time>` for getting elapsed simulation time. (`RFC 66`_)
68+
* Added: :meth:`Platform.default_clk_period <amaranth.build.plat.Platform.default_clk_period>`. (`RFC 66`_)
69+
* 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`_)
70+
* Changed: :meth:`Simulator.run_until <amaranth.sim.Simulator.run_until>` now accepts a :class:`Period <amaranth.hdl.Period>` for :py:`deadline`. (`RFC 66`_)
71+
* Changed: :meth:`SimulatorContext.delay <amaranth.sim._async.SimulatorContext.delay>` now accepts a :class:`Period <amaranth.hdl.Period>` for :py:`interval`. (`RFC 66`_)
72+
* 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`_)
73+
* Changed: :class:`Clock <amaranth.build.dsl.Clock>` now accepts a :class:`Period <amaranth.hdl.Period>` for :py:`period`. (`RFC 66`_)
74+
* Changed: :attr:`Clock.period <amaranth.build.dsl.Clock.period>` now returns a :class:`Period <amaranth.hdl.Period>`. (`RFC 66`_)
75+
* 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`_)
76+
* Deprecated: Passing :py:`frequency=` to :meth:`ResourceManager.add_clock_constraint <amaranth.build.res.ResourceManager.add_clock_constraint>`. (`RFC 66`_)
77+
* Deprecated: Passing :py:`frequency=` to :class:`Clock <amaranth.build.dsl.Clock>`. (`RFC 66`_)
78+
* Deprecated: :attr:`Clock.frequency <amaranth.build.dsl.Clock.frequency>`. (`RFC 66`_)
79+
* Deprecated: :meth:`Platform.default_clk_frequency <amaranth.build.plat.Platform.default_clk_frequency>`. (`RFC 66`_)
80+
81+
6182
Platform integration changes
6283
----------------------------
6384

0 commit comments

Comments
 (0)