mirror of https://github.com/YosysHQ/yosys.git
Tidying TODOs
This commit is contained in:
parent
1e3b90ae56
commit
aef9921fc9
|
@ -23,6 +23,9 @@ A simple counter
|
||||||
.. role:: yoscrypt(code)
|
.. role:: yoscrypt(code)
|
||||||
:language: yoscrypt
|
:language: yoscrypt
|
||||||
|
|
||||||
|
.. todo:: consider changing simple counter example for something with memory
|
||||||
|
using e.g. synth_ice40 to cover more of the synth flow
|
||||||
|
|
||||||
This section covers an `example project`_ available in
|
This section covers an `example project`_ available in
|
||||||
``docs/source/code_examples/intro/``. The project contains a simple ASIC
|
``docs/source/code_examples/intro/``. The project contains a simple ASIC
|
||||||
synthesis script (``counter.ys``), a digital design written in Verilog
|
synthesis script (``counter.ys``), a digital design written in Verilog
|
||||||
|
@ -181,11 +184,11 @@ Some of the commands we might use here are:
|
||||||
- :doc:`/cmd/alumacc`, and
|
- :doc:`/cmd/alumacc`, and
|
||||||
- :doc:`/cmd/share`.
|
- :doc:`/cmd/share`.
|
||||||
|
|
||||||
We could have also
|
|
||||||
|
|
||||||
Logic gate mapping
|
Logic gate mapping
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. todo:: example_synth mapping to gates
|
||||||
|
|
||||||
:yoscrypt:`techmap` - Map coarse-grain RTL cells (adders, etc.) to fine-grain
|
:yoscrypt:`techmap` - Map coarse-grain RTL cells (adders, etc.) to fine-grain
|
||||||
logic gates (AND, OR, NOT, etc.).
|
logic gates (AND, OR, NOT, etc.).
|
||||||
|
|
||||||
|
@ -207,6 +210,8 @@ cells used.
|
||||||
Mapping to hardware
|
Mapping to hardware
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. todo:: example_synth mapping to hardware
|
||||||
|
|
||||||
:ref:`cmos_lib`
|
:ref:`cmos_lib`
|
||||||
|
|
||||||
#. :yoscrypt:`dfflibmap -liberty mycells.lib` - Map registers to available
|
#. :yoscrypt:`dfflibmap -liberty mycells.lib` - Map registers to available
|
||||||
|
|
|
@ -117,13 +117,22 @@ Benefits of open source HDL synthesis
|
||||||
The extended Yosys universe
|
The extended Yosys universe
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. todo:: links and add SCY
|
|
||||||
|
|
||||||
In no particular order:
|
In no particular order:
|
||||||
|
|
||||||
- SBY for formal verification
|
- SBY for formal verification
|
||||||
|
- https://github.com/YosysHQ/sby
|
||||||
|
- https://yosyshq.readthedocs.io/projects/sby
|
||||||
|
|
||||||
- EQY for equivalence checking
|
- EQY for equivalence checking
|
||||||
|
- https://github.com/YosysHQ/eqy
|
||||||
|
- https://yosyshq.readthedocs.io/projects/eqy
|
||||||
|
|
||||||
- MCY for mutation coverage
|
- MCY for mutation coverage
|
||||||
|
- https://github.com/YosysHQ/mcy
|
||||||
|
- https://yosyshq.readthedocs.io/projects/mcy
|
||||||
|
|
||||||
|
- SCY for deep formal traces
|
||||||
|
- https://github.com/YosysHQ/scy
|
||||||
|
|
||||||
History of Yosys
|
History of Yosys
|
||||||
----------------
|
----------------
|
||||||
|
|
|
@ -24,6 +24,9 @@ keyword: Frontends
|
||||||
read_verilog file6.v
|
read_verilog file6.v
|
||||||
verilog_defaults -pop
|
verilog_defaults -pop
|
||||||
|
|
||||||
|
.. todo:: more info on other ``read_*`` commands, also is this the first time we
|
||||||
|
mention verific?
|
||||||
|
|
||||||
Others:
|
Others:
|
||||||
|
|
||||||
- :doc:`/cmd/read`
|
- :doc:`/cmd/read`
|
||||||
|
|
|
@ -39,7 +39,8 @@ The extract pass
|
||||||
subcircuit with an instance of the module from the map file.
|
subcircuit with an instance of the module from the map file.
|
||||||
- In a way the :cmd:ref:`extract` pass is the inverse of the techmap pass.
|
- In a way the :cmd:ref:`extract` pass is the inverse of the techmap pass.
|
||||||
|
|
||||||
.. todo:: add/expand supporting text
|
.. todo:: add/expand supporting text, also mention custom pattern matching and
|
||||||
|
pmgen
|
||||||
|
|
||||||
.. literalinclude:: /code_examples/macc/macc_simple_test.ys
|
.. literalinclude:: /code_examples/macc/macc_simple_test.ys
|
||||||
:language: yoscrypt
|
:language: yoscrypt
|
||||||
|
@ -277,7 +278,7 @@ Checking.
|
||||||
Checking techmap
|
Checking techmap
|
||||||
~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. todo:: add/expand supporting text
|
.. todo:: add/expand supporting text, reference no longer exists
|
||||||
|
|
||||||
Remember the following example from :doc:`/getting_started/typical_phases`?
|
Remember the following example from :doc:`/getting_started/typical_phases`?
|
||||||
|
|
||||||
|
|
|
@ -409,9 +409,7 @@ multiplexers.
|
||||||
In more complex examples (e.g. asynchronous resets) the part of the
|
In more complex examples (e.g. asynchronous resets) the part of the
|
||||||
``RTLIL::CaseRule``/``RTLIL::SwitchRule`` tree that describes the asynchronous
|
``RTLIL::CaseRule``/``RTLIL::SwitchRule`` tree that describes the asynchronous
|
||||||
reset must first be transformed to the correct ``RTLIL::SyncRule`` objects. This
|
reset must first be transformed to the correct ``RTLIL::SyncRule`` objects. This
|
||||||
is done by the ``proc_adff`` pass.
|
is done by the ``proc_arst`` pass.
|
||||||
|
|
||||||
.. todo:: The ``proc_adff`` pass doesn't exist anymore?
|
|
||||||
|
|
||||||
The ProcessGenerator algorithm
|
The ProcessGenerator algorithm
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
Loading…
Reference in New Issue