mirror of
https://github.com/YosysHQ/yosys
synced 2025-04-13 20:38:44 +00:00
e34a25ea27
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.
60 lines
1.6 KiB
ReStructuredText
60 lines
1.6 KiB
ReStructuredText
Auxiliary programs
|
|
==================
|
|
|
|
Besides the main yosys executable, the Yosys distribution contains a set of
|
|
additional helper programs.
|
|
|
|
yosys-config
|
|
------------
|
|
|
|
The ``yosys-config`` tool (an auto-generated shell-script) can be used to query
|
|
compiler options and other information needed for building loadable modules for
|
|
Yosys. See :doc:`/yosys_internals/extensions` for details.
|
|
|
|
.. literalinclude:: /temp/yosys-config
|
|
:start-at: Usage
|
|
|
|
.. _sec:filterlib:
|
|
|
|
yosys-filterlib
|
|
---------------
|
|
|
|
.. todo:: how does a filterlib rules-file work?
|
|
|
|
The ``yosys-filterlib`` tool is a small utility that can be used to strip or
|
|
extract information from a Liberty file. This can be useful for removing
|
|
sensitive or proprietary information such as timing or other trade secrets.
|
|
|
|
.. literalinclude:: /temp/yosys-filterlib
|
|
:start-at: Usage
|
|
|
|
yosys-abc
|
|
---------
|
|
|
|
This is a fork of ABC with a small set of custom modifications that have not yet
|
|
been accepted upstream. Not all versions of Yosys work with all versions of ABC.
|
|
So Yosys comes with its own yosys-abc to avoid compatibility issues between the
|
|
two.
|
|
|
|
.. literalinclude:: /temp/yosys-abc
|
|
:start-at: usage
|
|
:end-before: UC Berkeley
|
|
|
|
yosys-smtbmc
|
|
------------
|
|
|
|
The ``yosys-smtbmc`` tool is a utility used by SBY for interacting with smt
|
|
solvers.
|
|
|
|
.. literalinclude:: /temp/yosys-smtbmc
|
|
|
|
yosys-witness
|
|
-------------
|
|
|
|
``yosys-witness`` is a new tool to inspect and convert yosys witness traces.
|
|
This is used in SBY and SCY for producing traces in a consistent format
|
|
independent of the solver.
|
|
|
|
.. literalinclude:: /temp/yosys-witness
|
|
:start-at: Usage
|