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

Docs: Clarify verific caveats

This commit is contained in:
Krystine Sherwin 2024-08-22 10:04:00 +12:00
parent 6431534c24
commit 3317d80480
No known key found for this signature in database
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/source/yosys_internals/extending_yosys/build_verific.rst
View File

@ -17,12 +17,21 @@ The Yosys-Verific patch
YosysHQ maintains and develops a patch for Verific in order to better integrate YosysHQ maintains and develops a patch for Verific in order to better integrate
with Yosys and to provide features required by some of the formal verification with Yosys and to provide features required by some of the formal verification
front-end tools. Synthesis from RTL may be possible without this patch, however front-end tools. To license this patch for your own Yosys builds, `contact
we are unable to provide support for any Yosys+Verific builds without it. To YosysHQ`_.
license this patch for your own Yosys builds, `contact YosysHQ`_.
.. warning:: .. warning::
While synthesis from RTL may be possible without this patch, YosysHQ provides
no guarantees of correctness and is unable to provide support.
We recommend against using unpatched Yosys+Verific builds in conjunction with
the formal verification front-end tools unless you are familiar with their inner
workings. There are cases where the tools will appear to work, while producing
incorrect results.
.. note::
Some of the formal verification front-end tools may not be fully supported Some of the formal verification front-end tools may not be fully supported
without the full TabbyCAD suite. If you are wanting to use these tools, without the full TabbyCAD suite. If you are wanting to use these tools,
including SBY, make sure to ask us if the Yosys-Verific patch is right for including SBY, make sure to ask us if the Yosys-Verific patch is right for
@ -62,6 +71,10 @@ To find the compile options used for a given Yosys build, call ``yosys-config
:start-at: --cxxflags :start-at: --cxxflags
:end-before: --linkflags :end-before: --linkflags
.. note::
The YosysHQ specific extensions are only available with the TabbyCAD suite.
Required Verific features Required Verific features
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
@ -110,7 +123,7 @@ lists a series of build configurations which are possible, but only provide a
limited subset of features. Please note that support is limited without YosysHQ limited subset of features. Please note that support is limited without YosysHQ
specific extensions of Verific library. specific extensions of Verific library.
+--------------------------------------------------------------------------+---+---+---+-----------+ +--------------------------------------------------------------------------+-----+-----+-----+-----+
| | Configuration values | | | Configuration values |
+--------------------------------------------------------------------------+-----+-----+-----+-----+ +--------------------------------------------------------------------------+-----+-----+-----+-----+
| Features | a | b | c | d | | Features | a | b | c | d |