mirror of
https://github.com/YosysHQ/yosys
synced 2025-06-06 06:03:23 +00:00
TODOs
Blocking tasks are now capital TODO (compared to non-blocking todo). Updated some of the todos. Added note about which intel synth does which families. Rename extended Yosys universe to Yosys family. Added brief text to landing page, and also a note about the restructure and where to find old docs. Moved todolist above ToC in preparation for disabling it in the config (so that it doesn't need it's own header). Fixed pdf build, was previously breaking on trying to include the svg badges.
This commit is contained in:
parent
4ecceaed44
commit
e34a25ea27
20 changed files with 78 additions and 60 deletions
|
@ -1,6 +1,8 @@
|
|||
Using Yosys (advanced)
|
||||
======================
|
||||
|
||||
.. todo:: brief overview for the using Yosys index
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
|
|
@ -1,6 +1,8 @@
|
|||
More scripting
|
||||
--------------
|
||||
|
||||
.. todo:: brief overview for the more scripting index
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
|
|
|
@ -260,7 +260,7 @@ switch back). Now the `ls` command lists the objects within that module.
|
|||
:numref:`lscd` below demonstrates this using the ``example.v`` from
|
||||
`A simple circuit`_
|
||||
|
||||
.. todo:: update yosys output with $ternary$example.v$3
|
||||
.. TODO:: update yosys output with $ternary$example.v$3
|
||||
|
||||
.. code-block:: none
|
||||
:caption: Demonstration of :cmd:ref:`ls` and :cmd:ref:`cd` having run ``yosys example.v``
|
||||
|
|
|
@ -263,7 +263,7 @@ diagram in :numref:`memdemo_00`.
|
|||
|
||||
Complete circuit diagram for the design shown in :numref:`memdemo_src`
|
||||
|
||||
.. todo:: :ref:`memdemo_01` and :ref:`memdemo_02` are the same, probably change
|
||||
.. TODO:: :ref:`memdemo_01` and :ref:`memdemo_02` are the same, probably change
|
||||
the example so they aren't.
|
||||
|
||||
There's a lot going on there, but maybe we are only interested in the tree of
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
The :cmd:ref:`abc` command
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. todo:: discuss abc (more stable) vs abc9 (newer, possibly better)
|
||||
.. TODO:: discuss abc, consider using https://github.com/Ravenslofty/yosys-cookbook/blob/master/misc/abc9.md
|
||||
|
||||
The :cmd:ref:`abc` command provides an interface to ABC_, an open source tool
|
||||
for low-level logic synthesis.
|
||||
|
|
|
@ -1,6 +1,8 @@
|
|||
Synthesis in detail
|
||||
-------------------
|
||||
|
||||
.. todo:: brief overview for the synthesis index
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
|
|
|
@ -57,7 +57,7 @@ Example
|
|||
Memory mapping
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
.. todo:: :cmd:ref:`memory_libmap` description
|
||||
.. TODO:: :cmd:ref:`memory_libmap` description
|
||||
|
||||
Usually it is preferred to use architecture-specific RAM resources for memory.
|
||||
For example:
|
||||
|
|
|
@ -66,8 +66,6 @@ In some cases this pass can also optimize cells with some constant inputs.
|
|||
1 :math:`b` :math:`b`
|
||||
========= ========= ===========
|
||||
|
||||
.. todo:: How to format table?
|
||||
|
||||
:numref:`Table %s <tab:opt_expr_and>` shows the replacement rules used for
|
||||
optimizing an ``$_AND_`` gate. The first three rules implement the obvious const
|
||||
folding rules. Note that 'any' might include dynamic values calculated by other
|
||||
|
@ -131,7 +129,7 @@ is produced.
|
|||
The ``opt_rmdff`` pass
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. todo:: Update to ``opt_dff``
|
||||
.. TODO:: Update to ``opt_dff``
|
||||
|
||||
This pass identifies single-bit d-type flip-flops (``$_DFF_``, ``$dff``, and
|
||||
``$adff`` cells) with a constant data input and replaces them with a constant
|
||||
|
|
|
@ -4,11 +4,10 @@ Synth commands
|
|||
Packaged ``synth_*`` commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. todo:: are all these synth commands supported?
|
||||
|
||||
The following is a list of all synth commands included in Yosys for different
|
||||
platforms. Each command runs a script of sub commands specific to the platform
|
||||
being targeted.
|
||||
being targeted. Note that not all of these scripts are actively maintained and
|
||||
may not be up-to-date.
|
||||
|
||||
- :doc:`/cmd/synth_achronix`
|
||||
- :doc:`/cmd/synth_anlogic`
|
||||
|
@ -21,8 +20,8 @@ being targeted.
|
|||
- :doc:`/cmd/synth_gowin`
|
||||
- :doc:`/cmd/synth_greenpak4`
|
||||
- :doc:`/cmd/synth_ice40`
|
||||
- :doc:`/cmd/synth_intel`
|
||||
- :doc:`/cmd/synth_intel_alm`
|
||||
- :doc:`/cmd/synth_intel` (MAX10, Cyclone IV)
|
||||
- :doc:`/cmd/synth_intel_alm` (Cyclone V, Arria V, Cyclone 10 GX)
|
||||
- :doc:`/cmd/synth_lattice`
|
||||
- :doc:`/cmd/synth_nexus`
|
||||
- :doc:`/cmd/synth_quicklogic`
|
||||
|
|
|
@ -4,7 +4,7 @@ Flows, command types, and order
|
|||
Command order
|
||||
-------------
|
||||
|
||||
.. todo:: check text is coherent
|
||||
.. TODO:: check text is coherent
|
||||
|
||||
Intro to coarse-grain synthesis
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue