Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note on docs to clarify verific support #278

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,14 @@ As verification properties become more complex and check longer sequences, the
additional effort of hand-coding without SVA properties becomes much more
difficult. Using a parser such as Verific supports these checks *without*
having to write out potentially complicated state machines. Verific is included
for use in the *Tabby CAD Suite*.
for use in the *Tabby CAD Suite*.

.. note::

The Verific frontend for Yosys requires the commercial `Tabby CAD Suite`_.
This is not the same as simply having a Verific license when using Yosys.

.. _Tabby CAD Suite: https://www.yosyshq.com/tabby-cad-datasheet

Further information
*******************
Expand Down
8 changes: 8 additions & 0 deletions docs/source/verific.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
SystemVerilog, VHDL, SVA
========================

.. note::

This document describes features only available with the commercial `Tabby
CAD Suite`_ and the included Verific frontend. This is not the same as simply
having a Verific license when using Yosys.

.. _Tabby CAD Suite: https://www.yosyshq.com/tabby-cad-datasheet

Run ``verific -sv <files>`` in the ``[script]`` section of you ``.sby`` file
to read a SystemVerilog source file, and ``verific -vhdl <files>`` to read a
VHDL source file.
Expand Down
8 changes: 4 additions & 4 deletions docs/source/verilog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ within the core.
`endif
endmodule

The ``bind()`` operator can also be used when using the Verific front end.
This will provide an option to attach formal properties to a given piece
of logic, without actually modifying the module in question to do so as
we did in the example above.
The ``bind()`` operator can also be used when using the Verific front end. This
will provide an option to attach formal properties to a given piece of logic,
without actually modifying the module in question to do so as we did in the
example above. Refer to :doc:`verific` for more on the Verific front end.

SystemVerilog Immediate Assertions
----------------------------------
Expand Down