github/verilator
1
0
Fork 1
mirror of https://github.com/verilator/verilator.git synced 2025-04-05 04:02:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Commentary

Browse Source
This commit is contained in:
Wilson Snyder 2023-12-27 15:35:22 -05:00
parent 40f0378136
commit f3a97841bd
1 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/guide/verilating.rst
View File

@ -7,9 +7,13 @@ Verilating
Verilator may be used in five major ways: Verilator may be used in five major ways:
* With the :vlopt:`--binary` option, Verilator will translate the design
into an executable, via generating C++ and compiling it. See
:ref:`Binary, C++ and SystemC Generation`.
* With the :vlopt:`--cc` or :vlopt:`--sc` options, Verilator will translate * With the :vlopt:`--cc` or :vlopt:`--sc` options, Verilator will translate
the design into C++ or SystemC code, respectively. See :ref:`C++ and the design into C++ or SystemC code, respectively. See :ref:`Binary, C++
SystemC Generation`. and SystemC Generation`.
* With the :vlopt:`--lint-only` option, Verilator will lint the design to * With the :vlopt:`--lint-only` option, Verilator will lint the design to
check for warnings but will not typically create any output files. check for warnings but will not typically create any output files.
@ -24,13 +28,15 @@ Verilator may be used in five major ways:
expanded. expanded.
.. _C++ and SystemC Generation: .. _Binary, C++ and SystemC Generation:
C++ and SystemC Generation Binary, C++ and SystemC Generation
========================== ==================================
Verilator will translate a SystemVerilog design into C++ with the Verilator will translate a SystemVerilog design into C++ with the
:vlopt:`--cc` option, or into SystemC with the :vlopt:`--sc` option. :vlopt:`--cc` option, or into SystemC with the :vlopt:`--sc` option. It
will translate into C++ and compile it into an executable binary with the
:vlopt:`--binary` option.
When using these options: When using these options:
@ -45,14 +51,19 @@ When using these options:
The prefix is set with :vlopt:`--prefix`, or defaults to the name of the The prefix is set with :vlopt:`--prefix`, or defaults to the name of the
top module. top module.
#. If :vlopt:`--exe` is used, Verilator creates makefiles to generate a #. If :vlopt:`--binary` or :vlopt:`--main` is used, Verilator creates a C++
simulation executable, otherwise, it creates makefiles to generate an top wrapper to read command line arguments, create the model, and
archive (.a) containing the objects. execute the model.
#. If :vlopt:`--build` option was used, it calls :ref:`GNU Make` or #. If :vlopt:`--binary` or :vlopt:`--exe` is used, Verilator creates
:ref:`CMake` to build the model. makefiles to generate a simulation executable, otherwise, it creates
makefiles to generate an archive (.a) containing the objects.
Once a model is built, it is then typically run, see :ref:`Simulating`. #. If :vlopt:`--binary` or :vlopt:`--build` is used, it calls :ref:`GNU
Make` or :ref:`CMake` to build the model.
Once a model is built, the next step is typically for the user to run it,
see :ref:`Simulating`.
.. _Hierarchical Verilation: .. _Hierarchical Verilation: