Skip to content

Commit 4ed20f4

Browse files
Update more documentation links
1 parent 6a33f69 commit 4ed20f4

File tree

12 files changed

+15
-17
lines changed

12 files changed

+15
-17
lines changed

.svlint.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# Rules for svlint, a SystemVerilog linter commonly used in editors.
66
# The configuration matches the lowRISC SystemVerilog style guide at
77
# https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md.
8-
# See https://github.com/dalance/svlint/blob/master/RULES.md for a list of rules.
8+
# See https://github.com/dalance/svlint/blob/master/MANUAL.md for a list of rules.
99

1010
[option]
1111
exclude_paths = ["build.*", "sw/.*", ".sv.tpl$", "vendor/.*"]

doc/01_overview/verification_overview.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The configuration space is too large to fully verify the design for all possible
1414
To manage this complexity regressions runs and verification closure target a number of :ref:`supported configurations<ibex-config>`.
1515

1616
Current verification closure effort is focussed on the ``opentitan`` configuration and is the only configuration with nightly regression runs.
17-
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>`_.
17+
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>`_.
1818
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.
1919

2020
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:

doc/03_reference/coverage_plan.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ For more detail about each security countermeasure in Ibex see :ref:`security`
342342

343343
* ``cp_pc_mismatch_err`` - PC mismatch error seen.
344344

345-
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).
345+
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).
346346
The mapping between security countermeasures and coverpoints that demonstrate it being used is given below.
347347

348348
+--------------------------------+-------------------------------------------------------+

doc/03_reference/debug.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Debug Support
44
=============
55

6-
Ibex offers support for execution-based debug according to the `RISC-V Debug Specification <https://riscv.org/specifications/debug-specification/>`_, version 0.13.
6+
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.
77

88

99
.. note::

doc/03_reference/verification.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ At a high level, this testbench uses the open source `RISCV-DV random instructio
1919
simple memory model, stimulates the Ibex core to run this program in memory, and then compares the
2020
core trace log against a golden model ISS trace log to check for correctness of execution.
2121

22-
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>`_.
22+
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>`_.
2323

2424
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.
2525

@@ -140,7 +140,7 @@ to tell the RISCV-DV code where to find them:
140140
.. _LRSpike: https://github.com/lowRISC/riscv-isa-sim
141141
.. _riscv-toolchain-source: https://github.com/riscv/riscv-gnu-toolchain
142142
.. _riscv-toolchain-releases: https://github.com/lowRISC/lowrisc-toolchains/releases
143-
.. _bitmanip-patches: https://github.com/lowRISC/lowrisc-toolchains#how-to-generate-the-bitmanip-patches
143+
.. _bitmanip-patches: https://github.com/lowRISC/lowrisc-toolchains#how-to-generate-the-bitmanip-patch
144144
.. _bitmanip: https://github.com/riscv/riscv-bitmanip
145145

146146
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
169169
As a sidenote, the signature address that this testbench uses for the handshaking is ``0x8ffffffc``.
170170
Additionally, as is mentioned in the RISCV-DV documentation of this handshake, a small set of API
171171
tasks are provided in `dv/uvm/core_ibex/tests/core_ibex_base_test.sv
172-
<https://github.com/lowRISC/ibex/blob/master/dv/uvm/core_ibex/tests/core_ibex_base_tests.sv>`_ to enable easy
172+
<https://github.com/lowRISC/ibex/blob/master/dv/uvm/core_ibex/tests/core_ibex_base_test.sv>`_ to enable easy
173173
and efficient integration and usage of this mechanism in this test environment.
174174
To see how this handshake is used during real simulations, look in
175175
`dv/uvm/core_ibex/tests/core_ibex_test_lib.sv

doc/04_developer/concierge.rst

-2
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,8 @@ The concierge duties rotate between several core developers on a weekly basis.
2525
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>`_.
2626

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

3331
You can be Ibex Concierge, too.
3432
Please talk to any of the current concierges to discuss!

dv/cs_registers/lint/verilator_waiver.vlt

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

dv/riscv_compliance/lint/verilator_waiver.vlt

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

dv/uvm/icache/doc/ibex_icache_dv_plan.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ title: "Ibex ICache DV Plan"
1111

1212
## Current status
1313

14-
* 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)
14+
* 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)
1515
* Simulation results (TODO: Generate nightly simulation results & add link)
1616

1717
## Design features
1818

19-
The ICache design is documented in the [Instruction Cache](https://ibex-core.readthedocs.io/en/latest/icache.html) section of the Ibex User Manual.
19+
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.
2020

2121
## Testbench architecture
2222

@@ -155,7 +155,7 @@ Coverpoints will be created at two levels, ICache top level and individual fill
155155
* `FBAwaitingOutput` - Waiting for fill buffer data to be consumed by output before releasing
156156
* `cp_fb_done_reason` - Why the fill buffer has finished
157157
* `FBNotDone` - Fill buffer not yet done
158-
* `FBDoneHitNoExtReqs` - Fill buffer hit against cache and sent no external requests
158+
* `FBDoneHitNoExtReqs` - Fill buffer hit against cache and sent no external requests
159159
* `FBDoneHitExtReqs` - Fill buffer hit against cache and sent external requests (which must be completed before fill buffer can release)
160160
* `FBDoneMiss` - Fill buffer missed in cache and has fetched data to satisfy request
161161
* `FBDoneBranchNoExtReqs` - Fill buffer became stale due to branch and sent no external requests and so released

examples/simple_system/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ run stand-alone binaries. It contains:
1111

1212
## Prerequisites
1313

14-
* [Verilator](https://www.veripool.org/wiki/verilator)
14+
* [Verilator](https://www.veripool.org/verilator/)
1515
Note Linux package managers may have Verilator but often a very old version
1616
that is not suitable. It is recommended Verilator is built from source.
1717
* The Python dependencies of this repository.

examples/simple_system/lint/verilator_waiver.vlt

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

lint/verilator_waiver.vlt

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// SPDX-License-Identifier: Apache-2.0
44

55
// Lint waivers for Verilator
6-
// See https://www.veripool.org/projects/verilator/wiki/Manual-verilator#CONFIGURATION-FILES
6+
// See https://verilator.org/guide/latest/exe_verilator.html#configuration-files
77
// for documentation.
88
//
99
// Important: This file must included *before* any other Verilog file is read.

0 commit comments

Comments
 (0)