Skip to content

Commit

Permalink
Update more documentation links
Browse files Browse the repository at this point in the history
  • Loading branch information
elliotb-lowrisc committed Sep 19, 2024
1 parent 6a33f69 commit 4ed20f4
Show file tree
Hide file tree
Showing 12 changed files with 15 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .svlint.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# Rules for svlint, a SystemVerilog linter commonly used in editors.
# The configuration matches the lowRISC SystemVerilog style guide at
# 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]
exclude_paths = ["build.*", "sw/.*", ".sv.tpl$", "vendor/.*"]
Expand Down
2 changes: 1 addition & 1 deletion doc/01_overview/verification_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`.

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.

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:
Expand Down
2 changes: 1 addition & 1 deletion doc/03_reference/coverage_plan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ For more detail about each security countermeasure in Ibex see :ref:`security`

* ``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.

+--------------------------------+-------------------------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion doc/03_reference/debug.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
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::
Expand Down
6 changes: 3 additions & 3 deletions doc/03_reference/verification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
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.

Expand Down Expand Up @@ -140,7 +140,7 @@ to tell the RISCV-DV code where to find them:
.. _LRSpike: https://github.com/lowRISC/riscv-isa-sim
.. _riscv-toolchain-source: https://github.com/riscv/riscv-gnu-toolchain
.. _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

End-to-end RTL/ISS co-simulation flow
Expand Down Expand Up @@ -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``.
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
<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.
To see how this handshake is used during real simulations, look in
`dv/uvm/core_ibex/tests/core_ibex_test_lib.sv
Expand Down
2 changes: 0 additions & 2 deletions doc/04_developer/concierge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.

* Greg Chadwick (`@GregAC <https://github.com/gregac>`_)
* Tom Roberts (`@tomroberts-lowrisc <https://github.com/tomroberts-lowrisc>`_)
* Rupert Swarbrick (`@rswarbrick <https://github.com/rswarbrick>`_)
* Pirmin Vogel (`@vogelpi <https://github.com/vogelpi>`_)
* Philipp Wagner (`@imphil <https://github.com/imphil>`_)

You can be Ibex Concierge, too.
Please talk to any of the current concierges to discuss!
Expand Down
2 changes: 1 addition & 1 deletion dv/cs_registers/lint/verilator_waiver.vlt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
// 'rtl' directory), see verilator_waiver_rtl.vlt in the same
// 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.
//
// Important: This file must included *before* any other Verilog file is read.
Expand Down
2 changes: 1 addition & 1 deletion dv/riscv_compliance/lint/verilator_waiver.vlt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
// 'rtl' directory), see verilator_waiver_rtl.vlt in the same
// 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.
//
// Important: This file must included *before* any other Verilog file is read.
Expand Down
6 changes: 3 additions & 3 deletions dv/uvm/icache/doc/ibex_icache_dv_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ title: "Ibex ICache DV Plan"

## 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)

## 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

Expand Down Expand Up @@ -155,7 +155,7 @@ Coverpoints will be created at two levels, ICache top level and individual fill
* `FBAwaitingOutput` - Waiting for fill buffer data to be consumed by output before releasing
* `cp_fb_done_reason` - Why the fill buffer has finished
* `FBNotDone` - Fill buffer not yet done
* `FBDoneHitNoExtReqs` - Fill buffer hit against cache and sent no external requests
* `FBDoneHitNoExtReqs` - Fill buffer hit against cache and sent no external requests
* `FBDoneHitExtReqs` - Fill buffer hit against cache and sent external requests (which must be completed before fill buffer can release)
* `FBDoneMiss` - Fill buffer missed in cache and has fetched data to satisfy request
* `FBDoneBranchNoExtReqs` - Fill buffer became stale due to branch and sent no external requests and so released
Expand Down
2 changes: 1 addition & 1 deletion examples/simple_system/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ run stand-alone binaries. It contains:

## 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
that is not suitable. It is recommended Verilator is built from source.
* The Python dependencies of this repository.
Expand Down
2 changes: 1 addition & 1 deletion examples/simple_system/lint/verilator_waiver.vlt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
// 'rtl' directory), see verilator_waiver_rtl.vlt in the same
// 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.
//
// Important: This file must included *before* any other Verilog file is read.
Expand Down
2 changes: 1 addition & 1 deletion lint/verilator_waiver.vlt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// SPDX-License-Identifier: Apache-2.0

// 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.
//
// Important: This file must included *before* any other Verilog file is read.
Expand Down

0 comments on commit 4ed20f4

Please sign in to comment.