mirrors/sby
3
0
Fork 0
mirror of https://github.com/YosysHQ/sby.git synced 2025-04-05 22:14:08 +00:00
Code Activity

Update docs

Browse source
This commit is contained in:
Clifford Wolf 2017-02-06 17:49:20 +01:00
parent 88d0e4f13a
commit 24e19e3cda
2 changed files with 46 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/source/index.rst
View file

@ -22,10 +22,3 @@ at the moment.)
reference.rst reference.rst
license.rst license.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`

77
docs/source/reference.rst
View file

@ -2,43 +2,58 @@
Reference for .sby file format Reference for .sby file format
============================== ==============================
Yosys Script A ``.sby`` file consists of sections. Each section start with a single-line
------------ section header in square brackets. The order of sections in a ``.sby`` file
is irrelevant, but by convention the usual order is ``[options]``,
``[engines]``, ``[script]``, and ``[files]``.
Options section
---------------
The ``[options]`` section contains lines with key-value pairs. The ``mode``
option is mandatory. The possible values for the ``mode`` option are:
========= ===========
Mode Description
========= ===========
``bmc`` Bounded model check to verify safety properties (assert() statements)
``prove`` Unbounded model check to verify safety properties (assert() statements)
``cover`` Generate set of shortest trace required to reach all cover() statements
========= ===========
All other options have default values and thus are optional. The available
options are:
+-------------+-----------+---------------------------------------------------------+
| Option | Modes | Description |
+=============+===========+=========================================================+
| ``expect`` | All | Expected result as comma-separated list of the tokens |
| | | ``pass``, ``fail``, ``unknown``, ``error``, and |
| | | ``timeout``. Unexpected results yield a nonzero return |
| | | code . Default: ``pass`` |
+-------------+-----------+---------------------------------------------------------+
| ``timeout`` | All | Timeout in seconds. Default: ``none`` (i.e. no timeout) |
+-------------+-----------+---------------------------------------------------------+
| ``depth`` | ``bmc``, | Depth of the bounded model check. Only the specified |
| | ``cover`` | number of cycles are considered. Default: ``20`` |
| +-----------+---------------------------------------------------------+
| | ``prove`` | Depth for the k-induction performed by the ``smtbmc`` |
| | | engine. Other engines ignore this option in ``prove`` |
| | | mode. Default: ``20`` |
+-------------+-----------+---------------------------------------------------------+
Engines section
---------------
TBD TBD
File and files sections Script section
----------------------- --------------
TBD TBD
Modes, options, and engines Files section
--------------------------- -------------
TBD
Options and engines for bounded model checks
--------------------------------------------
TBD
Options and engines for unbounded model checks
----------------------------------------------
TBD
Options and engines for coverage analysis
-----------------------------------------
TBD
Options and engines for liveness properties
-------------------------------------------
TBD
Options and engines for formal equivalence
------------------------------------------
TBD TBD