riscv
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
yosys/docs/source/appendix/auxlibs.rst

64 lines
1.5 KiB
ReStructuredText
Raw Normal View History

Rst docs conversion (#3496) Rst docs conversion
2022-11-15 05:55:22 -06:00
Auxiliary libraries
===================
docs: update auxiliary programs Now includes usage output, (hopefully) generated by the tool during the docs build process so it will always be up to date. Included in makefile as `docs/usage` target. Also some updates/additions to the description text, esp `yosys-filterlib` and `yosys-smtbmc`.
2023-10-31 16:13:28 -05:00
The Yosys source distribution contains some auxiliary libraries that are
compiled into Yosys and can be used in plugins.
Rst docs conversion (#3496) Rst docs conversion
2022-11-15 05:55:22 -06: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.
2023-12-11 17:05:45 -06:00
.. TODO:: fill out the newer auxiliary libs
Rst docs conversion (#3496) Rst docs conversion
2022-11-15 05:55:22 -06:00
BigInt
------
The files in ``libs/bigint/`` provide a library for performing arithmetic with
arbitrary length integers. It is written by Matt McCutchen.
Reorganising documentation Also changing to furo theme.
2023-08-02 16:20:29 -05:00
The BigInt library is used for evaluating constant expressions, e.g. using the
Rst docs conversion (#3496) Rst docs conversion
2022-11-15 05:55:22 -06:00
ConstEval class provided in kernel/consteval.h.
See also: http://mattmccutchen.net/bigint/
docs: Stub new(er) auxlibs and auxprogs Still need to actually be filled in. Also rearranges auxlibs to be alphabetical order.
2023-10-29 17:13:48 -05:00
dlfcn-win32
-----------
Rst docs conversion (#3496) Rst docs conversion
2022-11-15 05:55:22 -06:00
docs: Stub new(er) auxlibs and auxprogs Still need to actually be filled in. Also rearranges auxlibs to be alphabetical order.
2023-10-29 17:13:48 -05:00
The files in ``libs/dlfcn-win32`` provide...
Rst docs conversion (#3496) Rst docs conversion
2022-11-15 05:55:22 -06:00
ezSAT
-----
The files in ``libs/ezsat`` provide a library for simplifying generating CNF
formulas for SAT solvers. It also contains bindings of MiniSAT. The ezSAT
library is written by C. Wolf. It is used by the sat pass (see
:doc:`../cmd/sat`).
docs: Stub new(er) auxlibs and auxprogs Still need to actually be filled in. Also rearranges auxlibs to be alphabetical order.
2023-10-29 17:13:48 -05:00
fst
---
The files in ``libs/fst`` provide...
json11
------
The files in ``libs/json11`` provide...
MiniSAT
-------
The files in ``libs/minisat`` provide...
SHA1
----
The files in ``libs/sha1/`` provide a public domain SHA1 implementation written
by Steve Reid, Bruce Guenter, and Volker Grabsch. It is used for generating
unique names when specializing parameterized modules.
.. _sec:SubCircuit:
SubCircuit
----------
The files in ``libs/subcircuit`` provide a library for solving the subcircuit
isomorphism problem. It is written by C. Wolf and based on the Ullmann Subgraph
Isomorphism Algorithm :cite:p:`UllmannSubgraphIsomorphism`. It is used by the
extract pass (see :doc:`../cmd/extract`).