Update more documentation links

This commit is contained in:
Elliot Baptist 2024-09-18 17:46:45 +01:00 committed by Elliot Baptist
parent 6a33f69ccb
commit 4ed20f4ac3
12 changed files with 15 additions and 17 deletions

View file

@ -5,7 +5,7 @@
# Rules for svlint, a SystemVerilog linter commonly used in editors. # Rules for svlint, a SystemVerilog linter commonly used in editors.
# The configuration matches the lowRISC SystemVerilog style guide at # The configuration matches the lowRISC SystemVerilog style guide at
# https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md. # https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md.
# See https://github.com/dalance/svlint/blob/master/RULES.md for a list of rules. # See https://github.com/dalance/svlint/blob/master/MANUAL.md for a list of rules.
[option] [option]
exclude_paths = ["build.*", "sw/.*", ".sv.tpl$", "vendor/.*"] exclude_paths = ["build.*", "sw/.*", ".sv.tpl$", "vendor/.*"]

View file

@ -14,7 +14,7 @@ The configuration space is too large to fully verify the design for all possible
To manage this complexity regressions runs and verification closure target a number of :ref:`supported configurations<ibex-config>`. To manage this complexity regressions runs and verification closure target a number of :ref:`supported configurations<ibex-config>`.
Current verification closure effort is focussed on the ``opentitan`` configuration and is the only configuration with nightly regression runs. Current verification closure effort is focussed on the ``opentitan`` configuration and is the only configuration with nightly regression runs.
Verification maturity is tracked via :ref:`verification_stages` that are `defined by the OpenTitan project <https://docs.opentitan.org/doc/project/development_stages/#hardware-verification-stages-v>`_. Verification maturity is tracked via :ref:`verification_stages` that are `defined by the OpenTitan project <https://opentitan.org/book/doc/project_governance/development_stages.html#hardware-verification-stages-v>`_.
Ibex has achieved **V2S** for the `opentitan` configuration, broadly this means verification is almost complete (over 90% code and functional coverage hit with over 90% regression pass rate with test plan and coverage plan fully implemented) but not yet closed. Ibex has achieved **V2S** for the `opentitan` configuration, broadly this means verification is almost complete (over 90% code and functional coverage hit with over 90% regression pass rate with test plan and coverage plan fully implemented) but not yet closed.
Nightly regression results, including a coverage summary and details of test failures, for the ``opentitan`` Ibex configuration are published at https://ibex.reports.lowrisc.org/opentitan/latest/report.html. Below is a summary of these results: Nightly regression results, including a coverage summary and details of test failures, for the ``opentitan`` Ibex configuration are published at https://ibex.reports.lowrisc.org/opentitan/latest/report.html. Below is a summary of these results:

View file

@ -342,7 +342,7 @@ For more detail about each security countermeasure in Ibex see :ref:`security`
* ``cp_pc_mismatch_err`` - PC mismatch error seen. * ``cp_pc_mismatch_err`` - PC mismatch error seen.
The :ref:`security features Ibex implements <security>` are given specific security countermeasure names in OpenTitan (see 'Security Countermeasures' in the `Hardware Interfaces <https://docs.opentitan.org/hw/ip/rv_core_ibex/doc/#hardware-interfaces>`_ documentation section). The :ref:`security features Ibex implements <security>` are given specific security countermeasure names in OpenTitan (see 'Security Countermeasures' in the `Comportability Definition and Specification <https://opentitan.org/book/doc/contributing/hw/comportability/index.html#security-countermeasures>`_ documentation section).
The mapping between security countermeasures and coverpoints that demonstrate it being used is given below. The mapping between security countermeasures and coverpoints that demonstrate it being used is given below.
+--------------------------------+-------------------------------------------------------+ +--------------------------------+-------------------------------------------------------+

View file

@ -3,7 +3,7 @@
Debug Support Debug Support
============= =============
Ibex offers support for execution-based debug according to the `RISC-V Debug Specification <https://riscv.org/specifications/debug-specification/>`_, version 0.13. Ibex offers support for execution-based debug according to the `RISC-V Debug Specification <https://github.com/riscv/riscv-debug-spec/blob/0.13-test-release/riscv-debug-spec.pdf>`_, version 0.13.
.. note:: .. note::

View file

@ -19,7 +19,7 @@ At a high level, this testbench uses the open source `RISCV-DV random instructio
simple memory model, stimulates the Ibex core to run this program in memory, and then compares the simple memory model, stimulates the Ibex core to run this program in memory, and then compares the
core trace log against a golden model ISS trace log to check for correctness of execution. core trace log against a golden model ISS trace log to check for correctness of execution.
Verification maturity is tracked via :ref:`verification_stages` that are `defined by the OpenTitan project <https://docs.opentitan.org/doc/project/development_stages/#hardware-verification-stages-v>`_. Verification maturity is tracked via :ref:`verification_stages` that are `defined by the OpenTitan project <https://opentitan.org/book/doc/project_governance/development_stages.html#hardware-verification-stages-v>`_.
Ibex has achieved **V2S** for the ``opentitan`` configuration, broadly this means verification almost complete (over 90% code and functional coverage hit with over 90% regression pass rate with test plan and coverage plan fully implemented) but not yet closed. Ibex has achieved **V2S** for the ``opentitan`` configuration, broadly this means verification almost complete (over 90% code and functional coverage hit with over 90% regression pass rate with test plan and coverage plan fully implemented) but not yet closed.
@ -140,7 +140,7 @@ to tell the RISCV-DV code where to find them:
.. _LRSpike: https://github.com/lowRISC/riscv-isa-sim .. _LRSpike: https://github.com/lowRISC/riscv-isa-sim
.. _riscv-toolchain-source: https://github.com/riscv/riscv-gnu-toolchain .. _riscv-toolchain-source: https://github.com/riscv/riscv-gnu-toolchain
.. _riscv-toolchain-releases: https://github.com/lowRISC/lowrisc-toolchains/releases .. _riscv-toolchain-releases: https://github.com/lowRISC/lowrisc-toolchains/releases
.. _bitmanip-patches: https://github.com/lowRISC/lowrisc-toolchains#how-to-generate-the-bitmanip-patches .. _bitmanip-patches: https://github.com/lowRISC/lowrisc-toolchains#how-to-generate-the-bitmanip-patch
.. _bitmanip: https://github.com/riscv/riscv-bitmanip .. _bitmanip: https://github.com/riscv/riscv-bitmanip
End-to-end RTL/ISS co-simulation flow End-to-end RTL/ISS co-simulation flow
@ -169,7 +169,7 @@ This mechanism is explained in detail at https://github.com/google/riscv-dv/blob
As a sidenote, the signature address that this testbench uses for the handshaking is ``0x8ffffffc``. As a sidenote, the signature address that this testbench uses for the handshaking is ``0x8ffffffc``.
Additionally, as is mentioned in the RISCV-DV documentation of this handshake, a small set of API Additionally, as is mentioned in the RISCV-DV documentation of this handshake, a small set of API
tasks are provided in `dv/uvm/core_ibex/tests/core_ibex_base_test.sv tasks are provided in `dv/uvm/core_ibex/tests/core_ibex_base_test.sv
<https://github.com/lowRISC/ibex/blob/master/dv/uvm/core_ibex/tests/core_ibex_base_tests.sv>`_ to enable easy <https://github.com/lowRISC/ibex/blob/master/dv/uvm/core_ibex/tests/core_ibex_base_test.sv>`_ to enable easy
and efficient integration and usage of this mechanism in this test environment. and efficient integration and usage of this mechanism in this test environment.
To see how this handshake is used during real simulations, look in To see how this handshake is used during real simulations, look in
`dv/uvm/core_ibex/tests/core_ibex_test_lib.sv `dv/uvm/core_ibex/tests/core_ibex_test_lib.sv

View file

@ -25,10 +25,8 @@ The concierge duties rotate between several core developers on a weekly basis.
You can find today's concierge on duty in a `public calendar <https://calendar.google.com/calendar/embed?src=lowrisc.org_s0pdodkddnggdp40jusjij27h4%40group.calendar.google.com>`_. You can find today's concierge on duty in a `public calendar <https://calendar.google.com/calendar/embed?src=lowrisc.org_s0pdodkddnggdp40jusjij27h4%40group.calendar.google.com>`_.
* Greg Chadwick (`@GregAC <https://github.com/gregac>`_) * Greg Chadwick (`@GregAC <https://github.com/gregac>`_)
* Tom Roberts (`@tomroberts-lowrisc <https://github.com/tomroberts-lowrisc>`_)
* Rupert Swarbrick (`@rswarbrick <https://github.com/rswarbrick>`_) * Rupert Swarbrick (`@rswarbrick <https://github.com/rswarbrick>`_)
* Pirmin Vogel (`@vogelpi <https://github.com/vogelpi>`_) * Pirmin Vogel (`@vogelpi <https://github.com/vogelpi>`_)
* Philipp Wagner (`@imphil <https://github.com/imphil>`_)
You can be Ibex Concierge, too. You can be Ibex Concierge, too.
Please talk to any of the current concierges to discuss! Please talk to any of the current concierges to discuss!

View file

@ -9,7 +9,7 @@
// 'rtl' directory), see verilator_waiver_rtl.vlt in the same // 'rtl' directory), see verilator_waiver_rtl.vlt in the same
// directory. // directory.
// //
// See https://www.veripool.org/projects/verilator/wiki/Manual-verilator#CONFIGURATION-FILES // See https://verilator.org/guide/latest/exe_verilator.html#configuration-files
// for documentation. // for documentation.
// //
// Important: This file must included *before* any other Verilog file is read. // Important: This file must included *before* any other Verilog file is read.

View file

@ -9,7 +9,7 @@
// 'rtl' directory), see verilator_waiver_rtl.vlt in the same // 'rtl' directory), see verilator_waiver_rtl.vlt in the same
// directory. // directory.
// //
// See https://www.veripool.org/projects/verilator/wiki/Manual-verilator#CONFIGURATION-FILES // See https://verilator.org/guide/latest/exe_verilator.html#configuration-files
// for documentation. // for documentation.
// //
// Important: This file must included *before* any other Verilog file is read. // Important: This file must included *before* any other Verilog file is read.

View file

@ -11,12 +11,12 @@ title: "Ibex ICache DV Plan"
## Current status ## Current status
* Design & verification stage (TODO: Create HW dashboard & add link) (see [HW development stages](https://docs.opentitan.org/doc/project/hw_stages) for what this means) * Design & verification stage (TODO: Create HW dashboard & add link) (see [HW development stages](https://opentitan.org/book/doc/project_governance/development_stages.html) for what this means)
* Simulation results (TODO: Generate nightly simulation results & add link) * Simulation results (TODO: Generate nightly simulation results & add link)
## Design features ## Design features
The ICache design is documented in the [Instruction Cache](https://ibex-core.readthedocs.io/en/latest/icache.html) section of the Ibex User Manual. The ICache design is documented in the [Instruction Cache](https://ibex-core.readthedocs.io/en/latest/03_reference/icache.html) section of the Ibex User Manual.
## Testbench architecture ## Testbench architecture

View file

@ -11,7 +11,7 @@ run stand-alone binaries. It contains:
## Prerequisites ## Prerequisites
* [Verilator](https://www.veripool.org/wiki/verilator) * [Verilator](https://www.veripool.org/verilator/)
Note Linux package managers may have Verilator but often a very old version Note Linux package managers may have Verilator but often a very old version
that is not suitable. It is recommended Verilator is built from source. that is not suitable. It is recommended Verilator is built from source.
* The Python dependencies of this repository. * The Python dependencies of this repository.

View file

@ -9,7 +9,7 @@
// 'rtl' directory), see verilator_waiver_rtl.vlt in the same // 'rtl' directory), see verilator_waiver_rtl.vlt in the same
// directory. // directory.
// //
// See https://www.veripool.org/projects/verilator/wiki/Manual-verilator#CONFIGURATION-FILES // See https://verilator.org/guide/latest/exe_verilator.html#configuration-files
// for documentation. // for documentation.
// //
// Important: This file must included *before* any other Verilog file is read. // Important: This file must included *before* any other Verilog file is read.

View file

@ -3,7 +3,7 @@
// SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: Apache-2.0
// Lint waivers for Verilator // Lint waivers for Verilator
// See https://www.veripool.org/projects/verilator/wiki/Manual-verilator#CONFIGURATION-FILES // See https://verilator.org/guide/latest/exe_verilator.html#configuration-files
// for documentation. // for documentation.
// //
// Important: This file must included *before* any other Verilog file is read. // Important: This file must included *before* any other Verilog file is read.