Commentary

This commit is contained in:
Wilson Snyder 2025-03-30 11:02:21 -04:00
parent 0a860f151c
commit 6f87443da5
5 changed files with 35 additions and 24 deletions

View File

@ -9,7 +9,7 @@ assignees: ''
Thanks for taking the time to report this. Thanks for taking the time to report this.
Can you attach an example that shows the issue? (Must be openly licensed, completely self-contaned so can directly run what you provide. Ideally use test_regress format, see https://veripool.org/guide/latest/contributing.html?highlight=test_regress#reporting-bugs Can you attach an example that shows the issue? (Must be openly licensed, completely self-contained and self-checking so can directly run what you provide. Ideally use test_regress format, see https://veripool.org/guide/latest/contributing.html?highlight=test_regress#reporting-bugs
What 'verilator' command line do we use to run your example? What 'verilator' command line do we use to run your example?

View File

@ -13,6 +13,6 @@ What would you like added/supported?
What 'verilator --version' are you using? Did you try it with the git master version? What 'verilator --version' are you using? Did you try it with the git master version?
Can you attach an example that runs on other simulators? (Must be openly licensed, ideally in test_regress format.) Can you attach an example that runs on other simulators? (Must be openly licensed, completely self-contained and self-checking so can directly run what you provide. Ideally use test_regress format, see https://veripool.org/guide/latest/contributing.html?highlight=test_regress#reporting-bugs
May we assist you in trying to fix this in Verilator yourself? May we assist you in trying to fix this in Verilator yourself?

View File

@ -169,15 +169,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
# latex_documents = [ # latex_documents = [ ... ]
# (
# master_doc,
# "Verilog-to-Routing.tex",
# "Verilog-to-Routing Documentation",
# "VTR Developers",
# "manual",
# ),
# ]
# For "manual" documents, if this is true, then toplevel headings are parts, # For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters. # not chapters.

View File

@ -73,8 +73,8 @@ often inlined into the root scope) will need to be updated as follows:
:code:`$` character, i.e.: :code:`rootp` points to the Verilated :code:`$` character, i.e.: :code:`rootp` points to the Verilated
SystemVerilog :code:`$root` scope. SystemVerilog :code:`$root` scope.
* Replace :code:`modelp->internal->member->lookup` references with * Replace :code:`modelp->internal->member` references with
:code:`modelp->rootp->internal->member->lookup` references, which :code:`modelp->rootp->internal->member` references, which
contain one additional indirection via the :code:`rootp` pointer. contain one additional indirection via the :code:`rootp` pointer.

View File

@ -15,9 +15,9 @@ Package Manager Quick Install
============================= =============================
Using a distribution's package manager is the easiest way to get Using a distribution's package manager is the easiest way to get
started. (Note packages are unlikely to have the most recent version, so started. (Note distribution packages almost never have the most recent
:ref:`Git Install` might be a better alternative.) To install as a Verilator version, so we recommend following :ref:`Git Install` below,
package: instead.) To install as a package:
.. code-block:: shell .. code-block:: shell
@ -118,6 +118,25 @@ To build or run Verilator, you need these standard packages:
sudo apt-get install libfl-dev # Ubuntu only (ignore if gives error) sudo apt-get install libfl-dev # Ubuntu only (ignore if gives error)
sudo apt-get install zlibc zlib1g zlib1g-dev # Ubuntu only (ignore if gives error) sudo apt-get install zlibc zlib1g zlib1g-dev # Ubuntu only (ignore if gives error)
For SystemC:
.. code-block:: shell
sudo apt-get install libsystemc libsystemc-dev
For constraints:
.. code-block:: shell
sudo apt-get install z3 # Optional solver
The following is optional but is recommended for nicely rendered command line
help when running Verilator:
.. code-block:: shell
sudo apt-get install perl-doc
To build or run Verilator, the following are optional but should be installed To build or run Verilator, the following are optional but should be installed
for good performance: for good performance:
@ -127,13 +146,6 @@ for good performance:
sudo apt-get install mold # If present at build, needed for run sudo apt-get install mold # If present at build, needed for run
sudo apt-get install libgoogle-perftools-dev numactl sudo apt-get install libgoogle-perftools-dev numactl
The following is optional but is recommended for nicely rendered command line
help when running Verilator:
.. code-block:: shell
sudo apt-get install perl-doc
To build Verilator you will need to install these packages; these do not To build Verilator you will need to install these packages; these do not
need to be present to run Verilator: need to be present to run Verilator:
@ -155,7 +167,10 @@ Those developing Verilator itself may also want these (see internals.rst):
Install SystemC Install SystemC
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
If you will be using SystemC (vs straight C++ output), download `SystemC SystemC code can be generated from Verilator (with :vlopt:`--sc`) if it is
installed as a package (see above).
Alternatively, from their sources, download `SystemC
<https://www.accellera.org/downloads/standards/systemc>`__. Follow their <https://www.accellera.org/downloads/standards/systemc>`__. Follow their
installation instructions. You will need to set the installation instructions. You will need to set the
:option:`SYSTEMC_INCLUDE` environment variable to point to the include :option:`SYSTEMC_INCLUDE` environment variable to point to the include
@ -170,6 +185,10 @@ To make use of Verilator FST tracing you will want `GTKwave
<http://gtkwave.sourceforge.net/>`__ installed, however this is not <http://gtkwave.sourceforge.net/>`__ installed, however this is not
required at Verilator build time. required at Verilator build time.
.. code-block:: shell
sudo apt-get install gtkwave # Optional Waveform viewer
Install Z3 Install Z3
^^^^^^^^^^ ^^^^^^^^^^