[doc] Replaced Hugo links with standard markdown A script, `util/check_links.py`, was written by Amaury to automate most of the relinking. Below are the commands run to perform the relinking. Some moves had to be manually added to the move list, because they were either not properly tracked by git or to fix quirky behaviour of the script. Note that command has to be run twice because it can't handle non-bijective moves and that it incorrectly re-links two files, which are fixed in the final file. ``` git show --name-status HEAD~11..HEAD | grep '^R100' | sed 's/^R100\t//' > move_list.txt echo "hw/dv/sv/dv_utils/doc/index.md hw/dv/sv/dv_utils/README.md" >> move_list.txt echo "hw/dv/tools/doc/index.md hw/dv/tools/README.md" >> move_list.txt echo "README.md doc/introduction.md" >> move_list.txt echo "doc/project/checklist.md doc/project_governance/checklist/README.md" >> move_list.txt ./util/check_links.py . --ignore-book --move-list-file move_list.txt --apply echo "hw/dv/tools/README.md util/dvsim/README.md" > move_list.txt ./util/check_links.py . --ignore-book --move-list-file move_list.txt --apply git checkout HEAD -- SUMMARY.md hw/doc/cores.md ``` Signed-off-by: Hugo McNally <hugo.mcnally@gmail.com> Co-authored-by: Amaury Pouly <amaury.pouly@lowrisc.org>
diff --git a/doc/contributing/README.md b/doc/contributing/README.md index 946a6bf..1c90d36 100644 --- a/doc/contributing/README.md +++ b/doc/contributing/README.md
@@ -22,7 +22,7 @@ We are always looking for ways to improve and welcome feedback on any project matter, technical or not. **Important**: Please read the next three, short sections on reporting bugs, reporting security issues, and contributing code in preparation for making your first contribution to OpenTitan. -If you would like more details, see the [Detailed Contribution Guide]({{<relref "detailed_contribution_guide/_index.md" >}}). +If you would like more details, see the [Detailed Contribution Guide](./detailed_contribution_guide/README.md). ## Bug reports @@ -30,7 +30,7 @@ Ideally, all designs are bug free. Realistically, each piece of collateral in our repository is in a different state of maturity with some still under active testing and development. -See the [Hardware Development Stages]({{< relref "development_stages" >}}) for an example of how hardware progress is tracked. +See the [Hardware Development Stages](../project_governance/development_stages.md) for an example of how hardware progress is tracked. We are happy to receive bug reports and eager to fix them. Please make reports by opening a new issue in our [GitHub issue tracker](https://github.com/lowRISC/opentitan/issues).
diff --git a/doc/contributing/bazel_notes.md b/doc/contributing/bazel_notes.md index f140829..2a52ff5 100644 --- a/doc/contributing/bazel_notes.md +++ b/doc/contributing/bazel_notes.md
@@ -69,11 +69,11 @@ ``` Note: `<device>` will be in {`sim_dv`, `sim_verilator`, `fpga_cw310`}. -See [Building (and Testing) Software]({{< relref "doc/getting_started/build_sw#device-artifacts" >}}), device software can be built for multiple OpenTitan devices and memories, using OpenTitan-specific Bazel macros. +See [Building (and Testing) Software](../guides/getting_started/src/build_sw.md#device-artifacts), device software can be built for multiple OpenTitan devices and memories, using OpenTitan-specific Bazel macros. ## `opentitan_functest` Artifacts -As described [Building (and Testing) Software]({{< relref "doc/getting_started/build_sw#device-artifacts" >}}), device software can be built for multiple OpenTitan devices and memories, using OpenTitan-specific Bazel macros. +As described [Building (and Testing) Software](../guides/getting_started/src/build_sw.md#device-artifacts), device software can be built for multiple OpenTitan devices and memories, using OpenTitan-specific Bazel macros. Since running tests on multiple OpenTitan devices (whether DV or Verilator simulation, or an FPGA) involves building several software images for multiple memories, we provide a Bazel macro for this. This macro is called `opentitan_functest`. @@ -101,7 +101,7 @@ # Building Software -* To build OpenTitan software see [here]({{< relref "doc/getting_started/build_sw#building-software-with-bazel" >}}), or run +* To build OpenTitan software see [here](../guides/getting_started/src/build_sw.md#building-software-with-bazel), or run ```console bazel build <target> ``` @@ -110,7 +110,7 @@ ## On-Host Tests -* To query-for/run *on-host* software tests see [here]({{< relref "doc/getting_started/build_sw#running-tests-with-bazel" >}}). +* To query-for/run *on-host* software tests see [here](../guides/getting_started/src/build_sw.md#running-tests-with-bazel). ## On-Device Tests @@ -230,8 +230,8 @@ Note, to run (software) tests on these OpenTitan hardware platforms **does not** require these Bazel commands be invoked before the test commands above. Bazel is aware of all dependency relationships, and knows what prerequisites to build to run a test. -- Build FPGA bitstream with (test) ROM, see [here]({{< relref "doc/getting_started/setup_fpga#build-an-fpga-bitstream" >}}). -- Build FPGA bitstream with (production) ROM, see [here]({{< relref "doc/getting_started/setup_fpga#build-an-fpga-bitstream" >}}). +- Build FPGA bitstream with (test) ROM, see [here](../guides/getting_started/src/setup_fpga.md#build-an-fpga-bitstream). +- Build FPGA bitstream with (production) ROM, see [here](../guides/getting_started/src/setup_fpga.md#build-an-fpga-bitstream). - Build Verilator simulation binary: ```console bazel build //hw:verilator
diff --git a/doc/contributing/detailed_contribution_guide/README.md b/doc/contributing/detailed_contribution_guide/README.md index c557327..f78ec3d 100644 --- a/doc/contributing/detailed_contribution_guide/README.md +++ b/doc/contributing/detailed_contribution_guide/README.md
@@ -88,7 +88,7 @@ # Overview on Contributing Code Depending on the size and impact of your contribution, it may need to go through the OpenTitan RFC process. -If your contribution is large, cross cutting, or potentially contentious, we will ask you to follow the procedure documented in the [Request for Comments (RFC) Process]({{< relref "doc/project/rfc_process" >}}). +If your contribution is large, cross cutting, or potentially contentious, we will ask you to follow the procedure documented in the [Request for Comments (RFC) Process](../../project_governance/rfc_process.md). If you believe an RFC is not required, a lighter weight process will suffice. Note that if a core committer suggests that a contributor follow the RFC process, you will likely need to do so. @@ -99,7 +99,7 @@ 1. Check if an issue or PR addressing the same matter already exists. If so, consider contributing to the existing issue/PR instead of opening a new one. 2. Assess whether the matter may be security sensitive. - If so, follow the [[Security Issues Process]({{< relref "doc/project/contributing.md#security-issues" >}}). + If so, follow the [[Security Issues Process](../README.md#security-issues). 3. [Create a GitHub issue](#working-with-issues) to raise awareness, start the discussion, and build consensus that the issue needs to be addressed. For more information, refer to [Communication](#communication). 4. Start discussing possible solutions in a smaller group, possibly outside of GitHub, but in a shared document (we typically use Google Docs for convenience) that is linked to the original GitHub issue. @@ -111,14 +111,14 @@ 6. Share the proposal with the wider team and collect feedback. For more information, refer to [Communication](#communication). 7. If the feedback is negative, go back to Step 4. - If agreement with the wider team cannot be found even after a second or third iteration, consider starting the [Request for Comments (RFC) Process]({{< relref "doc/project/rfc_process" >}}). + If agreement with the wider team cannot be found even after a second or third iteration, consider starting the [Request for Comments (RFC) Process](../../project_governance/rfc_process.md). 8. Start implementation and prepare a first PR. Create the PR from a fork rather than making new branches in `github.com/lowRISC/opentitan`. Reference the GitHub issue in your PR description and commit messages (see also [Working with Issues](#working-with-issues), [Writing Code](#writing-code)). To simplify and speed up code review, we expect larger contributions like new features and major changes to be broken into multiple, smaller PRs wherever possible. For more information refer to [Working with PRs](#working-with-pull-requests). -Further information can be found in [Getting Started with a Design]({{< relref "doc/ug/hw_design" >}}) and in [Request for Comments (RFC) Process]({{< relref "doc/project/rfc_process" >}}). +Further information can be found in [Getting Started with a Design](../hw/design.md) and in [Request for Comments (RFC) Process](../../project_governance/rfc_process.md). # Writing Code @@ -205,7 +205,7 @@ Instead, modifications should be discussed and implemented upstream and then be vendored into OpenTitan. However, when dealing with third-party code, please first raise awareness and discuss inside OpenTitan before creating issues and pull requests upstream. -Further information regarding vendor code can be found in the [Vendor Tool User Guide]({{< relref "doc/ug/vendor_hw.md" >}}) +Further information regarding vendor code can be found in the [Vendor Tool User Guide](../hw/vendor.md) # Working with Pull Requests @@ -228,7 +228,7 @@ PRs with more, smaller commits instead of a few large commits simplifies debugging in the case of regressions. -For more detailed information on how to submit a pull request, see our [GitHub notes]({{< relref "doc/ug/github_notes.md" >}}). +For more detailed information on how to submit a pull request, see our [GitHub notes](../github_notes.md). ## What are committers? @@ -306,7 +306,7 @@ Instead, use rebase to restructure your work as a series of logically ordered, atomic patches (`git rebase -i` helps). PRs should not be squashed when merging to keep the individual commits including commit messages making up the PR. -Also see our [GitHub notes]({{< relref "doc/ug/github_notes.md" >}}). +Also see our [GitHub notes](../github_notes.md). ## When to merge a PR after it has been approved?
diff --git a/doc/contributing/dv/methodology/README.md b/doc/contributing/dv/methodology/README.md index 1e58df3..a1693d4 100644 --- a/doc/contributing/dv/methodology/README.md +++ b/doc/contributing/dv/methodology/README.md
@@ -15,7 +15,7 @@ * Formal Property Verification (FPV) For running dynamic simulations, the strategy is to use the [UVM1.2 methodology](https://www.accellera.org/downloads/standards/uvm) on top of a foundation of SystemVerilog based verification to develop constrained-random functional tests. -Each DUT will include within the repository, a UVM testbench, a [testplan]({{< relref "doc/ug/dv_methodology/index.md#testplan" >}}), overall [DV document]({{< relref "doc/ug/dv_methodology/index.md#dv-document" >}}), a suite of tests, and a method to build, run tests and report the current status. +Each DUT will include within the repository, a UVM testbench, a [testplan](./README.md#testplan), overall [DV document](./README.md#dv-document), a suite of tests, and a method to build, run tests and report the current status. For FPV, some DUTs may also include an SV testbench along with design properties captured in the SystemVerilog Assertions (SVA) language. As the project is still in development, the current status will not be completed for all IP, but that is the ultimate goal. See discussion below on tracking progress. @@ -33,10 +33,10 @@ Verification within the OpenTitan project comes in a variety of completion status levels. Some designs are "tapeout ready" while others are still a work in progress. Understanding the status of verification is important to gauge the confidence in the design's advertised feature set. -To that end, we've designated a spectrum of design and verification stages in the [OpenTitan Hardware Development Stages]({{< relref "doc/project/development_stages.md" >}}) document. +To that end, we've designated a spectrum of design and verification stages in the [OpenTitan Hardware Development Stages](../../../project_governance/development_stages.md) document. It defines the verification stages and references where one can find the current verification status of each of the designs in the repository. Splitting the effort in such a way enables the team to pace the development effort and allows the progress to be in lock-step with the design stages. -The list of tasks that are required to be completed to enable the effort to transition from one stage to the next is defined in the [checklists]({{< relref "doc/project/checklist" >}}) document. +The list of tasks that are required to be completed to enable the effort to transition from one stage to the next is defined in the [checklists](../../../project_governance/checklist/README.md) document. Verification is said to be complete when the checklist items for all stages are marked as done. We will explain some of the key items in those checklists in the remainder of this document. @@ -44,7 +44,7 @@ DV effort needs to be well documented to not only provide a detailed description of what tests are being planned and functionality covered, but also how the overall effort is strategized and implemented. The first is provided by the **testplan** document and the second, by the **DV document**. -The [**project status**]({{< relref "doc/project/development_stages.md#indicating-stages-and-making-transitions" >}}) document tracks to progression of the effort through the stages. +The [**project status**](../../../project_governance/development_stages.md#indicating-stages-and-making-transitions) document tracks to progression of the effort through the stages. In addition to these documents, a nightly **regression dashboard** tabulating the test and coverage results will provide ability to track progress towards completion of the verification stages. @@ -64,13 +64,13 @@ * Provide the ability to insert the testplan and coverage plan as tables into the DV document itself, so that all of the required information is in one place * Annotate the nightly regression results to allow us to track our progress towards executing the testplan and coverage collection -The [testplanner]({{< relref "util/dvsim/doc/testplanner.md" >}}) tool provides some additional information on the Hjson testplan anatomy and some of the features and constructs supported. -The [build_docs]({{< relref "doc/ug/documentation" >}}) tool works in conjunction with the `testplanner` tool to enable its insertion into the DV document as a table. +The [testplanner](../../../../util/dvsim/README.md) tool provides some additional information on the Hjson testplan anatomy and some of the features and constructs supported. +The [build_docs](../../../guides/getting_started/src/build_docs.md) tool works in conjunction with the `testplanner` tool to enable its insertion into the DV document as a table. ### DV document The DV document expands the testplan inline, in addition to capturing the overall strategy, intent, the testbench block diagram, a list of interfaces / agents, VIPs, reference models, the functional coverage model, assertions and checkers. It also covers FPV goals, if applicable. -This is written in [Markdown]({{< relref "doc/sg/markdown_usage_style" >}}) and is made available in the corresponding `doc` directory of each DUT. +This is written in [Markdown](../../style_guides/markdown_usage_style.md) and is made available in the corresponding `doc` directory of each DUT. A [template](https://github.com/lowRISC/opentitan/blob/master/hw/dv/doc/dv_doc_template.md) for the DV documentation as well as the testbench block diagram in the OpenTitan team drive (under the 'design verification' directory) are available to help get started. @@ -89,15 +89,15 @@ As is the case with design, we strive for conformity in our verification efforts as well. The motivation for this is not just aesthetics, but also to reap the advantages of [code reuse](#code-reuse), which we rely heavily on. -To help achieve this, we provide a verification starter tool-kit called [uvmdvgen]({{< relref "util/uvmdvgen/doc" >}}). +To help achieve this, we provide a verification starter tool-kit called [uvmdvgen](../../../../util/uvmdvgen/README.md). It can be used to completely auto-generate the complete initial DV environment for a new DUT, including the [documentation](#documentation) pieces (testplan as well as DV document), the complete UVM environment including the testbench, to the collaterals for building and running tests along with some common tests. This significantly helps reduce the development time. It can also be used to auto-generate the initial skeleton source code for building a new reusable verification component for an interface (a complete UVM agent). ### UVM Register Abstraction Layer (RAL) Model -The UVM RAL model for DUTs containing CSRs is auto-generated using the [reggen]({{< relref "util/reggen/doc" >}}) tool. -The specification for capturing the CSRs in the Hjson format can be found in the [Register Tool]({{< relref "doc/rm/register_tool" >}}) documentation. +The UVM RAL model for DUTs containing CSRs is auto-generated using the [reggen](../../../../util/reggen/doc/setup_and_use.md) tool. +The specification for capturing the CSRs in the Hjson format can be found in the [Register Tool](../../../../util/reggen/README.md) documentation. We currently check-in the auto-generated UVM RAL model along with our UVM testbench code and rely on CI checks for consistency. In the future we may move to a flow where it is not checked into the repository, but auto-generated on-the-fly as a part of the simulation. @@ -106,7 +106,7 @@ For a parameterized DUT that may possibly have multiple flavors instantiated in the chip, it would be prohibitively difficult to manually maintain the DV testbenches for all those flavors. To cater to this, we develop a generic UVM testbench and rely on custom tooling to auto-generate the specific parameter sets that are required to undergo the full verification till signoff. <!-- TODO: have this point to TLUL DV document --> -An effort of this sort is planned for verifying the [TileLink XBAR]({{< relref "hw/ip/tlul/doc" >}}). +An effort of this sort is planned for verifying the [TileLink XBAR](../../../../hw/ip/tlul/README.md). ## Code Reuse @@ -115,7 +115,7 @@ ### DV Base Library -We provide an elementary scaffolding / base layer for constructing UVM testbenches via a [DV base library]({{< relref "hw/dv/sv/dv_lib/doc" >}}) of classes to help us get off the ground quickly. +We provide an elementary scaffolding / base layer for constructing UVM testbenches via a [DV base library](../../../../hw/dv/sv/dv_lib/README.md) of classes to help us get off the ground quickly. Most, if not all, testbenches in OpenTitan (whether developed for a comportable IP or not) extend from this library, which provides a common set of features. A UVM testbench feature (stimulus / sequence, checking logic or functional coverage element) that is generic enough to be applicable for use in all testbenches is a valid candidate to be added to the DV base library. By doing so, we improve synergies across our testbenches and reduce the overall development effort & time to market. @@ -124,8 +124,8 @@ ### Comportable IP DV Library -Defining a common ground to develop all OpenTitan IPs as described in the [Comportable IP specification]({{< relref "doc/rm/comportability_specification" >}}) provides us an excellent path to maximize code reuse and shorten the testbench development time even further. -In view of that, we provide the [Comportable IP DV library]({{< relref "hw/dv/sv/cip_lib/doc" >}}) of classes, which themselves extend from DV base library to form the second layer. +Defining a common ground to develop all OpenTitan IPs as described in the [Comportable IP specification](../../hw/comportability/README.md) provides us an excellent path to maximize code reuse and shorten the testbench development time even further. +In view of that, we provide the [Comportable IP DV library](../../../../hw/dv/sv/cip_lib/README.md) of classes, which themselves extend from DV base library to form the second layer. These provide a common set of DV features that are specific to Comportable IPs. The actual UVM testbenches for the Comportable IPs extend from this library as the third and the final layer. @@ -134,13 +134,13 @@ In addition to the above library of classes, there are several common plug-and-play verification components (a.k.a. universal verification components or UVCs) provided for use in testbenches at `hw/dv/sv` location. A few examples of these are as follows: -* [Common interfaces]({{< relref "hw/dv/sv/common_ifs" >}}) -* [DV utilities]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [CSR utilities]({{< relref "hw/dv/sv/csr_utils/doc" >}}) -* [Device memory model]({{< relref "hw/dv/sv/mem_model/doc" >}}) +* [Common interfaces](../../../../hw/dv/sv/common_ifs/README.md) +* [DV utilities](../../../../hw/dv/sv/dv_utils/README.md) +* [CSR utilities](../../../../hw/dv/sv/csr_utils/README.md) +* [Device memory model](../../../../hw/dv/sv/mem_model/README.md) * Interface agents - * [TileLink agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) - * [UART agent]({{< relref "hw/dv/sv/usb20_agent/doc" >}}) + * [TileLink agent](../../../../hw/dv/sv/tl_agent/README.md) + * [UART agent](../../../../hw/dv/sv/usb20_agent/README.md) This is not an exhaustive list since we are still actively developing and adding more such components as we speak. Please navigate to the above code location to find more sure UVCs. @@ -163,8 +163,8 @@ In some IPs, specifically the ones that provide cryptographic functions, we also use open source third party C libraries as reference models to check the behavior of the DUT through DPI-C calls. Each of the IP level DV environments are described in further detail within their own [DV document](#dv-document). -To find all of them, please navigate to this [landing page]({{< relref "hw" >}}). -The [UART DV document]({{< relref "hw/ip/uart/doc/dv" >}}) documentation can be used as a reference. +To find all of them, please navigate to this [landing page](../../../../hw/README.md). +The [UART DV document](../../../../hw/ip/uart/dv/README.md) documentation can be used as a reference. ### Core Ibex Level DV @@ -176,7 +176,7 @@ The chip level DV effort is aimed at ensuring that all of the IPs are integrated correctly into the chip. For IPs that are pre-verified sub-modules, we perform [integration testing](#integration-testing). These are simple functional tests written in C which are cross-compiled and run natively on the Ibex core. -The software compilation flow to enable this is explained in further detail in the [Building Software]({{< relref "doc/getting_started/build_sw" >}}) document. +The software compilation flow to enable this is explained in further detail in the [Building Software](../../../guides/getting_started/src/build_sw.md) document. Further, there is a mechanism for the C test running on the CPU to signal the SystemVerilog testbench the test pass or fail indication based on the observed DUT behavior. We also provide an environment knob to 'stub' the CPU and use a TL agent to drive the traffic via the CPU's data channel instead, in cases where more intensive testing is needed. <!-- TODO: add link to chip DV document --> @@ -185,10 +185,10 @@ ## Key Test Focus Areas When progressing through the verification stages, there are key focus areas or testing activities that are perhaps common across all DUTs. -These are described under [Hardware Verification Stages]({{< relref "doc/project/development_stages#hardware-verification-stages-v" >}}). +These are described under [Hardware Verification Stages](../../../project_governance/development_stages.md#hardware-verification-stages-v). The basic steps are: -### [Progressing towards V1]({{< relref "doc/project/checklist#v1" >}}) +### [Progressing towards V1](../../../project_governance/checklist/README.md#v1) These set of tests (not exhaustive) provide the confidence that the design is ready for vertical integration. @@ -205,7 +205,7 @@ The very first set of real tests validate the SW interface laid out using the regtool. These prove that the SW interface is solid and all assumptions in CSRs in terms of field descriptions and their accessibility are correctly captured and there are no address decode bugs. -### [Progressing towards V2]({{< relref "doc/project/checklist#v2" >}}) +### [Progressing towards V2](../../../project_governance/checklist/README.md#v2) Bulk of testing in this stage focus on functionally testing the DUT. There however are certain categories of tests that may need additional attention. @@ -252,7 +252,7 @@ The level of constraints are then slowly eased to allow deeper state space exploration, until all areas of the DUT are satisfactorily stressed. Stress tests are ideal for bug hunting and closing coverage. -### [Progressing towards V3]({{< relref "doc/project/checklist#v3" >}}) +### [Progressing towards V3](../../../project_governance/checklist/README.md#v3) The main focus of testing at this stage is to meet our [regression](#nightly) and [coverage](#coverage-collection) goals. Apart from that, there are cleanup activities to resolve all pending TODO items in the DV code base and fix all compile and run time warnings (if any) thrown by the simulator tools. @@ -261,7 +261,7 @@ In DV, we follow the same assertion methodology as indicated in the [design methodology]({{< relref "./design.md#assertion-methodology" >}}). Wherever possible, the assertion monitors developed for FPV are reused in UVM testbenches when running dynamic simulations. -An example of this is the [TLUL Protocol Checker]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}). +An example of this is the [TLUL Protocol Checker](../../../../hw/ip/tlul/doc/TlulProtocolChecker.md). Unlike design assertions, in DV assertions are typically created within SV interfaces bound to the DUT. This way assertions and any collateral code don't affect the design, and can reach any internal design signal if needed. @@ -575,7 +575,7 @@ ## FPV -Refer to the [formal verification documentation]({{< relref "hw/formal/doc" >}}). +Refer to the [formal verification documentation](../../../../hw/formal/README.md). ## Security Verification @@ -587,7 +587,7 @@ 1. Countermeasures using common primitives can be verified by the [Security Countermeasure Verification Framework]({{< relref "sec_cm_dv_framework" >}}). 2. The following common countermeasures can be verified by cip_lib. -The steps to enabling them is described in cip_lib [document]({{< relref "hw/dv/sv/cip_lib/doc#security-verification-in-cip_lib" >}}). +The steps to enabling them is described in cip_lib [document](../../../../hw/dv/sv/cip_lib/README.md#security-verification-in-cip_lib). - Bus integrity - Shadowed CSRs - REGWEN CSRs @@ -620,7 +620,7 @@ The feedback in this review flows both ways - the language in the design specification could be made more precise, and missing items in both the design specification and the testplan can be identified and added. This enables the development stages to progress smoothly. -Subsequently, the intermediate transitions within the verification stages are reviewed within the GitHub pull-request made for updating the checklist and the [project status]({{< relref "doc/project/development_stages.md#indicating-stages-and-making-transitions" >}}). +Subsequently, the intermediate transitions within the verification stages are reviewed within the GitHub pull-request made for updating the checklist and the [project status](../../../project_governance/development_stages.md#indicating-stages-and-making-transitions). Finally, after the verification effort is complete, there is a final sign-off review to ensure all checklist items are completed satisfactorily without any major exceptions or open issues. @@ -631,7 +631,7 @@ ## Getting Started with DV The process for getting started with DV involves many steps, including getting clarity on its purpose, setting up the testbench, documentation, etc. -These are discussed in the [Getting Started with DV]({{< relref "doc/getting_started/setup_dv.md" >}}) document. +These are discussed in the [Getting Started with DV](../../../guides/getting_started/src/setup_dv.md) document. ## Pending Work Items
diff --git a/doc/contributing/dv/sec_cm_dv_framework/README.md b/doc/contributing/dv/sec_cm_dv_framework/README.md index 39864ad..00adad2 100644 --- a/doc/contributing/dv/sec_cm_dv_framework/README.md +++ b/doc/contributing/dv/sec_cm_dv_framework/README.md
@@ -155,4 +155,4 @@ It uses the primitive types to anchor all the instances of countermeasure primitives and store all the handles that associate to the interface of the countermeasure primitive in a global location. The framework loops over all the handles and provides a common sequence to check common behavior as well as callback functions that allow users to test any non-standard behavior. -Refer to cip_lib [document]({{< relref "hw/dv/sv/cip_lib/doc#security-verification-in-cip_lib" >}}) at the section - "Security Verification for common countermeasure primitives" for the steps to enable this test in block-level testbench. +Refer to cip_lib [document](../../../../hw/dv/sv/cip_lib/README.md#security-verification-in-cip_lib) at the section - "Security Verification for common countermeasure primitives" for the steps to enable this test in block-level testbench.
diff --git a/doc/contributing/fpga/ref_manual_fpga.md b/doc/contributing/fpga/ref_manual_fpga.md index c600331..59039f0 100644 --- a/doc/contributing/fpga/ref_manual_fpga.md +++ b/doc/contributing/fpga/ref_manual_fpga.md
@@ -4,13 +4,13 @@ This manual provides additional usage details about the FPGA. Specifically, it provides instructions on SW development flows and testing procedures. -Refer to the [FPGA Setup]({{< relref "doc/getting_started/setup_fpga" >}}) guide for more information on initial setup. +Refer to the [FPGA Setup](../../guides/getting_started/src/setup_fpga.md) guide for more information on initial setup. ## FPGA SW Development Flow The FPGA is meant for both boot ROM and general software development. The flow for each is different, as the boot ROM is meant to be fairly static while general software can change very frequently. -However, for both flows, Vivado must be installed, with instructions described [here]({{< relref "doc/getting_started/install_vivado" >}}). +However, for both flows, Vivado must be installed, with instructions described [here](../../guides/getting_started/src/install_vivado/README.md). ### Boot ROM development @@ -46,7 +46,7 @@ $ bazel run //sw/host/opentitantool fpga load-bitstream build/lowrisc_systems_chip_earlgrey_cw310_0.1/synth-vivado/lowrisc_systems_chip_earlgrey_cw310_0.1.bit ``` - The script assumes that there is an existing bitfile `build/lowrisc_systems_chip_earlgrey_cw310_0.1/synth-vivado/lowrisc_systems_chip_earlgrey_cw310_0.1.bit` (this is created after following the steps in [FPGA Setup]({{< relref "doc/getting_started/setup_fpga" >}})). + The script assumes that there is an existing bitfile `build/lowrisc_systems_chip_earlgrey_cw310_0.1/synth-vivado/lowrisc_systems_chip_earlgrey_cw310_0.1.bit` (this is created after following the steps in [FPGA Setup](../../guides/getting_started/src/setup_fpga.md)). The script assumes that there is an existing boot ROM image under `build-bin/sw/device/lib/testing/test_rom` and then creates a new bitfile of the same name at the same location. The original input bitfile is moved to `build/lowrisc_systems_chip_earlgrey_cw310_0.1/synth-vivado/lowrisc_systems_chip_earlgrey_cw310_0.1.bit.orig`.
diff --git a/doc/contributing/github_notes.md b/doc/contributing/github_notes.md index 902b511..c94ffc4 100644 --- a/doc/contributing/github_notes.md +++ b/doc/contributing/github_notes.md
@@ -7,7 +7,7 @@ These notes are for people who intend to contribute back to OpenTitan (based on notes taken by a relatively inexperienced git user). If you don't intend to do this you can simply clone the main repository, instructions are in [install -instructions]({{< relref "doc/getting_started" >}}) and this document can be +instructions](../guides/getting_started/src/README.md) and this document can be ignored. There is much more to using git; a possible next step is to refer to [Resources to learn Git](https://try.github.io/).
diff --git a/doc/contributing/hw/comportability/README.md b/doc/contributing/hw/comportability/README.md index 1b69fe7..a5587bb 100644 --- a/doc/contributing/hw/comportability/README.md +++ b/doc/contributing/hw/comportability/README.md
@@ -119,7 +119,7 @@ Additionally an optional input `devmode` is shown which represents an indication to the peripheral what mode the SOC is operating in. For now this includes only two modes: development (`devmode = 1`) and production (`devmode = 0`). This is the beginning of a security feature that will convey the full life cycle mode status to the peripheral. -In its current form, only the distinction of development mode vs. production mode is required in order to determine how to handle software errors (see the [Register Tooling]({{< relref "doc/rm/register_tool" >}}) documentation for details). +In its current form, only the distinction of development mode vs. production mode is required in order to determine how to handle software errors (see the [Register Tooling](../../../../util/reggen/README.md) documentation for details). The full definition of life cycle modes will come upon further refinement of the security properties of the SOC. ## Peripheral Feature Details @@ -185,7 +185,7 @@ All peripherals use TileLink-UL (TileLink-Uncached-Lite, aka TL-UL) as their interface to the framework. To signify this, the peripheral must have a protocol of `tlul`. The TileLink-UL protocol and its usage within lowRISC devices is given in the -[TileLink-UL Bus Specification]({{< relref "hw/ip/tlul/doc" >}}). +[TileLink-UL Bus Specification](../../../../hw/ip/tlul/README.md). As of this writing, there are no other options, but this field leaves an option for extension in the future. Each entry must also contain a `direction`. @@ -212,7 +212,7 @@ #### Multiplexing Feature and Pad Control -In the top level chip framework there is a [pin multiplexing unit (`pinmux`)]({{< relref "/hw/ip/pinmux/doc" >}}) which provides flexible assignment to/from peripheral IO and chip pin IO. +In the top level chip framework there is a [pin multiplexing unit (`pinmux`)](../../../../hw/ip/pinmux/README.md) which provides flexible assignment to/from peripheral IO and chip pin IO. Comportable peripherals do not designate whether their available IO are hardwired to chip IO, or available for multiplexing. That is done at the top level with an Hjson configuration file. See the top level specification for information about that configuration file. @@ -231,7 +231,7 @@ ### Alerts -Each peripheral has the option of designating output signals as security critical alerts destined for the hardware [alert handler module]({{< relref "/hw/top_earlgrey/ip_autogen/alert_handler/doc" >}}). +Each peripheral has the option of designating output signals as security critical alerts destined for the hardware [alert handler module](../../../../hw/top_earlgrey/ip_autogen/alert_handler/README.md). These are differential signals (to avoid single point of failure) sent to the alert handler for it to send to the processor for first-line defense handling, or hardware security response if the processor does not act. The peripheral lists its collection of alerts with the `alert_list` attribute in the configuration file. For each alert in the full system, a corresponding set of signals will be generated in the alert handler to carry out this communication between alert sender and handler. @@ -329,16 +329,16 @@ ## Register Handling -The definition and handling of registers is a topic all on its own, and is specified in its [own document]({{< relref "doc/rm/register_tool" >}}). +The definition and handling of registers is a topic all on its own, and is specified in its [own document](../../../../util/reggen/README.md). All lowRISC peripheral designs must conform to this register specification. ## Configuration description Hjson The description of the IP block and its registers is done in an Hjson file that is specified in the -[Register Tool document]({{< relref "doc/rm/register_tool" >}}). +[Register Tool document](../../../../util/reggen/README.md). All lowRISC peripheral designs must conform to this configuration and register specification. -A description of Hjson (a variant of json) and the recommended style is in the [Hjson Usage and Style Guide]({{< relref "doc/sg/hjson_usage_style.md" >}}). +A description of Hjson (a variant of json) and the recommended style is in the [Hjson Usage and Style Guide](../../style_guides/hjson_usage_style.md). ### Configuration information in the file @@ -595,7 +595,7 @@ Alerts are another critical and common implementation to standardize for all peripherals. Unlike interrupts, there is no software component to alerts at the peripheral, though there is at the hardware alert handler. -See that [specification]({{< relref "/hw/top_earlgrey/ip_autogen/alert_handler/doc" >}}) for full details. +See that [specification](../../../../hw/top_earlgrey/ip_autogen/alert_handler/README.md) for full details. A general description of the handling of alerts at the hardware level is given here. ### Alerts per Module @@ -671,7 +671,7 @@ Cause registers for fatal alerts must not be clearable in any way and must hence be read-only. The `prim_alert_sender` converts the event into a differentially encoded signal pair to be routed to the hardware alert handler, as dictated by the details in the -[alert handler specification]({{< relref "/hw/top_earlgrey/ip_autogen/alert_handler/doc" >}}). +[alert handler specification](../../../../hw/top_earlgrey/ip_autogen/alert_handler/README.md). The alert handler module is automatically generated to have enough alert ports to represent each alert declared in the different included peripheral IP configuration files. ## Inter Signal Handling @@ -682,7 +682,7 @@ By contrast, many peripherals and the main processing unit in OpenTitan communicate between the modules. For example, `flash_ctrl` sends requests to the flash macro for read/ program/ erase operations. -Inter-module signal aims to handle the connection by the tool [topgen]({{<relref "/doc/rm/topgen_tool" >}}) +Inter-module signal aims to handle the connection by the tool [topgen](../../../../util/topgen/README.md) ### Defining the inter-module signal
diff --git a/doc/contributing/hw/design.md b/doc/contributing/hw/design.md index 71037c4..c699c9e 100644 --- a/doc/contributing/hw/design.md +++ b/doc/contributing/hw/design.md
@@ -3,7 +3,7 @@ --- This document aims to clarify how to get started with a hardware design within the OpenTitan project. -Design in this context nominally refers to a new [Comportable Peripheral]({{< relref "../rm/comportability_specification" >}}) but can include high level constructs like device reset strategy, etc. +Design in this context nominally refers to a new [Comportable Peripheral](./comportability/README.md) but can include high level constructs like device reset strategy, etc. This is primarily aimed at creating a new design from scratch, but has sections on how to contribute to an existing design. It is targeted to RTL designers to give clarity on the typical process for declaring features, finding others to review, etc. We aim for a healthy balance between adding clarity while not over prescribing rules and process. @@ -13,7 +13,7 @@ ## Stages of a Design -The life stages of a design within the OpenTitan are described in the [Hardware Development Stages]({{< relref "doc/project/development_stages.md" >}}) document. +The life stages of a design within the OpenTitan are described in the [Hardware Development Stages](../../project_governance/development_stages.md) document. This separates the life of the design into three broad stages: Specification, In Development, and Signed off. This document attempts to give guidance on how to get going with the first stage and have a smooth transition into the Development stage. They are not hard and fast rules but methods we have seen work well in the project. @@ -27,7 +27,7 @@ This proposal should be in **Google Doc** medium for agile review capability. Ideally this proposal document would be created in the Team Drive, but if the author does not have access to the team drive, they can share a privately-created document. -Design proposals should follow the recommended [RFC (Request for Comment)]({{< relref "../project/rfc_process.md" >}}) process, which handles all such proposals. +Design proposals should follow the recommended [RFC (Request for Comment)](../../project_governance/rfc_process.md) process, which handles all such proposals. If the RFC potentially contains information that could be certification-sensitive (guidance to be shared), send a note to security@opentitan.org first for feedback. The OpenTitan Technical Committee may be able to suggest other collaborators to help with early stage review. @@ -37,14 +37,14 @@ ## Detailed Specification Once past initial review of the feature set and high level description, as well as potential security review, the full detailed specification should be completed, still in Google Doc form. -The content, form, and format are discussed in the [design methodology]({{< relref "design.md" >}}) and [documentation methodology]({{< relref "doc/sg/markdown_usage_style.md" >}}) guides. +The content, form, and format are discussed in the [design methodology](./methodology.md) and [documentation methodology](../style_guides/markdown_usage_style.md) guides. The outcome of this process should be a specification that is ready for further detailed review by other project members. The content and the status of the proposal can be shared with the team. An example of a canonical detailed specification is the pinmux specification which can be found in the TeamDrive under TechnicalSpecifications --> deprecated, for those that have access to that resource. (Google Docs that have been converted into Markdown on GitHub are archived here). -Note that when developing OpenTitan security IP, designers should follow the [Secure Hardware Design Guidelines]({{< relref "doc/security/implementation_guidelines/hardware" >}}). +Note that when developing OpenTitan security IP, designers should follow the [Secure Hardware Design Guidelines](../../security/implementation_guidelines/hardware/README.md). ## Specification Publication @@ -60,12 +60,12 @@ One recommended method is as follows: * Start with a skeleton that includes a complete or near-complete definition of the register content in Hjson format * Combine with a basic Markdown including that file -* Combine with an IP-top-level Verilog module that instantiates the auto-generated register model (see the [register tool documentation]({{< relref "../rm/register_tool" >}})), includes all of the known IP-level IO, clocking and reset. +* Combine with an IP-top-level Verilog module that instantiates the auto-generated register model (see the [register tool documentation](../../../util/reggen/README.md)), includes all of the known IP-level IO, clocking and reset. This is not mandatory but allows the basics to come in first with one review, and the full custom details over time. Regardless the first check-ins of course should be compilable, syntax error free, [coding style guide](https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md) -friendly, [Comportability]({{< relref "../rm/comportability_specification" >}}) equivalent, etc., as indicated by the [design methodology user guide]({{< relref "design.md" >}}). +friendly, [Comportability](./comportability/README.md) equivalent, etc., as indicated by the [design methodology user guide](./methodology.md). A good example of an initial skeleton design can be seen in [Pull Request #166](https://github.com/lowRISC/opentitan/pull/166) for the AES module. @@ -77,7 +77,7 @@ ## Full Design -As the design develops within the OpenTitan repository, it transitions into "D0", "D1", etc., [design stages]({{< relref "doc/project/development_stages.md" >}}) and will be eventually plugged into the top level. +As the design develops within the OpenTitan repository, it transitions into "D0", "D1", etc., [design stages](../../project_governance/development_stages.md) and will be eventually plugged into the top level. Following the recommended best practices for digestible pull requests suggests that continuing to stage the design from the initial skeleton into the full featured design is a good way to make steady progress without over-burdening the reviewers. ## Top Level Inclusion
diff --git a/doc/contributing/hw/methodology.md b/doc/contributing/hw/methodology.md index bc89b07..8d4926d 100644 --- a/doc/contributing/hw/methodology.md +++ b/doc/contributing/hw/methodology.md
@@ -12,7 +12,7 @@ All IP should be developed and delivered under the feature set described by this style guide. Inconsistencies or lack of clarity within the style guide should be solved by filing and helping close an issue on the style guide in the [lowrisc/style-guides GitHub repo](https://github.com/lowRISC/style-guides). -Note that when developing OpenTitan security IP, designers should additionally follow the [Secure Hardware Design Guidelines]({{< relref "doc/security/implementation_guidelines/hardware" >}}). +Note that when developing OpenTitan security IP, designers should additionally follow the [Secure Hardware Design Guidelines](../../security/implementation_guidelines/hardware/README.md). For professional tooling, the team has chosen several industry-grade tools for its design signoff process. Wherever possible we attempt to remain tool-agnostic, but we must choose a selection of tools as our ground truth for our own confidence of signoff-level assurances. @@ -22,7 +22,7 @@ ## Comportability and the Importance of Architectural Conformity The OpenTitan program is adopting a design methodology aimed at unifying as much as possible the interfaces between individual designs and the rest of the SOC. -These are detailed in the [Comportability Specification]({{< relref "doc/rm/comportability_specification" >}}). +These are detailed in the [Comportability Specification](./comportability/README.md). This document details how peripheral IP interconnects with the embedded processor, the chip IO, other designs, and the security infrastructure within the SOC. Not all of the details are complete at this time, but will be tracked and finalized within that specification. @@ -36,7 +36,7 @@ Designs within the OpenTitan project come in a variety of completion status levels. Some designs are "tapeout ready" while others are still a work in progress. Understanding the status of a design is important to gauge the confidence in its advertised feature set. -To that end, we've designated a spectrum of design stages in the [OpenTitan Hardware Development Stages]({{< relref "doc/project/development_stages.md" >}}) document. +To that end, we've designated a spectrum of design stages in the [OpenTitan Hardware Development Stages](../../project_governance/development_stages.md) document. This document defines the design stages and references where one can find the current status of each of the designs in the repository. ## Documentation @@ -46,23 +46,23 @@ The first is the [Hugo](https://gohugo.io) tool, which converts an annotated Markdown file into a rendered HTML file (including this document). See the linked manual for information about the annotations and how to use it to create enhanced auto-generated additions to standard Markdown files. -To automate the process a script [build_docs.py]({{< relref "doc/ug/documentation" >}}) is provided for generating the documentation. +To automate the process a script [build_docs.py](../../guides/getting_started/src/build_docs.md) is provided for generating the documentation. -The second is the [reggen]({{< relref "doc/rm/register_tool" >}}) register tool that helps define the methodology and description language for specifying hardware registers. +The second is the [reggen](../../../util/reggen/README.md) register tool that helps define the methodology and description language for specifying hardware registers. These descriptions are used by `build_docs.py` to ensure that the technical specifications for the IP are accurate and up to date with the hardware being built. Underlying and critical to this tooling is the human-written content that goes into the source Markdown and register descriptions. Clarity and consistency is key. -See the [Markdown Style Guide]({{< relref "doc/sg/markdown_usage_style.md" >}}) for details and guidelines on the description language. +See the [Markdown Style Guide](../style_guides/markdown_usage_style.md) for details and guidelines on the description language. ## Usage of Register Tool One design element that is prime for consistent definitions and usages is in the area of register definitions. Registers are critical, being at the intersection of hardware and software, where uniformity can reduce confusion and increase re-usability. -The [register tool]({{< relref "doc/rm/register_tool" >}}) used within OpenTitan is custom for the project's needs, but flexible to add new features as they arise. +The [register tool](../../../util/reggen/README.md) used within OpenTitan is custom for the project's needs, but flexible to add new features as they arise. It attempts to stay lightweight yet solve most of the needs in this space. The description language (using HJSON format) described within that specification also details other features described in the -[Comportability Specification]({{< relref "doc/rm/comportability_specification" >}}). +[Comportability Specification](./comportability/README.md). ## Linting Methodology @@ -73,9 +73,9 @@ ### Semantic Linting using Verilator (Open Source) -The Verilator tool is open source, thus enabling all project contributors to conveniently download, install and run the tool locally as described [in the installation instructions]({{< relref "doc/getting_started/setup_verilator" >}}), without the need for buying a lint tool license. +The Verilator tool is open source, thus enabling all project contributors to conveniently download, install and run the tool locally as described [in the installation instructions](../../guides/getting_started/src/setup_verilator.md), without the need for buying a lint tool license. -For developers of design IP, the recommendation is thus to set up the Verilator lint flow for their IP as described in the [Lint Flow README]({{< relref "hw/lint/doc" >}}). +For developers of design IP, the recommendation is thus to set up the Verilator lint flow for their IP as described in the [Lint Flow README](../../../hw/lint/README.md). Developers should run their code through the Verilator lint tool before creating a design pull request. Linting errors and warnings can be closed by fixing the code in question (preferred), or waiving the error. These waivers have to be reviewed as part of the pull request review process. @@ -87,7 +87,7 @@ To complement the Verilator lint explained above, we also leverage the Verible style linter, which captures different aspects of the code and detects style elements that are in violation of our [Verilog Style Guide](https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md). The tool is open source and freely available on the [Verible GitHub page](https://github.com/google/verible/). -Hence, we recommend IP designers install the tool as described [here]({{< relref "doc/getting_started#step-6a-install-verible-optional" >}}) and in the [Lint Flow README]({{< relref "hw/lint/doc" >}}), and use the flow locally to close the errors and warnings. +Hence, we recommend IP designers install the tool as described [here](../../guides/getting_started/src/README.md#step-6a-install-verible-optional) and in the [Lint Flow README](../../../hw/lint/README.md), and use the flow locally to close the errors and warnings. Developers should run their code through the Verible style lint tool before creating a design pull request. Linting errors and warnings can be closed by fixing the code in question (preferred), or waiving the error. @@ -106,14 +106,14 @@ However, the _"lowRISC Lint Rules"_ are available as part of the default policies in AscentLint release 2019.A.p3 or newer (as `LRLR-v1.0.policy`). This allows designers with access to this tool to run the lint flow locally on their premises. -If developers of design IP have access to AscentLint, we recommend to set up the AscentLint flow for their IP as described in the [Lint Flow README]({{< relref "hw/lint/doc" >}}), and use the flow locally to close the errors and warnings. +If developers of design IP have access to AscentLint, we recommend to set up the AscentLint flow for their IP as described in the [Lint Flow README](../../../hw/lint/README.md), and use the flow locally to close the errors and warnings. Linting errors and warnings can be closed by fixing the code in question (preferred), or waiving the error. These waivers have to be reviewed as part of the pull request review process. Note that our continuous integration infrastructure does not currently run AscentLint on each pull request as it does with Verilator lint. However, all designs with enabled AscentLint targets on the master branch will be run through the tool in eight-hour intervals and the results are published as part of the tool dashboards on the [hardware IP overview page](https://docs.opentitan.org/hw), enabling designers to close the lint errors and warnings even if they cannot run the sign-off tool locally. -Goals for sign-off linting closure per design development stage are given in the [OpenTitan Development Stages]({{< relref "doc/project/development_stages" >}}) document. +Goals for sign-off linting closure per design development stage are given in the [OpenTitan Development Stages](../../project_governance/development_stages.md) document. Note that cases may occur where the open-source and the sign-off lint tools both output a warning/error that is difficult to fix in RTL in a way that satisfies both tools at the same time. In those cases, priority shall be given to the RTL fix that satisfies the sign-off lint tool, and the open-source tool message shall be waived. @@ -126,7 +126,7 @@ Within OpenTitan we attempt to maintain uniformity in assertion style and syntax using SystemVerilog Assertions and a list of common macros. An overview of the included macros and how to use them is given in this -[Design Assertion README file]({{< relref "hw/formal/doc" >}}). +[Design Assertion README file](../../../hw/formal/README.md). This document also describes how to formally verify assertions using [JasperGold](https://www.cadence.com/content/cadence-www/global/en_US/home/tools/system-design-and-verification/formal-and-static-verification/jasper-gold-verification-platform/formal-property-verification-app.html) from the company Cadence. @@ -192,7 +192,7 @@ At the moment, all generated code is checked in with the source files. The pros and cons of this decision are still being discussed, and the decision may be reversed, to be replaced with an over-arching build-all script to prepare a final design as source files changed. Until that time, all generated files (see for example the output files from the -[register generation tool]({{< relref "doc/rm/register_tool" >}})) +[register generation tool](../../../util/reggen/README.md)) are checked in. There is an over-arching build file in the repository under `hw/Makefile` that builds all of the `regtool` content. This is used by an Azure Pipelines pre-submit check script to ensure that the source files produce a generated file that is identical to the one being submitted. @@ -206,7 +206,7 @@ However, the tool is mature enough for manual use on individual files (i.e., certain edits may have to be manually amended after using it). The tool is open source and freely available on the [Verible GitHub page](https://github.com/google/verible/). -Hence, we encourage IP designers to install the tool as described [here]({{< relref "doc/getting_started#step-6a-install-verible-optional" >}}), and run their code through the formatter tool before creating a design pull request. +Hence, we encourage IP designers to install the tool as described [here](../../guides/getting_started/src/README.md#step-6a-install-verible-optional), and run their code through the formatter tool before creating a design pull request. The tool can be invoked on specific SystemVerilog files with the following command: ```shell @@ -221,7 +221,7 @@ ## Getting Started Designing Hardware The process for getting started with a design involves many steps, including getting clarity on its purpose, its feature set, authorship, documentation, etc. -These are discussed in the [Getting Started Designing Hardware]({{< relref "hw_design.md" >}}) document. +These are discussed in the [Getting Started Designing Hardware](./design.md) document. ## FPGA vs Silicon
diff --git a/doc/contributing/style_guides/README.md b/doc/contributing/style_guides/README.md index 3b4ae41..0bf80f9 100644 --- a/doc/contributing/style_guides/README.md +++ b/doc/contributing/style_guides/README.md
@@ -5,11 +5,11 @@ OpenTitan's CI enforces what it can of the following style guides to avoid conflict, toil and confusion. However, code reviewers are also responsible for enforcing coding style guidelines and best practices. -- [RISC-V Assembly Style Guide]({{< relref "asm_coding_style" >}}) -- [C and C++ Coding Style Guide]({{< relref "c_cpp_coding_style" >}}) -- [Hjson Usage and Style Guide]({{< relref "hjson_usage_style" >}}) -- [Markdown Usage and Style Guide]({{< relref "markdown_usage_style" >}}) -- [OTBN Assembly Style Guide]({{< relref "otbn_style_guide" >}}) -- [Python Coding Style Guide]({{< relref "python_coding_style" >}}) +- [RISC-V Assembly Style Guide](./asm_coding_style.md) +- [C and C++ Coding Style Guide](./c_cpp_coding_style.md) +- [Hjson Usage and Style Guide](./hjson_usage_style.md) +- [Markdown Usage and Style Guide](./markdown_usage_style.md) +- [OTBN Assembly Style Guide](./otbn_style_guide.md) +- [Python Coding Style Guide](./python_coding_style.md) - [Verilog Coding Style Guide](https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md) - [SystemVerilog Coding Style Guide for Design Verification (DV)](https://github.com/lowRISC/style-guides/blob/master/DVCodingStyle.md)
diff --git a/doc/contributing/style_guides/asm_coding_style.md b/doc/contributing/style_guides/asm_coding_style.md index 567b2bb..daf16f9 100644 --- a/doc/contributing/style_guides/asm_coding_style.md +++ b/doc/contributing/style_guides/asm_coding_style.md
@@ -190,7 +190,7 @@ Every function-like label which is meant to be called like a function (*especially* `.global`s) should be given a Doxygen-style comment. While Doxygen is not suited for assembly, that style should be used for consistency. -See the [C/C++ style guide]({{< relref "c_cpp_coding_style" >}}) for more information. +See the [C/C++ style guide](./c_cpp_coding_style.md) for more information. Comments should be indented to match the line immediately after. For example: ```S
diff --git a/doc/contributing/style_guides/c_cpp_coding_style.md b/doc/contributing/style_guides/c_cpp_coding_style.md index f63d292..00e9925 100644 --- a/doc/contributing/style_guides/c_cpp_coding_style.md +++ b/doc/contributing/style_guides/c_cpp_coding_style.md
@@ -492,7 +492,7 @@ ### `volatile` Type Qualifier Do not use `volatile` in production, i.e. non-test, silicon creator code unless you are implementing a library explicitly for this purpose like `sec_mmio`, `abs_mmio`, or `hardened`. -See [guidance for volatile]({{< relref "guidance_for_volatile" >}}) for more details. +See [guidance for volatile](./guidance_for_volatile.md) for more details. When in doubt, please do not hesitate to reach out by creating a GitHub issue (preferably with the "Type:Question" label). ### Nonstandard Attributes
diff --git a/doc/contributing/style_guides/markdown_usage_style.md b/doc/contributing/style_guides/markdown_usage_style.md index f7e3683..2df274a 100644 --- a/doc/contributing/style_guides/markdown_usage_style.md +++ b/doc/contributing/style_guides/markdown_usage_style.md
@@ -268,7 +268,7 @@ # Overview This document specifies Name hardware IP functionality. -This module conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification" >}}) +This module conforms to the [Comportable guideline for peripheral functionality.](../hw/comportability/README.md) See that document for integration overview within the broader top level system. ## Features
diff --git a/doc/contributing/style_guides/otbn_style_guide.md b/doc/contributing/style_guides/otbn_style_guide.md index 976b1e9..3f133e2 100644 --- a/doc/contributing/style_guides/otbn_style_guide.md +++ b/doc/contributing/style_guides/otbn_style_guide.md
@@ -2,7 +2,7 @@ title: "OTBN Assembly Style Guide" --- -Where possible, OTBN assembly should follow the same principles as the [RISC-V assembly style guide]({{< relref "asm_coding_style" >}}). +Where possible, OTBN assembly should follow the same principles as the [RISC-V assembly style guide](./asm_coding_style.md). This guide describes additional OTBN-specific guidelines, and places where OTBN assembly can or should diverge from the RISC-V style guidelines. ## General Advice
diff --git a/doc/contributing/sw/device_interface_functions.md b/doc/contributing/sw/device_interface_functions.md index 581b0d0..8f5eb4c 100644 --- a/doc/contributing/sw/device_interface_functions.md +++ b/doc/contributing/sw/device_interface_functions.md
@@ -19,8 +19,8 @@ #### Language -DIFs **must** be written in C, specifically [C11 (with a few allowed extensions)]({{< relref "doc/sg/c_cpp_coding_style.md#c-style-guide" >}}). -DIFs **must** conform to the style guide in [`sw/device/lib/dif`]({{< relref "sw/device/lib/dif" >}}). +DIFs **must** be written in C, specifically [C11 (with a few allowed extensions)](../style_guides/c_cpp_coding_style.md#c-style-guide). +DIFs **must** conform to the style guide in [`sw/device/lib/dif`](../../../sw/device/lib/dif/README.md). DIFs **must** only depend on: @@ -121,7 +121,7 @@ Each hardware IP block also contains a "programmers' guide" section, which tells programmers how to use the hardware interfaces correctly, using prose descriptions and relevant diagrams. The prose descriptions should include references to relevant DIF functions. -Programmers' guides **should** primarily refer to the [Software API Documentation]({{< relref "/sw#opentitan-software-api-documentation" >}}). +Programmers' guides **should** primarily refer to the [Software API Documentation](../../../sw/README.md#opentitan-software-api-documentation). Programmers' guides **should not** contain standalone examples that do not match how we implement DIFs and can become out of date. The software API documentation includes full source code of the respective DIFs, should extra clarity be needed to explain how a hardware interface should be used. @@ -153,7 +153,7 @@ ### DIF Development Stages As part of the DIF Standardisation process, we've decided to establish more concrete DIF lifecycle stages. -These are documented with the [Development Stages]({{< relref "doc/project/development_stages.md" >}}). +These are documented with the [Development Stages](../../project_governance/development_stages.md). In the hardware world, there are checklists for establishing that each stage is complete and the next stage can be moved to.
diff --git a/doc/contributing/sw/otbn_sw.md b/doc/contributing/sw/otbn_sw.md index 661bde2..6640d39 100644 --- a/doc/contributing/sw/otbn_sw.md +++ b/doc/contributing/sw/otbn_sw.md
@@ -3,7 +3,7 @@ --- OTBN is the OpenTitan Big Number accelerator and this document describes how to write and build software for it. -The [OTBN reference manual]({{< relref "hw/ip/otbn/doc" >}}) describes the hardware and associated ISA. +The [OTBN reference manual](../../../hw/ip/otbn/README.md) describes the hardware and associated ISA. Since OTBN is designed for cryptographic offload, not general computation, it has no C compiler. However, it does have the usual binutils programs: an assembler, linker and disassembler. @@ -12,12 +12,12 @@ ## Assembly format and examples -The OTBN ISA and programmer model are described in the [OTBN reference manual]({{< relref "hw/ip/otbn/doc" >}}). +The OTBN ISA and programmer model are described in the [OTBN reference manual](../../../hw/ip/otbn/README.md). In particular, note that the register `x1` has special stack-like behaviour. There are some example programs at `sw/otbn/code-snippets`. These range from simple examples of how to use pseudo-operations up to example cryptographic primitives. -For specific formatting and secure coding guidelines, see the [OTBN style guide]({{< relref "doc/sg/otbn_style_guide" >}}). +For specific formatting and secure coding guidelines, see the [OTBN style guide](../style_guides/otbn_style_guide.md). ## The tools
diff --git a/doc/contributing/system_list.md b/doc/contributing/system_list.md index 3cce4b1..9744c85 100644 --- a/doc/contributing/system_list.md +++ b/doc/contributing/system_list.md
@@ -7,6 +7,6 @@ | Design | Internal Name | Simulation Targets | FPGA Targets | ASIC Targets | Description | |--------|---------------|--------------------|--------------|--------------|-------------| -| [Earl Grey]({{< relref "hw/top_earlgrey/doc" >}}) | `top_earlgrey` | Verilator | ChipWhisperer CW310\* | *None yet.* | 0.1 release | +| [Earl Grey](../../hw/top_earlgrey/doc/specification.md) | `top_earlgrey` | Verilator | ChipWhisperer CW310\* | *None yet.* | 0.1 release | `*` There exists a modified version of the Earl Grey top-level design that can be implemented on the ChipWhisperer CW305 FPGA board usable with a free EDA tool license.
diff --git a/doc/guides/getting_started/src/README.md b/doc/guides/getting_started/src/README.md index 1b368c3..9d95009 100644 --- a/doc/guides/getting_started/src/README.md +++ b/doc/guides/getting_started/src/README.md
@@ -164,13 +164,13 @@ In order to run the software, we need to have some way to emulate an OpenTitan chip. There are a few different options depending on your equipment and use-case. Follow the guide(s) that applies to you: -* **Option 1 (Verilator setup, recommended for new users):** [Verilator guide]({{< relref "setup_verilator.md" >}}), or -* Option 2 (FPGA setup): [FPGA guide]({{< relref "setup_fpga.md" >}}), or -* Option 3 (design verification setup): [DV guide]({{< relref "setup_dv.md" >}}) +* **Option 1 (Verilator setup, recommended for new users):** [Verilator guide](./setup_verilator.md), or +* Option 2 (FPGA setup): [FPGA guide](./setup_fpga.md), or +* Option 3 (design verification setup): [DV guide](./setup_dv.md) ## Step 5: Build OpenTitan Software -Follow the [dedicated guide]({{< relref "build_sw" >}}) to build OpenTitan's software and run tests. +Follow the [dedicated guide](./build_sw.md) to build OpenTitan's software and run tests. ## Step 6: Optional Additional Steps @@ -189,7 +189,7 @@ ### Step 6a: Install Verible (optional) Verible is an open source SystemVerilog style linter and formatting tool. -The style linter is relatively mature and we use it as part of our [RTL design flow]({{< relref "doc/ug/design" >}}). +The style linter is relatively mature and we use it as part of our [RTL design flow](../../../contributing/hw/methodology.md). The formatter is still under active development, and hence its usage is more experimental in OpenTitan. You can download and build Verible from scratch as explained on the [Verible GitHub page](https://github.com/google/verible/). @@ -226,11 +226,11 @@ ### Step 6b: Install OpenOCD (optional) -See the [OpenOCD install guide]({{< relref "install_openocd.md" >}}). +See the [OpenOCD install guide](./install_openocd.md). ### Step 6c: Set up formal verification (optional) -See the [formal verification setup guide]({{< relref "setup_formal.md" >}}) +See the [formal verification setup guide](./setup_formal.md) ### Step 6d: Set up Siemens Questa (optional)  @@ -246,16 +246,16 @@ ### General * [Documentation Index]({{< relref "doc/_index.md" >}}) -* [Directory Structure]({{< relref "doc/ug/directory_structure.md" >}}) -* [GitHub Notes]({{< relref "doc/ug/github_notes.md" >}}) -* [Building Documentation]({{< relref "doc/ug/documentation.md" >}}) -* [Design Methodology within OpenTitan]({{< relref "doc/ug/design.md" >}}) +* [Directory Structure](../../../contributing/directory_structure.md) +* [GitHub Notes](../../../contributing/github_notes.md) +* [Building Documentation](./build_docs.md) +* [Design Methodology within OpenTitan](../../../contributing/hw/methodology.md) ### Hardware -* [Designing Hardware]({{< relref "doc/ug/hw_design.md" >}}) -* [OpenTitan Hardware]({{< relref "/hw" >}}) +* [Designing Hardware](../../../contributing/hw/design.md) +* [OpenTitan Hardware](../../../../hw/README.md) ### Software -* [OpenTitan Software]({{< relref "/sw" >}}) +* [OpenTitan Software](../../../../sw/README.md) * [Writing and Building Software for OTBN]({{< relref "otbn_sw.md" >}}) * [Rust for Embedded C Programmers]({{< relref "rust_for_c.md" >}})
diff --git a/doc/guides/getting_started/src/build_docs.md b/doc/guides/getting_started/src/build_docs.md index 6e34691..a0d8fd0 100644 --- a/doc/guides/getting_started/src/build_docs.md +++ b/doc/guides/getting_started/src/build_docs.md
@@ -4,7 +4,7 @@ The documentation for OpenTitan is available [online](https://docs.opentitan.org). The creation of documentation is mainly based around the conversion from Markdown to HTML files with [Hugo](https://gohugo.io/). -Rules for how to write correct Markdown files can be found in the [reference manual]({{< relref "doc/sg/markdown_usage_style.md" >}}). +Rules for how to write correct Markdown files can be found in the [reference manual](../../../contributing/style_guides/markdown_usage_style.md). ## Building locally
diff --git a/doc/guides/getting_started/src/build_sw.md b/doc/guides/getting_started/src/build_sw.md index 6cf97dd..918f2c9 100644 --- a/doc/guides/getting_started/src/build_sw.md +++ b/doc/guides/getting_started/src/build_sw.md
@@ -6,8 +6,8 @@ _Before following this guide, make sure you have read the_: * main [Getting Started]({{< relref "getting_started" >}}) instructions, -* install Verilator section of the [Verilator guide]({{< relref "setup_verilator.md" >}}), and -* [OpenTitan Software]({{< relref "sw/" >}}) documentation. +* install Verilator section of the [Verilator guide](./setup_verilator.md), and +* [OpenTitan Software](../../../../sw/README.md) documentation. All OpenTitan software is built with [Bazel](https://bazel.build/). Additionally, _most_ tests may be run with Bazel too. @@ -98,12 +98,12 @@ On-host tests are compiled and run on the host machine, while on-device tests are compiled and run on (simulated/emulated) OpenTitan hardware. Examples of on-host tests are: -* unit tests for device software, such as [DIF]({{< relref "/sw/device/lib/dif" >}}) and [ROM]({{< relref "/sw/device/silicon_creator/rom/docs/" >}}) unit tests. +* unit tests for device software, such as [DIF](../../../../sw/device/lib/dif/README.md) and [ROM](../../../../sw/device/silicon_creator/rom/README.md) unit tests. * any test for host software, such as `opentitan{lib,tool}`. Examples of on-device tests are: -* [chip-level tests]({{< relref "/sw/device/tests/index.md" >}}). -* [ROM functional tests]({{< relref "/sw/device/silicon_creator/rom/docs/" >}}) +* [chip-level tests](../../../../sw/device/tests/README.md). +* [ROM functional tests](../../../../sw/device/silicon_creator/rom/README.md) Test target names normally match file names (for instance, `//sw/device/tests:uart_smoketest` corresponds to `sw/device/test/uart_smoketest.c`). You can see all tests available under a given directory using `bazel query`, e.g.: @@ -161,11 +161,11 @@ bazel query 'attr(tags, cw310, tests(//sw/device/tests/...))' ``` -For more information, please refer to the [Verilator]({{< relref "setup_verilator" >}}) and/or [FPGA]({{< relref "setup_fpga" >}}) setup instructions. +For more information, please refer to the [Verilator](./setup_verilator.md) and/or [FPGA](./setup_fpga.md) setup instructions. ### Running on-host DIF Tests -The Device Interface Function or [DIF]({{< relref "/sw/device/lib/dif" >}}) libraries contain unit tests that run on the host and are built and run with Bazel. +The Device Interface Function or [DIF](../../../../sw/device/lib/dif/README.md) libraries contain unit tests that run on the host and are built and run with Bazel. As shown below, you may use Bazel to query which tests are available, build and run all tests, or build and run only one test. #### Querying which tests are available @@ -186,7 +186,7 @@ ### Running on-host ROM Tests -Similar to the DIF libraries, you can query, build, and run all the [ROM]({{< relref "/sw/device/silicon_creator/rom/docs/" >}}) unit tests (which also run on the host) with Bazel. +Similar to the DIF libraries, you can query, build, and run all the [ROM](../../../../sw/device/silicon_creator/rom/README.md) unit tests (which also run on the host) with Bazel. #### Querying which (on-host) tests are available Note, the ROM has both on-host and on-device tests. @@ -210,7 +210,7 @@ ### Bazel-built Software Artifacts -As described in the [OpenTitan Software]({{< relref "sw/" >}}) documentation, there are three categories of OpenTitan software, all of which are built with Bazel. These include: +As described in the [OpenTitan Software](../../../../sw/README.md) documentation, there are three categories of OpenTitan software, all of which are built with Bazel. These include: 1. _device_ software, 1. _OTBN_ software, 1. _host_ software,
diff --git a/doc/guides/getting_started/src/setup_dv.md b/doc/guides/getting_started/src/setup_dv.md index 088bcf3..7b3b683 100644 --- a/doc/guides/getting_started/src/setup_dv.md +++ b/doc/guides/getting_started/src/setup_dv.md
@@ -8,11 +8,11 @@ This document aims to enable a contributor to get started with a design verification (DV) effort within the OpenTitan project. While most of the focus is on development of a testbench from scratch, it should also be useful to understand how to contribute to an existing effort. -Please refer to the [DV methodology]({{< relref "doc/ug/dv_methodology" >}}) document for information on how design verification is done in OpenTitan. +Please refer to the [DV methodology](../../../contributing/dv/methodology/README.md) document for information on how design verification is done in OpenTitan. ## Stages of DV -The life stages of a design / DV effort within the OpenTitan are described in the [Hardware Development Stages]({{< relref "doc/project/development_stages.md" >}}) document. +The life stages of a design / DV effort within the OpenTitan are described in the [Hardware Development Stages](../../../project_governance/development_stages.md) document. It separates the life of DV into three broad stages: Initial Work, Under Test and Testing Complete. This document attempts to give guidance on how to get going with the first stage and have a smooth transition into the Under Test stage. They are not hard and fast rules but methods we have seen work well in the project. @@ -21,9 +21,9 @@ ## Getting Started -The very first thing to do in any DV effort is to [document the plan]({{< relref "doc/ug/dv_methodology#documentation" >}}) detailing the overall effort. +The very first thing to do in any DV effort is to [document the plan](../../../contributing/dv/methodology/README.md#documentation) detailing the overall effort. This is done in conjunction with developing the initial testbench. -It is recommended to use the [uvmdvgen]({{< relref "util/uvmdvgen/doc" >}}) tool, which serves both needs. +It is recommended to use the [uvmdvgen](../../../../util/uvmdvgen/README.md) tool, which serves both needs. The `uvmdvgen` tool provides the ability to generate the outputs in a specific directory. This should be set to the root of the DUT directory where the `rtl` directory exists. @@ -35,20 +35,20 @@ ## Documentation and Initial Review -The skeleton [DV document]({{< relref "doc/ug/dv_methodology#dv-document" >}}) and the [Hjson testplan]({{< relref "doc/ug/dv_methodology#testplan" >}}) should be addressed first. +The skeleton [DV document](../../../contributing/dv/methodology/README.md#dv-document) and the [Hjson testplan](../../../contributing/dv/methodology/README.md#testplan) should be addressed first. The DV documentation is not expected to be completed in full detail at this point. However, it is expected to list all the verification components needed and depict the planned testbench as a block diagram. Under the 'design verification' directory in the OpenTitan team drive, some sample testbench block diagrams are available in the `.svg` format, which can be used as a template. The Hjson testplan, on the other hand, is required to be completed. -Please refer to the [testplanner tool]({{< relref "util/dvsim/doc/testplanner.md" >}}) documentation for additional details on how to write the Hjson testplan. +Please refer to the [testplanner tool](../../../../util/dvsim/README.md) documentation for additional details on how to write the Hjson testplan. Once done, these documents are to be reviewed with the designer(s) and other project members for completeness and clarity. ## UVM RAL Model -Before running any test, the [UVM RAL model]({{< relref "doc/ug/dv_methodology#uvm-register-abstraction-layer-ral-model" >}}) needs to exist (if the design contains CSRs). -The [DV simulation flow]({{< relref "hw/dv/tools/doc" >}}) has been updated to generate the RAL model automatically at the start of the simulation. +Before running any test, the [UVM RAL model](../../../contributing/dv/methodology/README.md#uvm-register-abstraction-layer-ral-model) needs to exist (if the design contains CSRs). +The [DV simulation flow](../../../../util/dvsim/README.md) has been updated to generate the RAL model automatically at the start of the simulation. As such, nothing extra needs to be done. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ```console $ util/regtool.py -s -t /path-to-dv /path-to-module/data/<dut>.hjson ``` @@ -58,7 +58,7 @@ ## Supported Simulators The use of advanced verification constructs such as SystemVerilog classes (on which UVM is based on) requires commercial simulators. -The [DV simulation flow]({{< relref "hw/dv/tools/doc" >}}) fully supports Synopsys VCS. +The [DV simulation flow](../../../../util/dvsim/README.md) fully supports Synopsys VCS. There is support for Cadence Xcelium as well, which is being slowly ramped up. ## Building and Running Tests @@ -78,19 +78,19 @@ To dump waves from the simulation, pass the `--waves <format>` argument to `dvsim.py`. If you are using Verdi for waveform viewing, then '--waves fsdb' is probably the best option. For use with other viewers, '--waves shm' is probably the best choice for Xcelium, and '--waves vpd' with vcs. -Please refer to the [DV simulation flow]({{< relref "hw/dv/tools/doc" >}}) for additional details. +Please refer to the [DV simulation flow](../../../../util/dvsim/README.md) for additional details. The `uvmdvgen` script also enables the user to run the full suite of CSR tests, if the DUT does have CSRs in it. The most basic CSR power-on-reset check test can be run by invoking: ```console $ util/dvsim/dvsim.py path/to/<dut>_sim_cfg.hjson -i <dut>_csr_hw_reset [--waves <format>] [--tool xcelium] ``` -Please refer to [CSR utilities]({{< relref "hw/dv/sv/csr_utils/doc" >}}) for more information on how to add exclusions for the CSR tests. +Please refer to [CSR utilities](../../../../hw/dv/sv/csr_utils/README.md) for more information on how to add exclusions for the CSR tests. ## Full DV -Running the sanity and CSR suite of tests while making progress toward reaching the [V1 stage]({{< relref "doc/project/development_stages#hardware-verification-stages" >}}) should provide a good reference in terms of how to develop tests as outlined in the testplan and running and debugging them. -Please refer to the [checklist]({{< relref "doc/project/checklist" >}}) to understand the key requirements for progressing through the subsequent verification stages and final signoff. +Running the sanity and CSR suite of tests while making progress toward reaching the [V1 stage](../../../project_governance/development_stages.md#hardware-verification-stages) should provide a good reference in terms of how to develop tests as outlined in the testplan and running and debugging them. +Please refer to the [checklist](../../../project_governance/checklist/README.md) to understand the key requirements for progressing through the subsequent verification stages and final signoff. The [UART DV](https://github.com/lowRISC/opentitan/tree/master/hw/ip/uart/dv) area can be used as a canonical example for making progress. If it is not clear on how to proceed, feel free to file an issue requesting assistance.
diff --git a/doc/guides/getting_started/src/setup_formal.md b/doc/guides/getting_started/src/setup_formal.md index 17d8598..3661bcd 100644 --- a/doc/guides/getting_started/src/setup_formal.md +++ b/doc/guides/getting_started/src/setup_formal.md
@@ -9,7 +9,7 @@ This document aims to enable a contributor to get started with a formal verification effort within the OpenTitan project. While most of the focus is on development of a testbench from scratch, it should also be useful to understand how to contribute to an existing effort. -Please refer to the [OpenTitan Assertions]({{< relref "hw/formal/doc" >}}) for information on how formal verification is done in OpenTitan. +Please refer to the [OpenTitan Assertions](../../../../hw/formal/README.md) for information on how formal verification is done in OpenTitan. ## Formal property verification (FPV) @@ -17,15 +17,15 @@ There are three sets of FPV jobs in OpenTitan. They are all under the directory `hw/top_earlgrey/formal`. * `top_earlgrey_fpv_ip_cfgs.hjson`: List of IP targets. * `top_earlgrey_fpv_prim_cfgs.hjson`: List of prim targets (such as counters, fifos, etc) that are usually imported by an IP. -* `top_earlgrey_fpv_sec_cm_cfgs.hjson`: List of IPs that contains standard security countermeasure assertions. This FPV environment only proves these security countermeasure assertions. Detailed description of this FPV use case is documented in [Running FPV on security blocks for common countermeasure primitives]({{< relref "hw/formal/doc#running-fpv-on-security-blocks-for-common-countermeasure-primitives" >}}). +* `top_earlgrey_fpv_sec_cm_cfgs.hjson`: List of IPs that contains standard security countermeasure assertions. This FPV environment only proves these security countermeasure assertions. Detailed description of this FPV use case is documented in [Running FPV on security blocks for common countermeasure primitives](../../../../hw/formal/README.md#running-fpv-on-security-blocks-for-common-countermeasure-primitives). -To automatically create a FPV testbench, it is recommended to use the [fpvgen]({{< relref "util/fpvgen/doc" >}}) tool to create a template. +To automatically create a FPV testbench, it is recommended to use the [fpvgen](../../../../util/fpvgen/README.md) tool to create a template. To run the FPV tests in `dvsim`, please add the target to the corresponding `top_earlgrey_fpv_{category}_cfgs.hjson` file , then run with command: ```console util/dvsim/dvsim.py hw/top_earlgrey/formal/top_earlgrey_fpv_{category}_cfgs.hjson --select-cfgs {target_name} ``` -It is recommended to add the FPV target to [lint]({{< relref "hw/lint/doc" >}}) script `hw/top_earlgrey/lint/top_earlgrey_fpv_lint_cfgs.hjson` to quickly find typos. +It is recommended to add the FPV target to [lint](../../../../hw/lint/README.md) script `hw/top_earlgrey/lint/top_earlgrey_fpv_lint_cfgs.hjson` to quickly find typos. ## Formal connectivity verification
diff --git a/doc/guides/getting_started/src/setup_fpga.md b/doc/guides/getting_started/src/setup_fpga.md index 768a548..f787ff3 100644 --- a/doc/guides/getting_started/src/setup_fpga.md +++ b/doc/guides/getting_started/src/setup_fpga.md
@@ -74,7 +74,7 @@ bazel build //hw/bitstream/vivado:fpga_cw310_rom ``` -Note, building these bitstreams will require Vivado be installed on your system, with access to the proper licenses, described [here]({{< relref "doc/getting_started/install_vivado" >}}). +Note, building these bitstreams will require Vivado be installed on your system, with access to the proper licenses, described [here](./install_vivado/README.md). For general software development on the FPGA, Vivado must still be installed, but the Lab Edition is sufficient. #### Dealing with FPGA Congestion Issues @@ -145,7 +145,7 @@ If `dmesg` reports a problem you can trigger a *USB_RST* with *SW5*. When properly connected, `dmesg` should identify the board, not show any errors, and the status light should flash. They should be named `'/dev/ttyACM*'`, e.g. `/dev/ttyACM1`. -To ensure that you have sufficient access permissions, set up the udev rules as explained in the [Vivado installation instructions]({{< relref "install_vivado" >}}). +To ensure that you have sufficient access permissions, set up the udev rules as explained in the [Vivado installation instructions](./install_vivado/README.md). You will then need to run this command to configure the board. You only need to run it once. ```console @@ -384,7 +384,7 @@ TRSTn is available on the 20-pin ARM JTAG header only. Use `srst_only` if the adapter only supports SRSTn. -See the [install instructions]({{< relref "install_openocd" >}}) for guidance on installing OpenOCD. +See the [install instructions](./install_openocd.md) for guidance on installing OpenOCD. To actually debug through OpenOCD, it must either be connected through telnet or GDB.
diff --git a/doc/guides/getting_started/src/setup_verilator.md b/doc/guides/getting_started/src/setup_verilator.md index 6acf6ae..2aa8db0 100644 --- a/doc/guides/getting_started/src/setup_verilator.md +++ b/doc/guides/getting_started/src/setup_verilator.md
@@ -170,7 +170,7 @@ The simulation includes a "virtual JTAG" port to which OpenOCD can connect using its `remote_bitbang` driver. All necessary configuration files are included in this repository. -See the [OpenOCD install instructions]({{< relref "install_openocd.md" >}}) for guidance on installing OpenOCD. +See the [OpenOCD install instructions](./install_openocd.md) for guidance on installing OpenOCD. Run the simulation with Bazel, making sure to build the device software with debug symbols using ```console
diff --git a/doc/introduction.md b/doc/introduction.md index ae7df43..4733f07 100644 --- a/doc/introduction.md +++ b/doc/introduction.md
@@ -6,38 +6,38 @@ [OpenTitan](https://opentitan.org) is an open source silicon Root of Trust (RoT) project. OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. -OpenTitan is administered by lowRISC CIC as a collaborative [project]({{< relref "doc/project" >}}) to produce high quality, open IP for instantiation as a full-featured product. +OpenTitan is administered by lowRISC CIC as a collaborative [project](./project_governance/README.md) to produce high quality, open IP for instantiation as a full-featured product. This repository exists to enable collaboration across partners participating in the OpenTitan project. ## Getting Started -To get started with OpenTitan, see the [Getting Started]({{< relref "doc/getting_started" >}}) page. +To get started with OpenTitan, see the [Getting Started](./guides/getting_started/src/README.md) page. For additional resources when working with OpenTitan, see the [list of user guides]({{< relref "doc/ug" >}}). -For details on coding styles or how to use our project-specific tooling, see the [reference manuals]({{< relref "doc/rm" >}}). -Lastly, the [Hardware Dashboard page]({{< relref "hw" >}}) contains technical documentation on the SoC, the Ibex processor core, and the individual IP blocks. -For questions about how the project is organized, see the [project]({{< relref "doc/project" >}}) landing spot for more information. +For details on coding styles or how to use our project-specific tooling, see the [reference manuals](../util/README.md). +Lastly, the [Hardware Dashboard page](../hw/README.md) contains technical documentation on the SoC, the Ibex processor core, and the individual IP blocks. +For questions about how the project is organized, see the [project](./project_governance/README.md) landing spot for more information. ## Understanding OpenTitan -* [Use Cases]({{< relref "doc/use_cases" >}}) -* [Threat Model]({{< relref "doc/security/threat_model" >}}) -* [Security]({{< relref "doc/security" >}}) +* [Use Cases](./use_cases/README.md) +* [Threat Model](./security/threat_model/README.md) +* [Security](./security/README.md) ## Datasheets -* [OpenTitan Earl Grey Chip Datasheet]({{< relref "hw/top_earlgrey/doc" >}}) +* [OpenTitan Earl Grey Chip Datasheet](../hw/top_earlgrey/doc/specification.md) ## Documentation -* [Hardware]({{< relref "hw" >}}) -* [Software]({{< relref "sw" >}}) +* [Hardware](../hw/README.md) +* [Software](../sw/README.md) ## Development -* [Getting Started]({{< relref "doc/getting_started" >}}) +* [Getting Started](./guides/getting_started/src/README.md) * [User Guides]({{< relref "doc/ug" >}}) -* [Reference Manuals]({{< relref "doc/rm" >}}) -* [Style Guides]({{< relref "doc/sg" >}}) +* [Reference Manuals](../util/README.md) +* [Style Guides](./contributing/style_guides/README.md) ## Repository Structure
diff --git a/doc/project_governance/README.md b/doc/project_governance/README.md index 82348ae..4ef2acc 100644 --- a/doc/project_governance/README.md +++ b/doc/project_governance/README.md
@@ -8,15 +8,15 @@ ## Quality standards for open hardware IP -In order to gauge the quality of the different IP that is in our repository, we define a series of [Hardware Development Stages]({{< relref "development_stages" >}}) to track the designs. -The current status of different IP is reflected in the [Hardware Dashboard]({{< relref "hw" >}}). +In order to gauge the quality of the different IP that is in our repository, we define a series of [Hardware Development Stages](./development_stages.md) to track the designs. +The current status of different IP is reflected in the [Hardware Dashboard](../../hw/README.md). The final state for developed IP is *Signed Off*, indicating that design and verification is complete, and the IP should be bug free. -To make it to that stage, a [Hardware Signoff Checklist]({{< relref "checklist.md" >}}) is used to confirm completion. +To make it to that stage, a [Hardware Signoff Checklist](./checklist/README.md) is used to confirm completion. [Here](https://github.com/lowRISC/opentitan/blob/master/util/uvmdvgen/checklist.md.tpl) is a template that can be used as a checklist item. ## Contributing -See our documentation on [Contributing to OpenTitan]({{< relref "contributing.md" >}}) (and the more in-depth [Detailed Contribution Guide]({{<relref "detailed_contribution_guide/_index.md" >}})) for general guidance on how we work, making bug reports, dealing with security issues, and contributing code. +See our documentation on [Contributing to OpenTitan](../contributing/README.md) (and the more in-depth [Detailed Contribution Guide](../contributing/detailed_contribution_guide/README.md)) for general guidance on how we work, making bug reports, dealing with security issues, and contributing code. ## Governance @@ -26,14 +26,14 @@ As described in full detail in the [OpenTitan Technical Charter](https://static.opentitan.org/technical-charter.pdf), our governance structure consists of: * The Project Director, Dominic Rizzo, who is a representative of the lowRISC CIC's Board of Directors within the Steering Committee. * The Steering Committee, responsible for project oversight and agreeing the technical roadmap. -* The [Technical Committee]({{< relref "technical_committee" >}}), responsible for technical decision making required to implement the technical roadmap. +* The [Technical Committee](./technical_committee.md), responsible for technical decision making required to implement the technical roadmap. ## Initiating new development -The [OpenTitan RFC process]({{< relref "rfc_process" >}}) guides developers on how to initiate new development within the program. +The [OpenTitan RFC process](./rfc_process.md) guides developers on how to initiate new development within the program. ## Committers Committers are individuals with repository write access. Everyone is able and encouraged to contribute and to help with code review, but committers are responsible for the final approval and merge of contributions. -See the [Committers]({{< relref "committers.md" >}}) definition and role description for more information. +See the [Committers](./committers.md) definition and role description for more information.
diff --git a/doc/project_governance/checklist/README.md b/doc/project_governance/checklist/README.md index 85c2bbd..f07e9f8 100644 --- a/doc/project_governance/checklist/README.md +++ b/doc/project_governance/checklist/README.md
@@ -2,7 +2,7 @@ title: "Signoff Checklist" --- -This document explains the recommended checklist items to review when transitioning from one [Development Stage]({{<relref "/doc/project/development_stages.md" >}}) to another, for design, verification, and [software device interface function (DIF)]({{< relref "doc/rm/device_interface_functions.md" >}}) stages. +This document explains the recommended checklist items to review when transitioning from one [Development Stage](../development_stages.md) to another, for design, verification, and [software device interface function (DIF)](../../contributing/sw/device_interface_functions.md) stages. It is expected that the items in each stage (D1, V1, S1, etc) are completed. ## D1 @@ -27,7 +27,7 @@ ### IP_TOP -The unit `.sv` exists and meets [comportability]({{< relref "doc/rm/comportability_specification" >}}) requirements. +The unit `.sv` exists and meets [comportability](../../contributing/hw/comportability/README.md) requirements. ### IP_INSTANTIABLE @@ -77,7 +77,7 @@ ### DOC_INTEGRATION_GUIDE -Any integration specifics that are not captured by the [comportability]({{< relref "doc/rm/comportability_specification" >}}) specification have been documented. +Any integration specifics that are not captured by the [comportability](../../contributing/hw/comportability/README.md) specification have been documented. Examples include special synthesis constraints or clock requirements for this IP. ### MISSING_FUNC @@ -178,7 +178,7 @@ ### SEC_CM_IMPLEMENTED Any appropriate security counter-measures are implemented. -Implementations must follow the [OpenTitan Secure Hardware Design Guidelines]({{< relref "../security/implementation_guidelines/hardware" >}}). +Implementations must follow the [OpenTitan Secure Hardware Design Guidelines](../../security/implementation_guidelines/hardware/README.md). In particular, note that: @@ -297,11 +297,11 @@ ### SIM_RAL_MODEL_GEN_AUTOMATED -A RAL model is generated using [regtool]({{< relref "/util/reggen/doc" >}}) and instantiated in the UVM environment. +A RAL model is generated using [regtool](../../../util/reggen/doc/setup_and_use.md) and instantiated in the UVM environment. ### CSR_CHECK_GEN_AUTOMATED -A CSR check is generated using [regtool]({{< relref "/util/reggen/doc" >}}) and bound in the TB environment. +A CSR check is generated using [regtool](../../../util/reggen/doc/setup_and_use.md) and bound in the TB environment. ### TB_GEN_AUTOMATED @@ -363,7 +363,7 @@ ### TB_LINT_SETUP -[VeribleLint](https://google.github.io/verible/verilog_lint.html) for the testbench is [set up]({{< relref "hw/lint/doc" >}}) to run in nightly regression, with appropriate waivers. +[VeribleLint](https://google.github.io/verible/verilog_lint.html) for the testbench is [set up](../../../hw/lint/README.md) to run in nightly regression, with appropriate waivers. * For a constrained random testbench, an entry has been added to `hw/<top-level-design>/lint/<top-level-design>_dv_lint_cfgs.hjson` * For an FPV testbench, an entry has been added to `hw/<top-level-design>/lint/<top-level-design>_fpv_lint_cfgs.hjson` @@ -527,20 +527,20 @@ Tests implemented to verify the security countermeasures have been mapped to these testpoints. Common countermeasures can be fully verified or partially handled by cip_lib. -Follow this [document]({{< relref "hw/dv/sv/cip_lib/doc#security-verification-in-cip_lib" >}}) to enable them. +Follow this [document](../../../hw/dv/sv/cip_lib/README.md#security-verification-in-cip_lib) to enable them. Make sure to import the applicable common sec_cm [tests](https://github.com/lowRISC/opentitan/tree/master/hw/dv/tools/dvsim/tests) and [testplans](https://github.com/lowRISC/opentitan/tree/master/hw/dv/tools/dvsim/testplans). ### FPV_SEC_CM_PROVEN All security countermeasure assertions are proven in FPV. -The required assertions for countermeasure are defined in [Security Countermeasure Verification Framework]({{< relref "doc/ug/sec_cm_dv_framework" >}}). -Follow this [document]({{< relref "hw/formal/doc#running-fpv-on-security-blocks-for-common-countermeasure-primitives" >}}) to setup the FPV sec_cm testbench. +The required assertions for countermeasure are defined in [Security Countermeasure Verification Framework](../../contributing/dv/sec_cm_dv_framework/README.md). +Follow this [document](../../../hw/formal/README.md#running-fpv-on-security-blocks-for-common-countermeasure-primitives) to setup the FPV sec_cm testbench. ### SIM_SEC_CM_VERIFIED All security countermeasures are verified in simulation. Common countermeasures can be fully verified or partially handled by cip_lib. -Refer to the [cip_lib document]({{< relref "hw/dv/sv/cip_lib/doc#security-verification-in-cip_lib" >}}) for details. +Refer to the [cip_lib document](../../../hw/dv/sv/cip_lib/README.md#security-verification-in-cip_lib) for details. ### SIM_COVERAGE_REVIEWED @@ -670,7 +670,7 @@ ### DIF_CODE_STYLE -The DIF follows DIF-specific guidelines in [`sw/device/lib/dif`]({{< relref "sw/device/lib/dif" >}}) and the OpenTitan C style guidelines. +The DIF follows DIF-specific guidelines in [`sw/device/lib/dif`](../../../sw/device/lib/dif/README.md) and the OpenTitan C style guidelines. ### DIF_TEST_UNIT
diff --git a/doc/project_governance/committers.md b/doc/project_governance/committers.md index c06a48d..ffee7b5 100644 --- a/doc/project_governance/committers.md +++ b/doc/project_governance/committers.md
@@ -29,14 +29,14 @@ Although committers have the final say on patch approval or requiring changes, the task of reviewing is shared by all contributors, who may make similar requests. Options for reviewing a pull request include: * Approval, with no further conditions. - * This is appropriate when you are confident the changes are correct, sufficiently explained, in line with the project coding styles, and don't need further review by others or a companion [RFC]({{< relref "rfc_process" >}}) to be written. + * This is appropriate when you are confident the changes are correct, sufficiently explained, in line with the project coding styles, and don't need further review by others or a companion [RFC](./rfc_process.md) to be written. You should only use this for cases where you have sufficient expertise in the areas being modified. * Note that if the PR came from someone without commit rights, you will need to rebase and merge for them. * Approval, but with a request to get an additional approval from other named reviewers. * This is appropriate when you believe the changes are correct, but would either like a second opinion or to ensure that another contributor is aware of and approves of the changes. * Request for changes. * This is appropriate when problems or potential improvements are spotted that can be addressed by the original submitter updating the pull request. -* Request that further design rationale be written up and shared (but a full [RFC]({{< relref "rfc_process" >}}) isn't necessary). +* Request that further design rationale be written up and shared (but a full [RFC](./rfc_process.md) isn't necessary). * This is appropriate when the rationale for a change is not clear, or a lack of accompanying documentation makes reviewing the code challenging. This can commonly occur when further explanation would be valuable for people working in that area but no project-wide consensus is needed. * Request that an RFC be written up and submitted.
diff --git a/doc/project_governance/development_stages.md b/doc/project_governance/development_stages.md index 2b7b7e2..01d4ad5 100644 --- a/doc/project_governance/development_stages.md +++ b/doc/project_governance/development_stages.md
@@ -9,7 +9,7 @@ This includes design and verification stages meant to give a high-level view of the status of a design. OpenTitan being an open-source program aimed at a high quality silicon release, the intent is to find a balance between the rigor of a heavy tapeout process and the more fluid workings of an open source development. -This document also serves as a guide to the [Hardware Dashboard]({{< relref "hw" >}}), which gives the status of all of the designs in the OpenTitan repository. +This document also serves as a guide to the [Hardware Dashboard](../../hw/README.md), which gives the status of all of the designs in the OpenTitan repository. This document aims to mostly give a more defined structure to the process that is already followed. Proper versioning of RTL designs is a complex topic. @@ -20,10 +20,10 @@ The stages listed here are created to give insight into where a design is in its life from specification to silicon-ready sign-off. At the moment, this is strictly limited to a hardware design, but could be expanded to other components of development within OpenTitan. -Transitions between these stages are decided by the Technical Committee via the [RFC process]({{< relref "doc/project/rfc_process" >}}). +Transitions between these stages are decided by the Technical Committee via the [RFC process](./rfc_process.md). The first life stage is **Specification**. -The proposed design is written up and submitted through the [RFC process]({{< relref "doc/project/rfc_process" >}}). +The proposed design is written up and submitted through the [RFC process](./rfc_process.md). Depending on the complexity of the design and the guidance of the Technical Committee, it is possible a single design might require multiple RFCs. For example, a first RFC for the rationale, feature list, and a rough overview; followed by a more detailed RFC to get approval for the draft technical specification. As part of the specification process, the design author might reach out for feedback from a smaller group of reviewers while formulating an RFC proposal. @@ -49,7 +49,7 @@ There exists a [template for IP checklists](https://github.com/lowRISC/opentitan/blob/master/util/uvmdvgen/checklist.md.tpl). The DIF stages use a separate, [software-specific checklist](https://github.com/lowRISC/opentitan/blob/master/doc/project/sw_checklist.md.tpl). -All the checklist items are listed in the [Sign-off Checklist]({{< relref "doc/project/checklist.md" >}}). +All the checklist items are listed in the [Sign-off Checklist](./checklist/README.md). | **Stage** | **Name** | **Definition** | | --- | --- | --- | @@ -120,7 +120,7 @@ | **Stage** | **Name** | **Definition** | | --- | --- | --- | | V0 | Initial Work | Testbench being developed, not functional; testplan being written; decided which methodology to use (sim-based DV, FPV, or both). | -| V1 | Under Test | <ul> <li> Documentation: <ul> <li> [DV document]({{< relref "doc/ug/dv_methodology#documentation" >}}) available, <li> [Testplan]({{< relref "doc/ug/dv_methodology#documentation" >}}) completed and reviewed </ul> <li> Testbench: <ul> <li> DUT instantiated with major interfaces hooked up <li> All available interface assertion monitors hooked up <li> X / unknown checks on DUT outputs added <li> Skeleton environment created with UVCs <li> TLM connections made from interface monitors to the scoreboard </ul> <li> Tests (written and passing): <ul> <li> Sanity test accessing basic functionality <li> CSR / mem test suite </ul> <li> Regressions: Sanity and nightly regression set up</ul> | +| V1 | Under Test | <ul> <li> Documentation: <ul> <li> [DV document](../contributing/dv/methodology/README.md#documentation) available, <li> [Testplan](../contributing/dv/methodology/README.md#documentation) completed and reviewed </ul> <li> Testbench: <ul> <li> DUT instantiated with major interfaces hooked up <li> All available interface assertion monitors hooked up <li> X / unknown checks on DUT outputs added <li> Skeleton environment created with UVCs <li> TLM connections made from interface monitors to the scoreboard </ul> <li> Tests (written and passing): <ul> <li> Sanity test accessing basic functionality <li> CSR / mem test suite </ul> <li> Regressions: Sanity and nightly regression set up</ul> | | V2 | Testing Complete | <ul> <li> Documentation: <ul> <li> DV document completely written </ul> <li> Design Issues: <ul> <li> all high priority bugs addressed <li> low priority bugs root-caused </ul> <li> Testbench: <ul> <li> all interfaces hooked up and exercised <li> all assertions written and enabled </ul> <li> UVM environment: fully developed with end-to-end checks in scoreboard <li> Tests (written and passing): all tests planned for in the testplan <li> Functional coverage (written): all covergroups planned for in the testplan <li> Regression: all tests passing in nightly regression with multiple seeds (> 90%) <li> Coverage: 90% code coverage across the board and 90% functional coverage</ul></ul> | | V2S | Security Countermeasures Verified | <ul> <li> Tests (written and passing): all tests for security countermeasures (if any) </ul> | | V3 | Verification Complete | <ul> <li> Design Issues: all bugs addressed <li> Tests (written and passing): all tests including newly added post-V2 tests (if any) <li> Regression: all tests with all seeds passing <li> Coverage: 100% code and 100% functional coverage with waivers </ul> </ul> | @@ -130,14 +130,14 @@ | **Stage** | **Name** | **Definition** | | --- | --- | --- | | V0 | Initial Work | Testbench being developed, not functional; testplan being written; decided which methodology to use (sim-based DV, FPV, or both). | -| V1 | Under Test | <ul> <li> Documentation: <ul> <li> [DV document]({{< relref "doc/ug/dv_methodology#documentation" >}}) available, [Testplan]({{< relref "doc/ug/dv_methodology#documentation" >}}) completed and reviewed </ul> <li> Testbench: <ul> <li> Formal testbench with DUT bound to assertion module(s) <li> All available interface assertion monitors hooked up <li> X / unknown assertions on DUT outputs added </ul> <li> Assertions (written and proven): <ul> <li> All functional properties identified and described in testplan <li> Assertions for main functional path implemented and passing (smoke check)<li> Each input and each output is part of at least one assertion</ul> <li> Regressions: Sanity and nightly regression set up</ul> | +| V1 | Under Test | <ul> <li> Documentation: <ul> <li> [DV document](../contributing/dv/methodology/README.md#documentation) available, [Testplan](../contributing/dv/methodology/README.md#documentation) completed and reviewed </ul> <li> Testbench: <ul> <li> Formal testbench with DUT bound to assertion module(s) <li> All available interface assertion monitors hooked up <li> X / unknown assertions on DUT outputs added </ul> <li> Assertions (written and proven): <ul> <li> All functional properties identified and described in testplan <li> Assertions for main functional path implemented and passing (smoke check)<li> Each input and each output is part of at least one assertion</ul> <li> Regressions: Sanity and nightly regression set up</ul> | | V2 | Testing Complete | <ul> <li> Documentation: <ul> <li> DV document completely written </ul> <li> Design Issues: <ul> <li> all high priority bugs addressed <li> low priority bugs root-caused </ul> <li> Testbench: <ul> <li> all interfaces have assertions checking the protocol <li> all functional assertions written and enabled <li> assumptions for FPV specified and reviewed </ul> <li> Tests (written and passing): all tests planned for in the testplan <li> Regression: 90% of properties proven in nightly regression <li> Coverage: 90% code coverage and 75% logic cone of influence (COI) coverage </ul> | | V2S | Security Countermeasures Verified | <ul> <li> Tests (written and passing): all tests for security countermeasures (if any) </ul> | | V3 | Verification Complete | <ul> <li> Design Issues: all bugs addressed <li> Assertions (written and proven): all assertions including newly added post-V2 assertions (if any) <li> Regression: 100% of properties proven (with reviewed assumptions) <li> Coverage: 100% code coverage and 100% COI coverage</ul> | ## Device Interface Function Stages (S) -The following development stages are for [Device Interface Function (DIF)]({{< relref "doc/rm/device_interface_functions.md" >}}) work. +The following development stages are for [Device Interface Function (DIF)](../contributing/sw/device_interface_functions.md) work. These stages have a slightly different emphasis to the hardware design and verification stages, because software is much easier to change if bugs are found. The metric they are trying to capture is the stability and completeness of a low-level software interface to hardware design. We are aiming to keep this process fairly lightweight in the early stages, and not significantly burdensome to the associated HW designer through all stages. @@ -306,4 +306,4 @@ The stages are reported externally via a script-generated table exposed on the external website. This status is a summary of all `prj.hjson` files of all designs in the system, with multiple lines where there are multiple versions. -The link to that table is [here]({{< relref "hw" >}}). +The link to that table is [here](../../hw/README.md).
diff --git a/doc/project_governance/technical_committee.md b/doc/project_governance/technical_committee.md index e858dc3..1a5ea9d 100644 --- a/doc/project_governance/technical_committee.md +++ b/doc/project_governance/technical_committee.md
@@ -2,11 +2,11 @@ title: "OpenTitan Technical Committee" --- -The OpenTitan Technical Committee is part of the [OpenTitan governance structure]({{< relref "doc/project" >}}) and the definitive description of its operations and responsibilities are stated in the [OpenTitan Technical Charter](https://static.opentitan.org/technical-charter.pdf). +The OpenTitan Technical Committee is part of the [OpenTitan governance structure](./README.md) and the definitive description of its operations and responsibilities are stated in the [OpenTitan Technical Charter](https://static.opentitan.org/technical-charter.pdf). Key responsibilities defined in that document include: -* Oversight of the [RFC process]({{< relref "rfc_process" >}}), including voting to approve, reject, postpone or revise RFCs. -* Creating [Commit Escalation Guidelines]({{< relref "committers" >}}) setting out when Committers should escalate a particular Commit to the TC (e.g. for cross-cutting changes), and when Committers should recommend a design rationale write-up or RFC for wider feedback. -* Maintaining the list of [committers]({{< relref "committers" >}}). +* Oversight of the [RFC process](./rfc_process.md), including voting to approve, reject, postpone or revise RFCs. +* Creating [Commit Escalation Guidelines](./committers.md) setting out when Committers should escalate a particular Commit to the TC (e.g. for cross-cutting changes), and when Committers should recommend a design rationale write-up or RFC for wider feedback. +* Maintaining the list of [committers](./committers.md). Expectations of Technical Committee members include the following: * Be active participants in development discussions within the OpenTitan project, beyond just Technical Committee meetings.
diff --git a/doc/security/README.md b/doc/security/README.md index d086f08..1584bb6 100644 --- a/doc/security/README.md +++ b/doc/security/README.md
@@ -111,16 +111,16 @@ alert policy assignments to handle alerts completely in hardware depending on the assigned severity. -[aes]: {{< relref "hw/ip/aes/doc" >}} -[alert_handler]: {{< relref "hw/top_earlgrey/ip_autogen/alert_handler/doc" >}} -[comportable_ip]: {{< relref "doc/rm/comportability_specification" >}} -[csrng]: {{< relref "hw/ip/csrng/doc" >}} -[entropy_source]: {{< relref "hw/ip/entropy_src/doc" >}} -[hmac]: {{< relref "hw/ip/hmac/doc" >}} -[keymgr]: {{< relref "hw/ip/keymgr/doc" >}} -[logical_security_model]: {{< relref "logical_security_model" >}} -[implementation_guidelines]: {{< relref "implementation_guidelines/hardware" >}} -[otbn]: {{< relref "hw/ip/otbn/doc" >}} -[security_model]: {{< relref "specs" >}} -[use_cases]: {{< relref "doc/use_cases" >}} -[threat_model]: {{< relref "threat_model" >}} +[aes]: ../../hw/ip/aes/README.md +[alert_handler]: ../../hw/top_earlgrey/ip_autogen/alert_handler/README.md +[comportable_ip]: ../contributing/hw/comportability/README.md +[csrng]: ../../hw/ip/csrng/README.md +[entropy_source]: ../../hw/ip/entropy_src/README.md +[hmac]: ../../hw/ip/hmac/README.md +[keymgr]: ../../hw/ip/keymgr/README.md +[logical_security_model]: ./logical_security_model/README.md +[implementation_guidelines]: ./implementation_guidelines/hardware/README.md +[otbn]: ../../hw/ip/otbn/README.md +[security_model]: ./specs/README.md +[use_cases]: ../use_cases/README.md +[threat_model]: ./threat_model/README.md
diff --git a/doc/security/specs/README.md b/doc/security/specs/README.md index 6f907d2..105ecfe 100644 --- a/doc/security/specs/README.md +++ b/doc/security/specs/README.md
@@ -72,14 +72,14 @@ option of provisioning additional secrets after taking ownership of the device. -[attestation]: {{< relref "doc/security/specs/attestation" >}} -[creator_identity]: {{< relref "doc/security/specs/identities_and_root_keys#creator-identity" >}} -[device_life_cycle]: {{< relref "doc/security/specs/device_life_cycle" >}} -[firmware_update]: {{< relref "doc/security/specs/firmware_update" >}} -[identities_and_root_keys]: {{< relref "doc/security/specs/identities_and_root_keys" >}} -[ownership_transfer]: {{< relref "doc/security/specs/ownership_transfer" >}} +[attestation]: ./attestation/README.md +[creator_identity]: ./identities_and_root_keys/README.md#creator-identity +[device_life_cycle]: ./device_life_cycle/README.md +[firmware_update]: ./firmware_update/README.md +[identities_and_root_keys]: ./identities_and_root_keys/README.md +[ownership_transfer]: ./ownership_transfer/README.md [pmp]: https://ibex-core.readthedocs.io/en/latest/03_reference/pmp.html -[provisioning]: {{< relref "doc/security/specs/device_provisioning" >}} -[secure_boot]: {{< relref "doc/security/specs/secure_boot" >}} -[silicon_creator]: {{< relref "doc/security/logical_security_model#silicon-creator" >}} -[silicon_owner]: {{< relref "doc/security/logical_security_model#silicon-owner" >}} +[provisioning]: ./device_provisioning/README.md +[secure_boot]: ./secure_boot/README.md +[silicon_creator]: ../logical_security_model/README.md#silicon-creator +[silicon_owner]: ../logical_security_model/README.md#silicon-owner
diff --git a/doc/security/specs/attestation/README.md b/doc/security/specs/attestation/README.md index 173d0d7..9dea444 100644 --- a/doc/security/specs/attestation/README.md +++ b/doc/security/specs/attestation/README.md
@@ -863,12 +863,12 @@ <!-- References --> [open-dice]: https://pigweed.googlesource.com/open-dice/+/refs/heads/main/docs/specification.md -[device-identifier]: {{< relref "/doc/security/specs/identities_and_root_keys" >}}#device-identifier -[creator-identity]: {{< relref "/doc/security/specs/identities_and_root_keys" >}}#creator-identity -[owner-identity]: {{< relref "/doc/security/specs/identities_and_root_keys" >}}#owner-identity -[owner-root-secret]: {{< relref "/doc/security/specs/identities_and_root_keys" >}}#owner-root-secret -[root-key]: {{< relref "/doc/security/specs/identities_and_root_keys" >}}#root-key -[diversification-key]:{{< relref "/doc/security/specs/identities_and_root_keys" >}}#diversification-key +[device-identifier]: ../identities_and_root_keys/README.md#device-identifier +[creator-identity]: ../identities_and_root_keys/README.md#creator-identity +[owner-identity]: ../identities_and_root_keys/README.md#owner-identity +[owner-root-secret]: ../identities_and_root_keys/README.md#owner-root-secret +[root-key]: ../identities_and_root_keys/README.md#root-key +[diversification-key]:../identities_and_root_keys/README.md#diversification-key -[device-provisioning]: {{< relref "/doc/security/specs/device_provisioning" >}} -[owner-personalization]: {{< relref "/doc/security/specs/device_provisioning" >}}#owner_personalization +[device-provisioning]: ../device_provisioning/README.md +[owner-personalization]: ../device_provisioning/README.md#owner_personalization
diff --git a/doc/security/specs/device_life_cycle/README.md b/doc/security/specs/device_life_cycle/README.md index e8bbe44..4279920 100644 --- a/doc/security/specs/device_life_cycle/README.md +++ b/doc/security/specs/device_life_cycle/README.md
@@ -13,11 +13,11 @@ Manufacturing refers to the process in which a device is tested and prepared for silicon correctness prior to production. -The technical specification of the corresponding life cycle controller IP can be found [here]({{< relref "hw/ip/lc_ctrl/doc" >}}). +The technical specification of the corresponding life cycle controller IP can be found [here](../../../../hw/ip/lc_ctrl/README.md). ## Background -First see [here]({{< relref "doc/security/logical_security_model" >}}) for +First see [here](../../logical_security_model/README.md) for OpenTitan's logical entity breakdowns. OpenTitan implements standard device life cycle manufacturing states which are
diff --git a/doc/security/specs/device_provisioning/README.md b/doc/security/specs/device_provisioning/README.md index 1af66e8..09bc725 100644 --- a/doc/security/specs/device_provisioning/README.md +++ b/doc/security/specs/device_provisioning/README.md
@@ -952,12 +952,12 @@ is erased after personalization is complete. -[attestation]: {{< relref "/doc/security/specs/attestation" >}} -[attestation_keys]: {{< relref "/doc/security/specs/attestation" >}}#asymmetric-keys -[attestation_certificate]: {{< relref "/doc/security/specs/attestation" >}}#certificate-format -[creator_identity]: {{< relref "/doc/security/specs/identities_and_root_keys" >}}#creator-identity -[device_lifecycle]: {{< relref "/doc/security/specs/device_life_cycle" >}} -[device_id]: {{< relref "/doc/security/specs/identities_and_root_keys" >}}#device-identifier -[identities_and_root_keys]: {{< relref "/doc/security/specs/identities_and_root_keys" >}} +[attestation]: ../attestation/README.md +[attestation_keys]: ../attestation/README.md#asymmetric-keys +[attestation_certificate]: ../attestation/README.md#certificate-format +[creator_identity]: ../identities_and_root_keys/README.md#creator-identity +[device_lifecycle]: ../device_life_cycle/README.md +[device_id]: ../identities_and_root_keys/README.md#device-identifier +[identities_and_root_keys]: ../identities_and_root_keys/README.md [nist_800_56r3]: https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Ar3.pdf -[ownership_transfer]: {{< relref "/doc/security/specs/ownership_transfer" >}} +[ownership_transfer]: ../ownership_transfer/README.md
diff --git a/doc/security/specs/secure_boot/README.md b/doc/security/specs/secure_boot/README.md index d9e24b2..8675273 100644 --- a/doc/security/specs/secure_boot/README.md +++ b/doc/security/specs/secure_boot/README.md
@@ -186,15 +186,15 @@ * **Entrypoint.** The executable entrypoint for this `ROM_EXT` slot. <!-- TODO: Update with published documents when available. --> -[attestation]: {{< relref "/doc/security/specs/attestation" >}} -[attestation-command]: {{< relref "/doc/security/specs/attestation" >}}#attestation-command +[attestation]: ../attestation/README.md +[attestation-command]: ../attestation/README.md#attestation-command [ibex-epmp]: https://ibex-core.readthedocs.io/en/latest/03_reference/pmp.html -[identities-keys]: {{< relref "/doc/security/specs/identities_and_root_keys" >}} -[key-manager]: {{< relref "/hw/ip/keymgr/doc" >}} -[manifest-format]: {{< relref "/sw/device/silicon_creator/rom_ext/docs/manifest" >}} -[rom-epmp]: {{< relref "/sw/device/silicon_creator/rom/docs/memory_protection" >}} +[identities-keys]: ../identities_and_root_keys/README.md +[key-manager]: ../../../../hw/ip/keymgr/README.md +[manifest-format]: ../../../../sw/device/silicon_creator/rom_ext/doc/manifest.md +[rom-epmp]: ../../../../sw/device/silicon_creator/rom/doc/memory_protection.md [ot-flash]: # [ot-unlock-flow]: # -[ownership-transfer]: {{< relref "/doc/security/specs/ownership_transfer" >}} +[ownership-transfer]: ../ownership_transfer/README.md [rv-isa-priv]: https://riscv.org/technical/specifications/ [silicon-creator-keys]: {{< relref "#silicon-creator-keys" >}}
diff --git a/doc/security/threat_model/README.md b/doc/security/threat_model/README.md index b5406e0..8c2b0a6 100644 --- a/doc/security/threat_model/README.md +++ b/doc/security/threat_model/README.md
@@ -90,5 +90,5 @@ ## Read More -* [Use Cases]({{< relref "doc/use_cases" >}}) -* [OpenTitan Security]({{< relref "../../security" >}}) +* [Use Cases](../../use_cases/README.md) +* [OpenTitan Security](../README.md)
diff --git a/doc/use_cases/README.md b/doc/use_cases/README.md index bdd77bb..56f2016 100644 --- a/doc/use_cases/README.md +++ b/doc/use_cases/README.md
@@ -14,6 +14,6 @@ ## Discrete Use Cases -* [Platform Integrity Module]({{< relref "doc/use_cases/platform_integrity_module" >}}) -* [Trusted Platform Module]({{< relref "doc/use_cases/tpm" >}}) -* [Universal 2nd-Factor Security Key]({{< relref "doc/use_cases/u2f" >}}) +* [Platform Integrity Module](./platform_integrity_module/README.md) +* [Trusted Platform Module](./tpm/README.md) +* [Universal 2nd-Factor Security Key](./u2f/README.md)
diff --git a/hw/README.md b/hw/README.md index d7d5e4f..fed27c9 100644 --- a/hw/README.md +++ b/hw/README.md
@@ -5,11 +5,11 @@ This page serves as the landing spot for all hardware development within the OpenTitan project. -We start off by providing links to the [results of various tool-flows](#results-of-toolflows) run on all of our [Comportable]({{< relref "doc/rm/comportability_specification" >}}) IPs. +We start off by providing links to the [results of various tool-flows](#results-of-toolflows) run on all of our [Comportable](../doc/contributing/hw/comportability/README.md) IPs. This includes DV simulations, FPV and lint, all of which are run with the `dvsim` tool which serves as the common frontend. The [Comportable IPs](#comportable-ips) following it provides links to their design specifications and DV documents, and tracks their current stage of development. -See the [Hardware Development Stages]({{< relref "/doc/project/development_stages.md" >}}) for description of the hardware stages and how they are determined. +See the [Hardware Development Stages](../doc/project_governance/development_stages.md) for description of the hardware stages and how they are determined. Next, we focus on all available [processor cores](#processor-cores) and provide links to their design specifications, DV documents and the DV simulation results. @@ -40,9 +40,9 @@ ## Earl Grey chip-level results -* [Datasheet]({{< relref "hw/top_earlgrey/doc" >}}) -* [Specification]({{< relref "hw/top_earlgrey/doc/design" >}}) -* [DV Document]({{< relref "hw/top_earlgrey/doc/dv" >}}) +* [Datasheet](./top_earlgrey/doc/specification.md) +* [Specification](./top_earlgrey/doc/design/README.md) +* [DV Document](./top_earlgrey/dv/README.md) * [DV simulation results, with coverage (nightly)](https://reports.opentitan.org/hw/top_earlgrey/dv/latest/report.html) * [Connectivity results (nightly)](https://reports.opentitan.org/hw/top_earlgrey/conn/jaspergold/latest/report.html) * [AscentLint results (nightly)](https://reports.opentitan.org/hw/top_earlgrey/lint/ascentlint/latest/report.html)
diff --git a/hw/dv/doc/dv_doc_template.md b/hw/dv/doc/dv_doc_template.md index 435ad94..24aabd8 100644 --- a/hw/dv/doc/dv_doc_template.md +++ b/hw/dv/doc/dv_doc_template.md
@@ -23,8 +23,8 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages.md" >}}) +* [Design & verification stage](../../README.md) + * [HW development stages](../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/foo/dv/latest/results.html) ## Design features @@ -32,7 +32,7 @@ For detailed information on FOO design features, please see the [FOO HWIP technical specification]({{</* relref "hw/ip/foo/doc" */>}}). ## Testbench architecture -FOO testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +FOO testbench has been constructed based on the [CIP testbench architecture](../sv/cip_lib/README.md). ### Block diagram  @@ -40,17 +40,17 @@ ### Top level testbench Top level testbench is located at `hw/ip/foo/dv/tb/tb.sv`. It instantiates the FOO DUT module `hw/ip/foo/rtl/foo.sv`. In addition, it instantiates the following interfaces and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../sv/common_ifs/README.md) +* [TileLink host interface](../sv/tl_agent/README.md) * FOO IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Alerts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../sv/common_ifs/README.md)) +* Alerts ([`pins_if`](../sv/common_ifs/README.md)) +* Devmode ([`pins_if`](../sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../sv/dv_utils/README.md) +* [csr_utils_pkg](../sv/csr_utils/README.md) ### Compile-time configurations [list compile time configurations, if any and what are they used for] @@ -62,7 +62,7 @@ [list a few parameters, types & methods; no need to mention all] ``` ### TL_agent -FOO testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +FOO testbench instantiates (already handled in CIP base env) [tl_agent](../sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into FOO device. @@ -73,7 +73,7 @@ [Describe here or add link to its README] ### UVM RAL Model -The FOO RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The FOO RAL model is created with the [`ralgen`](../tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. It can be created manually (separately) by running `make` in the the `hw/` area. @@ -105,13 +105,13 @@ <!-- explain inputs monitored, flow of data and outputs checked --> #### Assertions -* TLUL assertions: The `tb/foo_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/foo_bind.sv` binds the `tlul_assert` [assertions](../../ip/tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. * assert prop 1: * assert prop 2: ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test:
diff --git a/hw/dv/sv/alert_esc_agent/README.md b/hw/dv/sv/alert_esc_agent/README.md index 17999ba..7596480 100644 --- a/hw/dv/sv/alert_esc_agent/README.md +++ b/hw/dv/sv/alert_esc_agent/README.md
@@ -9,7 +9,7 @@ This agent implements both alert(alert_rx, alert_tx) and escalation (esc_rx, esc_tx) interface protocols, and can be configured to behave in both host and device modes. For design documentation, please refer to [alert_handler -spec]({{< relref "hw/top_earlgrey/ip_autogen/alert_handler/doc/_index.md" >}}). +spec](../../../top_earlgrey/ip_autogen/alert_handler/README.md). ### Alert Agent @@ -19,7 +19,7 @@ For IPs that send out alerts, it is recommended to attach alert device agents to the block level testbench. -Please refer to [cip_lib documentation]({{< relref "hw/dv/sv/cip_lib/doc/index.md" >}}) +Please refer to [cip_lib documentation](../cip_lib/README.md) regarding instructions to configure alert device agent in DV testbenches. ### Escalation Agent
diff --git a/hw/dv/sv/cip_lib/README.md b/hw/dv/sv/cip_lib/README.md index 6624b32..2d69b60 100644 --- a/hw/dv/sv/cip_lib/README.md +++ b/hw/dv/sv/cip_lib/README.md
@@ -19,7 +19,7 @@ ## CIP environment block diagram - + ## CIP library classes The CIP library includes the base ral model, env cfg object, coverage @@ -385,10 +385,10 @@ Note that if the testbench is generated from `uvmdvgen.py`, using the `-hr` switch will automatically generate the skeleton code listed above for alert device agent. Details on how to use `uvmdvgen.py` please refer to the -[uvmdvgen document]({{< relref "util/uvmdvgen/doc" >}}). +[uvmdvgen document](../../../../util/uvmdvgen/README.md). ## CIP Testbench - + The block diagram above shows the CIP testbench architecture, that puts together the static side `tb` which instantiates the `dut`, and the dynamic side, which is the UVM environment extended from CIP library. The diagram @@ -471,7 +471,7 @@ The helper functions `cip_base_pkg::get_rand_mubi4|8|12|16_val(t_weight, f_weight, other_weight)` can be used to get the random values. ### Security Verification for MUBI/LC_TX type ports -In OpenTitan [Design Verification Methodology]({{< relref "doc/ug/dv_methodology" >}}), it's mandatory to have 100% toggle coverage on all the ports. +In OpenTitan [Design Verification Methodology](../../../../doc/contributing/dv/methodology/README.md), it's mandatory to have 100% toggle coverage on all the ports. However, the MUBI defined values (`True` and `False`) are complement numbers. If users only test with `True` and `False` without using other values, toggle coverage can be 100%. Hence, user should add a functional covergroup for each MUBI type input port, via binding the interface `cip_mubi_cov_if` which contains a covergroup for MUBI. @@ -497,7 +497,7 @@ Note: The `sim_tops` in sim_cfg.hjson should be updated to include this bind file. ### Security Verification for common countermeasure primitives -A [security countermeasure verification framework]({{< relref "doc/ug/sec_cm_dv_framework" >}}) is implemented in cip_lib to verify common countermeasure primitives in a semi-automated way. +A [security countermeasure verification framework](../../../../doc/contributing/dv/sec_cm_dv_framework/README.md) is implemented in cip_lib to verify common countermeasure primitives in a semi-automated way. #### Design Verification cip_lib imports [sec_cm_pkg](https://github.com/lowRISC/opentitan/tree/master/hw/dv/sv/sec_cm), which automatically locates all the common countermeasure primitives and binds an interface to each of them. @@ -603,4 +603,4 @@ ``` #### Formal Verification -Please refer to [formal document]({{< relref "hw/formal/doc" >}}) on how to create a FPV environment for common countermeasures. +Please refer to [formal document](../../../formal/README.md) on how to create a FPV environment for common countermeasures.
diff --git a/hw/dv/sv/csr_utils/README.md b/hw/dv/sv/csr_utils/README.md index 17ce59f..60e1256 100644 --- a/hw/dv/sv/csr_utils/README.md +++ b/hw/dv/sv/csr_utils/README.md
@@ -155,6 +155,6 @@ and is not intended to use externally ### CSR sequence framework -The [cip_lib]({{< relref "hw/dv/sv/cip_lib/doc" >}}) includes a virtual sequence named `cip_base_vseq`, +The [cip_lib](../cip_lib/README.md) includes a virtual sequence named `cip_base_vseq`, that provides a common framework for all testbenches to run these CSR test sequences and add exclusions.
diff --git a/hw/dv/sv/dv_lib/README.md b/hw/dv/sv/dv_lib/README.md index 3092fab..96fe0cf 100644 --- a/hw/dv/sv/dv_lib/README.md +++ b/hw/dv/sv/dv_lib/README.md
@@ -18,7 +18,7 @@ layer), UVM agent, and UVM environment extensions. ### UVM RAL extensions -The RAL model generated using the [reggen]({{< relref "util/reggen/doc" >}}) tool +The RAL model generated using the [reggen](../../../../util/reggen/doc/setup_and_use.md) tool extend from these classes. These themselves extend from the corresponding RAL classes provided in UVM.
diff --git a/hw/dv/sv/jtag_agent/README.md b/hw/dv/sv/jtag_agent/README.md index 6694a3f..6b6d2d0 100644 --- a/hw/dv/sv/jtag_agent/README.md +++ b/hw/dv/sv/jtag_agent/README.md
@@ -3,13 +3,13 @@ --- JTAG UVM Agent is extended from the -[DV library agent]({{<relref "hw/dv/sv/dv_lib/doc" >}}) classes, which +[DV library agent](../dv_lib/README.md) classes, which provide common knobs and verification logic that help ease the effort of writing interface agents. ## Block diagram - + ## jtag_if @@ -26,7 +26,7 @@ what we thought we wrote to these registers and compare what we expect the design to return on reads. This RAL model is hand-written, given that it is only a few set of registers. It can be used to drive reads and writes using -our standard [CSR routines]({{<relref "hw/dv/sv/csr_utils/doc">}}). It +our standard [CSR routines](../csr_utils/README.md). It can also be used in higher level testbench components to develop the predicted verification logic.
diff --git a/hw/dv/sv/jtag_dmi_agent/README.md b/hw/dv/sv/jtag_dmi_agent/README.md index 1cd20f4..6913896 100644 --- a/hw/dv/sv/jtag_dmi_agent/README.md +++ b/hw/dv/sv/jtag_dmi_agent/README.md
@@ -10,7 +10,7 @@ ## Block diagram - + ## jtag_dmi_item @@ -52,7 +52,7 @@ This class represents the JTAG DMI register space, as indicated in the [RISCV debug specification 0.13.2](https://github.com/riscv/riscv-debug-spec/raw/4e0bb0fc2d843473db2356623792c6b7603b94d4/riscv-debug-release.pdf). The registers were specified in the adjoining `jtag_dmi.hjson` file and -converted to the model using our [reggen]({{< relref "util/reggen/doc">}}) +converted to the model using our [reggen](../../../../util/reggen/doc/setup_and_use.md) tool. It has been hand-edited after generation to remove the comportability assumptions. See the notes in the file for details.
diff --git a/hw/dv/sv/sim_sram/README.md b/hw/dv/sv/sim_sram/README.md index 3f6565e..d39bcbc 100644 --- a/hw/dv/sv/sim_sram/README.md +++ b/hw/dv/sv/sim_sram/README.md
@@ -6,13 +6,13 @@ This chunk of memory must not overlap with any device on the system address map - it must be an invalid address range from the system's perspective. It has 4 interfaces - clock, reset, input TL interface and the output TL interface. -It instantiates a [1:2 TL socket]({{< relref "hw/ip/tlul/doc#bus-primitives" >}}) to split the incoming TL access into two. +It instantiates a [1:2 TL socket](../../../ip/tlul/README.md#bus-primitives) to split the incoming TL access into two. One of the outputs of the socket is sinked within the module while the other is returned back. If the user chooses to instantiate an actual SRAM instance, the sinked TL interface is connected to TL SRAM adapter which converts the TL access into an SRAM access. -The [technology-independent]({{< relref "hw/ip/prim/doc" >}}) `prim_ram_1p` module is used for instantiating the memory. +The [technology-independent](../../../ip/prim/README.md) `prim_ram_1p` module is used for instantiating the memory. - + This module is not meant to be synthesized. An easy way to ensure this is to instantiate it in simulation if and only if a special macro is defined.
diff --git a/hw/dv/tools/ralgen/README.md b/hw/dv/tools/ralgen/README.md index 6fe20a7..56d9d74 100644 --- a/hw/dv/tools/ralgen/README.md +++ b/hw/dv/tools/ralgen/README.md
@@ -70,7 +70,7 @@ extract those parameters. `ralgen.py` really is just a wrapper around -[`reggen`]({{< relref "util/reggen/doc" >}}) and the `util/topgen.py` +[`reggen`](../../../../util/reggen/doc/setup_and_use.md) and the `util/topgen.py` scripts, which are the ones that actually create the RAL package. Due to the way those scripts are implemented, RAL packages for the IP level testbenches are generated using @@ -86,7 +86,7 @@ The generated core file adds **`lowrisc:dv:dv_base_reg`** as a dependency for the generated RAL package. This is required because our DV register block, register and field models are derived from the -[DV library]({{< relref "hw/dv/sv/dv_lib/doc" >}}) of classes. This +[DV library](../../sv/dv_lib/README.md) of classes. This ensures the right compilation order is maintained. If the `dv_base_names` argument is set, then it adds **`lowrisc:dv:my_base_reg`** as an extra dependency, where `my_base` is the value of the argument as shown in the
diff --git a/hw/formal/README.md b/hw/formal/README.md index 784cd8c..66c072b 100644 --- a/hw/formal/README.md +++ b/hw/formal/README.md
@@ -20,7 +20,7 @@ whose four arguments are assertion name, property, clock, and reset (active-high reset). Assertions are usually added by the designer in the RTL file. -Assertions can also be added in a separate module, see for example [tlul_assert.sv](https://github.com/lowRISC/opentitan/blob/master/hw/ip/tlul/rtl/tlul_assert.sv) and its [documentation]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}), which contains a generic protocol checker for the TileLink-UL standard. +Assertions can also be added in a separate module, see for example [tlul_assert.sv](https://github.com/lowRISC/opentitan/blob/master/hw/ip/tlul/rtl/tlul_assert.sv) and its [documentation](../ip/tlul/doc/TlulProtocolChecker.md), which contains a generic protocol checker for the TileLink-UL standard. ## Types of Assertions There are two types of assertions: @@ -77,7 +77,7 @@ ### More Macros and Examples * For more macros see file [prim_assert.sv](https://github.com/lowRISC/opentitan/blob/master/hw/ip/prim/rtl/prim_assert.sv) and [prim_assert_standard_macros.svh](https://github.com/lowRISC/opentitan/blob/master/hw/ip/prim/rtl/prim_assert_standard_macros.svh). * For more examples, search the repository for ASSERT by typing `grep -r ASSERT .` -* Also see [tlul_assert.sv](https://github.com/lowRISC/opentitan/blob/master/hw/ip/tlul/rtl/tlul_assert.sv) and its [documentation]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}). +* Also see [tlul_assert.sv](https://github.com/lowRISC/opentitan/blob/master/hw/ip/tlul/rtl/tlul_assert.sv) and its [documentation](../ip/tlul/doc/TlulProtocolChecker.md). ## Useful SVA System Functions Below table lists useful SVA (SystemVerilog assertion) functions that can be used for assertion properties. @@ -226,7 +226,7 @@ ### Cadence JasperGold If you have access to JasperGold from Cadence, you can formally verify your assertions. -Before running FPV, please make sure the target has been added to one of the [three batch scripts]({{< relref "doc/getting_started/setup_formal.md#formal-property-verification-fpv" >}}). +Before running FPV, please make sure the target has been added to one of the [three batch scripts](../../doc/guides/getting_started/src/setup_formal.md#formal-property-verification-fpv). For example, to run formal property verification (FPV) using JasperGold on the prim module `prim_arbiter_fixed`, type: ``` @@ -270,7 +270,7 @@ Adding a `--gui` option will open the JaperGold GUI. ## Running FPV on security blocks for common countermeasure primitives -A [security countermeasure verification framework]({{< relref "doc/ug/sec_cm_dv_framework" >}}) is implemented in design and fpv tcl script to verify common countermeasure primitives in a semi-automated way. +A [security countermeasure verification framework](../../doc/contributing/dv/sec_cm_dv_framework/README.md) is implemented in design and fpv tcl script to verify common countermeasure primitives in a semi-automated way. ### Common security assertion macros OpenTitan's security IP blocks have implemented assertions to check against common fault injections.
diff --git a/hw/ip/adc_ctrl/README.md b/hw/ip/adc_ctrl/README.md index 0ca797c..e0b40ea 100644 --- a/hw/ip/adc_ctrl/README.md +++ b/hw/ip/adc_ctrl/README.md
@@ -6,7 +6,7 @@ This document specifies the ADC controller IP functionality. This IP block implements control and filter logic for an analog block that implements a dual ADC. -This module conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification" >}}) +This module conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) See that document for integration overview within the broader top level system. ## Features
diff --git a/hw/ip/adc_ctrl/doc/checklist.md b/hw/ip/adc_ctrl/doc/checklist.md index 43090cf..330314f 100644 --- a/hw/ip/adc_ctrl/doc/checklist.md +++ b/hw/ip/adc_ctrl/doc/checklist.md
@@ -7,8 +7,8 @@ directory for a new design that transitions from L0 (Specification) to L1 (Development) stage, and updated as needed. Once done, please remove this comment before checking it in. --> -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [ADC_CTRL peripheral.]() -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [ADC_CTRL peripheral.]() +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -16,7 +16,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | In progress | [ADC_CTRL Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | In progress | [ADC_CTRL Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -26,15 +26,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -59,24 +59,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -90,13 +90,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -114,15 +114,15 @@ Review | Reviewer(s) | Done | msfschaffner@ timothytrippel@ weicaiyang@ tjaychen@ Review | Signoff date | Done | 2022-08-01 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -130,8 +130,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [ADC_CTRL DV document]({{<relref "dv/index.md" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [ADC_CTRL Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [ADC_CTRL DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [ADC_CTRL Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -153,28 +153,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -201,26 +201,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -232,11 +232,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -258,16 +258,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/adc_ctrl/dv/README.md b/hw/ip/adc_ctrl/dv/README.md index c57b6d6..8936421 100644 --- a/hw/ip/adc_ctrl/dv/README.md +++ b/hw/ip/adc_ctrl/dv/README.md
@@ -10,52 +10,52 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/adc_ctrl/dv/latest/report.html) ## Design features For detailed information on ADC_CTRL design features, please see the [ADC_CTRL HWIP technical specification](). ## Testbench architecture -ADC_CTRL testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +ADC_CTRL testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/adc_ctrl/dv/tb/tb.sv`. It instantiates the ADC_CTRL DUT module `hw/ip/adc_ctrl/rtl/adc_ctrl.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [Always on clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [Always on clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * ADC_CTRL IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) -* Alerts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) -* Wakeup ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) -* [Push Pull Interface] ({{< relref "hw/dv/sv/push_pull_agent/doc" >}}) combined with some logic in `tb.sv` to emulate the ADC data interface +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md) +* Alerts ([`pins_if`](../../../dv/sv/common_ifs/README.md) +* Wakeup ([`pins_if`](../../../dv/sv/common_ifs/README.md) +* [Push Pull Interface] (../../../dv/sv/push_pull_agent/README.md) combined with some logic in `tb.sv` to emulate the ADC data interface ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in `adc_ctrl_env_pkg`. ### TL_agent -ADC_CTRL testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +ADC_CTRL testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into ADC_CTRL device. ### push_pull agents -The ADC data interface is emulated using push_pull agents. ([`push_pull_agent`]({{< relref "hw/dv/sv/push_pull_agent/doc" >}}) +The ADC data interface is emulated using push_pull agents. ([`push_pull_agent`](../../../dv/sv/push_pull_agent/README.md) ### UVM RAL Model -The ADC_CTRL RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The ADC_CTRL RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -88,7 +88,7 @@ The scoreboard uses the predictions to compare against the RTL signals and register read data. #### Assertions -* TLUL assertions: The `sva/adc_ctrl_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `sva/adc_ctrl_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * ADC_CTRL FSM assertions `sva/adc_ctrl_fsm_sva.sv` bound inside adc_ctrl_fsm * FsmStateSwReset_A: Checks FSM is reset by rst_aon_ni * PwrupTimerCntSwReset_A: Checks powerup timer counter is reset by rst_aon_ni @@ -114,7 +114,7 @@ ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/aes/README.md b/hw/ip/aes/README.md index f777c35..f659bfe 100644 --- a/hw/ip/aes/README.md +++ b/hw/ip/aes/README.md
@@ -8,7 +8,7 @@ This document specifies the AES hardware IP functionality. [Advanced Encryption Standard (AES)](https://www.nist.gov/publications/advanced-encryption-standard-aes) is the primary symmetric encryption and decryption mechanism used in OpenTitan protocols. The AES unit is a cryptographic accelerator that accepts requests from the processor to encrypt or decrypt 16 byte blocks of data. -It is attached to the chip interconnect bus as a peripheral module and conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification" >}}) +It is attached to the chip interconnect bus as a peripheral module and conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) ## Features @@ -106,7 +106,7 @@ Using an iterative architecture allows for a smaller circuit area at the cost of throughput. Employing a 128-bit wide data path allows to achieve the latency requirements of 12/14/16 clock cycles per 16B data block in AES-128/192/256 mode in the unmasked implementation, respectively. - + Inside the cipher core, both the data paths for the actual cipher (left) and the round key generation (right) are shared between encryption and decryption. Consequently, the blocks shown in the diagram always implement the forward and backward (inverse) version of the corresponding operation. @@ -129,13 +129,13 @@ Signal | Direction | Type | Description -------------------|------------------|------------------------|--------------- `idle_o` | `output` | `logic` | Idle indication signal for clock manager. -`lc_escalate_en_i` | `input` | `lc_ctrl_pkg::lc_tx_t` | Life cycle escalation enable coming from [life cycle controller]({{< relref "hw/ip/lc_ctrl/doc" >}}). This signal moves the main controller FSM within the AES unit into the terminal error state. The AES unit needs to be reset. -`edn_o` | `output` | `edn_pkg::edn_req_t` | Entropy request to [entropy distribution network (EDN)]({{< relref "hw/ip/edn/doc" >}}) for reseeding internal pseudo-random number generators (PRNGs) used for register clearing and masking. -`edn_i` | `input` | `edn_pkg::edn_rsp_t` | [EDN]({{< relref "hw/ip/edn/doc" >}}) acknowledgment and entropy input for reseeding internal PRNGs. -`keymgr_key_i` | `input` | `keymgr_pgk::hw_key_req_t` | Key sideload request coming from [key manager]({{< relref "hw/ip/keymgr/doc" >}}). +`lc_escalate_en_i` | `input` | `lc_ctrl_pkg::lc_tx_t` | Life cycle escalation enable coming from [life cycle controller](../lc_ctrl/README.md). This signal moves the main controller FSM within the AES unit into the terminal error state. The AES unit needs to be reset. +`edn_o` | `output` | `edn_pkg::edn_req_t` | Entropy request to [entropy distribution network (EDN)](../edn/README.md) for reseeding internal pseudo-random number generators (PRNGs) used for register clearing and masking. +`edn_i` | `input` | `edn_pkg::edn_rsp_t` | [EDN](../edn/README.md) acknowledgment and entropy input for reseeding internal PRNGs. +`keymgr_key_i` | `input` | `keymgr_pgk::hw_key_req_t` | Key sideload request coming from [key manager](../keymgr/README.md). -Note that the `edn_o` and `edn_i` signals used to interface [EDN]({{< relref "hw/ip/edn/doc" >}}) follow a REQ/ACK protocol. -The entropy distributed by EDN is obtained from the [cryptographically secure random number generator (CSRNG)]({{< relref "hw/ip/csrng/doc" >}}). +Note that the `edn_o` and `edn_i` signals used to interface [EDN](../edn/README.md) follow a REQ/ACK protocol. +The entropy distributed by EDN is obtained from the [cryptographically secure random number generator (CSRNG)](../csrng/README.md). ## Design Details @@ -325,7 +325,7 @@ By default, the AES unit is controlled entirely by the processor. The processor writes both input data as well as the initial key to dedicated registers via the system bus interconnect. -Alternatively, the processor can configure the AES unit to use an initial key provided by the [key manager]({{< relref "hw/ip/keymgr/doc" >}}) via key sideload interface without exposing the key to the processor or other hosts attached to the system bus interconnect. +Alternatively, the processor can configure the AES unit to use an initial key provided by the [key manager](../keymgr/README.md) via key sideload interface without exposing the key to the processor or other hosts attached to the system bus interconnect. To this end, the processor has to set the SIDELOAD bit in {{< regref "CTRL_SHADOWED" >}} to `1`. Any write operations of the processor to the Initial Key registers {{< regref "KEY_SHARE0_0" >}} - {{< regref "KEY_SHARE1_7" >}} are then ignored. In normal/automatic mode, the AES unit only starts encryption/decryption if the sideload key is marked as valid. @@ -347,7 +347,7 @@ More precisely, both the cipher and the key expand data path use two shares. As shown in the block diagram below, the width of all registers and data paths basically doubles. - + The initial key is provided in two shares via the register interface. The input data is provided in unmasked form and masked outside of the cipher core to obtain the two shares of the initial state. @@ -366,18 +366,18 @@ These are fully combinational (one S-Box evaluation every cycle) and have lower area footprint, but they are significantly less resistant to SCA. They are mainly included for reference but their usage is discouraged due to potential vulnerabilities to the correlation-enhanced collision attack as described by [Moradi et al.: "Correlation-Enhanced Power Analysis Collision Attack".](https://eprint.iacr.org/2010/297.pdf) -The masking PRNG is reseeded with fresh entropy via [EDN]({{< relref "hw/ip/edn/doc" >}}) automatically 1) whenever a new key is provided (see {{< regref "CTRL_AUX_SHADOWED.KEY_TOUCH_FORCES_RESEED" >}}) and 2) based on a block counter. +The masking PRNG is reseeded with fresh entropy via [EDN](../edn/README.md) automatically 1) whenever a new key is provided (see {{< regref "CTRL_AUX_SHADOWED.KEY_TOUCH_FORCES_RESEED" >}}) and 2) based on a block counter. The rate at which this block counter initiates automatic reseed operations can be configured via {{< regref "CTRL_SHADOWED.PRNG_RESEED_RATE" >}}. In addition software can manually initiate a reseed operation via {{< regref "TRIGGER.PRNG_RESEED" >}}. Note that the masking can be enabled/disabled via compile-time Verilog parameter. -It may be acceptable to disable the masking when using the AES cipher core for random number generation e.g. inside [CSRNG.]({{< relref "hw/ip/csrng/doc" >}}) +It may be acceptable to disable the masking when using the AES cipher core for random number generation e.g. inside [CSRNG.](../csrng/README.md) When disabling the masking, also an unmasked S-Box implementation needs to be selected using the corresponding compile-time Verilog parameter. When disabling masking, it is recommended to use the unmasked Canright or LUT S-Box implementation for ASIC or FPGA targets, respectively. Both are fully combinational and allow for one S-Box evaluation every clock cycle. It's worth noting that since input/output data are provided/retrieved via register interface in unmasked form, the AES unit should not be used to form an identity ladder where the output of one AES operation is used to form the key for the next AES operation in the ladder. -In OpenTitan, the [Keccak Message Authentication Code (KMAC) unit]({{< relref "hw/ip/kmac/doc" >}}) is used for that purpose. +In OpenTitan, the [Keccak Message Authentication Code (KMAC) unit](../kmac/README.md) is used for that purpose. ### Fully-Parallel Data Path @@ -426,7 +426,7 @@ The main control register is implemented as a shadow register. This means software has to perform two subsequent write operations to perform an update. Internally, a shadow copy is used that is constantly compared with the actual register. - For further details, refer to the [Register Tool documentation.]({{< relref "doc/rm/register_tool#shadow-registers" >}}) + For further details, refer to the [Register Tool documentation.](../../../util/reggen/README.md#shadow-registers) - Sparse encodings of FSM states: All FSMs inside the AES unit use sparse state encodings. @@ -637,6 +637,6 @@ Also, using a FIFO interface for something that is not actually FIFO (internally, 16B of input/output data are consumed/produced at once) is less natural. -For a detailed overview of the register tool, please refer to the [Register Tool documentation.]({{< relref "doc/rm/register_tool" >}}) +For a detailed overview of the register tool, please refer to the [Register Tool documentation.](../../../util/reggen/README.md) {{< incGenFromIpDesc "../data/aes.hjson" "registers" >}}
diff --git a/hw/ip/aes/doc/checklist.md b/hw/ip/aes/doc/checklist.md index 91dfa1a..7af1138 100644 --- a/hw/ip/aes/doc/checklist.md +++ b/hw/ip/aes/doc/checklist.md
@@ -2,8 +2,8 @@ title: "AES Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [AES peripheral.]({{<relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [AES peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|----------------------- |-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [AES Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [AES Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,8 +125,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [AES DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [AES Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [AES DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [AES Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Power) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Tests | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/aes/dv/README.md b/hw/ip/aes/dv/README.md index 802888d..d276bb9 100644 --- a/hw/ip/aes/dv/README.md +++ b/hw/ip/aes/dv/README.md
@@ -10,32 +10,32 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages.md" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/aes/dv/latest/report.html) ## Design features -For detailed information on AES design features, please see the [AES HWIP Technical Specification]({{< relref ".." >}}). +For detailed information on AES design features, please see the [AES HWIP Technical Specification](../README.md). ## Testbench architecture -AES testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +AES testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/aes/dv/tb/tb.sv`. It instantiates the AES DUT module `hw/ip/aes/rtl/aes.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in `aes_env_pkg`. @@ -45,19 +45,19 @@ ``` ### TL_agent -AES instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +AES instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into AES device. ### EDN agent -AES instantiates (already handles in the CIP base env) [edn_agent]({{< relref "hw/ip/edn/doc/dv/index.md" >}}) +AES instantiates (already handles in the CIP base env) [edn_agent](../../edn/dv/README.md) which provides the ability to drive and monitor edn traffic via the edn interface. ### UVM RAL model -The AES RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The AES RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -132,11 +132,11 @@ This setting is only available when using the C-model as reference and is controlled with a knob. #### Assertions -* TLUL assertions: The `tb/aes_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/aes_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for both building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for both building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/aon_timer/README.md b/hw/ip/aon_timer/README.md index 3ea3726..704898d 100644 --- a/hw/ip/aon_timer/README.md +++ b/hw/ip/aon_timer/README.md
@@ -5,7 +5,7 @@ # Overview This document specifies the Always-On ("AON") Timer IP functionality. -This module conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification" >}}) +This module conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) See that document for an overview of how it is integrated into the top level system. ## Features @@ -67,7 +67,7 @@ ## Block Diagram - + See the block diagram for high level function and connectivity. The timer interacts with the CPU core and the power manager and reset manager to drive wakeup / reset events and interrupts.
diff --git a/hw/ip/aon_timer/doc/checklist.md b/hw/ip/aon_timer/doc/checklist.md index 1c945a1..1e23e62 100644 --- a/hw/ip/aon_timer/doc/checklist.md +++ b/hw/ip/aon_timer/doc/checklist.md
@@ -2,8 +2,8 @@ title: "AON Timer Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [AON Timer peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [AON Timer peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [AON Timer Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [AON Timer Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Done | msf@ gac@ jeoong@ ctopal@ awill@ Review | Signoff date | Done | 2022-07-18 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (?) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/aon_timer/dv/README.md b/hw/ip/aon_timer/dv/README.md index 7319e7a..d56cafa 100644 --- a/hw/ip/aon_timer/dv/README.md +++ b/hw/ip/aon_timer/dv/README.md
@@ -10,20 +10,20 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/aon_timer/dv/latest/report.html) ## Design features -The AON timer is documented in the [AON Timer HWIP technical specification]({{< relref ".." >}}). +The AON timer is documented in the [AON Timer HWIP technical specification](../README.md). ## Testbench architecture -The testbench is based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +The testbench is based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top-level testbench @@ -31,9 +31,9 @@ It instantiates the `aon_timer` DUT module, defined at `hw/ip/aon_timer/rtl/aon_timer.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and registers their handles in `uvm_config_db`: -* A [clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) for the fast clock -* A [clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) for the AON clock -* A [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* A [clock and reset interface](../../../dv/sv/common_ifs/README.md) for the fast clock +* A [clock and reset interface](../../../dv/sv/common_ifs/README.md) for the AON clock +* A [TileLink host interface](../../../dv/sv/tl_agent/README.md) The AON timer exposes a TL device. Here, the testbench is acting as the host CPU; in the OpenTitan SoC, this will be the Ibex core. * Two interrupts (wakeup timer; watchdog bark) in the fast clock domain @@ -41,12 +41,12 @@ * The sleep mode input * The core interface (see below). -The interrupts and sleep mode input are modelled with the basic [`pins_if`]({{< relref "hw/dv/sv/common_ifs#pins_if" >}}) interface. +The interrupts and sleep mode input are modelled with the basic [`pins_if`](../../../dv/sv/common_ifs/README.md#pins_if) interface. The AON timer uses three clock domains (`async`, `clk_i` and `clk_aon_i`), with synchronisation logic between them. The following diagram shows the different inputs and outputs for the module and in which clock domain each resides. - + To model this accurately without having to precisely model the timing of the synchronisation logic, the testbench is split into two pieces. The first piece has a precise model of the AON timer core and checks that the DUT respects it. @@ -56,13 +56,13 @@ ### TileLink agent -In order to communicate through the register interface, the testbench uses the [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) that is instantiated in the CIP base environment. +In order to communicate through the register interface, the testbench uses the [tl_agent](../../../dv/sv/tl_agent/README.md) that is instantiated in the CIP base environment. This is also used by generic test sequences to exercise the register interface. ### UVM RAL Model -The `aon_timer` RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The `aon_timer` RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}). +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md). Running ``` util/regtool.py -s -t . hw/ip/aon_timer/data/aon_timer.hjson @@ -133,13 +133,13 @@ #### Assertions -TLUL protocol assertions are checked by binding the [TL-UL protocol checker]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) into the design. +TLUL protocol assertions are checked by binding the [TL-UL protocol checker](../../tlul/doc/TlulProtocolChecker.md) into the design. Outputs are also checked for `'X` values by assertions in the design RTL. ## Building and running tests -Tests can be run with [`dvsim.py`]({{< relref "hw/dv/tools/doc" >}}). +Tests can be run with [`dvsim.py`](../../../../util/dvsim/README.md). The link gives details of the tool's features and command line arguments. To run a basic smoke test, go to the top of the repository and run: ```console
diff --git a/hw/ip/clkmgr/README.md b/hw/ip/clkmgr/README.md index 385ded4..eda0a5c 100644 --- a/hw/ip/clkmgr/README.md +++ b/hw/ip/clkmgr/README.md
@@ -17,12 +17,12 @@ Clock management in OpenTitan is divided into groups. Each group has specific attributes and controls whether software is allowed to influence individual clocks during the active power state. -For low power states, please see [power manager]({{< relref "hw/ip/pwrmgr/doc" >}}). +For low power states, please see [power manager](../pwrmgr/README.md). The grouping is derived from the chip partition and related security properties. For illustrative purposes, this document uses the following assumed chip partition - + The actual partition may differ per design, however the general principles are assumed to be the same. Each group can be made up of more than 1 source clock. @@ -152,12 +152,12 @@ The following is a high level block diagram of the clock manager. - + ### Reset Domains Since the function of the clock manager is tied closely into the power-up behavior of the device, the reset domain selection must also be purposefully done. -To ensure that default clocks are available for the [power manager to release resets and initialize memories]({{< relref "hw/ip/pwrmgr/doc/_index.md#fast-clock-domain-fsm" >}}), the clock dividers inside the clock manager directly use `por` (power-on-reset) derived resets. +To ensure that default clocks are available for the [power manager to release resets and initialize memories](../pwrmgr/README.md#fast-clock-domain-fsm), the clock dividers inside the clock manager directly use `por` (power-on-reset) derived resets. This ensures that the root clocks are freely running after power-up and its status can be communicated to the `pwrmgr` regardless of any other activity in the device. The other functions inside the clock manager operate on the `life cycle reset` domain. @@ -166,10 +166,10 @@ The escalation reset restoration is especially important as the clock manager can generate fatal faults that lead to escalation. If there were not a mechanism that allows escalation to clear the original fault, the system would simply remain in a faulted state until a user initiated a `por` event. -For a detailed breakdown between `por` and `life cycle` resets, please see the [reset manager]({{< relref "hw/ip/rstmgr/doc" >}}). +For a detailed breakdown between `por` and `life cycle` resets, please see the [reset manager](../rstmgr/README.md). The following diagram enhances the block diagram to illustrate the overall reset domains of the clock manager. - + ## Hardware Interfaces @@ -208,7 +208,7 @@ Clock manager supports the ability to request root clocks switch to an external clock. There are two occasions where this is required: -- Life cycle transition from `Raw` / `Test_locked` to `Test_unlocked` [states]({{< relref "hw/ip/lc_ctrl/doc/_index.md#clk_byp_req" >}}). +- Life cycle transition from `Raw` / `Test_locked` to `Test_unlocked` [states](../lc_ctrl/README.md#clk_byp_req). - Software request for external clocks during normal functional mode. @@ -224,7 +224,7 @@ Unlike the life cycle controller, a software request for external clocks switches all clock sources to an external source. Software request for external clocks is not always valid. -Software is only able to request for external clocks when hardware debug functions are [allowed]({{< relref "hw/ip/lc_ctrl/doc/_index.md#hw_debug_en" >}}). +Software is only able to request for external clocks when hardware debug functions are [allowed](../lc_ctrl/README.md#hw_debug_en). When software requests the external clock switch, it also provides an indication how fast the external clock is through {{< regref "EXTCLK_CTRL.HI_SPEED_SEL" >}}. There are two supported clock speeds:
diff --git a/hw/ip/clkmgr/doc/checklist.md b/hw/ip/clkmgr/doc/checklist.md index 2dc6a13..f0bcfa4 100644 --- a/hw/ip/clkmgr/doc/checklist.md +++ b/hw/ip/clkmgr/doc/checklist.md
@@ -7,8 +7,8 @@ directory for a new design that transitions from L0 (Specification) to L1 (Development) stage, and updated as needed. Once done, please remove this comment before checking it in. --> -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [CLKMGR peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [CLKMGR peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -16,7 +16,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [CLKMGR Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [CLKMGR Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -26,15 +26,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -59,24 +59,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -90,13 +90,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -114,15 +114,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -130,8 +130,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [CLKMGR DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [CLKMGR Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [CLKMGR DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [CLKMGR Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -153,28 +153,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -201,26 +201,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -232,11 +232,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -258,16 +258,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/clkmgr/dv/README.md b/hw/ip/clkmgr/dv/README.md index a44e19d..298916a 100644 --- a/hw/ip/clkmgr/dv/README.md +++ b/hw/ip/clkmgr/dv/README.md
@@ -11,35 +11,35 @@ * Verify clock gating assertions. ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/clkmgr/dv/latest/report.html) ## Design features -The detailed information on CLKMGR design features is at [CLKMGR HWIP technical specification]({{< relref "hw/ip/clkmgr/doc" >}}). +The detailed information on CLKMGR design features is at [CLKMGR HWIP technical specification](../README.md). ## Testbench architecture -CLKMGR testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +CLKMGR testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/clkmgr/dv/tb.sv`. It instantiates the CLKMGR DUT module `hw/top_earlgrey/ip/clkmgr/rtl/autogen/clkmgr.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * CLKMGR IOs: `hw/ip/clkmgr/dv/env/clkmgr_if.sv` -The Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) interface should be connected once the RTL adds support for it. +The Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) interface should be connected once the RTL adds support for it. ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -60,12 +60,12 @@ ``` ### TL_agent -CLKMGR testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) which provides the ability to drive and independently monitor random traffic via TL host interface into CLKMGR device. +CLKMGR testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into CLKMGR device. ### UVM RAL Model -The CLKMGR RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The CLKMGR RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy This module is rather simple: the stimulus is just the external pins and the CSR updates. @@ -147,11 +147,11 @@ * Gated clock assertions: Interface `clkmgr_gated_clock_sva_if` contains concurrent SVA that checks each gated clock is either running or stopped based on their control logic. There is one assertion for each of the four peripheral clock and five hintable clocks. * Clock divider assertions: Interface `clkmgr_div_sva_if` contains concurrent SVA that checks the `io_div2` and `io_div4` clocks are running at nominal frequency, or are divided by two each in response to the `extclk` logic. -* TLUL assertions: `clkmgr_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: `clkmgr_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test:
diff --git a/hw/ip/csrng/README.md b/hw/ip/csrng/README.md index 36088db..f47415d 100644 --- a/hw/ip/csrng/README.md +++ b/hw/ip/csrng/README.md
@@ -8,14 +8,14 @@ Due to the importance of secure random number generation (RNG), it is a topic which is extensively covered in security standards. This IP targets compliance with both [BSI's AIS31 recommendations for Common Criteria (CC)](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Zertifizierung/Interpretationen/AIS_31_Functionality_classes_for_random_number_generators_e.pdf), as well as [NIST's SP 800-90A](https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-90Ar1.pdf) and [NIST's SP 800-90C (Second Draft)](https://csrc.nist.gov/CSRC/media/Publications/sp/800-90c/draft/documents/sp800_90c_second_draft.pdf), both of which are referenced in [FIPS 140-3](https://csrc.nist.gov/publications/detail/fips/140/3/final). The CSRNG IP supports both of these standards for both deterministic (DRNG) and true random number generation (TRNG). -In NIST terms, it works with the [Entropy Source IP]({{< relref "hw/ip/entropy_src/doc" >}}) to satisfy the requirements as a deterministic random bit generator (DRBG) or non-deterministic random bit generator (NRBG). +In NIST terms, it works with the [Entropy Source IP](../entropy_src/README.md) to satisfy the requirements as a deterministic random bit generator (DRBG) or non-deterministic random bit generator (NRBG). In AIS31 language, this same implementation can be used to satisfy either the DRG.3 requirements for deterministic generation, or the PTG.3 requirements for cryptographically processed physical generation. In this document the terms "DRNG" and "TRNG" are used most generally to refer to deterministic or true random number generation functionalities implemented to this specification. However, the terms "DRBG" or "NRBG" are specifically used when respectively referring to SP 800-90A or SP 800-90C requirements. Meanwhile, when addressing requirements which originate from AIS31 we refer to the specific DRG.3 or PTG.3 classes of RNGs. -This IP block is attached to the chip interconnect bus as a peripheral module conforming to the [comportability definition and specification]({{< relref "doc/rm/comportability_specification" >}}), but also has direct hardware links to other IPs for secure and software-inaccessible transmission of random numbers. +This IP block is attached to the chip interconnect bus as a peripheral module conforming to the [comportability definition and specification](../../../doc/contributing/hw/comportability/README.md), but also has direct hardware links to other IPs for secure and software-inaccessible transmission of random numbers. The bus connections to peripheral modules are done using the CSRNG application interface. This interface allows peripherals to manage CSRNG instances, and request the CSRNG module to return obfuscated entropy. @@ -145,7 +145,7 @@ ## Block Diagram - + ## Hardware Interfaces
diff --git a/hw/ip/csrng/doc/checklist.md b/hw/ip/csrng/doc/checklist.md index 943f4d6..d501811 100644 --- a/hw/ip/csrng/doc/checklist.md +++ b/hw/ip/csrng/doc/checklist.md
@@ -7,8 +7,8 @@ directory for a new design that transitions from L0 (Specification) to L1 (Development) stage, and updated as needed. Once done, please remove this comment before checking it in. --> -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [CSRNG peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [CSRNG peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -16,7 +16,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [CSRNG Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [CSRNG Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -26,15 +26,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -59,24 +59,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -90,13 +90,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -114,15 +114,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -130,8 +130,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [CSRNG DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [CSRNG Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [CSRNG DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [CSRNG Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -153,28 +153,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (?) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -201,26 +201,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -232,11 +232,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -258,16 +258,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/csrng/dv/README.md b/hw/ip/csrng/dv/README.md index 86b7617..d29adf1 100644 --- a/hw/ip/csrng/dv/README.md +++ b/hw/ip/csrng/dv/README.md
@@ -10,34 +10,34 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) -* [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) +* [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/csrng/dv/latest/report.html) ## Design features -For detailed information on CSRNG design features, please see the [CSRNG HWIP technical specification]({{< relref ".." >}}). +For detailed information on CSRNG design features, please see the [CSRNG HWIP technical specification](../README.md). ## Testbench architecture -CSRNG testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +CSRNG testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/csrng/dv/tb/tb.sv`. It instantiates the CSRNG DUT module `hw/ip/csrng/rtl/csrng.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * CSRNG IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) -* Alerts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md) +* Alerts ([`pins_if`](../../../dv/sv/common_ifs/README.md) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -47,20 +47,20 @@ ``` ### TL_agent -CSRNG testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +CSRNG testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into CSRNG device. ### Entropy_src_agent -CSRNG testbench instantiates this [push_pull_agent]({{< relref "hw/dv/sv/push_pull_agent/doc" >}}) which models the ENTROPY_SRC module. +CSRNG testbench instantiates this [push_pull_agent](../../../dv/sv/push_pull_agent/README.md) which models the ENTROPY_SRC module. ### Csrng_agent -CSRNG testbench instantiates this [agent]({{< relref "hw/dv/sv/csrng_agent/doc" >}}) which models the EDN module. +CSRNG testbench instantiates this [agent](../../../dv/sv/csrng_agent/README.md) which models the EDN module. ### UVM RAL Model -The CSRNG RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The CSRNG RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -85,11 +85,11 @@ #### Assertions -* TLUL assertions: The `tb/csrng_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/csrng_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/edn/README.md b/hw/ip/edn/README.md index 7493305..f4e627b 100644 --- a/hw/ip/edn/README.md +++ b/hw/ip/edn/README.md
@@ -5,11 +5,11 @@ # Overview This document specifies EDN hardware IP functionality. -This module conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification" >}}) +This module conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) ## Features -The Entropy Distribution Network (EDN) block provides both hardware and software interfaces to the [CSRNG IP]({{< relref "hw/ip/csrng/doc" >}}) module. +The Entropy Distribution Network (EDN) block provides both hardware and software interfaces to the [CSRNG IP](../csrng/README.md) module. A primary objective of the EDN block is to provide a simpler hardware interface for the peripheral blocks to use, in which case they do not have to directly interface with the CSRNG module. - The EDN block provides a set of registers for firmware to manage a CSRNG application interface port. - There are four request/acknowledge hardware interfaces. @@ -62,7 +62,7 @@ In this mode a single `instantiate` command is sent, followed by a stream of `generate` commands. This sequence fetches the initial random values needed for the system to boot. Use of boot-time request mode, though simpler in operation, is only for applications which do not require FIPS-approved random values. -Please see the [entropy_src IP documentation]({{< relref "hw/ip/entropy_src/doc" >}}) for more information on trade-offs when creating CSRNG seeds before the completion of the FIPS-required health checks. +Please see the [entropy_src IP documentation](../entropy_src/README.md) for more information on trade-offs when creating CSRNG seeds before the completion of the FIPS-required health checks. In boot-time request mode the generate commands continue until `EDN_ENABLE` field is cleared (set to false), the `BOOT_REQ_MODE` field is cleared, or the EDN is reset. Note that when the `EDN_ENABLE` field is cleared or the `BOOT_REQ_MODE` field is cleared, an `uninstantiate` command needs to be sent by firmware to destroy the instance in csrng. Note that the EDNs and CSRNG should always be reset together to ensure proper instantiation or uninstantiation of state variables. @@ -85,7 +85,7 @@ The `entropy_src` only supports one connection to a CSRNG, but the CSRNG has multiple application interface ports for connecting to EDN's or other hardware blocks. The diagram below shows an example topology where two EDN modules are used to distribute `genbits` from the CSRNG to peripheral modules. - + # Theory of Operations @@ -103,7 +103,7 @@ Whenever commands are directly forwarded from firmware to the CSRNG through the {{< regref "SW_CMD_REQ" >}} register, firmware must poll and clear the `CMD_ACK` bit of the {{< regref "SW_CMD_STS" >}} register before sending any further commands. Note that CSRNG commands are to be written into the {{< regref "SW_CMD_REQ" >}}, {{< regref "RESEED_CMD" >}}, and {{< regref "GENERATE_CMD" >}} registers. -CSRNG command format details can be found in [CSRNG]({{< relref "hw/ip/csrng/doc" >}}). +CSRNG command format details can be found in [CSRNG](../csrng/README.md). There are two broad modes for state machine control: auto request mode and boot-time request mode. @@ -131,7 +131,7 @@ Boot-time request mode is not intended for normal operation, as it tolerates the potential use of preliminary seeds for the attached CSRNG instance. These preliminary seeds are described as "pre-FIPS" since they are released from the `entropy_src` before the complete start-up health-checks recommended by FIPS have been completed. Thus pre-FIPS seeds have weaker guarantees on the amount of physical entropy included in their creation. -As detailed in the [`entropy_src` documentation]({{< relref "hw/ip/entropy_src/doc" >}}), only the first CSRNG seed created after reset is pre-FIPS. +As detailed in the [`entropy_src` documentation](../entropy_src/README.md), only the first CSRNG seed created after reset is pre-FIPS. All following seeds from the `entropy_src` are passed through the full FIPS-approved health checks. Therefore at most one EDN can receive a pre-FIPS seed after reset. Since boot-time request mode EDN streams may be FIPS non-compliant, firmware must at some point disable boot-time request mode and reinitialize the EDN for either firmware-driven operation or auto request mode. @@ -155,7 +155,7 @@ The required `generate` and `reseed` commands must also be custom generated by firmware and loaded into the respective command replay FIFOs via the {{< regref "GENERATE_CMD" >}} and {{< regref "RESEED_CMD" >}} registers. These `generate` commands will be issued as necessary to meet the bandwidth requirements of the endpoints. The `reseed` commands will be issued once every `MAX_NUM_REQS_BETWEEN_RESEEDS` generate requests. -For details on the options for application interface commands please see the [CSRNG IP Documentation]({{< relref "hw/ip/csrng/doc/_index.md" >}}). +For details on the options for application interface commands please see the [CSRNG IP Documentation](../csrng/README.md). Once the CSRNG instance has been instantiated, and the `generate` and `reseed` commands have been loaded, auto request mode can be entered by programming the {{< regref "CTRL" >}} register with `EDN_ENABLE` and `AUTO_REQ_MODE` fields are enabled. Note that if BOOT_REQ_MODE is asserted the state machine will enter boot-time request mode, even if AUTO_REQ_MODE is asserted. @@ -194,7 +194,7 @@ ## Block Diagram - + ## Hardware Interfaces @@ -223,7 +223,7 @@ #### Waveforms -See the [CSRNG IP]({{< relref "hw/ip/csrng/doc" >}}) waveform section for the CSRNG application interface commands. +See the [CSRNG IP](../csrng/README.md) waveform section for the CSRNG application interface commands. ##### Peripheral Hardware Interface - Req/Ack The following waveform shows an example of how the peripheral hardware interface works.
diff --git a/hw/ip/edn/doc/checklist.md b/hw/ip/edn/doc/checklist.md index 5086406..4b84be3 100644 --- a/hw/ip/edn/doc/checklist.md +++ b/hw/ip/edn/doc/checklist.md
@@ -7,8 +7,8 @@ directory for a new design that transitions from L0 (Specification) to L1 (Development) stage, and updated as needed. Once done, please remove this comment before checking it in. --> -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [EDN peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [EDN peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -16,7 +16,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [EDN Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [EDN Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -26,15 +26,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -59,24 +59,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -90,13 +90,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -114,15 +114,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -130,8 +130,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [EDN DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [EDN Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [EDN DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [EDN Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -153,28 +153,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power, Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -201,26 +201,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Reviewed on 02/18/2022 Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -232,11 +232,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | Reviewed on 11/11/2022 -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -258,16 +258,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/edn/dv/README.md b/hw/ip/edn/dv/README.md index e7f0a87..37c1837 100644 --- a/hw/ip/edn/dv/README.md +++ b/hw/ip/edn/dv/README.md
@@ -10,34 +10,34 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/edn/dv/latest/report.html) ## Design features -For detailed information on EDN design features, please see the [EDN HWIP technical specification]({{< relref ".." >}}). +For detailed information on EDN design features, please see the [EDN HWIP technical specification](../README.md). ## Testbench architecture -EDN testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +EDN testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/edn/dv/tb.sv`. It instantiates the EDN DUT module `hw/ip/edn/rtl/edn.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * EDN IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) -* Alerts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md) +* Alerts ([`pins_if`](../../../dv/sv/common_ifs/README.md) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -48,20 +48,20 @@ ``` ### TL_agent -EDN testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +EDN testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into EDN device. ### Endpoint_agent -EDN testbench instantiates this push_pull_agent({{< relref "hw/dv/sv/push_pull_agent/doc" >}}) which models an endpoint module. +EDN testbench instantiates this push_pull_agent(../../../dv/sv/push_pull_agent/README.md) which models an endpoint module. ### Csrng_agent -EDN testbench instantiates this agent({{< relref "hw/dv/sv/csrng_agent/doc" >}}) which models the csrng module. +EDN testbench instantiates this agent(../../../dv/sv/csrng_agent/README.md) which models the csrng module. ### UVM RAL Model -The EDN RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The EDN RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -87,11 +87,11 @@ explain inputs monitored, flow of data and outputs checked --> #### Assertions -* TLUL assertions: The `tb/edn_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/edn_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/entropy_src/README.md b/hw/ip/entropy_src/README.md index fa0f38e..2c85a17 100644 --- a/hw/ip/entropy_src/README.md +++ b/hw/ip/entropy_src/README.md
@@ -5,7 +5,7 @@ # Overview This document specifies ENTROPY_SRC hardware IP functionality. -This module conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification" >}}) +This module conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) ## Features @@ -187,7 +187,7 @@ ## Block Diagram - + ## Hardware Interfaces @@ -249,7 +249,7 @@ The larger circles show the how the overall state machine transitions. The sub-state machines with smaller circles show more detail about how the large circles operate. - + ### Entropy Source Hardware Interface
diff --git a/hw/ip/entropy_src/doc/checklist.md b/hw/ip/entropy_src/doc/checklist.md index 77f9e54..bee6aa9 100644 --- a/hw/ip/entropy_src/doc/checklist.md +++ b/hw/ip/entropy_src/doc/checklist.md
@@ -2,8 +2,8 @@ title: "ENTROPY_SRC Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [ENTROPY_SRC peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [ENTROPY_SRC peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [ENTROPY_SRC Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [ENTROPY_SRC Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,8 +125,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [ENTROPY_SRC DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | In Progress | [ENTROPY_SRC Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [ENTROPY_SRC DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | In Progress | [ENTROPY_SRC Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power, Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/entropy_src/dv/README.md b/hw/ip/entropy_src/dv/README.md index f97032a..ac6bbe7 100644 --- a/hw/ip/entropy_src/dv/README.md +++ b/hw/ip/entropy_src/dv/README.md
@@ -10,34 +10,34 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/entropy_src/dv/latest/report.html) ## Design features -For detailed information on ENTROPY_SRC design features, please see the [ENTROPY_SRC HWIP technical specification]({{< relref ".." >}}). +For detailed information on ENTROPY_SRC design features, please see the [ENTROPY_SRC HWIP technical specification](../README.md). ## Testbench architecture -ENTROPY_SRC testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +ENTROPY_SRC testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/entropy_src/dv/tb/tb.sv`. It instantiates the ENTROPY_SRC DUT module `hw/ip/entropy_src/rtl/entropy_src.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * ENTROPY_SRC IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Alerts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Alerts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) <!--### Compile-time configurations TODO--> @@ -58,18 +58,18 @@ ``` ### TL_agent -ENTROPY_SRC testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +ENTROPY_SRC testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into ENTROPY_SRC device. ### Rng_agent -Entropy_src testbench instantiates this PUSH_pull_agent({{< relref "hw/dv/sv/push_pull_agent/doc" >}}) which models the rng source. +Entropy_src testbench instantiates this PUSH_pull_agent(../../../dv/sv/push_pull_agent/README.md) which models the rng source. ### Csrng_agent -Entropy_src testbench instantiates this push_PULL_agent({{< relref "hw/dv/sv/push_pull_agent/doc" >}}) which models the csrng module. +Entropy_src testbench instantiates this push_PULL_agent(../../../dv/sv/push_pull_agent/README.md) which models the csrng module. ### UVM RAL Model -The ENTROPY_SRC RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The ENTROPY_SRC RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. It can be created manually (separately) by running `make` in the `hw/` area. @@ -95,11 +95,11 @@ * rng_fifo, csrng_fifo: The rng_fifo provides transaction items from the predictor and the csrng_fifo provide actual post-entropy_src transaction items to compare #### Assertions -* TLUL assertions: The `tb/entropy_src_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/entropy_src_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/flash_ctrl/README.md b/hw/ip/flash_ctrl/README.md index 97396de..64245a5 100644 --- a/hw/ip/flash_ctrl/README.md +++ b/hw/ip/flash_ctrl/README.md
@@ -11,7 +11,7 @@ * Closed source vendor flash module A breakdown of the 3 can be seen below - + This open source flash controller is divided into two partitions. @@ -21,7 +21,7 @@ The remaining document focuses primarily on the function of these blocks. -This module conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification" >}}) +This module conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) See that document for integration overview within the broader top level system. ## Features @@ -94,7 +94,7 @@ Note, there **can** be more than one information partition, and none of them are required to be the same size as the data partition. See the diagram below for an illustrative example. - + Which type of partition is accessed is controlled through the {{< regref "CONTROL.PARTITION_SEL" >}} field. The current flash controller implements one type of information partition and thus is controlled by 1 bit only. @@ -175,7 +175,7 @@ The seed pages are read under the following initialization conditions: * life cycle sets provision enable - `lc_seed_hw_rd_en` is set. -See [life cycle]({{< relref "hw/ip/lc_ctrl/doc/_index.md#creator_seed_sw_rw_en-and-owner_seed_sw_rw_en" >}}) for more details on when this partition is allowed to be populated. +See [life cycle](../lc_ctrl/README.md#creator_seed_sw_rw_en-and-owner_seed_sw_rw_en) for more details on when this partition is allowed to be populated. #### Isolated Information Partitions @@ -188,14 +188,14 @@ During production and RMA states, the isolated page is also readable. * Both `lc_iso_part_sw_wr_en` and `lc_iso_part_sw_rd_en` are set. -See [life cycle]({{< relref "hw/ip/lc_ctrl/doc/_index.md#iso_part_sw_rd_en-and-iso_part_sw_wr_en" >}}) for more details +See [life cycle](../lc_ctrl/README.md#iso_part_sw_rd_en-and-iso_part_sw_wr_en) for more details # Theory of Operation ## Block Diagram - + ### Flash Protocol Controller @@ -232,7 +232,7 @@ #### Initialization The flash protocol controller is initialized through {{< regref "INIT" >}}. -When initialization is invoked, the flash controller requests the address and data scrambling keys from an external entity, [otp_ctrl]({{< relref "hw/ip/otp_ctrl/doc/_index.md#interface-to-flash-scrambler" >}}) in this case. +When initialization is invoked, the flash controller requests the address and data scrambling keys from an external entity, [otp_ctrl](../otp_ctrl/README.md#interface-to-flash-scrambler) in this case. After the scrambling keys are requested, the flash protocol controller reads the root seeds out of the [secret partitions]({{< relref "#secret-information-partitions" >}}) and sends them to the key manager. Once the above steps are completed, the read buffers in the flash physical controller are enabled for operation. @@ -331,7 +331,7 @@ If software programs {{< regref "EXEC" >}} to `0xa26a38f7`, code fetch from flash is allowed. If software programs {{< regref "EXEC" >}} to any other value, code fetch from flash results in an error. -The flash protocol controller distinguishes code / data transactions through the [instruction type attribute]({{< relref "hw/ip/lc_ctrl/doc/_index.md#usage-of-user-bits" >}}) of the TL-UL interface. +The flash protocol controller distinguishes code / data transactions through the [instruction type attribute](../lc_ctrl/README.md#usage-of-user-bits) of the TL-UL interface. #### Flash Errors and Faults @@ -494,7 +494,7 @@ ##### Overall ICV and ECC Application The following diagram shows how the various ICV / ECC tags are applied and used through the life of a transactions. -. +. Note that the ICV (integrity ECC) is calculated over the descrambled data and is only 4-bits, while the reliability ECC is calculated over both the scrambled data and the ICV. @@ -547,7 +547,7 @@ * When the descrambling is complete, the descrambled text is pushed to the response queue. The following diagram shows how the flash read pipeline timing works. - + In this example, the first two host requests trigger a full sequence. @@ -682,7 +682,7 @@ See detailed steps in theory of operation. The following is a diagram of the controller construction as well as its over connectivity with the flash module. - + ### Host Read
diff --git a/hw/ip/flash_ctrl/doc/checklist.md b/hw/ip/flash_ctrl/doc/checklist.md index cb90074..46216bb 100644 --- a/hw/ip/flash_ctrl/doc/checklist.md +++ b/hw/ip/flash_ctrl/doc/checklist.md
@@ -2,8 +2,8 @@ title: "FLASH_CTRL Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [FLASH_CTRL peripheral.](../) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [FLASH_CTRL peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -22,15 +22,15 @@ Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -55,24 +55,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -86,13 +86,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -110,15 +110,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -126,7 +126,7 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [flash_ctrl_dv_doc]({{<relref "dv/index.md" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [flash_ctrl_dv_doc](../dv/README.md) Documentation | [TESTPLAN_COMPLETED][] | Done | Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | @@ -149,28 +149,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -197,26 +197,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -228,11 +228,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -254,16 +254,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/flash_ctrl/dv/README.md b/hw/ip/flash_ctrl/dv/README.md index 09ec47f..9b76902 100644 --- a/hw/ip/flash_ctrl/dv/README.md +++ b/hw/ip/flash_ctrl/dv/README.md
@@ -10,44 +10,44 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/flash_ctrl/dv/latest/report.html) ## Design features -For detailed information on `flash_ctrl` design features, please see the [`flash_ctrl` HWIP technical specification]({{< relref ".." >}}). +For detailed information on `flash_ctrl` design features, please see the [`flash_ctrl` HWIP technical specification](../README.md). The design-under-test (DUT) wraps the `flash_ctrl` IP, `flash_phy` and the TLUL SRAM adapter that converts the incoming TL accesses from the from host (CPU) interface into flash requests. These modules are instantiated and connected to each other and to the rest of the design at the top level. For the IP level DV, we replicate the instantiations and connections in `flash_ctrl_wrapper` module maintained in DV, located at `hw/ip/flash_ctrl/dv/tb/flash_ctrl_wrapper.sv`. In future, we will consider having the wrapper maintained in the RTL area instead. ## Testbench architecture -The `flash_ctrl` UVM DV testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +The `flash_ctrl` UVM DV testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/flash_ctrl/dv/tb/tb.sv`. It instantiates the `flash_ctrl_wrapper`. In addition, the testbench instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface for the flash controller]({{< relref "hw/dv/sv/tl_agent/doc" >}}) -* [TileLink host interface for the eflash]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface for the flash controller](../../../dv/sv/tl_agent/README.md) +* [TileLink host interface for the eflash](../../../dv/sv/tl_agent/README.md) * TileLink host interface for the prim registers -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) -* [Memory backdoor utility]({{< relref "hw/dv/sv/mem_bkdr_util/doc" >}}) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md) +* [Memory backdoor utility](../../../dv/sv/mem_bkdr_util/README.md) * Secret key interface from the OTP * Interface from the life cycle manager * Interface to the `keymgr` and `pwrmgr` ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### TL_agent -`flash_ctrl` UVM environment instantiates a (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) which provides the ability to drive and independently monitor random traffic via TL host interface into `flash_ctrl` device. +`flash_ctrl` UVM environment instantiates a (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into `flash_ctrl` device. There are two additional instances of the `tl_agent`. * Host interface to the `flash_phy`, to directly fetch the contents of the flash memory, bypassing the `flash_ctrl`. * Host interface to the `prim registers`. @@ -55,9 +55,9 @@ The `tl_agent` monitor supplies partial TileLink request packets as well as completed TileLink response packets over the TLM analysis port for further processing within the `flash_ctrl` scoreboard. ### UVM RAL Model -The `flash_ctrl` RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The `flash_ctrl` RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): #### Sequence cfg An efficient way to develop test sequences is by providing some random variables that are used to configure the DUT / drive stimulus. @@ -142,7 +142,7 @@ For the write transaction, `on-the-fly` model collects rtl data at the boundary of the controller and flash model. #### Assertions -* TLUL assertions: The `hw/ip/flash_ctrl/dv/sva/flash_ctrl_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `hw/ip/flash_ctrl/dv/sva/flash_ctrl_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ### Global types and methods @@ -201,7 +201,7 @@ ``` ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/gpio/README.md b/hw/ip/gpio/README.md index 1fc5cee..4301745 100644 --- a/hw/ip/gpio/README.md +++ b/hw/ip/gpio/README.md
@@ -6,7 +6,7 @@ This document specifies GPIO hardware IP functionality. This module conforms to the [Comportable guideline for peripheral device -functionality]({{< relref "doc/rm/comportability_specification" >}}) +functionality](../../../doc/contributing/hw/comportability/README.md) See that document for integration overview within the broader top level system. @@ -54,7 +54,7 @@ ## Block Diagram - + The block diagram above shows the `DATA_OUT` and `DATA_OE` registers managed by hardware outside of the auto-generated register file. @@ -69,7 +69,7 @@ ### GPIO Output logic - + The GPIO module maintains one 32-bit output register `DATA_OUT` with two ways to write to it. Direct write access uses {{< regref "DIRECT_OUT" >}}, and @@ -133,7 +133,7 @@ The GPIO module provides 32 interrupt signals to the main processor. Each interrupt can be independently enabled, tested, and configured. Following the standard interrupt guidelines in the [Comportability -Specification]({{< relref "doc/rm/comportability_specification" >}}), +Specification](../../../doc/contributing/hw/comportability/README.md), the 32 bits of the {{< regref "INTR_ENABLE" >}} register determines whether the associated inputs are configured to detect interrupt events. If enabled via the various `INTR_CTRL_EN` registers, their current state can be
diff --git a/hw/ip/gpio/doc/checklist.md b/hw/ip/gpio/doc/checklist.md index 956e8c0..9f564a2 100644 --- a/hw/ip/gpio/doc/checklist.md +++ b/hw/ip/gpio/doc/checklist.md
@@ -2,8 +2,8 @@ title: "GPIO Checklist" --- -This checklist is for [Hardware Stage]({{<relref "/doc/project/development_stages.md">}}) transitions for the [GPIO peripheral][GPIO Spec]. -All checklist items refer to the content in the [Checklist.]({{<relref "/doc/project/checklist.md">}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [GPIO peripheral][GPIO Spec]. +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -25,15 +25,15 @@ [GPIO CSR]: ../data/gpio.hjson -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -58,24 +58,24 @@ Code Quality | [TIMING_CHECK][] | Done | Fmax 50MHz on NexysVideo Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -89,13 +89,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -113,15 +113,15 @@ Review | Reviewer(s) | Done | eunchan@ jeoong@ weicai@ alphan@ Review | Signoff date | Done | 2022-05-26 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -152,30 +152,30 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power, Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[gpio_dv_doc]: {{<relref "dv/index.md">}} +[gpio_dv_doc]: ../dv/README.md -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -207,26 +207,26 @@ [#680]: https://github.com/lowRISC/opentitan/pull/680 [#807]: https://github.com/lowRISC/opentitan/pull/807 -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -238,11 +238,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -266,19 +266,19 @@ [#807]: https://github.com/lowRISC/opentitan/pull/807 -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending [common_cov_excl.el]:https://github.com/lowRISC/opentitan/blob/9dff09b6c57f4962d67f5f64f8e69ac9bea6885c/hw/dv/tools/vcs/common_cov_excl.el [gpio_cov_excl.el]: https://github.com/lowRISC/opentitan/blob/39aaeefdb43661b065c29ceab2efc1065aebf6dd/hw/ip/gpio/dv/cov/gpio_cov_excl.el
diff --git a/hw/ip/gpio/dv/README.md b/hw/ip/gpio/dv/README.md index 317df9f..834d6f9 100644 --- a/hw/ip/gpio/dv/README.md +++ b/hw/ip/gpio/dv/README.md
@@ -10,32 +10,32 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages.md" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/gpio/dv/latest/report.html) ## Design features -For detailed information on GPIO design features, please see the [GPIO design specification]({{< relref ".." >}}). +For detailed information on GPIO design features, please see the [GPIO design specification](../README.md). ## Testbench architecture -GPIO testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +GPIO testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/gpio/dv/tb/tb.sv`. It instantiates the GPIO DUT module `hw/ip/gpio/rtl/gpio.sv`. In addition, it instantiates the following interfaces and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) -* GPIO IOs ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) +* GPIO IOs ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in `gpio_env_pkg`. Some of them in use are: @@ -44,12 +44,12 @@ parameter uint FILTER_CYCLES = 16; ``` ### TL_agent -GPIO testbench instantiates (handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) which provides the ability to drive and independently monitor random traffic via TL host interface into GPIO device. +GPIO testbench instantiates (handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into GPIO device. ### UVM RAL Model -The GPIO RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The GPIO RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -98,14 +98,14 @@ Any CSR read transaction would check actual read data against predicted value. Additionally, CSR read on intr_state would also check if monitored value of interrupt pins match the predicted value. #### Assertions -* TLUL assertions: The `tb/gpio_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/gpio_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset * `IntrGpioKnown`: Checks that GPIO interrupt pins do not have any unknowns * `CioGpioEnOKnown`: Checks that GPIO output does not have any unknowns * `CioGpioOKnown`: Checks that GPIO output enable does not have any unknowns ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/hmac/README.md b/hw/ip/hmac/README.md index a445ef7..33c3c5a 100644 --- a/hw/ip/hmac/README.md +++ b/hw/ip/hmac/README.md
@@ -5,7 +5,7 @@ # Overview This document specifies HMAC hardware IP functionality. This module conforms to -the [OpenTitan guideline for peripheral device functionality.]({{< relref "doc/rm/comportability_specification" >}}) +the [OpenTitan guideline for peripheral device functionality.](../../../doc/contributing/hw/comportability/README.md) See that document for integration overview within the broader OpenTitan top level system. @@ -27,7 +27,7 @@ This HMAC implementation is not hardened against side channel or fault injection attacks. It is meant purely for hashing acceleration. -If hardened MAC operations are required, users should use either [KMAC]({{< relref "hw/ip/kmac/doc" >}}) or a software implementation. +If hardened MAC operations are required, users should use either [KMAC](../kmac/README.md) or a software implementation. The 256-bit secret key is written in {{< regref "KEY_0" >}} to {{< regref "KEY_7" >}}. The message to authenticate is written to {{< regref "MSG_FIFO" >}} and the HMAC generates a 256-bit digest value which can be read from {{< regref "DIGEST_0" >}} to {{< regref "DIGEST_7" >}}. @@ -58,7 +58,7 @@ ## Block Diagram - + The HMAC block diagram above shows that the HMAC core converts the secret key registers into an inner padded key and an outer padded key which are fed to the @@ -69,7 +69,7 @@ padded key and first round digest result for the second round. See [Design Details](#design-details) for more information. - + The SHA-256 (SHA-2) block diagram shows the message FIFO inside SHA-256, hash registers, digest registers, and SHA-256 compression function. The message FIFO @@ -118,7 +118,7 @@ Push to SHA2 #1 | 00000004h | 00000005h -Small writes to {{< regref "MSG_FIFO" >}} are coalesced with into 32-bit words by the [packer logic]({{< relref "hw/ip/prim/doc/prim_packer" >}}). +Small writes to {{< regref "MSG_FIFO" >}} are coalesced with into 32-bit words by the [packer logic](../prim/doc/prim_packer.md). These words are fed into the internal message FIFO. While passing writes to the packer logic, the block also counts the number of bytes that are being passed. This gives the received message length, which is used in HMAC and SHA-256 as part of the hash computation. @@ -131,7 +131,7 @@ below. The padding logic handles this so software only needs to write the actual message bits into the FIFO. - + For instance, if the message is empty, the message length is 64-bit 0. In this case, the padding logic gives `0x80000000` into the SHA-256 module first. Then @@ -162,7 +162,7 @@ ### HMAC computation - + HMAC can be used with any hash algorithm but this version of HMAC IP only uses SHA-256. The first phase of HMAC calculates the SHA-256 hash of the inner
diff --git a/hw/ip/hmac/doc/checklist.md b/hw/ip/hmac/doc/checklist.md index 939e8b4..18ba03c 100644 --- a/hw/ip/hmac/doc/checklist.md +++ b/hw/ip/hmac/doc/checklist.md
@@ -2,8 +2,8 @@ title: "HMAC Checklist" --- -This checklist is for [Hardware Stage]({{<relref "/doc/project/development_stages.md" >}}) transitions for the [HMAC peripheral](../). -All checklist items refer to the content in the [Checklist.]({{<relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [HMAC peripheral](../README.md). +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -21,17 +21,17 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[HMAC Spec]: {{<relref ".">}} +[HMAC Spec]: ../README.md -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -58,23 +58,23 @@ [#761]: https://github.com/loWRISC/opentitan/issues/761 -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[FPGA_TIMING]: {{<relref "/doc/project/checklist.md#fpga_timing" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} -[SEC_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_rnd_cnst" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[FPGA_TIMING]: ../../../../doc/project_governance/checklist/README.md#fpga_timing +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented +[SEC_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_rnd_cnst ### D2S @@ -88,13 +88,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -112,17 +112,17 @@ Review | Reviewer(s) | Done | @rswarbrick @cindychip @jadephilipoom Review | Signoff date | Done | 2022-07-27 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} -[SEC_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_non_reset_flops" >}} -[SEC_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_shadow_regs" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata +[SEC_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_non_reset_flops +[SEC_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_shadow_regs ## Verification Checklist @@ -130,7 +130,7 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|----------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [hmac_dv_doc]({{<relref "dv/index.md" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [hmac_dv_doc](../dv/README.md) Documentation | [TESTPLAN_COMPLETED][] | Done | Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | @@ -153,28 +153,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power, Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -203,26 +203,26 @@ [#820]: https://github.com/lowRISC/opentitan/pull/820 -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -234,11 +234,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -267,16 +267,16 @@ [issue #991]: https://github.com/loWRISC/opentitan/issues/523 [issue #860]: https://github.com/loWRISC/opentitan/issues/860 -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/hmac/dv/README.md b/hw/ip/hmac/dv/README.md index b6ff8f7..e14244d 100644 --- a/hw/ip/hmac/dv/README.md +++ b/hw/ip/hmac/dv/README.md
@@ -10,34 +10,34 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages.md" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/hmac/dv/latest/report.html) ## Design features For detailed information on HMAC design features, please see the -[HMAC design specification]({{< relref ".." >}}). +[HMAC design specification](../README.md). ## Testbench architecture HMAC testbench has been constructed based on the -[CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +[CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/hmac/dv/tb/tb.sv`. It instantiates the HMAC DUT module `hw/ip/hmac/rtl/hmac.sv`. In addition, it instantiates the following interfaces and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in `env/hmac_env_pkg`. @@ -49,14 +49,14 @@ ``` ### TL_agent -HMAC instantiates (handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +HMAC instantiates (handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into HMAC device. ### UVM RAL Model -The HMAC RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The HMAC RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Reference models To check the correctness of the output for SHA256 and HMAC, the testbench uses @@ -129,12 +129,12 @@ #### Assertions * TLUL assertions: The `tb/hmac_bind.sv` binds the `tlul_assert` - [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to hmac to ensure TileLink interface protocol compliance. + [assertions](../../tlul/doc/TlulProtocolChecker.md) to hmac to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests We are using our in-house developed -[regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +[regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test:
diff --git a/hw/ip/i2c/README.md b/hw/ip/i2c/README.md index 283472b..754fdc1 100644 --- a/hw/ip/i2c/README.md +++ b/hw/ip/i2c/README.md
@@ -6,7 +6,7 @@ # Overview This document specifies I2C hardware IP functionality. -This module conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification/index.md" >}}) +This module conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) See that document for integration overview within the broader top level system. @@ -80,7 +80,7 @@ ## Block Diagram - + ## Hardware Interfaces @@ -185,7 +185,7 @@ A STOP or repeated START indicator is inserted into ACQ FIFO as the next entry following the last byte received, in which case other bits may be junk. The following diagram shows consecutive entries inserted into ACQ FIFO during a write operation: - + If the transaction is a read operation (R/W bit = 1), the target pulls bytes out of TX FIFO and transmits them to the bus until the host signals the end of the transfer by sending a NACK signal. If TX FIFO holds no data, or if the ACQ FIFO contains more than 1 entry, the target will hold SCL low to stretch the clock and give software time to write data bytes into TX FIFO or handle the available command. @@ -196,7 +196,7 @@ For ACK and NACK signals, the value of the first bit is 0 and 1, respectively. The following diagram shows consecutive entries inserted into ACQ FIFO during a read operation: - + The ACQ FIFO entry consists of 10 bits: - Address (bits 7:1) and R/W bit (bit 0) or data byte @@ -375,11 +375,11 @@ However, all transitions which are dependent on formatting flags are shown explicitly in this figure. - + Similarly, the figure below shows a simplified version of the I2C_Target state machine. - + In this diagram, "R/W" stands for a R/W bit value. The host is reading when R/W bit is "1" and writing when R/W bit is "0".
diff --git a/hw/ip/i2c/doc/checklist.md b/hw/ip/i2c/doc/checklist.md index 9abc1a5..1e56396 100644 --- a/hw/ip/i2c/doc/checklist.md +++ b/hw/ip/i2c/doc/checklist.md
@@ -2,10 +2,10 @@ title: "I2C Checklist" --- -This checklist is for [Hardware Stage][] transitions for the [I2C peripheral.]({{<relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{<relref "/doc/project/checklist.md">}}) +This checklist is for [Hardware Stage][] transitions for the [I2C peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) -[Hardware Stage]: {{<relref "/doc/project/development_stages.md" >}} +[Hardware Stage]: ../../../../doc/project_governance/development_stages.md ## Design Checklist @@ -13,7 +13,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [I2C Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [I2C Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -23,15 +23,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -56,24 +56,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -87,13 +87,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -111,15 +111,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -127,8 +127,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [I2C_DV doc]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [I2C Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [I2C_DV doc](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [I2C Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -150,28 +150,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power, Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -198,26 +198,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Not Started | Review | [V3_CHECKLIST_SCOPED][] | Not Started | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -229,11 +229,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -255,16 +255,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/i2c/dv/README.md b/hw/ip/i2c/dv/README.md index 82f2ab2..a1a7894 100644 --- a/hw/ip/i2c/dv/README.md +++ b/hw/ip/i2c/dv/README.md
@@ -10,34 +10,34 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages.md" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/i2c/dv/latest/results.html) ## Design features For detailed information on I2C design features, please see the -[I2C design specification]({{< relref ".." >}}). +[I2C design specification](../README.md). ## Testbench architecture I2C testbench has been constructed based on the -[CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +[CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/i2c/dv/tb/tb.sv`. It instantiates the I2C DUT module `hw/ip/i2c/rtl/i2c.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * I2C IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -48,7 +48,7 @@ ``` ### TL_agent -I2C instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +I2C instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into I2C device. @@ -56,9 +56,9 @@ I2C agent is configured to work device mode and implemented as [reactive agent](https://www.verilab.com/files/mastering_reactive_slaves.pdf) ### UVM RAL Model -The I2C RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The I2C RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -84,13 +84,13 @@ * analysis port2: #### Assertions -* TLUL assertions: The `tb/i2c_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/i2c_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. * assertion 1 * assertion 2 ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/keymgr/README.md b/hw/ip/keymgr/README.md index b939585..a9c2a0a 100644 --- a/hw/ip/keymgr/README.md +++ b/hw/ip/keymgr/README.md
@@ -24,11 +24,11 @@ Key manager behavior can be summarized by the functional model below. - + In the diagram, the red boxes represent the working state and the associated internal key, the black ovals represent derivation functions, the green squares represent software inputs, and the remaining green / purple shapes represent outputs to both software and hardware. -In OpenTitan, the derivation method selected is [KMAC]({{< relref "hw/ip/kmac/doc" >}}). +In OpenTitan, the derivation method selected is [KMAC](../kmac/README.md). Each valid operation involves a KMAC invocation using the key manager internal key and other HW / SW supplied inputs as data. While KMAC can generate outputs of arbitrary length, this design fixes the size to 256b. @@ -160,7 +160,7 @@ If ever multiple conditions collide (a fault is detected at the same time software issues disable command), the `Invalid` entry path always takes precedence. ## Life Cycle Connection -The function of the key manager is directly managed by the [life cycle controller]({{< relref "hw/ip/lc_ctrl/doc/#key-manager-en" >}}). +The function of the key manager is directly managed by the [life cycle controller](../lc_ctrl/README.md#key-manager-en). Until the life cycle controller activates the key manager, the key manager does not accept any software commands. Once the key manager is activated by the life cycle controller, it is then allowed to transition to the various states previously [described](#key-manager-states). @@ -364,7 +364,7 @@ ## Block Diagram The following is a high level block diagram of the key manager. - + ## Design Details @@ -377,7 +377,7 @@ The key manager control block manages the working state, sideload key updates, as well as what commands are valid in each state. It also handles the life cycle `keymgr_en` input, which deactivates the entire key manager function in the event of an escalation. - + ### KMAC Interface Control @@ -385,7 +385,7 @@ The KMAC interface control represents the bulk of key manager logic. Based on input from key manager control, this module selects the inputs for each given command and sequences the data to KMAC. - + The KMAC interface works on a simple `valid / ready` protocol. When there is data to send, the KMAC interface sends out a `valid` and keeps it active.
diff --git a/hw/ip/keymgr/doc/checklist.md b/hw/ip/keymgr/doc/checklist.md index 0d825a2..7997759 100644 --- a/hw/ip/keymgr/doc/checklist.md +++ b/hw/ip/keymgr/doc/checklist.md
@@ -7,8 +7,8 @@ directory for a new design that transitions from L0 (Specification) to L1 (Development) stage, and updated as needed. Once done, please remove this comment before checking it in. --> -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [KEYMGR peripheral.](../) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [KEYMGR peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -16,7 +16,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [KEYMGR Design Spec](../) +Documentation | [SPEC_COMPLETE][] | Done | [KEYMGR Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -26,15 +26,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -59,24 +59,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -90,13 +90,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -114,15 +114,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -130,8 +130,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [KEYMGR DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [KEYMGR Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [KEYMGR DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [KEYMGR Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -153,28 +153,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Verification for security hasn't been planned yet. Will revisit it in V2. Exception (Power, Performance, Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -201,26 +201,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -232,11 +232,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | 11/09/2022 -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -258,16 +258,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/keymgr/dv/README.md b/hw/ip/keymgr/dv/README.md index ffa22ac..af5b3e2 100644 --- a/hw/ip/keymgr/dv/README.md +++ b/hw/ip/keymgr/dv/README.md
@@ -10,33 +10,33 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/keymgr/dv/latest/report.html) ## Design features -For detailed information on KEYMGR design features, please see the [KEYMGR HWIP technical specification]({{< relref ".." >}}). +For detailed information on KEYMGR design features, please see the [KEYMGR HWIP technical specification](../README.md). ## Testbench architecture -KEYMGR testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +KEYMGR testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/keymgr/dv/tb/tb.sv`. It instantiates the KEYMGR DUT module `hw/ip/keymgr/rtl/keymgr.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * KEYMGR IOs (`keymgr_if`) -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Alerts ([`alert_esc_if`]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Alerts ([`alert_esc_if`](../../../dv/sv/alert_esc_agent/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Compile-time configurations [list compile time configurations, if any and what are they used for] @@ -48,21 +48,21 @@ [list a few parameters, types & methods; no need to mention all] ``` ### TL_agent -KEYMGR testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +KEYMGR testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into KEYMGR device. ### EDN Agent -The KEYMGR testbench instantiates a `push_pull_agent` in `Pull` mode as the agent modelling the [EDN interface]({{< relref "hw/dv/sv/push_pull_agent/doc" >}}) (this is already handled in the CIP base classes). +The KEYMGR testbench instantiates a `push_pull_agent` in `Pull` mode as the agent modelling the [EDN interface](../../../dv/sv/push_pull_agent/README.md) (this is already handled in the CIP base classes). This agent will return random data as entropy when the KEYMGR sends a request. ### KMAC_APP Agent -The KEYMGR testbench instantiates a [`kmac_app_agent`]({{< relref "hw/dv/sv/kmac_app_agent/doc" >}}) to request a KMAC hash operation on the secret data. +The KEYMGR testbench instantiates a [`kmac_app_agent`](../../../dv/sv/kmac_app_agent/README.md) to request a KMAC hash operation on the secret data. ### UVM RAL Model -The KEYMGR RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The KEYMGR RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Reference models [Describe reference models in use if applicable, example: SHA256/HMAC] @@ -93,13 +93,13 @@ * edn_fifo: An analysis FIFO to hold transactions coming from the EDN interface. #### Assertions -* TLUL assertions: The `tb/keymgr_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/keymgr_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. * Check(Kmac|Aes|Otbn)Key: Check keys on the 3 sideload interfaces. * CheckEdn1stReq / CheckEdn2ndReq: Check KEYMGR sends 2 EDN request periodically based on the CSR `reseed_interval`. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/kmac/README.md b/hw/ip/kmac/README.md index c04ca3d..946e4ce 100644 --- a/hw/ip/kmac/README.md +++ b/hw/ip/kmac/README.md
@@ -41,7 +41,7 @@ ## Block Diagram - + The above figure shows the KMAC/SHA3 HWIP block diagram. The KMAC has register interfaces for SW to configure the module, initiate the hashing process, and acquire the result digest from the STATE memory region. @@ -89,7 +89,7 @@ For instance, 200 bits of internal state run 18 rounds. KMAC/SHA3 instantiates the Keccak round module with 1600 bit. - + Keccak round logic has two phases inside. Theta, Rho, Pi functions are executed at the 1st phase. @@ -128,7 +128,7 @@ This module talks to Keccak round logic with a more memory-like interface. The interface has an additional address signal on top of the valid, ready, and data signals. - + The hashing process begins when the software issues the start command to {{< regref "CMD" >}} . If cSHAKE is enabled, the padding logic expands the prefix value (`N || S` above) into a block size. @@ -145,7 +145,7 @@ The padding logic, after receiving the Process command, appends proper ending bits with respect to the {{< regref "CFG.mode" >}} value. The logic writes 0 up to the block size to the Keccak round logic then ends with 1 at the end of the block. - + After the Keccak round completes the last block, the padding logic asserts an `absorbed` signal to notify the software. The signal generates the `kmac_done` interrupt. @@ -157,7 +157,7 @@ ### Padding for KMAC - + KMAC core prepends and appends additional bitstream on top of Keccak padding logic in SHA3 core. The [NIST SP 800-185][] defines `KMAC[128,256](K, X, L, S)` as a cSHAKE function. @@ -278,7 +278,7 @@ ### Application Interface - + KMAC/SHA3 HWIP has an option to receive the secret key from the KeyMgr via sideload key interface. The software should set {{< regref "CFG.sideload" >}} to use the KeyMgr sideloaded key for the SW-initiated KMAC operation. @@ -327,7 +327,7 @@ KMAC has an entropy generator to provide the design with pseudo-random numbers while processing the secret key block. The entropy is used for both remasking the DOM multipliers inside the Chi function of the Keccak core as well as for masking the message if {{<regref "CFG_SHADOWED.msg_mask" >}} is enabled. - + The entropy generator is made up of 25 32-bit linear feedback shift registers (LFSRs). This allows the module to generate 800 bits of fresh, pseudo-random numbers required by the 800 DOM multipliers for remasking in every clock cycle. @@ -344,7 +344,7 @@ Similarly, the previous states of LFSRs 1/6/11/16/21 from before the reseeding operation are permuted and then forwarded to reseed LFSRs 2/7/12/17/22. Software can still request a complete reseed of all 25 LFSRs from EDN by subsequently triggering five reseeding operations through {{<regref "CMD.entropy_req" >}}. -[edn]: {{<relref "/hw/ip/edn/doc/_index.md">}} +[edn]: ../edn/README.md ### Error Report
diff --git a/hw/ip/kmac/doc/checklist.md b/hw/ip/kmac/doc/checklist.md index c9d570b..fefdd4c 100644 --- a/hw/ip/kmac/doc/checklist.md +++ b/hw/ip/kmac/doc/checklist.md
@@ -2,8 +2,8 @@ title: "KMAC Checklist" --- -This checklist is for [Hardware Stage]({{<relref "/doc/project/development_stages.md" >}}) transitions for the [KMAC peripheral](../). -All checklist items refer to the content in the [Checklist.]({{<relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [KMAC peripheral](../README.md). +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [KMAC Spec](../) +Documentation | [SPEC_COMPLETE][] | Done | [KMAC Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -149,28 +149,28 @@ (Security/Power/Debug) Review | [V2_CHECKLIST_SCOPED][] | Not Started | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -197,26 +197,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -228,11 +228,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | 09/29/2022 -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -254,16 +254,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/kmac/dv/README.md b/hw/ip/kmac/dv/README.md index b92ac64..774316b 100644 --- a/hw/ip/kmac/dv/README.md +++ b/hw/ip/kmac/dv/README.md
@@ -10,32 +10,32 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/kmac/dv/latest/report.html) ## Design features -For detailed information on KMAC design features, please see the [KMAC HWIP technical specification]({{< relref ".." >}}). +For detailed information on KMAC design features, please see the [KMAC HWIP technical specification](../README.md). ## Testbench architecture -KMAC testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +KMAC testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/kmac/dv/tb/tb.sv`. It instantiates the KMAC DUT module `hw/ip/kmac/rtl/kmac.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * KMAC IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Compile-time configurations Two compile-time configurations are tested: @@ -86,20 +86,20 @@ endfunction ``` ### TL_agent -KMAC testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) which provides the ability to drive and independently monitor random traffic via TL host interface into KMAC device. +KMAC testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into KMAC device. ### EDN Agent -The KMAC testbench instantiates a `push_pull_agent` in `Pull` mode as the agent modelling the [EDN interface]({{< relref "hw/dv/sv/push_pull_agent/doc" >}}) (this is already handled in the CIP base classes). +The KMAC testbench instantiates a `push_pull_agent` in `Pull` mode as the agent modelling the [EDN interface](../../../dv/sv/push_pull_agent/README.md) (this is already handled in the CIP base classes). This agent will return random data as entropy after a random delay any time the KMAC sends a request. ### KMAC_APP Agent -The KMAC testbench instantiates an array of [`kmac_app_agent`]({{< relref "hw/dv/sv/kmac_app_agent/doc" >}}) to model the application interfaces used by other IP blocks to request a KMAC hash operation on some data. +The KMAC testbench instantiates an array of [`kmac_app_agent`](../../../dv/sv/kmac_app_agent/README.md) to model the application interfaces used by other IP blocks to request a KMAC hash operation on some data. These interfaces are used to send in message data to the KMAC, and to receive an output digest. ### UVM RAL Model -The KMAC RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The KMAC RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Reference models The KMAC testbench utilizes a [C++ reference model](https://github.com/lowRISC/opentitan/blob/master/hw/ip/kmac/dv/dpi/vendor/kerukuro_digestpp/README.md) for various hashing operations (SHA3, SHAKE, CSHAKE, KMAC) to check the DUT's digest output for correctness. @@ -138,11 +138,11 @@ As the test sequence reads the output STATE_SHARE windows after a hash operation, the scoreboard will assemble the read digest data into the actual digest value, which can easily be compared against the output of the C++ reference model. #### Assertions -* TLUL assertions: The `tb/kmac_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/kmac_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/lc_ctrl/README.md b/hw/ip/lc_ctrl/README.md index 12295bb..d09aaba 100644 --- a/hw/ip/lc_ctrl/README.md +++ b/hw/ip/lc_ctrl/README.md
@@ -6,8 +6,8 @@ # Overview This document specifies the functionality of the life cycle controller. -The life cycle controller is a module that is a peripheral on the chip interconnect bus, and thus follows the [Comportability Specification]({{< relref "doc/rm/comportability_specification" >}}). -For the high-level description of the life cycle architecture of OpenTitan, please refer to the [Device Life Cycle Architecture]({{< relref "doc/security/specs/device_life_cycle" >}}). +The life cycle controller is a module that is a peripheral on the chip interconnect bus, and thus follows the [Comportability Specification](../../../doc/contributing/hw/comportability/README.md). +For the high-level description of the life cycle architecture of OpenTitan, please refer to the [Device Life Cycle Architecture](../../../doc/security/specs/device_life_cycle/README.md). The life cycle implementation refers to the design that encompasses all life cycle functions. This touches on the functionality of the following modules, listed in no particular order: - The life cycle controller itself - A new peripheral @@ -53,20 +53,20 @@ ## Power Up Sequence -Upon power up, the life cycle controller will default to "RAW" state and wait for the OTP controller to initialize and sense the contents of the [life cycle partition]({{< relref "hw/ip/otp_ctrl/doc/_index.md#logical-partitions">}}). +Upon power up, the life cycle controller will default to "RAW" state and wait for the OTP controller to initialize and sense the contents of the [life cycle partition](../otp_ctrl/README.md#logical-partitions). When the OTP is ready, the life cycle controller reads the contents of the life cycle partition, decodes the life cycle state and updates its internal state to match. This implies that unlike the life cycle definition diagram, there is a one-time "RAW to any state" logical transition that is implicit within the implementation. Note during OTP sensing, the life cycle controller does not perform any redundant checks upon the value it reads; instead that responsibility is allocated to the OTP controller. Once the state values are correctly sensed, the life cycle controller performs checks on state consistency and dependencies, and if correct, broadcasts both the raw state value as well as the decoded functional outputs to the rest of the device. -Once the broadcast is complete and signals stable, modules held under reset by ["sys_rst_n"]({{< relref "hw/ip/rstmgr/doc" >}}) are then released from reset to begin mission mode operations (this includes the processor). +Once the broadcast is complete and signals stable, modules held under reset by ["sys_rst_n"](../rstmgr/README.md) are then released from reset to begin mission mode operations (this includes the processor). Note this point is also when it is safe for DFT to commence operations, as DFT functions may be blocked until life cycle completes its broadcast. The following diagram illustrates this power-up sequence. Note the sequence is not designed into one specific module, but rather a result of coordination between the OTP controller, life cycle controller and the reset / power controllers. - + ## Normal Operation @@ -81,11 +81,11 @@ ### Conditional Transitions For conditional transitions, such as those that require a token (RAW_UNLOCK, TEST_UNLOCK, TEST_EXIT, RMA_UNLOCK), the life cycle controller advances the state via OTP programming only after it is supplied with the valid token. -[Some tokens]({{< relref "doc/security/specs/device_life_cycle/_index.md#manufacturing-states" >}}) are hardcoded design constants, while others are stored in OTP. +[Some tokens](../../../doc/security/specs/device_life_cycle/README.md#manufacturing-states) are hardcoded design constants, while others are stored in OTP. Note that conditional transitions will only be allowed if the OTP partition holding the corresponding token has been provisioned and locked. Since unlock tokens are considered secret, they are not stored in their raw form. -Instead, the tokens are wrapped and unwrapped based on a global constant using a [PRESENT-based scrambling mechanism]({{< relref "hw/ip/otp_ctrl/doc/_index.md#secret-vs-non-secret-partitions" >}}). +Instead, the tokens are wrapped and unwrapped based on a global constant using a [PRESENT-based scrambling mechanism](../otp_ctrl/README.md#secret-vs-non-secret-partitions). This ensures that a breach of fuse physical security does not automatically expose all the relevant information without also breaking the constant key. RAW_UNLOCK is not exposed in the open source design, rather it is something provisioned by the silicon creators prior to tapeout. @@ -111,7 +111,7 @@ This mechanism is used to guard against reverse engineering and brute-forcing attempts. An attacker able to extract the hashed token values from the scrambled OTP partitions or from the netlist would first have to find a hash collision in order to perform a life cycle transition, since the values supplied to the life cycle controller must be valid hash pre-images. -The employed one way function is a 128bit cSHAKE hash with the function name "" and customization string "LC_CTRL", see also [kmac documentation]({{< relref "hw/ip/kmac/doc/_index.md" >}}) and [`kmac_pkg.sv`](https://github.com/lowRISC/opentitan/blob/master/hw/ip/kmac/rtl/kmac_pkg.sv#L148-L155). +The employed one way function is a 128bit cSHAKE hash with the function name "" and customization string "LC_CTRL", see also [kmac documentation](../kmac/README.md) and [`kmac_pkg.sv`](https://github.com/lowRISC/opentitan/blob/master/hw/ip/kmac/rtl/kmac_pkg.sv#L148-L155). ### Post Transition Handling @@ -136,7 +136,7 @@ ## Life Cycle Decoded Outputs and Controls The core function of life cycle is how various functions of the design are modulated by what state the design is in. -[This section]({{< relref "doc/security/specs/device_life_cycle/_index.md#manufacturing-states" >}}) in the life cycle architecture documentation summarizes the overall behavior. +[This section](../../../doc/security/specs/device_life_cycle/README.md#manufacturing-states) in the life cycle architecture documentation summarizes the overall behavior. The signals have been split into two summary tables in the sections below. The first table contains all control signals that enable certain functionality in the system, whereas the second table contains all signals that change access to certain elements in the flash and OTP memories. @@ -197,7 +197,7 @@ CPU_EN controls whether code execution is allowed. This is implemented as part of the processor's reset controls. -In OpenTitan's [reset topology]({{< relref "hw/ip/rstmgr/doc" >}}), it is not possible to reset only the processor by itself, so this reset control extends to a large population of the OpenTitan peripherals. +In OpenTitan's [reset topology](../rstmgr/README.md), it is not possible to reset only the processor by itself, so this reset control extends to a large population of the OpenTitan peripherals. This ensures that during specific states (RAW, TEST_LOCKED, SCRAP, INVALID) it is not possible for the processor to execute code that breaks the device out of a non-functional state. @@ -217,7 +217,7 @@ #### CHECK_BYP_EN -The CHECK_BYP_EN signal is used to disable the [background consistency checks]({{< relref "hw/ip/otp_ctrl/doc/_index.md#partition-checks" >}}) of the life cycle OTP partition during life cycle transitions to prevent spurious consistency check failures (the OTP contents and the buffer registers can get out of sync during state transitions). +The CHECK_BYP_EN signal is used to disable the [background consistency checks](../otp_ctrl/README.md#partition-checks) of the life cycle OTP partition during life cycle transitions to prevent spurious consistency check failures (the OTP contents and the buffer registers can get out of sync during state transitions). The CHECK_BYP_EN signal is only asserted when a transition command is issued. #### CLK_BYP_REQ @@ -227,7 +227,7 @@ Note that the {{< regref TRANSITION_CTRL.EXT_CLOCK_EN >}} register can only be set to one if the transition interface has been claimed via the {{< regref "CLAIM_TRANSITION_IF" >}} mutex. This function is not available in production life cycle states. -For details on the clock switch, please see [clkmgr]({{< relref "hw/ip/clkmgr/doc/_index.md#life-cycle-requested-external-clock" >}}). +For details on the clock switch, please see [clkmgr](../clkmgr/README.md#life-cycle-requested-external-clock). ### Life Cycle Access Control Signals @@ -275,7 +275,7 @@ Before use, the secrets are unwrapped. The SECRET0_DIGEST and SECRET2_DIGEST are the digest values computed over the secret partitions in OTP holding the tokens and root keys. -As described in more detail in the [OTP controller specification]({{< relref "hw/ip/otp_ctrl/doc/_index.md#direct-access-memory-map">}}), these digests have a non-zero value once the partition has been provisioned and write/read access has been locked. +As described in more detail in the [OTP controller specification](../otp_ctrl/README.md#direct-access-memory-map), these digests have a non-zero value once the partition has been provisioned and write/read access has been locked. ### ID State of the Device @@ -288,7 +288,7 @@ ### Secret Collateral -Among the OTP life cycle collateral, the following are considered secrets (note there may be other secrets unrelated to life cycle, please see [OTP controller specification]({{< relref "hw/ip/otp_ctrl/doc/_index.md#partition-listing-and-description">}}) for more details): +Among the OTP life cycle collateral, the following are considered secrets (note there may be other secrets unrelated to life cycle, please see [OTP controller specification](../otp_ctrl/README.md#partition-listing-and-description) for more details): - *_TOKEN - CREATOR_ROOT_KEY* @@ -303,7 +303,7 @@ Note also, a global key is used here because there is no other non-volatile location to store a secret key. If PUFs were available (either in memory form or fused form), it could become an appealing alternative to hold a device unique fuse key. -See the [OTP controller]({{< relref "hw/ip/otp_ctrl/doc/_index.md#secret-vs-non-secret-partitions">}}) for more details. +See the [OTP controller](../otp_ctrl/README.md#secret-vs-non-secret-partitions) for more details. ### OTP Accessibility Summary and Impact of Life Cycle Signals @@ -350,7 +350,7 @@ SEED_HW_RD_EN only becomes active if SECRET2_DIGEST has a nonzero value in DEV, PROD, PROD_END and RMA states. OWNER_SEED_SW_RW_EN is always enabled during DEV, PROD, PROD_END and RMA states. -See also [Device Life Cycle Architecture]({{< relref "doc/security/specs/device_life_cycle" >}}) for more information on creator/owner isolation. +See also [Device Life Cycle Architecture](../../../doc/security/specs/device_life_cycle/README.md) for more information on creator/owner isolation. ## Hardware Interfaces @@ -422,15 +422,15 @@ Since the power manager may run in a different clock domain, the `pwr_lc_i.lc_init` signal is synchronized within the life cycle controller. The power manager is responsible for synchronizing the `pwr_lc_o.lc_done` and `pwr_lc_o.lc_idle` signals. -See also [power manager documentation]({{< relref "hw/ip/pwrmgr/doc" >}}). +See also [power manager documentation](../pwrmgr/README.md). #### OTP Interfaces -All interfaces to and from OTP are explained in detail in the [OTP Specification Document]({{< relref "hw/ip/otp_ctrl/doc/_index.md#life-cycle-interfaces" >}}). +All interfaces to and from OTP are explained in detail in the [OTP Specification Document](../otp_ctrl/README.md#life-cycle-interfaces). #### KMAC Interface -The life cycle controller interfaces with KMAC through a [side load interface]({{< relref "hw/ip/kmac/doc/_index.md#keymgr-interface" >}}) in the same way as the key manager. +The life cycle controller interfaces with KMAC through a [side load interface](../kmac/README.md#keymgr-interface) in the same way as the key manager. Since the KMAC and life cycle controller are in different clock domains, the KMAC interface signals are synchronized to the life cycle clock inside the life cycle controller. #### Control Signal Propagation @@ -443,7 +443,7 @@ Since many signals cross clock boundaries, their synchronization needs to be taken into account. However, since the ON / OFF encoding above has been chosen such that **all bits toggle exactly once** for a transition from OFF to ON (and vice-versa), all that needs to be done is guard against metastability using a two-stage synchronizer, as illustrated below. - + In other words, since each bit in the encoding flips exactly once upon an OFF -> ON or ON -> OFF transition, we can guarantee that there are no transient patterns toggling back and forth between enabling and disabling a function. Note that even though synchronization can be achieved with a simple two-stage synchronizer, designs **must** use the `prim_lc_sync` primitive. @@ -472,7 +472,7 @@ Conceptually speaking, the life cycle controller consists of a large FSM that is further subdivided into logical modules for maintainability, as illustrated below. All blue blocks in the block diagram are purely combinational and do not contain any registers. - + The main FSM implements a linear state sequence that always moves in one direction for increased glitch resistance. I.e., it never returns to the initialization and broadcast states as described in the [life cycle state controller section]({{< relref "#main-fsm" >}}). @@ -495,10 +495,10 @@ The figure below provides more context about how the life cycle controller is integrated into the system, and how its control signals interact with various components. - + Although technically a life cycle feature, the sampling of the strap pins and JTAG / TAP isolation is performed in the pinmux after the life cycle controller has initialized. -See [pinmux documentation]({{< relref "hw/ip/pinmux/doc/#strap-sampling-and-tap-isolation" >}}) and the detailed selection listed in [Life Cycle Definition Table]({{< relref "doc/security/specs/device_life_cycle/_index.md#manufacturing-states" >}}). +See [pinmux documentation](../pinmux/README.md#strap-sampling-and-tap-isolation) and the detailed selection listed in [Life Cycle Definition Table](../../../doc/security/specs/device_life_cycle/README.md#manufacturing-states). ### Life Cycle Manufacturing State Encodings @@ -531,7 +531,7 @@ In order to guard against glitch attacks during OTP sense and readout, the OTP controller makes sure to read out the life cycle partition before releasing the state to the life cycle controller. I.e., the OTP controller senses and buffers the life cycle in registers in a first readout pass. -Then, as part of the [consistency check mechanism]({{< relref "hw/ip/otp_ctrl/doc/_index.md#storage-consistency" >}}), the OTP controller performs a second and third readout pass to verify whether the buffered life cycle state indeed corresponds to the values stored in OTP. +Then, as part of the [consistency check mechanism](../otp_ctrl/README.md#storage-consistency), the OTP controller performs a second and third readout pass to verify whether the buffered life cycle state indeed corresponds to the values stored in OTP. The second readout pass uses a linearly increasing address sequence, whereas the third readout pass uses a linearly decreasing address sequence (i.e., reads in reverse order). ### Transition Counter Encoding @@ -550,7 +550,7 @@ The life cycle state controller is the main entity that handles life cycle requests, escalation events and transactions with the OTP and flash controllers. The state diagram for the controller FSM is shown below. - + Once the FSM has initialized upon request from the power manager, it moves into `IdleSt`, which is the state where all life cycle control signals are broadcast. The life cycle controller stays in `IdleSt` unless a life cycle state request is initiated via the CSRs. @@ -604,7 +604,7 @@ See diagram below. - + In order to claim the hardware mutex, the value kMuBi8True must be written to the claim register ({{< regref "CLAIM_TRANSITION_IF" >}}). If the register reads back as kMuBi8True, then the mutex is claimed, and the interface that won arbitration can continue operations. @@ -645,7 +645,7 @@ As currently defined, the life cycle controller TAP is a separate entity from the main SOC DFT TAP and the processor TAP. This physical separation aids in logical isolation, as the SOC DFT tap can be disabled by DFT_EN, while the processor TAP can be disabled by DEBUG_EN. -The TAP isolation and multiplexing is implemented in the pinmux IP as [described here]({{< relref "hw/ip/pinmux/doc/#strap-sampling-and-tap-isolation" >}}). +The TAP isolation and multiplexing is implemented in the pinmux IP as [described here](../pinmux/README.md#strap-sampling-and-tap-isolation). # Programmer's Guide
diff --git a/hw/ip/lc_ctrl/doc/checklist.md b/hw/ip/lc_ctrl/doc/checklist.md index 27deac4..42fd7f4 100644 --- a/hw/ip/lc_ctrl/doc/checklist.md +++ b/hw/ip/lc_ctrl/doc/checklist.md
@@ -7,8 +7,8 @@ directory for a new design that transitions from L0 (Specification) to L1 (Development) stage, and updated as needed. Once done, please remove this comment before checking it in. --> -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [LC_CTRL peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [LC_CTRL peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -16,7 +16,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [LC_CTRL Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [LC_CTRL Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -26,15 +26,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -59,24 +59,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -90,13 +90,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -114,15 +114,15 @@ Review | Reviewer(s) | Done | msf@ rswarbrick@ chencindy@ ttrippel@ Review | Signoff date | Done | 2022-05-24 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -130,8 +130,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [LC_CTRL DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [LC_CTRL Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [LC_CTRL DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [LC_CTRL Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -153,28 +153,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -201,26 +201,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -232,11 +232,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Waive reg_en coverage that will implement in common test and FSM coverage covered in FPV test Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -258,16 +258,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/lc_ctrl/dv/README.md b/hw/ip/lc_ctrl/dv/README.md index acdfa9a..31acf28 100644 --- a/hw/ip/lc_ctrl/dv/README.md +++ b/hw/ip/lc_ctrl/dv/README.md
@@ -10,33 +10,33 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/lc_ctrl/dv/latest/report.html) ## Design features -For detailed information on LC_CTRL design features, please see the [LC_CTRL HWIP technical specification]({{< relref ".." >}}). +For detailed information on LC_CTRL design features, please see the [LC_CTRL HWIP technical specification](../README.md). ## Testbench architecture -LC_CTRL testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +LC_CTRL testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/lc_ctrl/dv/tb/tb.sv`. It instantiates the LC_CTRL DUT module `hw/ip/lc_ctrl/rtl/lc_ctrl.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * LC_CTRL IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Alerts ([`alert_esc_if`]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Alerts ([`alert_esc_if`](../../../dv/sv/alert_esc_agent/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Compile-time configurations [list compile time configurations, if any and what are they used for] @@ -46,23 +46,23 @@ `lc_ctrl_env_pkg`. ### TL_agent -LC_CTRL testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +LC_CTRL testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into LC_CTRL device. ### JTAG RISCV Agent -[jtag_riscv_agent]({{< relref "hw/dv/sv/jtag_riscv_agent/doc" >}}) is used to read and write LC_CTRL registers via -the JTAG interface. It contains an embedded instance of [jtag_agent] {{< relref "hw/dv/sv/jtag_agent/doc" >}} which +[jtag_riscv_agent](../../../dv/sv/jtag_riscv_agent/README.md) is used to read and write LC_CTRL registers via +the JTAG interface. It contains an embedded instance of [jtag_agent] ../../../dv/sv/jtag_agent/README.md which uses the jtag_if interface in the testbench. ### PUSH/PULL Agent -[push_pull_agent]({{< relref "hw/dv/sv/push_pull_agent/doc" >}}) is used to emulate the Token and +[push_pull_agent](../../../dv/sv/push_pull_agent/README.md) is used to emulate the Token and OTP programming interfaces. ### UVM RAL Model -The LC_CTRL RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The LC_CTRL RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy @@ -97,12 +97,12 @@ * Alert data is decoded and used to indicate an alert has occurred #### Assertions -* TLUL assertions: The `tb/lc_ctrl_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/lc_ctrl_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/otbn/README.md b/hw/ip/otbn/README.md index 69c0c39..43ca3a9 100644 --- a/hw/ip/otbn/README.md +++ b/hw/ip/otbn/README.md
@@ -7,7 +7,7 @@ This document specifies functionality of the OpenTitan Big Number Accelerator, or OTBN. OTBN is a coprocessor for asymmetric cryptographic operations like RSA or Elliptic Curve Cryptography (ECC). -This module conforms to the [Comportable guideline for peripheral functionality]({{< relref "doc/rm/comportability_specification" >}}). +This module conforms to the [Comportable guideline for peripheral functionality](../../../doc/contributing/hw/comportability/README.md). See that document for integration overview within the broader top level system. ## Features @@ -40,7 +40,7 @@ # Instruction Set OTBN is a processor with a custom instruction set. -The full ISA description can be found in our [ISA manual]({{< relref "isa" >}}). +The full ISA description can be found in our [ISA manual](./doc/isa.md). The instruction set is split into two groups: * The **base instruction subset** operates on the 32b General Purpose Registers (GPRs). @@ -379,7 +379,7 @@ <td>RO</td> <td><a name="key-s0-l">KEY_S0_L</a></td> <td> -Bits [255:0] of share 0 of the 384b OTBN sideload key provided by the [Key Manager]({{< relref "/hw/ip/keymgr/doc" >}}). +Bits [255:0] of share 0 of the 384b OTBN sideload key provided by the [Key Manager](../keymgr/README.md). A `KEY_INVALID` software error is raised on read if the Key Manager has not provided a key. </td> @@ -390,7 +390,7 @@ <td><a name="key-s0-h">KEY_S0_H</a></td> <td> Bits [255:128] of this register are always zero. -Bits [127:0] contain bits [383:256] of share 0 of the 384b OTBN sideload key provided by the [Key Manager]({{< relref "/hw/ip/keymgr/doc" >}}). +Bits [127:0] contain bits [383:256] of share 0 of the 384b OTBN sideload key provided by the [Key Manager](../keymgr/README.md). A `KEY_INVALID` software error is raised on read if the Key Manager has not provided a valid key. </td> @@ -400,7 +400,7 @@ <td>RO</td> <td><a name="key-s1-l">KEY_S1_L</a></td> <td> -Bits [255:0] of share 1 of the 384b OTBN sideload key provided by the [Key Manager]({{< relref "/hw/ip/keymgr/doc" >}}). +Bits [255:0] of share 1 of the 384b OTBN sideload key provided by the [Key Manager](../keymgr/README.md). A `KEY_INVALID` software error is raised on read if the Key Manager has not provided a valid key. </td> @@ -411,7 +411,7 @@ <td><a name="key-s1-h">KEY_S1_H</a></td> <td> Bits [255:128] of this register are always zero. -Bits [127:0] contain bits [383:256] of share 1 of the 384b OTBN sideload key provided by the [Key Manager]({{< relref "/hw/ip/keymgr/doc" >}}). +Bits [127:0] contain bits [383:256] of share 1 of the 384b OTBN sideload key provided by the [Key Manager](../keymgr/README.md). A `KEY_INVALID` software error is raised on read if the Key Manager has not provided a valid key. </td> @@ -475,7 +475,7 @@ A secure wipe is performed automatically in certain situations, or can be requested manually by the host software. The full secure wipe is automatically initiated as a local reaction to a fatal error. -In addition, it can be triggered by the [Life Cycle Controller]({{<relref "/hw/ip/lc_ctrl/doc" >}}) before RMA entry using the `lc_rma_req/ack` interface. +In addition, it can be triggered by the [Life Cycle Controller](../lc_ctrl/README.md) before RMA entry using the `lc_rma_req/ack` interface. In both cases OTBN enters the locked state afterwards and needs to be reset. A secure wipe of only the internal state is performed after reset, whenever an OTBN operation is complete, and after a recoverable error. Finally, host software can manually trigger the data memory and instruction memory secure wipe operations by issuing an appropriate [command](#design-details-commands). @@ -491,7 +491,7 @@ ## Key Sideloading -OTBN software can make use of a single 384b wide key provided by the [Key Manager]({{<relref "/hw/ip/keymgr/doc" >}}), which is made available in two shares. +OTBN software can make use of a single 384b wide key provided by the [Key Manager](../keymgr/README.md), which is made available in two shares. The key is passed through a dedicated connection between the Key Manager and OTBN to avoid exposing it to other components. Software can access the first share of the key through the [`KEY_S0_L`](#key-s0-l) and [`KEY_S0_H`](#key-s0-h) WSRs, and the second share of the key through the [`KEY_S1_L`](#key-s1-l) and [`KEY_S1_H`](#key-s1-h) WSRs. @@ -523,7 +523,7 @@ ## Block Diagram - + ## Hardware Interfaces @@ -594,7 +594,7 @@ ### Random Numbers -OTBN is connected to the [Entropy Distribution Network (EDN)]({{< relref "hw/ip/edn/doc" >}}) which can provide random numbers via the `RND` and `URND` CSRs and WSRs. +OTBN is connected to the [Entropy Distribution Network (EDN)](../edn/README.md) which can provide random numbers via the `RND` and `URND` CSRs and WSRs. `RND` provides bits taken directly from the EDN connected via `edn_rnd`. The EDN interface provides 32b of entropy per transaction and comes from a different clock domain to the OTBN core. @@ -633,7 +633,7 @@ Download the SVG from Google Draw, open it in Inkscape once and save it without changes to add width/height information to the image. --> - + OTBN can be in different operational states. After reset (*init*), OTBN performs a secure wipe of the internal state and then becomes *idle*. @@ -860,7 +860,7 @@ ### Reaction to Life Cycle Escalation Requests {#design-details-lifecycle-escalation} -OTBN receives and reacts to escalation signals from the [life cycle controller]({{< relref "/hw/ip/lc_ctrl/doc#security-escalation" >}}). +OTBN receives and reacts to escalation signals from the [life cycle controller](../lc_ctrl/README.md#security-escalation). An incoming life cycle escalation is a fatal error of type `lifecycle_escalation` and treated as described in the section [Fatal Errors](#design-details-fatal-errors). ### Idle @@ -954,7 +954,7 @@ Before being stored in SRAM, the data word with the attached Integrity Protection Code, as well as the address are scrambled according to the [memory scrambling algorithm]({{< relref "#design-details-memory-scrambling">}}). The scrambling is reversed on a read. -The ephemeral memory scrambling key and the nonce are provided by the [OTP block]({{<relref "/hw/ip/otp_ctrl/doc" >}}). +The ephemeral memory scrambling key and the nonce are provided by the [OTP block](../otp_ctrl/README.md). They are set once when OTBN block is reset, and changed whenever a [secure wipe]({{<relref "#design-details-secure-wipe-dmem">}}) of the data memory is performed. @@ -970,7 +970,7 @@ Before being stored in SRAM, the instruction word with the attached Integrity Protection Code, as well as the address are scrambled according to the [memory scrambling algorithm]({{< relref "#design-details-memory-scrambling">}}). The scrambling is reversed on a read. -The ephemeral memory scrambling key and the nonce are provided by the [OTP block]({{<relref "/hw/ip/otp_ctrl/doc" >}}). +The ephemeral memory scrambling key and the nonce are provided by the [OTP block](../otp_ctrl/README.md). They are set once when OTBN block is reset, and changed whenever a [secure wipe]({{<relref "#design-details-secure-wipe-imem">}}) of the instruction memory is performed. The Integrity Protection Code is checked on every memory read, even though the code remains attached to the data. @@ -1019,7 +1019,7 @@ A secure wipe of either the instruction or the data memory can be triggered from from host software by issuing a `SEC_WIPE_DMEM` or `SEC_WIPE_IMEM` [command](#design-details-command). A secure wipe of instruction memory, data memory, and all internal state is performed automatically when handling a [fatal error](#design-details-fatal-errors). -In addition, it can be triggered by the [Life Cycle Controller]({{<relref "/hw/ip/lc_ctrl/doc" >}}) before RMA entry using the `lc_rma_req/ack` interface. +In addition, it can be triggered by the [Life Cycle Controller](../lc_ctrl/README.md) before RMA entry using the `lc_rma_req/ack` interface. In both cases OTBN enters the locked state afterwards and needs to be reset. A secure wipe of the internal state only is triggered automatically after reset and when OTBN [ends the software execution](#design-details-software-execution), either successfully, or unsuccessfully due to a [recoverable error](#design-details-recoverable-errors). @@ -1125,9 +1125,9 @@ # Writing OTBN applications {#writing-otbn-applications} OTBN applications are (small) pieces of software written in OTBN assembly. -The full instruction set is described in the [ISA manual]({{< relref "isa" >}}), and example software is available in the `sw/otbn` directory of the OpenTitan source tree. +The full instruction set is described in the [ISA manual](./doc/isa.md), and example software is available in the `sw/otbn` directory of the OpenTitan source tree. -A hands-on user guide to develop OTBN software can be found in the section [Writing and building software for OTBN]({{<relref "doc/ug/otbn_sw.md" >}}). +A hands-on user guide to develop OTBN software can be found in the section [Writing and building software for OTBN](../../../doc/contributing/sw/otbn_sw.md). ## Toolchain support
diff --git a/hw/ip/otbn/doc/checklist.md b/hw/ip/otbn/doc/checklist.md index 7e0b7b4..48e9289 100644 --- a/hw/ip/otbn/doc/checklist.md +++ b/hw/ip/otbn/doc/checklist.md
@@ -2,8 +2,8 @@ title: "OTBN Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [OTBN peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [OTBN peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [OTBN Design Spec]({{<relref "." >}}). The specification is feature-complete, we were able to successfully run larger chunks of crypto code with the described feature set. At the same time, the specification has (known and unknown) issues, such as incomplete or buggy descriptions of individual instructions. These issues are being worked on as they are discovered while the design is in the D1 stage. +Documentation | [SPEC_COMPLETE][] | Done | [OTBN Design Spec](../README.md). The specification is feature-complete, we were able to successfully run larger chunks of crypto code with the described feature set. At the same time, the specification has (known and unknown) issues, such as incomplete or buggy descriptions of individual instructions. These issues are being worked on as they are discovered while the design is in the D1 stage. Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | Two things are not yet documented, this will be done as part of D2S: Blanking, specifying exactly what is blanked. Loop stack hardening, there are a couple of options to discuss. -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,8 +125,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [OTBN DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [OTBN Testplan]({{<relref "dv#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [OTBN DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [OTBN Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Not Started | Review | [V3_CHECKLIST_SCOPED][] | Not Started | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | 11 Oct 2022 -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/otbn/doc/isa.md b/hw/ip/otbn/doc/isa.md index b45476d..6b56fb8 100644 --- a/hw/ip/otbn/doc/isa.md +++ b/hw/ip/otbn/doc/isa.md
@@ -3,7 +3,7 @@ --- This document describes the instruction set for OTBN. -For more details about the processor itself, see the [OTBN Technical Specification]({{< relref "." >}}). +For more details about the processor itself, see the [OTBN Technical Specification](../README.md). In particular, this document assumes knowledge of the *Processor State* section from that guide. The instruction set is split into *base* and *big number* subsets. @@ -107,7 +107,7 @@ # Errors OTBN can detect various errors when it is operating. -For details about OTBN's approach to error handling, see the [Errors section]({{< relref ".#design-details-errors" >}}) of the Technical Specification. +For details about OTBN's approach to error handling, see the [Errors section](../README.md#design-details-errors) of the Technical Specification. The instruction descriptions below describe any software errors that executing the instruction can cause. These errors are listed explicitly and also appear in the pseudo-code description, where the code sets a bit in the `ERR_BITS` register with a call to `state.stop_at_end_of_cycle()`.
diff --git a/hw/ip/otbn/dv/README.md b/hw/ip/otbn/dv/README.md index 58f580b..cda12e4 100644 --- a/hw/ip/otbn/dv/README.md +++ b/hw/ip/otbn/dv/README.md
@@ -11,19 +11,19 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/otbn/dv/uvm/latest/results.html) ## Design features OTBN, the OpenTitan Big Number accelerator, is a cryptographic accelerator. -For detailed information on OTBN design features, see the [OTBN HWIP technical specification]({{< relref ".." >}}). +For detailed information on OTBN design features, see the [OTBN HWIP technical specification](../README.md). ## Testbench architecture -The OTBN testbench is based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). -It builds on the [dv_utils]({{< relref "hw/dv/sv/dv_utils/doc" >}}) and [csr_utils]({{< relref "hw/dv/sv/csr_utils/doc" >}}) packages. +The OTBN testbench is based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). +It builds on the [dv_utils](../../../dv/sv/dv_utils/README.md) and [csr_utils](../../../dv/sv/csr_utils/README.md) packages. ### Block diagram @@ -31,7 +31,7 @@ This is shown in the block diagram. The dotted interfaces in the `otbn` block are bound in by the model to access internal signals (register file and memory contents). - + ### Top level testbench @@ -39,27 +39,27 @@ This instantiates the OTBN DUT module `hw/ip/otbn/rtl/otbn.sv`. OTBN has the following interfaces: -- A [Clock and reset interface]({{< relref "/hw/dv/sv/common_ifs#clk_rst_if" >}}) +- A [Clock and reset interface](../../../dv/sv/common_ifs/README.md#clk_rst_if) - A [TileLink interface]({{< relref "/hw/dv/sv/tl_agent/doc.md" >}}). OTBN is a TL-UL device, which expects to communicate with a TL-UL host. In the OpenTitan SoC, this will be the Ibex core. - Idle signals in each clock domain, `idle_o`, and `idle_otp_o` - One interrupt -- An [alert interface]({{< relref "/hw/dv/sv/alert_esc_agent/doc" >}}) +- An [alert interface](../../../dv/sv/alert_esc_agent/README.md) - A life cycle escalation interface -- An [OTP]({{< relref "/hw/ip/otp_ctrl/doc" >}}) connection -- Two [EDN]({{< relref "/hw/ip/edn/doc" >}}) connections +- An [OTP](../../otp_ctrl/README.md) connection +- Two [EDN](../../edn/README.md) connections - A RAM configuration interface, which is passed through to the SRAM macros The idle and interrupt signals are modelled with the basic -[`pins_if`]({{< relref "hw/dv/sv/common_ifs#pins_if" >}}) interface. +[`pins_if`](../../../dv/sv/common_ifs/README.md#pins_if) interface. As well as instantiating OTBN, the testbench also instantiates an `otbn_core_model`. This module wraps an ISS (instruction set simulator) subprocess and performs checks to make sure that OTBN behaves the same as the ISS. The `otbn_core_model` module communicates with test sequences through an `otbn_model_if` interface, which is monitored by the `otbn_model_agent`, described below. The module communicates with the Python subprocess as shown in the diagram below. - + ### OTBN model agent @@ -97,7 +97,7 @@ ### Functional coverage As a complicated IP block, OTBN has a lot of functional coverage points defined. -To avoid overwhelming this document, these are described in [OTBN functional coverage]({{< relref "/hw/ip/otbn/doc/dv/fcov.md" >}}). +To avoid overwhelming this document, these are described in [OTBN functional coverage](./doc/fcov.md). ### Test sequences @@ -115,7 +115,7 @@ ### Assertions -Core TLUL protocol assertions are checked by binding the [TL-UL protocol checker]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) into the design. +Core TLUL protocol assertions are checked by binding the [TL-UL protocol checker](../../tlul/doc/TlulProtocolChecker.md) into the design. Outputs are also checked for `'X` values by assertions in the design RTL. The design RTL contains other assertions defined by the designers, which will be checked in simulation (and won't have been checked by the pre-DV Verilator simulations). @@ -124,7 +124,7 @@ ## Building and running tests -Tests can be run with [`dvsim.py`]({{< relref "hw/dv/tools/doc" >}}). +Tests can be run with [`dvsim.py`](../../../../util/dvsim/README.md). The link gives details of the tool's features and command line arguments. To run a basic smoke test, go to the top of the repository and run: ```console
diff --git a/hw/ip/otbn/dv/doc/fcov.md b/hw/ip/otbn/dv/doc/fcov.md index 07b1853..5755b08 100644 --- a/hw/ip/otbn/dv/doc/fcov.md +++ b/hw/ip/otbn/dv/doc/fcov.md
@@ -14,7 +14,7 @@ ## Call stack -The [call stack]({{< relref ".#call-stack" >}}) is exposed as a special register behind `x1`. +The [call stack](../README.md#call-stack) is exposed as a special register behind `x1`. It has a bounded depth of 8 elements. We expect to see the following events: @@ -32,7 +32,7 @@ ## Loop stack -The [loop stack]({{< relref ".#loop-stack" >}}) is accessed by executing `LOOP` and `LOOPI` instructions. +The [loop stack](../README.md#loop-stack) is accessed by executing `LOOP` and `LOOPI` instructions. Events concerning the start of loops are tracked at those instructions, but we can't track things like loop completion there. > Coverage for these points is tracked with cover properties in the `otbn_loop_if` interface. @@ -142,7 +142,7 @@ ## External (bus-accessible) CSRs {#ext-csrs} The OTBN block exposes functionality to a bus host through bus-accessible CSRs. -Behavior of some CSRs depends on [OTBN's operational state]({{< relref "..#design-details-operational-states" >}}). +Behavior of some CSRs depends on [OTBN's operational state](../../README.md#design-details-operational-states). For every CSR (no matter its access restrictions), we want to see an attempt to read it and an attempt to write it. The CSRs are tracked in covergroups based on the CSR name, with the format: `ext_csr_<name>_cg`.
diff --git a/hw/ip/otbn/dv/otbnsim/README.md b/hw/ip/otbn/dv/otbnsim/README.md index 8f818ed..9ac070c 100644 --- a/hw/ip/otbn/dv/otbnsim/README.md +++ b/hw/ip/otbn/dv/otbnsim/README.md
@@ -3,7 +3,7 @@ `OTBNSim` class represents a simulator that models the whole OTBN block. Therefore it includes abstract models for the the state of the core, its memory modules, and also the register modules. It has methods for starting the execution, cycle-accurate simulation tracing, and for injecting errors and reacting to those errors with a secure wipe. -As explained in the overall [OTBN DV documentation](../../doc/dv/_index.md), this simulator is driven essentially from the SystemVerilog model of the OTBN module. +As explained in the overall [OTBN DV documentation](../README.md), this simulator is driven essentially from the SystemVerilog model of the OTBN module. The simulator works in a step-by-step fashion and it has multiple methods to apply external stimuli to OTBN. In a typical run without errors, the ISS does the following:
diff --git a/hw/ip/otp_ctrl/README.md b/hw/ip/otp_ctrl/README.md index 826cc4b..6c2b67c 100644 --- a/hw/ip/otp_ctrl/README.md +++ b/hw/ip/otp_ctrl/README.md
@@ -6,7 +6,7 @@ # Overview This document specifies the functionality of the one time programmable (OTP) memory controller. -The OTP controller is a module that is a peripheral on the chip interconnect bus, and thus follows the [Comportability Specification]({{< relref "doc/rm/comportability_specification" >}}). +The OTP controller is a module that is a peripheral on the chip interconnect bus, and thus follows the [Comportability Specification](../../../doc/contributing/hw/comportability/README.md). The OTP is a module that provides a device with one-time-programming functionality. The result of this programming is non-volatile, and unlike flash, cannot be reversed. @@ -14,7 +14,7 @@ The OTP controller provides: - An open-source abstraction interface that software can use to interact with a proprietary OTP block underneath. -- An open-source abstraction interface that hardware components (for example [life cycle controller]({{< relref "hw/ip/lc_ctrl/doc" >}}) and [key manager]({{< relref "hw/ip/keymgr/doc" >}})) can use to interact with a proprietary OTP block underneath. +- An open-source abstraction interface that hardware components (for example [life cycle controller](../lc_ctrl/README.md) and [key manager](../keymgr/README.md)) can use to interact with a proprietary OTP block underneath. - High level logical security protection, such as integrity checks and scrambling of sensitive content. - Software isolation for when OTP contents are readable and programmable. @@ -45,7 +45,7 @@ The functionality of OTP is split into an open-source and a closed-source part, with a clearly defined boundary in between, as illustrated in the simplified high-level block diagram below. - + It is the task of the open-source controller to provide a common, non-technology specific interface to OTP users with a common register interface and a clearly defined I/O interface to hardware. The open-source controller implements logical isolation and partitioning of OTP storage that enables users to separate different functions of the OTP into "partitions" with different properties. @@ -55,7 +55,7 @@ This split implies that every proprietary OTP IP must implement a translation layer from a standardized OpenTitan interface to the module underneath. It also implies that no matter how the OTP storage or word size may change underneath, the open-source controller must present a consistent and coherent software and hardware interface. -This standardized interface is defined further below, and the wrapper leverages the same [technology primitive mechanism]({{< relref "hw/ip/prim/doc" >}}) that is employed in other parts of OpenTitan in order to wrap and abstract technology-specific macros (such as memories and clocking cells) that are potentially closed-source. +This standardized interface is defined further below, and the wrapper leverages the same [technology primitive mechanism](../prim/README.md) that is employed in other parts of OpenTitan in order to wrap and abstract technology-specific macros (such as memories and clocking cells) that are potentially closed-source. In order to enable simulation and FPGA emulation of the OTP controller even without access to the proprietary OTP IP, a generalized and synthesizable model of the OTP IP is provided in the form of a [generic technology primitive](https://github.com/lowRISC/opentitan/blob/master/hw/ip/prim_generic/rtl/prim_generic_otp.sv). @@ -67,7 +67,7 @@ The "back-end" represents the programming interface used by hardware and software components to stage the upcoming values. The diagram below illustrates this behavioral model. - + Note that the front-end contains both buffered and unbuffered partitions. Buffered partitions are sensed once per power cycle and their contents are stored in registers, whereas unbuffered partitions are read on-demand. @@ -131,7 +131,7 @@ The life cycle partition is active throughout all stages and hence it is the **ONLY** partition that cannot be locked. After the device finishes provisioning and goes into production, it must retain the ability to transition back to RMA in case of unexpected failures. -In order to support this transition, the [life cycle state]({{< relref "hw/ip/lc_ctrl/doc" >}}) and counters must always be update-able. +In order to support this transition, the [life cycle state](../lc_ctrl/README.md) and counters must always be update-able. ## Locking a Partition @@ -184,7 +184,7 @@ Secret partitions contain data that are critical to security, for example FLASH scrambling keys, device root secret and unlock tokens. These values are stored scrambled in OTP, and are descrambled upon read. -The currently employed cipher is PRESENT, as it lends itself well to iterative decomposition, and it is a proven lightweight block cipher (see also [PRESENT Scrambling Primitive]({{< relref "hw/ip/prim/doc/prim_present.md" >}}). +The currently employed cipher is PRESENT, as it lends itself well to iterative decomposition, and it is a proven lightweight block cipher (see also [PRESENT Scrambling Primitive](../prim/doc/prim_present.md). The usage of a block cipher however implies that the secret partitions can only be written in 64bit chunks. Further, the contents of a particular secret partition are not readable by software once locked (other than the digest which must be always readable); while non-secret partitions are always readable unless read accessibility is explicitly removed by software. @@ -287,7 +287,7 @@ As mentioned previously, any updates made during the current power cycle are **NOT** reflected in the buffered partitions until the next reboot. The life cycle interface is used to update the life cycle state and transition counter only. -The commands are issued from the [life cycle controller]({{< relref "hw/ip/lc_ctrl/doc" >}}), and similarly, successful or failed indications are also sent back to the life cycle controller. +The commands are issued from the [life cycle controller](../lc_ctrl/README.md), and similarly, successful or failed indications are also sent back to the life cycle controller. Similar to the functional interface, the life cycle controller allows only one update per power cycle, and after a requested transition reverts to an inert state until reboot. For more details on how the software programs the OTP, please refer to the [Programmer's Guide]({{< relref "#programmers-guide" >}})) further below. @@ -308,7 +308,7 @@ `RndCnstKey` | (see RTL) | (see RTL) | Random scrambling keys for secret partitions, to be used in the [scrambling datapath]({{< relref "#scrambling-datapath" >}}). `RndCnstDigestConst` | (see RTL) | (see RTL) | Random digest finalization constants, to be used in the [scrambling datapath]({{< relref "#scrambling-datapath" >}}). `RndCnstDigestIV` | (see RTL) | (see RTL) | Random digest initialization vectors, to be used in the [scrambling datapath]({{< relref "#scrambling-datapath" >}}). -`RndCnstRawUnlockToken` | (see RTL) | (see RTL) | Global RAW unlock token to be used for the first life cycle transition. See also [conditional life cycle transitions]({{< relref "hw/ip/lc_ctrl/doc/_index.md#conditional-transitions" >}}). +`RndCnstRawUnlockToken` | (see RTL) | (see RTL) | Global RAW unlock token to be used for the first life cycle transition. See also [conditional life cycle transitions](../lc_ctrl/README.md#conditional-transitions). ### Signals @@ -321,7 +321,7 @@ The entropy request interface that talks to EDN in order to fetch fresh entropy for ephemeral SRAM scrambling key derivation and the LFSR counters for background checks. It is comprised of the `otp_edn_o` and `otp_edn_i` signals and follows a req / ack protocol. -See also [EDN documentation]({{< relref "hw/ip/edn/doc" >}}). +See also [EDN documentation](../edn/README.md). #### Power Manager Interface @@ -334,13 +334,13 @@ Since the power manager may run in a different clock domain, the `pwr_otp_i.otp_init` signal is synchronized within the OTP controller. The power manager is responsible for synchronizing the `pwr_otp_o.otp_done` and `pwr_otp_o.otp_idle` signals. -See also [power manager documentation]({{< relref "hw/ip/pwrmgr/doc" >}}). +See also [power manager documentation](../pwrmgr/README.md). #### Life Cycle Interfaces The interface to the life cycle controller can be split into three functional sub-interfaces (vendor test, state output, state transitions), and these are explained in more detail below. Note that the OTP and life cycle controllers are supposed to be in the same clock domain, hence no additional signal synchronization is required. -See also [life cycle controller documentation]({{< relref "hw/ip/lc_ctrl/doc" >}}) for more details. +See also [life cycle controller documentation](../lc_ctrl/README.md) for more details. ##### Vendor Test Signals @@ -403,7 +403,7 @@ An error is fatal and indicates that the OTP programming operation has failed. Note that the new state must not clear any bits that have already been programmed to OTP - i.e., the new state must be incrementally programmable on top of the previous state. -There are hence some implications on the life cycle encoding due to the ECC employed, see [life cycle state encoding]({{< relref "hw/ip/lc_ctrl/doc/_index.md#life-cycle-manufacturing-state-encodings" >}}) for details. +There are hence some implications on the life cycle encoding due to the ECC employed, see [life cycle state encoding](../lc_ctrl/README.md#life-cycle-manufacturing-state-encodings) for details. Note that the behavior of the `lc_otp_program_i.otp_test_ctrl` signal is vendor-specific, and hence the signal is set to `x` in the timing diagram above. The purpose of this signal is to control vendor-specific test mechanisms, and its value will only be forwarded to the OTP macro in RAW, TEST_* and RMA states. @@ -440,7 +440,7 @@ Note that the req/ack protocol runs on the OTP clock. It is the task of the scrambling device to synchronize the handshake protocol by instantiating the `prim_sync_reqack.sv` primitive as shown below. - + Note that the key and nonce output signals on the OTP controller side are guaranteed to remain stable for at least 62 OTP clock cycles after the `ack` signal is pulsed high, because the derivation of a 64bit half-key takes at least two passes through the 31-cycle PRESENT primitive. Hence, if the scrambling device clock is faster or in the same order of magnitude as the OTP clock, the data can be directly sampled upon assertion of `src_ack_o`. @@ -491,7 +491,7 @@ The following is a high-level block diagram that illustrates everything that has been discussed. - + Each of the partitions P0-P7 has its [own controller FSM]({{< relref "#partition-implementations" >}}) that interacts with the OTP wrapper and the [scrambling datapath]({{< relref "#scrambling-datapath" >}}) to fulfill its tasks. The partitions expose the address ranges and access control information to the Direct Access Interface (DAI) in order to block accesses that go to locked address ranges. @@ -528,7 +528,7 @@ The life cycle state is hence encoded such that incremental updates to the state are always carried out at the granularity of a 16bit word. Further, the life cycle transition counter is encoded such that each stroke consumes a full 16bit word for the same reason. -See [life cycle controller documentation]({{< relref "hw/ip/lc_ctrl/doc" >}}) for more details on the life cycle encoding. +See [life cycle controller documentation](../lc_ctrl/README.md) for more details on the life cycle encoding. ### Partition Controllers @@ -538,7 +538,7 @@ #### Unbuffered Partition - + As shown above, the unbuffered partition module has a relatively simple controller FSM that only reads out the digest value of the partition upon initialization, and then basically waits for TL-UL read transactions to its corresponding window in the CSR space. @@ -550,7 +550,7 @@ #### Buffered Partition - + The controller FSM of the buffered partition module is more complex than the unbuffered counterpart, since it has to account for scrambling and digest calculation. @@ -572,11 +572,11 @@ Note that in case of unrecoverable OTP errors or ECC failures in the buffer registers, the partition controller FSM is moved into a terminal error state, which locks down all access through DAI and clamps the values that are broadcast in hardware to their defaults. External escalation via the `lc_escalate_en` signal will move the partition controller FSM into the terminal error state as well. -See [life cycle controller documentation]({{< relref "hw/ip/lc_ctrl/doc" >}}) for more details. +See [life cycle controller documentation](../lc_ctrl/README.md) for more details. ### Direct Access Interface Control - + Upon reset release, the DAI controller first sends an initialization command to the OTP macro. Once the OTP macro becomes operational, an initialization request is sent to all partition controllers, which will read out and initialize the corresponding buffer registers. @@ -591,7 +591,7 @@ ### Life Cycle Interface Control - + Upon reset release the LCI FSM waits until the OTP controller has initialized and the LCI gets enabled. Once it is in the idle state, life cycle state updates can be initiated via the life cycle interface as [described here]({{< relref "#state-transitions" >}}). @@ -600,7 +600,7 @@ ### Key Derivation Interface - + Upon reset release the KDI FSM waits until the OTP controller has initialized and the KDI gets enabled. Once it is in the idle state, key derivation can be requested via the [flash]({{< relref "#interface-to-flash-scrambler" >}}) and [sram]({{< relref "#interface-to-sram-and-otbn-scramblers" >}}) interfaces. @@ -608,9 +608,9 @@ ### Scrambling Datapath - + -The scrambling datapath is built around an iterative implementation of the [PRESENT lightweight cipher]({{< relref "hw/ip/prim/doc/prim_present" >}}) that performs one round per cycle. +The scrambling datapath is built around an iterative implementation of the [PRESENT lightweight cipher](../prim/doc/prim_present.md) that performs one round per cycle. The datapath contains some additional multiplexing circuitry to enable the DAI, KDI and partition controllers to evaluate different functions with the same datapath. The algorithmic steps of these functions are explained in more detail below. @@ -666,7 +666,7 @@ ### Primitive Wrapper and FPGA Emulation - + The OTP IP is wrapped up in a primitive wrapper that exposes a TL-UL interface for testing purposes, and a generalized open-source interface for functional operation (described below). Any OTP redundancy mechanism like per-word ECC is assumed to be handled inside the wrapper, which means that the word width exposed as part of the generalized interface is the effective word width. @@ -807,7 +807,7 @@ It should be noted that the locked status of the partition holding the creator root key (i.e., the value of the {{< regref "SECRET2_DIGEST_0" >}}) determines the ID_STATUS of the device, which in turn determines SW accessibility of creator seed material in flash and OTP. That means that creator-seed-related collateral needs to be provisioned to Flash **before** the OTP digest lockdown mechanism is triggered, since otherwise accessibility to the corresponding flash region is lost. -See the [life cycle controller documentation]({{< relref "hw/ip/lc_ctrl/doc/_index.md#id-state-of-the-device" >}}) for more details. +See the [life cycle controller documentation](../lc_ctrl/README.md#id-state-of-the-device) for more details. ## Direct Access Interface @@ -948,7 +948,7 @@ Digest calculation can be triggered via the DAI. Finally, it should be noted that the RMA_TOKEN and CREATOR_ROOT_KEY_SHARE0 / CREATOR_ROOT_KEY_SHARE1 items can only be programmed when the device is in the DEV, PROD, PROD_END and RMA stages. -Please consult the [life cycle controller documentation]({{< relref "hw/ip/lc_ctrl/doc" >}}) documentation for more information. +Please consult the [life cycle controller documentation](../lc_ctrl/README.md) documentation for more information. ## Examples
diff --git a/hw/ip/otp_ctrl/doc/checklist.md b/hw/ip/otp_ctrl/doc/checklist.md index 276311d..c8fd2e4 100644 --- a/hw/ip/otp_ctrl/doc/checklist.md +++ b/hw/ip/otp_ctrl/doc/checklist.md
@@ -7,8 +7,8 @@ directory for a new design that transitions from L0 (Specification) to L1 (Development) stage, and updated as needed. Once done, please remove this comment before checking it in. --> -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [OTP_CTRL peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [OTP_CTRL peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -16,7 +16,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [OTP_CTRL Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [OTP_CTRL Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -26,15 +26,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#mem_instanced_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#mem_instanced_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -59,24 +59,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -90,13 +90,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -114,15 +114,15 @@ Review | Reviewer(s) | Done | msf@ gac@ chencindy@ awill@ Review | Signoff date | Done | 2022-06-27 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -130,8 +130,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [OTP_CTRL DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [OTP_CTRL Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [OTP_CTRL DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [OTP_CTRL Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -153,28 +153,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power, Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -201,26 +201,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Reviewed on 05/24/2021 Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -232,11 +232,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -258,16 +258,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/otp_ctrl/dv/README.md b/hw/ip/otp_ctrl/dv/README.md index 9312cae..d7b127f 100644 --- a/hw/ip/otp_ctrl/dv/README.md +++ b/hw/ip/otp_ctrl/dv/README.md
@@ -10,33 +10,33 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/otp_ctrl/dv/latest/report.html) ## Design features -For detailed information on OTP_CTRL design features, please see the [OTP_CTRL HW IP technical specification]({{< relref ".." >}}). +For detailed information on OTP_CTRL design features, please see the [OTP_CTRL HW IP technical specification](../README.md). ## Testbench architecture -OTP_CTRL testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +OTP_CTRL testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/otp_ctrl/dv/tb.sv`. It instantiates the OTP_CTRL DUT module `hw/ip/otp_ctrl/rtl/otp_ctrl.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * OTP_CTRL IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Alerts ([`alert_esc_if`]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Alerts ([`alert_esc_if`](../../../dv/sv/alert_esc_agent/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -59,10 +59,10 @@ ``` ### TL_agent -OTP_CTRL testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}), which provides the ability to drive and independently monitor random traffic via TL host interface into OTP_CTRL device. +OTP_CTRL testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md), which provides the ability to drive and independently monitor random traffic via TL host interface into OTP_CTRL device. ### Alert_agents -OTP_CTRL testbench instantiates (already handled in CIP base env) two [alert_agents]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}}): +OTP_CTRL testbench instantiates (already handled in CIP base env) two [alert_agents](../../../dv/sv/alert_esc_agent/README.md): fatal_check_alert and fatal_macro_alert. The alert_agents provide the ability to drive and independently monitor alert handshakes via alert interfaces in OTP_CTRL device. @@ -71,15 +71,15 @@ This interface is created to initialize, use simple task to drive, and use assertions to monitor these signals. ### Memory backdoor interface -OTP_CTRL testbench binds design's non-volatile OTP memory with a [`mem_bkdr_util`]({{< relref "hw/dv/sv/mem_bkdr_util/doc" >}}), which supports read, write, and injection of ECC errors to design's OTP memory. +OTP_CTRL testbench binds design's non-volatile OTP memory with a [`mem_bkdr_util`](../../../dv/sv/mem_bkdr_util/README.md), which supports read, write, and injection of ECC errors to design's OTP memory. ### UVM RAL model -The OTP_CTRL RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The OTP_CTRL RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}). +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md). ### Reference models -The OTP_CTRL's utilizes [PRESENT]({{< relref "hw/ip/prim/doc/prim_present.md" >}} as the cipher to scramble and protect secrets. +The OTP_CTRL's utilizes [PRESENT](../../prim/doc/prim_present.md as the cipher to scramble and protect secrets. Thus OTP_CTRL's scoreboard adopted PRESENT's C reference model, located under `hw/ip/prim/dv/prim_present/` folder, for encryption and decryption purpose. ### Stimulus strategy @@ -133,12 +133,12 @@ To avoid mismatches, scoreboard utilizes flags `dai_wr_ip` and `dai_digest_ip` to track otp write operations, and issue a backdoor read if the write operation is interrupted. #### Assertions -* TLUL assertions: The `tb/otp_ctrl_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/otp_ctrl_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. * OTP_CTRL_IF assertions: This interface has assertions to ensure certain OTP_CTRL's outputs (such as: otp_hw_cfg_o, keymgr_key_o) are stable after OTP initialization. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/pattgen/README.md b/hw/ip/pattgen/README.md index fdc476f..7e3cc9c 100644 --- a/hw/ip/pattgen/README.md +++ b/hw/ip/pattgen/README.md
@@ -5,7 +5,7 @@ # Overview This document specifies the functionality of the pattern generator hardware IP (HWIP). -This module conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification/index.md" >}}) +This module conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) See that document for integration overview within the broader top-level system. ## Features @@ -43,7 +43,7 @@ ## Block Diagram - + ## Hardware Interfaces
diff --git a/hw/ip/pattgen/doc/checklist.md b/hw/ip/pattgen/doc/checklist.md index 94f2436..5af0cea 100644 --- a/hw/ip/pattgen/doc/checklist.md +++ b/hw/ip/pattgen/doc/checklist.md
@@ -2,8 +2,8 @@ title: "Pattgen Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Pattgen peripheral.]({{<relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Pattgen peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|----------------------- |-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [Pattgen Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [Pattgen Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,8 +125,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [Pattgen DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [Pattgen Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [Pattgen DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [Pattgen Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power, Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/pattgen/dv/README.md b/hw/ip/pattgen/dv/README.md index e814890..2662956 100644 --- a/hw/ip/pattgen/dv/README.md +++ b/hw/ip/pattgen/dv/README.md
@@ -11,8 +11,8 @@ * Build comprehensive coverage framework to measure coverage provided by existing tests ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages.md" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/pattgen/dv/latest/report.html) ## Design features @@ -20,28 +20,28 @@ * Channels are configured by register model output values * The core of each channel is a state machine built on three independent counters For detailed information on PATTGEN design features, please see the -[PATTGEN design specification]({{< relref ".." >}}). +[PATTGEN design specification](../README.md). ## Testbench architecture -PATTGEN testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +PATTGEN testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). * The coverage framework is bound to RTL for coverage collection ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/pattgen/dv/tb/tb.sv`. It instantiates the PATTGEN DUT module `hw/ip/pattgen/rtl/pattgen.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * PATTGEN IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in `pattgen_env_pkg`. Some of them in use are: @@ -50,7 +50,7 @@ ``` ### TL_agent -PATTGEN instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +PATTGEN instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into PATTGEN device. ### PATTGEN agent @@ -59,8 +59,8 @@ Since the DUT does not require any response thus agent driver is fairly simple. ### UVM RAL Model -The PATTGEN RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +The PATTGEN RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): #### Test sequences All test sequences reside in `hw/ip/pattgen/dv/env/seq_lib`. @@ -82,11 +82,11 @@ The `pattgen_scoreboard` is primarily used for end to end checking. #### Assertions -* TLUL assertions: The `sva/pattgen_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `sva/pattgen_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/pinmux/README.md b/hw/ip/pinmux/README.md index 0de39c2..98fefdb 100644 --- a/hw/ip/pinmux/README.md +++ b/hw/ip/pinmux/README.md
@@ -6,7 +6,7 @@ # Overview This document specifies the functionality of the pin multiplexer (`pinmux`) peripheral. -This module conforms to the [OpenTitan guideline for peripheral device functionality]({{< relref "doc/rm/comportability_specification" >}}). +This module conforms to the [OpenTitan guideline for peripheral device functionality](../../../doc/contributing/hw/comportability/README.md). See that document for integration overview within the broader OpenTitan top level system. The module provides a mechanism to reconfigure the peripheral-to-pin mapping at runtime, which greatly enhances the system flexibility. In addition to that, the `pinmux` also allows the user to control pad attributes (such as pull-up, pull-down, open-drain, drive-strength, keeper and inversion), and it contains features that facilitate low-power modes of the system. @@ -40,7 +40,7 @@ The top-level module `pinmux` contains the CSRs accessible via the TL-UL interface, the main muxing matrix, retention registers, a set of programmable wakeup detectors, and the HW strap sampling and TAP / JTAG muxing logic. The chip-level module `padring` instantiates the bidirectional pads and connects the physical pad attributes. - + ### MIO and DIO Signal Categories @@ -133,7 +133,7 @@ Two example peripherals (`uart` and `spidev`) are attached to the `pinmux` in this example, one with one input and one output, the other with three inputs and one output. The diagram also shows the `padring` module which instantiates the bidirectional chip pads with output enable control. - + Note that apart from selecting a specific input pad, the `periph_insel[*]` signals can also be used to tie the peripheral input to 0 or 1. Likewise, the output select signals `mio_outsel[*]` can also be used to constantly drive an output pin to 0/1 or to put it into high-Z state (default). @@ -207,7 +207,7 @@ Also, it should be noted that the pad attributes of all JTAG IOs will be gated to all-zero temporarily, while the JTAG is enabled (this does not affect the values in the CSRs). This is to ensure that any functional attributes like inversion or pull-ups / pull-downs do not interfere with the JTAG while it is in use. -For more information about the life cycle states, see [Life Cycle Controller Specification]({{< relref "hw/ip/lc_ctrl/doc" >}}) and the [Life Cycle Definition Table]({{< relref "doc/security/specs/device_life_cycle/_index.md#manufacturing-states" >}}). +For more information about the life cycle states, see [Life Cycle Controller Specification](../lc_ctrl/README.md) and the [Life Cycle Definition Table](../../../doc/security/specs/device_life_cycle/README.md#manufacturing-states). ## Generic Pad Wrapper @@ -360,7 +360,7 @@ 3. During sleep, the wakeup detectors will trigger a wakeup request if a matching pattern has been observed. A bit corresponding to the wakeup detector that has observed the pattern will be set in the {{< regref "WKUP_CAUSE" >}} register. -4. When exiting sleep, SW should read the wake info register in the [power manager]({{< relref "hw/ip/pwrmgr/doc/" >}}) to determine the reason(s) for the wakeup request. +4. When exiting sleep, SW should read the wake info register in the [power manager](../pwrmgr/README.md) to determine the reason(s) for the wakeup request. 5. If the wakeup request was due to a pin wakeup pattern detector, SW should inspect the {{< regref "WKUP_CAUSE" >}} registers in order to determine the exact cause. @@ -383,7 +383,7 @@ ## Register Table The register description below matches the instance in the [Earl Grey top level -design]({{< relref "hw/top_earlgrey/doc" >}}). +design](../../top_earlgrey/doc/specification.md). Similar register descriptions can be generated with different parameterizations.
diff --git a/hw/ip/pinmux/doc/checklist.md b/hw/ip/pinmux/doc/checklist.md index 659b004..464658f 100644 --- a/hw/ip/pinmux/doc/checklist.md +++ b/hw/ip/pinmux/doc/checklist.md
@@ -2,8 +2,8 @@ title: "Pinmux Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Pinmux peripheral.]({{< relref "./" >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Pinmux peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [Pinmux spec]({{< relref "./" >}}) +Documentation | [SPEC_COMPLETE][] | Done | [Pinmux spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -22,15 +22,15 @@ Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -55,24 +55,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -86,13 +86,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -110,15 +110,15 @@ Review | Reviewer(s) | Done | msf@ tjaychen@ chencindy@ awill@ Review | Signoff date | Done | 2022-08-17 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -149,28 +149,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | N/A | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -197,26 +197,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -228,11 +228,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -254,16 +254,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/pinmux/doc/dv/README.md b/hw/ip/pinmux/doc/dv/README.md index 7b81eb5..a69d1b2 100644 --- a/hw/ip/pinmux/doc/dv/README.md +++ b/hw/ip/pinmux/doc/dv/README.md
@@ -11,22 +11,22 @@ * Verify TileLink device protocol compliance with a FPV based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../../README.md) + * [HW development stages](../../../../../doc/project_governance/development_stages.md) * [FPV dashboard](https://reports.opentitan.org/hw/top_earlgrey/formal/summary.html) ## Design features For detailed information on PINMUX design features, please see the -[PINMUX design specification]({{< relref ".." >}}). +[PINMUX design specification](../../README.md). ## Testbench architecture -PINMUX FPV testbench has been constructed based on the [formal architecture]({{< relref "hw/formal/doc" >}}). +PINMUX FPV testbench has been constructed based on the [formal architecture](../../../../formal/README.md). ### Block diagram  #### TLUL assertions -* The `../fpv/tb/pinmux_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) with pinmux to ensure TileLink interface protocol compliance. +* The `../fpv/tb/pinmux_bind.sv` binds the `tlul_assert` [assertions](../../../tlul/doc/TlulProtocolChecker.md) with pinmux to ensure TileLink interface protocol compliance. * The `../fpv/tb/pinmux_bind.sv` also binds the `pinmux_csr_assert_fpv` to assert the TileLink writes and reads correctly. #### PINMUX assertions @@ -40,7 +40,7 @@ ##### Symbolic variables Due to the large number of peripheral, muxed, dedicated IOs, and wakeup causes, symbolic variables are used to reduce the number of repeated assertions code. In the pinmux_assert_fpv module, we declared four symbolic variables (`mio_sel_i`, `periph_sel_i`, `dio_sel_i`, `wkup_sel_i`) to represent the index for muxed IOs, peripheral IOs, dedicated IOs, and wakeup causes. -Detailed explanation is listed in the [Symbolic Variables]({{< relref "hw/formal/doc#symbolic-variables" >}}) section. +Detailed explanation is listed in the [Symbolic Variables](../../../../formal/README.md#symbolic-variables) section. ## Testplan {{< incGenFromIpDesc "../../data/pinmux_fpv_testplan.hjson" "testplan" >}}
diff --git a/hw/ip/prim/doc/prim_ram_1p_scr.md b/hw/ip/prim/doc/prim_ram_1p_scr.md index 0da475e..5b7cf85 100644 --- a/hw/ip/prim/doc/prim_ram_1p_scr.md +++ b/hw/ip/prim/doc/prim_ram_1p_scr.md
@@ -5,7 +5,7 @@ # Overview The scrambling primitive `prim_ram_1p_scr` employs a reduced-round (5 instead of 11) PRINCE block cipher in CTR mode to scramble the data. -The PRINCE lightweight block cipher has been selected due to its low latency and low area characteristics, see also [prim_prince]({{< relref "hw/ip/prim/doc/prim_prince" >}}) for more information on PRINCE. +The PRINCE lightweight block cipher has been selected due to its low latency and low area characteristics, see also [prim_prince](./prim_prince.md) for more information on PRINCE. The number of rounds is reduced to 5 in order to ease timing pressure and ensure single cycle operation (the number of rounds can always be increased if it turns out that there is enough timing slack). In [CTR mode](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR)), the block cipher is used to encrypt a 64bit IV with the scrambling key in order to create a 64bit keystream block that is bitwise XOR'ed with the data in order to transform plaintext into ciphertext and vice versa.
diff --git a/hw/ip/pwm/README.md b/hw/ip/pwm/README.md index a47ac1b..473b5d6 100644 --- a/hw/ip/pwm/README.md +++ b/hw/ip/pwm/README.md
@@ -5,7 +5,7 @@ # Overview This document specifies PWM hardware IP (HWIP) functionality. -This module conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification/index.md" >}}) +This module conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) See that document for integration overview within the broader top-level system. ## Features @@ -73,7 +73,7 @@ ## Block Diagram - + ## Hardware Interfaces
diff --git a/hw/ip/pwm/doc/checklist.md b/hw/ip/pwm/doc/checklist.md index 6112e3a..061cbd3 100644 --- a/hw/ip/pwm/doc/checklist.md +++ b/hw/ip/pwm/doc/checklist.md
@@ -2,8 +2,8 @@ title: "PWM Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [PWM peripheral.]({{< relref "hw/ip/pwm/doc" >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [PWM peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [PWM Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [PWM Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,8 +125,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [PWM DV document]({{<relref "hw/ip/pwm/doc/dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [PWM Testplan]({{<relref "hw/ip/pwm/doc/dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [PWM DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [PWM Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Power) Review | [V2_CHECKLIST_SCOPED][] | Not Started | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | N/A | Review | [SEC_CM_DV_REVIEWED][] | N/A | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/pwm/dv/README.md b/hw/ip/pwm/dv/README.md index d2b63e2..d41a63d 100644 --- a/hw/ip/pwm/dv/README.md +++ b/hw/ip/pwm/dv/README.md
@@ -10,36 +10,36 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/pwm/dv/latest/report.html) ## Design features For detailed information on PWM design features, please see the -[PWM HWIP technical specification]({{< relref "hw/ip/pwm/doc" >}}). +[PWM HWIP technical specification](../README.md). ## Testbench architecture PWM testbench has been constructed based on the -[CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +[CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/pwm/dv/tb/tb.sv`. It instantiates the PWM DUT module `hw/ip/pwm/rtl/pwm.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * PWM IOs -* Alerts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Alerts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -87,7 +87,7 @@ endfunction : get_pwm_mode ``` ### TL_agent -PWM instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +PWM instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into PWM device. @@ -102,10 +102,10 @@ * relative delay to be used for phase calculation ### UVM RAL Model -The PWM RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) +The PWM RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}) +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md) ### Stimulus strategy #### Test sequences @@ -145,12 +145,12 @@ If an error is found the scoreboard will throw an error. #### Assertions -* TLUL assertions: The `tb/pwm_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/pwm_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/pwrmgr/README.md b/hw/ip/pwrmgr/README.md index 88a8672..56ce791 100644 --- a/hw/ip/pwrmgr/README.md +++ b/hw/ip/pwrmgr/README.md
@@ -47,7 +47,7 @@ See the below high level block diagram that illustrates the connections between the power manager and various system components. Blocks outlined with a solid magenta line are always on; while blocks outlined with a dashed magenta line are a mix of components that are and those that are not. - + ## Hardware Interfaces @@ -64,7 +64,7 @@ The green state machine is clocked by the normal fixed domain, while the orange state machine is clocked by the slow domain. Specific request / acknowledge signals are also highlighted in this color scheme to show where the two state machines communicate. - + Note, most of the states are transitional states, and only the following state combinations are resting states. @@ -81,7 +81,7 @@ The slow clock domain FSM (referred to as the slow FSM from here on) resets to the Reset state. This state is released by `por_rst_n`, which is supplied from the reset controller. The `por_rst_n` signal is released when the reset controller detects the root power domains (`vcaon_pok` from AST) of the system are ready. -Please see the [ast]({{< relref "hw/top_earlgrey/ip/ast/doc" >}}) for more details. +Please see the [ast](../../top_earlgrey/ip/ast/README.md) for more details. The slow FSM requests the AST to power up the main domain and high speed clocks. Once those steps are done, it requests the [fast FSM](#fast-clock-domain-fsm) to begin operation. @@ -107,12 +107,12 @@ The fast clock domain FSM (referred to as fast FSM from here on) resets to `Low Power` state and waits for a power-up request from the slow FSM. -Once received, the fast FSM releases the life cycle reset stage (see [reset controller]({{< relref "hw/ip/rstmgr/doc" >}}) for more details). -This allows the [OTP]({{< relref "hw/ip/otp_ctrl/doc" >}}) to begin sensing. +Once received, the fast FSM releases the life cycle reset stage (see [reset controller](../rstmgr/README.md) for more details). +This allows the [OTP](../otp_ctrl/README.md) to begin sensing. Once OTP sensing completes , the life cycle controller is initialized. -The initialization of the life cycle controller puts the device into its allowed operating state (see [life cycle controller]({{< relref "hw/ip/lc_ctrl/doc" >}}) for more details). +The initialization of the life cycle controller puts the device into its allowed operating state (see [life cycle controller](../lc_ctrl/README.md) for more details). -Once life cycle initialization is done, the fast FSM enables all second level clock gating (see [clock controller]({{< relref "hw/ip/clkmgr/doc" >}}) for more details) and initiates strap sampling. +Once life cycle initialization is done, the fast FSM enables all second level clock gating (see [clock controller](../clkmgr/README.md) for more details) and initiates strap sampling. For more details on what exactly the strap samples, please see [here](https://docs.google.com/spreadsheets/d/1pH8T1MhQ7TXtP_bFNT85T9jSVIHlxHAfbMnPbsMdjc0/edit?usp=sharing). Once strap sampling is complete, the system is ready to begin normal operations (note `flash_ctrl` initialization is explicitly not done here, please see [sections below](#flash-handling) for more details). @@ -143,7 +143,7 @@ ### ROM Integrity Checks -The power manager coordinates the [start up ROM check]({{< relref "hw/ip/rom_ctrl/doc/_index.md#the-startup-rom-check" >}}) with `rom_ctrl`. +The power manager coordinates the [start up ROM check](../rom_ctrl/README.md#the-startup-rom-check) with `rom_ctrl`. After every reset, the power manager sends an indication to the `rom_ctrl` to begin performing integrity checks. When the `rom_ctrl` checks are finished, a `done` and `good` indication are sent back to the power manager. @@ -284,7 +284,7 @@ ### Power-Up Handling -The [AST]({{< relref "hw/top_earlgrey/ip/ast/doc" >}}) automatically takes the flash macro out of power down state as part of the power manager's power up request. +The [AST](../../top_earlgrey/ip/ast/README.md) automatically takes the flash macro out of power down state as part of the power manager's power up request. Once flash macro is powered up and ready, an indication is sent to the `flash_ctrl`. @@ -384,7 +384,7 @@ When exiting from deep sleep, the system begins execution in ROM. 1. Complete normal preparation steps. -2. Check reset cause in [rstmgr]({{< relref "hw/ip/rstmgr/doc" >}}) +2. Check reset cause in [rstmgr](../rstmgr/README.md) 3. Re-enable modules that have powered down. 4. Disable wakeup recording through {{< regref "WAKE_INFO_CAPTURE_DIS" >}}. 5. Check which source woke up the system through {{< regref "WAKE_INFO" >}}.
diff --git a/hw/ip/pwrmgr/doc/checklist.md b/hw/ip/pwrmgr/doc/checklist.md index 41425a4..373e4f8 100644 --- a/hw/ip/pwrmgr/doc/checklist.md +++ b/hw/ip/pwrmgr/doc/checklist.md
@@ -2,8 +2,8 @@ title: "PWRMGR Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [PWRMGR peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [PWRMGR peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done |[PWRMGR Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done |[PWRMGR Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,8 +125,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [PWRMGR DV document]({{<relref "dv/index.md" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [PWRMGR testplan]({{< relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [PWRMGR DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [PWRMGR testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exceptions: debug, power, performance Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | UNR will be added after intra structure issue is resolved. Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/pwrmgr/dv/README.md b/hw/ip/pwrmgr/dv/README.md index a8ae0e2..c86d2b5 100644 --- a/hw/ip/pwrmgr/dv/README.md +++ b/hw/ip/pwrmgr/dv/README.md
@@ -10,34 +10,34 @@ * Verify TileLink device protocol compliance with an SVA based testbench. ## Current status -* [Design & verification stage]({{< relref "hw/ip/pwrmgr/doc/checklist" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../doc/checklist.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/pwrmgr/dv/latest/report.html) ## Design features -For detailed information on PWRMGR design features, please see the [PWRMGR HWIP technical specification]({{< relref "hw/ip/pwrmgr/doc" >}}). +For detailed information on PWRMGR design features, please see the [PWRMGR HWIP technical specification](../README.md). ## Testbench architecture -PWRMGR testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +PWRMGR testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at [`hw/ip/pwrmgr/dv/tb.sv`](https://github.com/lowRISC/opentitan/blob/master/hw/ip/pwrmgr/dv/tb.sv). It instantiates the PWRMGR DUT module [`hw/ip/pwrmgr/rtl/pwrmgr.sv`](https://github.com/lowRISC/opentitan/blob/master/hw/ip/pwrmgr/rtl/pwrmgr.sv). In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * PWRMGR interface [`hw/ip/pwrmgr/dv/env/pwrmgr_if.sv`](https://github.com/lowRISC/opentitan/blob/master/hw/ip/pwrmgr/dv/env/pwrmgr_if.sv). -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Alerts ([`alert_esc_if`]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Alerts ([`alert_esc_if`](../../../dv/sv/alert_esc_agent/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -68,12 +68,12 @@ typedef bit [pwrmgr_pkg::HwResetWidth-1:0] resets_out_t; ``` ### TL_agent -PWRMGR testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) which provides the ability to drive and independently monitor random traffic via TL host interface into PWRMGR device. +PWRMGR testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into PWRMGR device. ### UVM RAL Model -The PWRMGR RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The PWRMGR RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}). +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md). ### Stimulus strategy The sequences are closely related to the testplan's testpoints. @@ -230,7 +230,7 @@ #### Assertions The [`hw/ip/pwrmgr/dv/sva/pwrmgr_bind.sv`](https://github.com/lowRISC/opentitan/blob/master/hw/ip/pwrmgr/dv/sva/pwrmgr_bind.sv) module binds a few modules containing assertions to the IP as follows: -* TLUL assertions: the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) ensures TileLink interface protocol compliance. +* TLUL assertions: the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) ensures TileLink interface protocol compliance. * Clock enables assertions: The `pwrmgr_clock_enables_sva_if` module contains assertions checking that the various clk_en outputs correspond to the settings in the `control` CSR. * CLKMGR clk_en to status handshake assertions: @@ -247,7 +247,7 @@ In addition, the RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/rom_ctrl/README.md b/hw/ip/rom_ctrl/README.md index 9abedb1..1230ef8 100644 --- a/hw/ip/rom_ctrl/README.md +++ b/hw/ip/rom_ctrl/README.md
@@ -5,13 +5,13 @@ # Overview This document describes the ROM controller (`rom_ctrl`). -This module attaches as a peripheral to the system bus, and thus follows the [Comportability Specification]({{< relref "doc/rm/comportability_specification" >}}). +This module attaches as a peripheral to the system bus, and thus follows the [Comportability Specification](../../../doc/contributing/hw/comportability/README.md). The ROM controller interfaces between the system bus and the ROM. This ROM has scrambled contents (scrambled with a fixed key, derived from a global constant). The controller is responsible for descrambling these contents on memory fetches. -Unlike the [SRAM controller]({{< relref "hw/ip/sram_ctrl/doc" >}}), which performs the equivalent task for SRAM, the ROM controller also contains a *ROM checker* block. +Unlike the [SRAM controller](../sram_ctrl/README.md), which performs the equivalent task for SRAM, the ROM controller also contains a *ROM checker* block. This ROM checker is used to compute a cryptographic hash of the ROM contents just after boot, detecting any malicious changes that have been made to the ROM when the system was at rest. ## Features @@ -33,7 +33,7 @@ This is triggered by the power manager early in the chip boot sequence to check validity of the ROM image. It runs exactly once, and releases the green multiplexer when it is done. - + ## ROM access when chip is in operation @@ -44,7 +44,7 @@ In parallel with the ROM access, a reduced `prim_prince` primitive (5 rounds with latency 1; equivalent to the cipher used for SRAM) computes a 39-bit truncated keystream for the block. On the following cycle, the scrambled data from ROM goes through a substitution-permutation network and is then XOR'd with the keystream. -This scheme is the same as that used by the [SRAM controller]({{< relref "hw/ip/sram_ctrl/doc" >}}), but is much simplified because the ROM doesn't have to deal with writes, byte accesses or key changes. +This scheme is the same as that used by the [SRAM controller](../sram_ctrl/README.md), but is much simplified because the ROM doesn't have to deal with writes, byte accesses or key changes. The output from the XOR is the unscrambled 32-bit data, plus seven ECC bits. This data is passed straight through the TL-UL SRAM adapter; the ECC bits are used as a signal integrity check by the system bus. @@ -78,9 +78,9 @@ Until it is done, it controls ROM address requests (through the green multiplexer). The select signal for this multiplexer has a redundant encoding to protect it against fault injection attacks. If the select signal has an invalid value, this will trigger a fatal alert. -Before starting to read data, it starts a cSHAKE operation on the [KMAC]({{< relref "hw/ip/kmac/doc" >}}) module using one of its application interfaces. +Before starting to read data, it starts a cSHAKE operation on the [KMAC](../kmac/README.md) module using one of its application interfaces. We expect to use the `cSHAKE256` algorithm, with prefix "ROM_CTRL". -The [Application Interface]({{< relref "hw/ip/kmac/doc#application-interface" >}}) section of the KMAC documentation details the parameters used. +The [Application Interface](../kmac/README.md#application-interface) section of the KMAC documentation details the parameters used. The checker reads the ROM contents in address order, resulting in a scattered access pattern on the ROM itself because of the address scrambling. Each read produces 39 bits of data, which are padded with zeros to 64 bits to match the interface expected by the KMAC block. @@ -91,7 +91,7 @@ Unlike the rest of ROM, their data is not stored scrambled, so the expected hash can be read directly. This is taken by the checker FSM (ignoring ECC bits) and will be compared with the digest that is read back from the KMAC block. -Once it comes back, the digest is forwarded directly to the [Key Manager]({{< relref "hw/ip/keymgr/doc" >}}). +Once it comes back, the digest is forwarded directly to the [Key Manager](../keymgr/README.md). It is also compared with the hash that was read from the top eight words of ROM. On a match, `pwrmgr_data_o.good` is signalled as `Mubi4True`. In either case, `pwrmgr_data_o.done` goes high when the calculation is complete. @@ -100,7 +100,7 @@ <div align="center"> - + </div> @@ -125,7 +125,7 @@ The KMAC module may choose to add a check for this, to detect reset glitches affecting the `rom_ctrl` block. The integration with the key manager is based on forwarding the digest data in `kmac_data_i` as `keymgr_data_o.data`. -This 256-bit digest will be incorporated into the [`CreatorRootKey`]({{< relref "doc/security/specs/identities_and_root_keys#creator-root-key" >}}). +This 256-bit digest will be incorporated into the [`CreatorRootKey`](../../../doc/security/specs/identities_and_root_keys/README.md#creator-root-key). The key manager should only allow one transaction (of 256 bits / 32 bits = 8 beats) after reset to pass this information across. On future messages, it should raise an alert, defeating an attacker that tries to trigger extra transactions before or after the real one.
diff --git a/hw/ip/rom_ctrl/doc/checklist.md b/hw/ip/rom_ctrl/doc/checklist.md index b7e9847..a6a4735 100644 --- a/hw/ip/rom_ctrl/doc/checklist.md +++ b/hw/ip/rom_ctrl/doc/checklist.md
@@ -2,8 +2,8 @@ title: "Rom Controller Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [ROM Controller peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [ROM Controller peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [ROM Controller Technical Specification]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [ROM Controller Technical Specification](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Done | msf@ vogelpi@ prajwalaputtappa@ ttrippel@ Review | Signoff date | Done | 2022-08-09 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Not Started | Review | [V3_CHECKLIST_SCOPED][] | Not Started | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/rom_ctrl/dv/README.md b/hw/ip/rom_ctrl/dv/README.md index 3e1ebb4..4a83d9c 100644 --- a/hw/ip/rom_ctrl/dv/README.md +++ b/hw/ip/rom_ctrl/dv/README.md
@@ -10,43 +10,43 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/rom_ctrl/dv/latest/report.html) ## Design features -For detailed information on `rom_ctrl` design features, please see the [ROM Controller HWIP technical specification]({{< relref "hw/ip/rom_ctrl/doc" >}}). +For detailed information on `rom_ctrl` design features, please see the [ROM Controller HWIP technical specification](../README.md). ## Testbench architecture -The `rom_ctrl` testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +The `rom_ctrl` testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench The top level testbench is located at `hw/ip/rom_ctrl/dv/tb/tb.sv`. It instantiates the `rom_ctrl` DUT module `hw/ip/rom_ctrl/rtl/rom_ctrl.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) -* [Memory backdoor utility]({{< relref "hw/dv/sv/mem_bkdr_util/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) +* [Memory backdoor utility](../../../dv/sv/mem_bkdr_util/README.md) * `rom_ctrl` IOs -* Alerts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) +* Alerts ([`pins_if`](../../../dv/sv/common_ifs/README.md) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Compile-time configurations There is only one compile-time configuration, where arbitrary values are chosen for compile-time constants. ### TL_agent -The `rom_ctrl` testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}). +The `rom_ctrl` testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md). This provides the ability to drive and independently monitor random traffic via both TL host interfaces into the DUT. ### UVM RAL Model -The `rom_ctrl` RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The `rom_ctrl` RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. ### Stimulus strategy #### Test sequences @@ -85,11 +85,11 @@ Traffic from the ROM TLUL interface is monitored and compared against memory model to check for correctness. #### Assertions -* TLUL assertions: The `tb/rom_ctrl_bind.sv` file binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/rom_ctrl_bind.sv` file binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/rstmgr/README.md b/hw/ip/rstmgr/README.md index bc0d81e..f04cf39 100644 --- a/hw/ip/rstmgr/README.md +++ b/hw/ip/rstmgr/README.md
@@ -21,9 +21,9 @@ # Theory of Operation The OpenTitan reset topology and reset controller block diagram are shown in the diagram below. -The reset controller is closely related to the [power controller]({{< relref "hw/ip/pwrmgr/doc" >}}), please refer to that spec for details on how reset controller inputs are controlled. +The reset controller is closely related to the [power controller](../pwrmgr/README.md), please refer to that spec for details on how reset controller inputs are controlled. - + ## Reset Topology @@ -31,7 +31,7 @@ * There are two reset domains * Test Domain - Driven by `TRSTn` - * Core Domain - Driven by internal [POR circuitry]({{< relref "hw/top_earlgrey/ip/ast/doc" >}}). + * Core Domain - Driven by internal [POR circuitry](../../top_earlgrey/ip/ast/README.md). * Test domain is comprised of the following components * SOC TAP and related DFT circuits * RISC-V TAP (part of the `rv_dm` module) @@ -118,7 +118,7 @@ Additionally, the reset manager, along with the power manager, accepts requests from the system and asserts resets for the appropriate clock trees. These requests primarily come from the following sources: -* Peripherals capable of reset requests: such as [sysrst_ctrl]({{< relref "hw/ip/sysrst_ctrl/doc/_index.md" >}}) and [always on timers ]({{< relref "hw/ip/aon_timer/doc/_index.md" >}}). +* Peripherals capable of reset requests: such as [sysrst_ctrl](../sysrst_ctrl/README.md) and [always on timers ](../aon_timer/README.md). * Debug modules such as `rv_dm`. * Power manager request for low power entry and exit. * Escalation reset requests such as those from `alert_handler` or `pwrmgr` itself. @@ -335,7 +335,7 @@ The CPU information register contains the value of the CPU state prior to a triggered reset. Since this information differs in length between system implementation, the information register only displays 32-bits at a time. -For more details on the CPU dump details, please see [crash dump]({{< relref "hw/ip/rv_core_ibex/doc/_index.md#crash-dump-collection" >}}). +For more details on the CPU dump details, please see [crash dump](../rv_core_ibex/README.md#crash-dump-collection). The {{< regref "CPU_INFO_ATTR" >}} register indicates how many 32-bit data segments must be read. Software then simply needs to write in {{< regref "CPU_INFO_CTRL.INDEX" >}} which segment it wishes and then read out the {{< regref "CPU_INFO" >}} register.
diff --git a/hw/ip/rstmgr/doc/checklist.md b/hw/ip/rstmgr/doc/checklist.md index 9e741d6..df61a66 100644 --- a/hw/ip/rstmgr/doc/checklist.md +++ b/hw/ip/rstmgr/doc/checklist.md
@@ -2,8 +2,8 @@ title: "RSTMGR Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [RSTMGR peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [RSTMGR peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [RSTMGR Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [RSTMGR Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,8 +125,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [RSTMGR DV document]({{< relref "dv/index.md" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [RSTMGR Testplan]({{< relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [RSTMGR DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [RSTMGR Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception: power, performance Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/rstmgr/dv/README.md b/hw/ip/rstmgr/dv/README.md index 575f26f..a745342 100644 --- a/hw/ip/rstmgr/dv/README.md +++ b/hw/ip/rstmgr/dv/README.md
@@ -10,33 +10,33 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/rstmgr/dv/latest/report.html) ## Design features -For detailed information on RSTMGR design features, please see the [RSTMGR HWIP technical specification]({{< relref "hw/ip/rstmgr/doc" >}}). +For detailed information on RSTMGR design features, please see the [RSTMGR HWIP technical specification](../README.md). ## Testbench architecture -RSTMGR testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +RSTMGR testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench The top level testbench is located at [`hw/ip/rstmgr/dv/tb.sv`](https://github.com/lowRISC/opentitan/blob/master/hw/ip/rstmgr/dv/tb.sv). It instantiates the RSTMGR DUT module [`hw/top_earlgrey/ip/rstmgr/rtl/autogen/rstmgr.sv`](https://github.com/lowRISC/opentitan/blob/master/hw/top_earlgrey/ip/rstmgr/rtl/autogen/rstmgr.sv). In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * RSTMGR interface [`hw/ip/rstmgr/dv/env/rstmgr_if.sv`](https://github.com/lowRISC/opentitan/blob/master/hw/ip/rstmgr/dv/env/rstmgr_if.sv) -* Alerts ([`alert_esc_if`]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Alerts ([`alert_esc_if`](../../../dv/sv/alert_esc_agent/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -47,18 +47,18 @@ typedef virtual pwrmgr_rstmgr_sva_if #(.CHECK_RSTREQS(0)) parameterized_pwrmgr_rstmgr_sva_vif; ``` ### TL_agent -The RSTMGR testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}). +The RSTMGR testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md). This provides the ability to drive and independently monitor random traffic via the TL host interface into the RSTMGR device. ### Alert_agents -RSTMGR testbench instantiates (already handled in CIP base env) [alert_agents]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}}): +RSTMGR testbench instantiates (already handled in CIP base env) [alert_agents](../../../dv/sv/alert_esc_agent/README.md): [list alert names]. The alert_agents provide the ability to drive and independently monitor alert handshakes via alert interfaces in RSTMGR device. ### UVM RAL Model -The RSTMGR RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The RSTMGR RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}). +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md). ### Stimulus strategy The following test sequences and covergroups are described in more detail in the testplan at `hw/ip/pwrmgr/data/rstmgr_testplan.hjson`, and also included [below](#testplan). @@ -106,7 +106,7 @@ The latter are described in the testplan. #### Assertions -* TLUL assertions: The `tb/rstmgr_bind.sv` file binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/rstmgr_bind.sv` file binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. * Response to pwrmgr's `rst_lc_req` and `rst_sys_req` inputs: these trigger transitions in `rst_lc_src_n` and `rst_sys_rst_n` outputs. Checked via SVAs in [`hw/ip/pwrmgr/dv/sva/pwrmgr_rstmgr_sva_if.sv`](https://github.com/lowRISC/opentitan/blob/master/hw/ip/pwrmgr/dv/sva/pwrmgr_rstmgr_sva_if.sv). @@ -132,7 +132,7 @@ It is excluded from coverage for the rstmgr dv tests. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/rv_core_ibex/README.md b/hw/ip/rv_core_ibex/README.md index 9cbe105..f7f49a6 100644 --- a/hw/ip/rv_core_ibex/README.md +++ b/hw/ip/rv_core_ibex/README.md
@@ -63,7 +63,7 @@ ## Random Number Generation -The wrapper has a connection to the [Entropy Distribution Network (EDN)]({{< relref "hw/ip/edn/doc" >}}) with a register based interface. +The wrapper has a connection to the [Entropy Distribution Network (EDN)](../edn/README.md) with a register based interface. The {{< regref "RND_DATA" >}} register provides 32-bits directly from the EDN. {{< regref "RND_STATUS.RND_DATA_VALID" >}} indicates if the data in {{< regref "RND_DATA" >}} is valid or not. A polling style interface is used to get new random data.
diff --git a/hw/ip/rv_core_ibex/doc/checklist.md b/hw/ip/rv_core_ibex/doc/checklist.md index f487436..4790acb 100644 --- a/hw/ip/rv_core_ibex/doc/checklist.md +++ b/hw/ip/rv_core_ibex/doc/checklist.md
@@ -2,10 +2,10 @@ title: "Ibex Processor Core Checklist" --- -This checklist is for [Hardware Stage][] transitions for the [Ibex Processor Core.](../) -All checklist items refer to the content in the [Checklist.]({{<relref "/doc/project/checklist.md">}}) +This checklist is for [Hardware Stage][] transitions for the [Ibex Processor Core.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) -[Hardware Stage]: {{<relref "/doc/project/development_stages.md" >}} +[Hardware Stage]: ../../../../doc/project_governance/development_stages.md ## Design Checklist @@ -25,15 +25,15 @@ Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D1 Exceptions @@ -62,24 +62,24 @@ Code Quality | [TIMING_CHECK][] | Done | FPGA timing acceptable Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -93,13 +93,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -115,15 +115,15 @@ Review | [REVIEW_SW_CHANGE][] | Not Started | Review | [REVIEW_SW_ERRATA][] | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -131,7 +131,7 @@ Ibex is at **V2S**. Features specific to rv_core_ibex do not have block-level verification. -Top-level testing suffices for these, see the [rv_core_ibex DV document]({{<relref "hw/ip/rv_core_ibex/doc/dv/" >}}) for more details. +Top-level testing suffices for these, see the [rv_core_ibex DV document](../dv/README.md) for more details. ### V1
diff --git a/hw/ip/rv_core_ibex/dv/README.md b/hw/ip/rv_core_ibex/dv/README.md index 56f1503..5c92ff8 100644 --- a/hw/ip/rv_core_ibex/dv/README.md +++ b/hw/ip/rv_core_ibex/dv/README.md
@@ -14,12 +14,12 @@ The wrapper adapts Ibex's top-level interfaces to be suitable for use with OpenTitan. In addition rv_core_ibex provides some extra functionality controlled via bus accessible registers. -For more information please see the [Ibex RISC-V Core Wrapper Technical Specification]({{< relref ".." >}}). +For more information please see the [Ibex RISC-V Core Wrapper Technical Specification](../README.md). ## Current Status * Ibex Verification is tracked in the [Ibex documentation](https://ibex-core.readthedocs.io/en/latest/03_reference/verification_stages.html) - * Verification follows the OpenTitan [HW development stages]({{< relref "doc/project/development_stages.md" >}}) + * Verification follows the OpenTitan [HW development stages](../../../../doc/project_governance/development_stages.md) * [Nightly regression results](https://dev.azure.com/lowrisc/lowrisc-private/_build?definitionId=11) * These are from the Ibex private-ci which is restricted to OpenTitan project members @@ -28,10 +28,10 @@ The main Ibex testbench is not contained in the OpenTitan repository. Verification is primarily done by the testbench in the Ibex repository, see the [Ibex Testplan](https://ibex-core.readthedocs.io/en/latest/03_reference/testplan.html) for more details. -The additional features provided by the RISC-V Core Wrapper are verified at a chip level only (See the [Earlgrey Chip DV testplan]({{< relref "hw/top_earlgrey/doc/dv" >}}). +The additional features provided by the RISC-V Core Wrapper are verified at a chip level only (See the [Earlgrey Chip DV testplan](../../../top_earlgrey/dv/README.md). As they are simple features chip level only verification suffices to meet our goals. -Similarly there is no specific verification for the TL-UL <-> Ibex memory protocol wrappers (provided by the separate [TLUL IP]({{< relref "hw/ip/tlul/doc" >}})). +Similarly there is no specific verification for the TL-UL <-> Ibex memory protocol wrappers (provided by the separate [TLUL IP](../../tlul/README.md)). These are exercised extensively by all chip-level testing that runs software on Ibex providing comprehensive verification. ## Coverage
diff --git a/hw/ip/rv_dm/README.md b/hw/ip/rv_dm/README.md index 6977f0c..0666edb 100644 --- a/hw/ip/rv_dm/README.md +++ b/hw/ip/rv_dm/README.md
@@ -57,7 +57,7 @@ ### Life Cycle Control -Debug system functionality is controlled by the [HW_DEBUG_EN]({{< relref "hw/ip/lc_ctrl/doc/#hw_debug_en" >}}) function of the life cycle controller. +Debug system functionality is controlled by the [HW_DEBUG_EN](../lc_ctrl/README.md#hw_debug_en) function of the life cycle controller. ```verilog input lc_ctrl_pkg::lc_tx_t lc_hw_debug_en_i, // Debug module lifecycle enable/disable
diff --git a/hw/ip/rv_dm/doc/checklist.md b/hw/ip/rv_dm/doc/checklist.md index a95c9a9..50be755 100644 --- a/hw/ip/rv_dm/doc/checklist.md +++ b/hw/ip/rv_dm/doc/checklist.md
@@ -2,8 +2,8 @@ title: "RV_DM Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [RV_DM peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [RV_DM peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [RV_DM Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [RV_DM Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -55,24 +55,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -86,13 +86,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -110,15 +110,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -126,8 +126,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [RV_DM DV document]({{<relref "dv">}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [RV_DM Testplan]({{<relref "dv#testplan">}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [RV_DM DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [RV_DM Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -149,28 +149,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Security, debug, stress, error test cases planned. Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -197,26 +197,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Not Started | Review | [V3_CHECKLIST_SCOPED][] | Not Started | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -228,11 +228,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -254,16 +254,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/rv_dm/dv/README.md b/hw/ip/rv_dm/dv/README.md index b91b50a..36f0ab1 100644 --- a/hw/ip/rv_dm/dv/README.md +++ b/hw/ip/rv_dm/dv/README.md
@@ -10,22 +10,22 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/rv_dm/dv/latest/report.html) ## Design features -For detailed information on RV_DM design features, please see the [RV_DM HWIP technical specification]({{< relref "hw/ip/rv_dm/doc" >}}). +For detailed information on RV_DM design features, please see the [RV_DM HWIP technical specification](../README.md). The internal debug logic is vendored-in from the external [PULP RISC-V debug repository](https://github.com/pulp-platform/riscv-dbg). ## Testbench architecture -RV_DM has a standard UVM testbench, which is based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +RV_DM has a standard UVM testbench, which is based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + The flow of data into the scoreboard is described [below](#scoreboard). @@ -34,12 +34,12 @@ The top level testbench is located at `hw/ip/rv_dm/dv/tb.sv`. It instantiates the RV_DM DUT module `hw/ip/rv_dm/rtl/rv_dm.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) for the config space (which only contains the alert register). -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) for the debug memory space (which only contains the alert register). -* [TileLink device interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) for the SBA interface that is used by the JTAG debugger to access the whole chip. -* [JTAG interface]({{< relref "hw/dv/sv/jtag_agent/doc" >}}) to act as an external JTAG host. -* [Alert and escalation interface]({{<relref "hw/dv/sv/alert_esc_agent/doc" >}}) for the alert interface. +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) for the config space (which only contains the alert register). +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) for the debug memory space (which only contains the alert register). +* [TileLink device interface](../../../dv/sv/tl_agent/README.md) for the SBA interface that is used by the JTAG debugger to access the whole chip. +* [JTAG interface](../../../dv/sv/jtag_agent/README.md) to act as an external JTAG host. +* [Alert and escalation interface](../../../dv/sv/alert_esc_agent/README.md) for the alert interface. * The instantiation and hookup of this interface is done using the standardized common macro `` `DV_ALERT_IF_CONNECT`` defined in `hw/dv/sv/dv_utils/dv_macros.svh`. * RV_DM interface for driving / sampling the remaining DUT IOs * Inputs driven / sampled: `lc_hw_debug_en_i`, `scanmode_i`, `scan_rst_ni`, `unavailable_i` @@ -48,20 +48,20 @@ ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [dv_lib_pkg]({{< relref "hw/dv/sv/dv_lib/doc" >}}) -* [cip_lib_pkg]({{< relref "hw/dv/sv/cip_lib/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [dv_lib_pkg](../../../dv/sv/dv_lib/README.md) +* [cip_lib_pkg](../../../dv/sv/cip_lib/README.md) * dv_base_reg_pkg -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### TL_agent -The RV_DM testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}). +The RV_DM testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md). This provides the ability to drive and independently monitor random traffic via the TL host interface into the RV_DM device. ### Alert_agent -RV_DM testbench instantiates an [alert_agent]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}}). +RV_DM testbench instantiates an [alert_agent](../../../dv/sv/alert_esc_agent/README.md). This is already done in the CIP base environment. It uses a string array of alert names to associate each instance of an alert signal. RV_DM exposes only a single alert signal, so this array is set to ["fatal_fault"]. This alert is wired from the bus integrity logic. @@ -70,15 +70,15 @@ ### JTAG Agent -The RVDM testbench instantiates an instance of [jtag_agent]({{<relref "hw/dv/sv/jtag_agent/doc">}}). +The RVDM testbench instantiates an instance of [jtag_agent](../../../dv/sv/jtag_agent/README.md). ### JTAG DMI Agent -The RV_DM testbench instantiates the sub-components of [jtag_dmi_agent]({{<relref "hw/dv/sv/jtag_dmi_agent/doc">}}) - the `jtag_dmi_monitor`, `sba_access_monitor` and the `jtag_dmi_reg_block`. +The RV_DM testbench instantiates the sub-components of [jtag_dmi_agent](../../../dv/sv/jtag_dmi_agent/README.md) - the `jtag_dmi_monitor`, `sba_access_monitor` and the `jtag_dmi_reg_block`. ### UVM RAL Model -On OpenTitan, the DV RAL models are typically generated with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulations are run. +On OpenTitan, the DV RAL models are typically generated with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulations are run. `ralgen` invokes the `reggen` tool underneath, which takes the design specification `hjson` file as input, which contains the register descriptions. This generator is invoked by FuseSoC when it processes the RV_DM environment core file located at `hw/ip/rv_dm/dv/env/rv_dm_env.core`. @@ -101,13 +101,13 @@ * **JTAG DTM RAL model**: This RAL model describes the JTAG data transport module (DTM) registers, and can be accessed only via JTAG. - This RAL model is hand-written and checked into our repository in the [`jtag_agent`]({{<relref "hw/dv/sv/jtag_agent/doc">}}) area. + This RAL model is hand-written and checked into our repository in the [`jtag_agent`](../../../dv/sv/jtag_agent/README.md) area. * **JTAG DMI RAL model**: The RISC-V debug specification defines registers in the DMI space, which also can be accessed only via JTAG. These registers facilitate CPU debug. The PULP RISC-V debug implementation however only implements a subset of these registers. - This RAL model is also checked into our repository in the [`jtag_agent`]({{<relref "hw/dv/sv/jtag_agent/doc">}}) area. + This RAL model is also checked into our repository in the [`jtag_agent`](../../../dv/sv/jtag_agent/README.md) area. It is created in the RV_DM environment configuration object. All four of these RAL models can be referenced (directly or indirectly) using the RV_DM environment configuration object. @@ -148,14 +148,14 @@ #### Assertions -* TLUL assertions: The `tb/rv_dm_bind.sv` file binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/rv_dm_bind.sv` file binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. * assert prop 1: * assert prop 2: ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/rv_timer/README.md b/hw/ip/rv_timer/README.md index 1817e89..e9231df 100644 --- a/hw/ip/rv_timer/README.md +++ b/hw/ip/rv_timer/README.md
@@ -6,7 +6,7 @@ This document specifies RISC-V Timer hardware IP functionality. This module conforms to the -[Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification" >}}) +[Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) See that document for integration overview within the broader top level system. @@ -39,7 +39,7 @@ ## Block Diagram - + The timer module is composed of tick generators, counters, and comparators. A tick generator creates a tick every time its internal counter hits the
diff --git a/hw/ip/rv_timer/doc/checklist.md b/hw/ip/rv_timer/doc/checklist.md index 93ec2e1..0888539 100644 --- a/hw/ip/rv_timer/doc/checklist.md +++ b/hw/ip/rv_timer/doc/checklist.md
@@ -2,9 +2,9 @@ title: "RV_TIMER Checklist" --- -This checklist is for [Hardware Stage]({{<relref "/doc/project/development_stages.md" >}}) -transitions for the [rv_timer peripheral.](../) All checklist -items refer to the content in the [Checklist.]({{<relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) +transitions for the [rv_timer peripheral.](../README.md) All checklist +items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -22,17 +22,17 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[RV_TIMER Spec]: {{<relref "/_index.md">}} +[RV_TIMER Spec]: ../../../../doc/introduction.md -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -59,24 +59,24 @@ [#68]: https://github.com/lowRISC/opentitan/issues/68 -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -90,13 +90,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -116,15 +116,15 @@ Review | Reviewer(s) | Done | @jeoongp @timothytrippel @sriyerg Review | Signoff date | Done | 2022-07-28 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -132,8 +132,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-----------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [RV_TIMER DV document]({{<relref "dv/index.md" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [RV_TIMER Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [RV_TIMER DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [RV_TIMER Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -155,28 +155,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power, Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -205,26 +205,26 @@ [#69]: https://github.com/lowRISC/opentitan/issues/69 -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -236,11 +236,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -265,16 +265,16 @@ [#671]: https://github.com/lowRISC/opentitan/pull/671 [#844]: https://github.com/lowRISC/opentitan/pull/844 -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/rv_timer/dv/README.md b/hw/ip/rv_timer/dv/README.md index e9803d9..97cd3aa 100644 --- a/hw/ip/rv_timer/dv/README.md +++ b/hw/ip/rv_timer/dv/README.md
@@ -10,30 +10,30 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages.md" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/rv_timer/dv/latest/report.html) ## Design features -For detailed information on RV_TIMER design features, please see the [RV_TIMER design specification]({{< relref ".." >}}). +For detailed information on RV_TIMER design features, please see the [RV_TIMER design specification](../README.md). ## Testbench architecture -RV_TIMER testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +RV_TIMER testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/rv_timer/dv/tb/tb.sv`. It instantiates the RV_TIMER DUT module `hw/ip/rv_timer/rtl/rv_timer.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in `env/rv_timer_env_pkg`. @@ -44,14 +44,14 @@ ``` ### TL_agent -RV_TIMER testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +RV_TIMER testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into RV_TIMER device. ### UVM RAL Model -The RV_TIMER RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The RV_TIMER RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -90,11 +90,11 @@ Interrupt pins are checked against expected at every read/write data channel. #### Assertions -* TLUL assertions: The `tb/rv_timer_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance +* TLUL assertions: The `tb/rv_timer_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/spi_device/README.md b/hw/ip/spi_device/README.md index f595eff..08fd212 100644 --- a/hw/ip/spi_device/README.md +++ b/hw/ip/spi_device/README.md
@@ -115,7 +115,7 @@ ## Block Diagram - + In Generic mode, the incoming data is stored byte-based into an asynchronous FIFO. The logic inside the generic mode then updates the DPSRAM RX space. @@ -160,7 +160,7 @@ ## SPI Device Generic mode - + The block diagram above shows how the SPI Device generic mode converts incoming bit-serialized SDI data into a valid byte, where the data bit is valid when the @@ -249,7 +249,7 @@ The following diagram shows the expected data transfer in SPI Generic mode. - + In this diagram, bursts of data transfer are shown as "pages" of firmware content being driven into the device. The size of the page is not relevant, @@ -393,7 +393,7 @@ ### Command Parser - + Command parser (*cmdparse*) processes the first byte of the SPI and activates the processing submodules depending on the received opcode and the *cmd_info* list described in the previous section. @@ -489,7 +489,7 @@ #### Buffer Management - + The SPI Device IP uses the first half of the DPSRAM as a read buffer when the SPI mode is flash or passthrough mode. The IP returns data from the read buffer based on the given address in the received read command. @@ -563,7 +563,7 @@ Filtering the incoming command is the key role of the Passthrough module. - + {{<wavejson>}} { signal: [ @@ -640,7 +640,7 @@ ## TPM over SPI - + The TPM over SPI submodule processes the low level data only. The TPM submodule parses the incoming SPI MOSI line and stacks the stream up to the SW accessible registers, such as TPM_CMD_ADDR, and TPM_WRITE_FIFO. @@ -769,7 +769,7 @@ ### RXFIFO control - + The RXFIFO Control module controls data flow from RXFIFO to SRAM. It connects two FIFOs having different data widths. RXFIFO is byte width, SRAM storing @@ -782,7 +782,7 @@ words to SRAM. A read-modify-write operation is triggered to perform the partial update. - + ### TXFIFO control @@ -791,7 +791,7 @@ to transmit. Data is written into the TXF SRAM by software which also controls the TXF write pointer. - + The TXFIFO control module latches the write pointer then uses it internally. This prevents HW from using incorrect data from SRAM if the write pointer @@ -809,7 +809,7 @@ of data with that value. As shown in the Theory Of Operations figure, for example, internal software could prepare FFh values for first page. - + ## Data Storage Sizes @@ -858,7 +858,7 @@ In generic mode, the whole DPSRAM is used as RX/TX buffers as described in the generic mode section. The SRAM begins at `0x1000`, which in the figure is `0x000`. - + The regions starting from `0xF00` to `0xFFF` are assigned to TPM Read/Write FIFOs. They are not used in this version of IP.
diff --git a/hw/ip/spi_device/doc/checklist.md b/hw/ip/spi_device/doc/checklist.md index c9316b8..0106e94 100644 --- a/hw/ip/spi_device/doc/checklist.md +++ b/hw/ip/spi_device/doc/checklist.md
@@ -2,8 +2,8 @@ title: "SPI_DEVICE Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [spi_device peripheral]({{< relref "./" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [spi_device peripheral](../README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). ## Design Checklist @@ -21,17 +21,17 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPI_DEVICE Spec]: {{<relref "./">}} +[SPI_DEVICE Spec]: ../README.md -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -56,24 +56,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -87,13 +87,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -111,15 +111,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -127,8 +127,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done |[SPI_DEVICE DV document]({{<relref "dv/index.md" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done |[SPI_DEVICE Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done |[SPI_DEVICE DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done |[SPI_DEVICE Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -150,28 +150,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -198,26 +198,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Reviewed on 10/14/2022 Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -229,11 +229,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | Waived the V2S review meeting, since only 1 standard sec_cm - bus integrity. -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -255,16 +255,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/spi_device/dv/README.md b/hw/ip/spi_device/dv/README.md index 30a1d65..facf32f 100644 --- a/hw/ip/spi_device/dv/README.md +++ b/hw/ip/spi_device/dv/README.md
@@ -11,33 +11,33 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages.md" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/spi_device/dv/latest/report.html) ## Design features -For detailed information on SPI Device design features, please see the [SPI_device design specification]({{< relref ".." >}}). +For detailed information on SPI Device design features, please see the [SPI_device design specification](../README.md). ## Testbench architecture SPI Device testbench has been constructed based on the -[CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +[CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/spi_device/dv/tb/tb.sv`. It instantiates the SPI Device DUT module `hw/ip/spi_device/rtl/spi_device.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) -* [SPI interface]({{< relref "hw/dv/sv/spi_agent/doc" >}}) -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) +* [SPI interface](../../../dv/sv/spi_agent/README.md) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -48,21 +48,21 @@ ``` ### TL_agent -SPI Device instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +SPI Device instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into SPI Device. ### SPI Device agent -[spi agent]({{< relref "hw/dv/sv/spi_agent/doc" >}}) is used to drive and monitor SPI items. +[spi agent](../../../dv/sv/spi_agent/README.md) is used to drive and monitor SPI items. There are 2 spi_agents in the testbench to serve as a SPI host and a SPI device. * The host agent is connected to the upstream port to drive stimulus for FW mode, TPM mode and flash mode. * The device agent is connected to the passthrough port. When host sends a flash transaction with passthrough enabled, the device agent receives it and provides the return data when it's a read command. ### UVM RAL Model -The SPI Device RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The SPI Device RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -93,11 +93,11 @@ * upstream_spi_host_fifo, upstream_spi_device_fifo: These 2 fifos provides TX/RX words of data from spi_monitor #### Assertions -* TLUL assertions: The `tb/spi_device_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/spi_device_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/spi_host/README.md b/hw/ip/spi_host/README.md index 081ea8d..d115801 100644 --- a/hw/ip/spi_host/README.md +++ b/hw/ip/spi_host/README.md
@@ -5,7 +5,7 @@ # Overview This document specifies SPI_HOST hardware IP (HWIP) functionality. -This module conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification/index.md" >}}) +This module conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) See that document for integration overview within the broader top-level system. ## Features @@ -28,7 +28,7 @@ - Additional support for "Full-cycle" SPI transactions, wherein data can be read a full SPI Clock cycle after the active edge (as opposed to one half cycle as is typical for SPI interfaces) - Single Transfer Rate (STR) only (i.e. data received on multiple lines, but only on one clock edge) - *No support* for Dual Transfer Rate (DTR) -- Pass-through mode for coordination with [SPI_DEVICE IP]({{< relref "hw/ip/spi_device/doc/_index.md" >}}) +- Pass-through mode for coordination with [SPI_DEVICE IP](../spi_device/README.md) - Automatic control of chip select lines - Condensed interrupt footprint: Two lines for two distinct interrupt classes: "error" and "spi_event" - Fine-grain interrupt masking supplied by secondary enable registers @@ -669,7 +669,7 @@ ## Block Diagram - + ## Hardware Interfaces @@ -918,7 +918,7 @@ Multi-segment commands are considered in the following sections. In this case the state machine can be simplified to the following figure. - + The operation of the state machine is the same regardless of the polarity (CPOL) or phase (CPHA) of the current command. Commands with `CPOL==0` or `CPOL==1` are processed nearly identically, since the only difference is in the polarity of the `sck` output. @@ -1206,7 +1206,7 @@ The following figure shows the complete state transition diagram of for the SPI_HOST FSM. - + ### Skipped idle states @@ -1221,7 +1221,7 @@ However they could also be explicitly added to the state diagram. For example, the implicit transitions around the `Idle` are shown in the following figure. - + ### Stall
diff --git a/hw/ip/spi_host/doc/checklist.md b/hw/ip/spi_host/doc/checklist.md index cc67802..c23bd66 100644 --- a/hw/ip/spi_host/doc/checklist.md +++ b/hw/ip/spi_host/doc/checklist.md
@@ -7,8 +7,8 @@ directory for a new design that transitions from L0 (Specification) to L1 (Development) stage, and updated as needed. Once done, please remove this comment before checking it in. --> -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [SPI_HOST peripheral.]({{< relref "hw/ip/spi_host/doc" >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SPI_HOST peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -16,7 +16,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [SPI_HOST Design Spec]({{< relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [SPI_HOST Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -26,15 +26,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -59,24 +59,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -90,13 +90,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -114,15 +114,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -130,8 +130,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | DONE | [SPI_HOST DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | DONE | [SPI_HOST Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | DONE | [SPI_HOST DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | DONE | [SPI_HOST Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | DONE | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| DONE | Testbench | [SIM_TB_ENV_CREATED][] | DONE | @@ -153,35 +153,35 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | DONE | Review | [V2_CHECKLIST_SCOPED][] | Not Started | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 Type | Item | Resolution | Note/Collaterals --------------|-----------------------------------------|-------------|------------------ -Documentation | [DESIGN_DELTAS_CAPTURED_V2][] | DONE | [SPI_HOST DV document]({{<relref "dv" >}}) -Documentation | [DV_DOC_COMPLETED][] | DONE | [SPI_HOST Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DESIGN_DELTAS_CAPTURED_V2][] | DONE | [SPI_HOST DV document](../dv/README.md) +Documentation | [DV_DOC_COMPLETED][] | DONE | [SPI_HOST Testplan](../dv/README.md#testplan) Testbench | [FUNCTIONAL_COVERAGE_IMPLEMENTED][] | DONE | Testbench | [ALL_INTERFACES_EXERCISED][] | DONE | Testbench | [ALL_ASSERTION_CHECKS_ADDED][] | DONE | @@ -201,26 +201,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | DONE | Review | [V3_CHECKLIST_SCOPED][] | Not Started | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -232,11 +232,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -258,16 +258,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/spi_host/dv/README.md b/hw/ip/spi_host/dv/README.md index 3727f4a..426dc51 100644 --- a/hw/ip/spi_host/dv/README.md +++ b/hw/ip/spi_host/dv/README.md
@@ -10,36 +10,36 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/spi_host/dv/latest/report.html) ## Design features For detailed information on SPI_HOST design features, please see the -[SPI_HOST HWIP technical specification]({{< relref "hw/ip/spi_host/doc" >}}). +[SPI_HOST HWIP technical specification](../README.md). ## Testbench architecture SPI_HOST testbench has been constructed based on the -[CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +[CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/spi_host/dv/tb/tb.sv`. It instantiates the SPI_HOST DUT module `hw/ip/spi_host/rtl/spi_host.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * SPI_HOST IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Alerts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Alerts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Compile-time configurations [list compile time configurations, if any and what are they used for] @@ -172,7 +172,7 @@ ### TL_agent SPI_HOST testbench instantiates (already handled in CIP base env) -[tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +[tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into SPI_HOST device. Transactions will be sampled by the monitor and passed on to the predictor in the scoreboard. @@ -197,9 +197,9 @@ ### UVM RAL Model -The SPI_HOST RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The SPI_HOST RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -258,12 +258,12 @@ #### Assertions -* TLUL assertions: The `tb/spi_host_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/spi_host_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/sram_ctrl/README.md b/hw/ip/sram_ctrl/README.md index c1b1bc2..e0387c6 100644 --- a/hw/ip/sram_ctrl/README.md +++ b/hw/ip/sram_ctrl/README.md
@@ -6,14 +6,14 @@ # Overview This document specifies the functionality of the SRAM memory controller. -The SRAM controller is a module that is a peripheral on the chip interconnect bus, and thus follows the [Comportability Specification]({{< relref "doc/rm/comportability_specification" >}}). +The SRAM controller is a module that is a peripheral on the chip interconnect bus, and thus follows the [Comportability Specification](../../../doc/contributing/hw/comportability/README.md). The SRAM controller contains the SRAM data and address scrambling device and provides CSRs for requesting the scrambling keys and triggering the hardware initialization feature. ## Features -- [Lightweight scrambling mechanism]({{< relref "hw/ip/prim/doc/prim_ram_1p_scr#custom-substitution-permutation-network" >}}) based on the PRINCE prince cipher. +- [Lightweight scrambling mechanism](../prim/doc/prim_ram_1p_scr.md#custom-substitution-permutation-network) based on the PRINCE prince cipher. - Key request logic for the lightweight memory and address scrambling device. - Alert sender and checking logic for detecting bus integrity failures. - LFSR-based memory initialization feature. @@ -24,7 +24,7 @@ ## Block Diagram - + As shown in the block diagram above, the SRAM controller contains a TL-UL adapter, an initialization LFSR, the CSR node, key request logic and an instance of `prim_ram_1p_scr` that implements the actual scrambling mechanism. @@ -73,13 +73,13 @@ `lc_escalate_en_i` | `input` | `lc_ctrl_pkg::lc_tx_t` | Multibit life cycle escalation enable signal coming from life cycle controller, asserted if an escalation has occurred. `sram_otp_key_o` | `output` | `otp_ctrl_pkg::sram_otp_key_req_t` | Key derivation request going to the key derivation interface of the OTP controller. `sram_otp_key_i` | `input` | `otp_ctrl_pkg::sram_otp_key_rsp_t` | Ephemeral scrambling key coming back from the key derivation interface of the OTP controller. -`otp_en_sram_ifetch_i` | `input` | `otp_ctrl_pkg::mubi8_t` | Multibit value coming from the OTP HW_CFG partition ([EN_SRAM_IFETCH]({{< relref "hw/ip/otp_ctrl/doc/#direct-access-memory-map" >}})), set to kMuBi8True in order to enable the {{< regref "EXEC" >}} CSR. +`otp_en_sram_ifetch_i` | `input` | `otp_ctrl_pkg::mubi8_t` | Multibit value coming from the OTP HW_CFG partition ([EN_SRAM_IFETCH](../otp_ctrl/README.md#direct-access-memory-map)), set to kMuBi8True in order to enable the {{< regref "EXEC" >}} CSR. `cfg_i` | `input` | `logic [CfgWidth-1:0]` | Attributes for physical memory macro. #### Interfaces to OTP and the SRAM Scrambling Primitive The interface to the key derivation interface inside the OTP controller follows a simple req / ack protocol, where the SRAM controller first requests an updated ephemeral key by asserting the `sram_otp_key_i.req`. -The OTP controller then fetches entropy from CSRNG and derives an ephemeral key using the SRAM_DATA_KEY_SEED and the PRESENT scrambling data path as described in the [OTP controller spec]({{< relref "hw/ip/otp_ctrl/doc/#scrambling-datapath" >}}). +The OTP controller then fetches entropy from CSRNG and derives an ephemeral key using the SRAM_DATA_KEY_SEED and the PRESENT scrambling data path as described in the [OTP controller spec](../otp_ctrl/README.md#scrambling-datapath). Finally, the OTP controller returns a fresh ephemeral key via the response channels (`sram_otp_key_o[*]`, `otbn_otp_key_o`), which complete the req / ack handshake. The key and nonce are made available to the scrambling primitive in the subsequent cycle. The wave diagram below illustrates this process. @@ -107,7 +107,7 @@ Note that the req/ack protocol runs on `clk_otp_i`. The SRAM controller synchronizes the data over via a req/ack handshake primitive `prim_sync_reqack.sv` primitive as shown below. - + Note that the key and nonce output signals on the OTP controller side are guaranteed to remain stable for at least 62 OTP clock cycles after the `ack` signal is pulsed high, because the derivation of a 64bit half-key takes at least two passes through the 31-cycle PRESENT primitive. Hence, if the SRAM controller clock `clk_i` is faster or in the same order of magnitude as `clk_otp_i`, the data can be directly sampled upon assertion of `src_ack_o`. @@ -117,16 +117,16 @@ If `lc_escalate_en_i` is set to any different value than `lc_ctrl_pkg::Off`, the current scrambling keys are discarded and reset to `RndCnstSramKey` and `RndCnstSramNonce` in the subsequent cycle. Any subsequent memory request to `prim_ram_1p_scr` will then be blocked as well. -This mechanism is part of the [life cycle]({{< relref "hw/ip/lc_ctrl/doc" >}}) state scrapping and secret wiping countermeasure triggered by the alert handler (global escalation). +This mechanism is part of the [life cycle](../lc_ctrl/README.md) state scrapping and secret wiping countermeasure triggered by the alert handler (global escalation). Note that if any local bus integrity or counter errors are detected, the SRAM controller will locally escalate without assertion of `lc_escalate_en_i`. The behavior of local escalation is identical to global escalation via `lc_escalate_en_i`. ## Scrambling Primitive -As explained in [`prim_ram_1p_scr`]({{< relref "hw/ip/prim/doc/prim_ram_1p_scr" >}}) the scrambling mechanism employs a reduced-round PRINCE block cipher in CTR mode to scramble the data. +As explained in [`prim_ram_1p_scr`](../prim/doc/prim_ram_1p_scr.md) the scrambling mechanism employs a reduced-round PRINCE block cipher in CTR mode to scramble the data. Since plain CTR mode does not diffuse the data bits due to the bitwise XOR, the scheme is augmented by passing each word through a shallow substitution-permutation (S&P) network implemented with the `prim_subst_perm` primitive. -The S&P network employed is similar to the one employed in PRESENT and is explained in more detail [here]({{< relref "hw/ip/prim/doc/prim_ram_1p_scr#custom-substitution-permutation-network" >}}). +The S&P network employed is similar to the one employed in PRESENT and is explained in more detail [here](../prim/doc/prim_ram_1p_scr.md#custom-substitution-permutation-network). Another CTR mode augmentation that is aimed at breaking the linear address space is SRAM address scrambling. The same S&P network construction that is used for intra-word diffusion is leveraged to non-linearly remap the SRAM address as shown in the block diagram above. @@ -157,9 +157,9 @@ ### Code Execution from SRAM The SRAM controller contains an access control mechanism for filtering instruction fetches from the processor. -As illustrated below, an OTP switch EN_SRAM_IFETCH (see [OTP memory map]({{< relref "hw/ip/otp_ctrl/doc/#direct-access-memory-map" >}})) allows to either tie code execution from SRAM to the life cycle state via the HW_DEBUG_EN function (see [life cycle docs]({{< relref "hw/ip/lc_ctrl/doc/#hw_debug_en" >}})), or it can be enabled / disabled via the {{< regref "EXEC" >}} CSR. +As illustrated below, an OTP switch EN_SRAM_IFETCH (see [OTP memory map](../otp_ctrl/README.md#direct-access-memory-map)) allows to either tie code execution from SRAM to the life cycle state via the HW_DEBUG_EN function (see [life cycle docs](../lc_ctrl/README.md#hw_debug_en)), or it can be enabled / disabled via the {{< regref "EXEC" >}} CSR. - + The different configuration options are listed in the table below: @@ -188,11 +188,11 @@ Note that this arrangement still allows full read/write throughput as illustrated in the alternating R/W sequence below. - + However, due to the end-to-end bus integrity scheme, sub-word write accesses currently require a read-modify-write operation in order to recompute the integrity bits for the entire word, as illustrated in the diagram below. - + Sub-word write accesses are therefore 3x slower than full-word write accesses. Read accesses however always take 1 cycle, no matter whether the access is a full-word or sub-word read operation.
diff --git a/hw/ip/sram_ctrl/doc/checklist.md b/hw/ip/sram_ctrl/doc/checklist.md index 14273f5..c6880cb 100644 --- a/hw/ip/sram_ctrl/doc/checklist.md +++ b/hw/ip/sram_ctrl/doc/checklist.md
@@ -2,8 +2,8 @@ title: "SRAM_CTRL Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [SRAM_CTRL peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SRAM_CTRL peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|-----------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [SRAM_CTRL Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [SRAM_CTRL Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][]| Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[MEM_INSTANCED_80]: {{<relref "/doc/project/checklist.md#mem_instanced_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[MEM_INSTANCED_80]: ../../../../doc/project_governance/checklist/README.md#mem_instanced_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Done | msf@ weicai@ tjaychen@ gac@ Review | Signoff date | Done | 2022-07-15 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security/Power/Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/sram_ctrl/dv/README.md b/hw/ip/sram_ctrl/dv/README.md index 2989146..97f2e3d 100644 --- a/hw/ip/sram_ctrl/dv/README.md +++ b/hw/ip/sram_ctrl/dv/README.md
@@ -17,35 +17,35 @@ Only toggle coverage on the IOs of these sub-modules is enabled for coverage collection. ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/sram_ctrl/dv/latest/report.html) ## Design features -For detailed information on SRAM_CTRL design features, please see the [SRAM_CTRL HWIP technical specification]({{< relref ".." >}}). +For detailed information on SRAM_CTRL design features, please see the [SRAM_CTRL HWIP technical specification](../README.md). ## Testbench architecture -SRAM_CTRL testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +SRAM_CTRL testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). Note that there are 2 separate TLUL interfaces exposed to the rest of the OpenTitan system - one for CSR accesses, and one for accessing memory directly. This is because the "full" DUT consists of the actual SRAM memory controller (which contains the CSR file) connected to a scrambling RAM primitive, with a TLUL adapter module to convert TL requests on the memory TL interface into SRAM format for the RAM primitive. ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/sram_ctrl/dv/tb/tb.sv`. It instantiates the SRAM_CTRL DUT module `hw/ip/sram_ctrl/rtl/sram_ctrl.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * SRAM_CTRL IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Alerts ([`alert_esc_if`]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Alerts ([`alert_esc_if`](../../../dv/sv/alert_esc_agent/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Compile-time configurations Two compile-time configurations are tested: @@ -83,11 +83,11 @@ } sram_ctrl_status_e; ``` ### TL_agent -SRAM_CTRL testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +SRAM_CTRL testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into SRAM_CTRL device. ### Alert agents -The SRAM_CTRL testbench instantiates 2 [alert agents]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}}) for: +The SRAM_CTRL testbench instantiates 2 [alert agents](../../../dv/sv/alert_esc_agent/README.md) for: * fatal_intg_error - signals a transmission integrity error * fatal_parity_error - signals an internal parity error in the memory primitive @@ -102,9 +102,9 @@ This interface contains the necessary Lifecycle and OTP structs to enable and disable this functionality. ### UVM RAL Model -The SRAM_CTRL RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The SRAM_CTRL RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): Besides default RAL that provides the access to CSRs, there is another RAL for SRAM memory. This RAL is in `sram_ctrl_prim_ral_pkg.sv`, it is added manually and enabled with all the common CSR and memory tests, such as mem_walk, tl_errors, tl_intg_err, etc. @@ -112,8 +112,8 @@ ### Reference models There are 3 DV reference models used in this testbench. - The SRAM_CTRL testbench uses a SystemVerilog golden model for its address and data scrambling to ensure that internal encryption and decryption perform correctly. -This golden model, [`sram_scrambler_pkg`]({{<relref "hw/dv/sv/mem_bkdr_util/doc" >}}) is tightly integrated with the mem_bkdr_util for ease of use such that we can choose to enable encryption on any backdoor access. -- The frontdoor check [`mem_model`]({{<relref "hw/dv/sv/mem_model/doc" >}}) is also enabled in cip_base_scoreboard. +This golden model, [`sram_scrambler_pkg`](../../../dv/sv/mem_bkdr_util/README.md) is tightly integrated with the mem_bkdr_util for ease of use such that we can choose to enable encryption on any backdoor access. +- The frontdoor check [`mem_model`](../../../dv/sv/mem_model/README.md) is also enabled in cip_base_scoreboard. The model is invoked at the end of the transaction as follows: - If it’s write, store the data on the address in the memory array. - If it’s read and the address has been written, compare read value with stored value. @@ -125,8 +125,8 @@ 3. Can’t check the write value if the address isn’t read after the write. 4. Not aware of any B2B hazard (such as RAW). -- The backdoor check [`mem_bkdr_scb`]({{<relref "hw/dv/sv/mem_bkdr_scb/doc" >}}) is used to ensure frontdoor access matches with the backdoor expected value. -The [`sram_scrambler_pkg`]({{<relref "hw/dv/sv/mem_bkdr_util/doc" >}}) is invoked in [`mem_bkdr_scb`]({{<relref "hw/dv/sv/mem_bkdr_scb/doc" >}}) +- The backdoor check [`mem_bkdr_scb`](../../../dv/sv/mem_bkdr_scb/README.md) is used to ensure frontdoor access matches with the backdoor expected value. +The [`sram_scrambler_pkg`](../../../dv/sv/mem_bkdr_util/README.md) is invoked in [`mem_bkdr_scb`](../../../dv/sv/mem_bkdr_scb/README.md) This backdoor check covers all the limitations of frontdoor check. There is a limitation as follows, which can be covered by frontdoor check. - Can’t check when memory is modified unintentionally after the access is completed. @@ -161,7 +161,7 @@ All CSR accesses made to the SRAM_CTRL register file are tracked and predicted by the scoreboard. -Verifying memory accesses is somewhat involved, and makes heavy use of the [`mem_bkdr_util`]({{< relref "hw/dv/sv/mem_bkdr_util/doc" >}}). +Verifying memory accesses is somewhat involved, and makes heavy use of the [`mem_bkdr_util`](../../../dv/sv/mem_bkdr_util/README.md). At a high level, whenever a TL access is made to memory, all relevant information is stored in an `sram_trans_t` struct. @@ -180,11 +180,11 @@ If the DUT is configured correctly the scoreboard will let the memory transaction finish being checked, otherwise the scoreboard will discard that transaction - this approach makes it easy to check whether the design is behaving correctly as well. #### Assertions -* TLUL assertions: The `tb/sram_ctrl_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/sram_ctrl_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/sysrst_ctrl/README.md b/hw/ip/sysrst_ctrl/README.md index 28618be..eff0b75 100644 --- a/hw/ip/sysrst_ctrl/README.md +++ b/hw/ip/sysrst_ctrl/README.md
@@ -6,7 +6,7 @@ This document specifies the functionality of the System Reset Controller (`sysrst_ctrl`) that provides programmable hardware-level responses to trusted IOs and basic board-level reset sequencing capabilities. These capabilities include keyboard and button combination-triggered actions, reset stretching for system-level reset signals, and internal reset / wakeup requests that go to the OpenTitan reset and power manager blocks. -This module conforms to the [Comportable guideline for peripheral functionality]({{< relref "doc/rm/comportability_specification" >}}). +This module conforms to the [Comportable guideline for peripheral functionality](../../../doc/contributing/hw/comportability/README.md). See that document for integration overview within the broader top level system. ## Features @@ -32,7 +32,7 @@ # Theory of Operations - + The block diagram above shows a conceptual view of the `sysrst_ctrl` block, which consists of 3 main modules: The first is the configuration and status registers, the second is the keyboard combo debounce and detection logic, and the third is the pinout override logic. @@ -186,7 +186,7 @@ The power-on-reset value of {{< regref PIN_ALLOWED_CTL.EC_RST_L_1 >}} and {{< regref PIN_OUT_CTL.EC_RST_L >}} will guarantee that `ec_rst_l_o` remains asserted after OpenTitan reset is released. The software can release `ec_rst_l_o` explicitly by setting {{< regref PIN_OUT_CTL.EC_RST_L >}} to 0 during boot in order to complete the OpenTitan and EC power-on-reset sequence. -Note that since the `sysrst_ctrl` does not have control over the pad open-drain settings, software should properly initialize the pad attributes of the corresponding pad in the [pinmux configuration]({{< relref "hw/ip/pinmux/doc/" >}}) before releasing `ec_rst_l_o`. +Note that since the `sysrst_ctrl` does not have control over the pad open-drain settings, software should properly initialize the pad attributes of the corresponding pad in the [pinmux configuration](../pinmux/README.md) before releasing `ec_rst_l_o`. ## Flash Write Protect Output @@ -195,7 +195,7 @@ The `flash_wp_l_o` signal does have a corresponding input signal `flash_wp_l_i` - but that one is mainly intended for pad observability and does not have a bypass path to `flash_wp_l_o`. Hence, the value of `flash_wp_l_o` defaults to logic 0 when it is not explicitly driven via the override function. -Note that since the `sysrst_ctrl` does not have control over the pad open-drain settings, software should properly initialize the pad attributes of the corresponding pad in the [pinmux configuration]({{< relref "hw/ip/pinmux/doc/" >}}) before releasing `flash_wp_l_o`. +Note that since the `sysrst_ctrl` does not have control over the pad open-drain settings, software should properly initialize the pad attributes of the corresponding pad in the [pinmux configuration](../pinmux/README.md) before releasing `flash_wp_l_o`. ## Device Interface Functions (DIFs)
diff --git a/hw/ip/sysrst_ctrl/doc/checklist.md b/hw/ip/sysrst_ctrl/doc/checklist.md index 3fb5638..37d05ea 100644 --- a/hw/ip/sysrst_ctrl/doc/checklist.md +++ b/hw/ip/sysrst_ctrl/doc/checklist.md
@@ -2,8 +2,8 @@ title: "SYSRST_CTRL Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [SYSRST_CTRL peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SYSRST_CTRL peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [SYSRST_CTRL Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [SYSRST_CTRL Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Done | msf@ tjaychen@ weicai@ ttrippel@ Review | Signoff date | Done | 2022-08-03 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,8 +125,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done |({{<relref "dv/index.md" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done |({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done |(../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done |(../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -197,26 +197,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -228,11 +228,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -254,16 +254,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/sysrst_ctrl/dv/README.md b/hw/ip/sysrst_ctrl/dv/README.md index 2ab0d36..2e5a632 100644 --- a/hw/ip/sysrst_ctrl/dv/README.md +++ b/hw/ip/sysrst_ctrl/dv/README.md
@@ -19,34 +19,34 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/sysrst_ctrl/dv/latest/report.html) ## Design features -For detailed information on SYSRST_CTRL design features, please see the [SYSRST_CTRL HWIP technical specification]({{< relref "hw/ip/sysrst_ctrl/doc" >}}). +For detailed information on SYSRST_CTRL design features, please see the [SYSRST_CTRL HWIP technical specification](../README.md). ## Testbench architecture -SYSRST_CTRL testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +SYSRST_CTRL testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench The top level testbench is located at `hw/ip/sysrst_ctrl/dv/tb.sv`. It instantiates the SYSRST_CTRL DUT module `hw/ip/sysrst_ctrl/rtl/sysrst_ctrl.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * SYSRST_CTRL IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Alerts ([`alert_esc_if`]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Alerts ([`alert_esc_if`](../../../dv/sv/alert_esc_agent/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Compile-time configurations [list compile time configurations, if any and what are they used for] @@ -56,18 +56,18 @@ `sysrst_ctrl_env_pkg`. ### TL_agent -The SYSRST_CTRL testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}). +The SYSRST_CTRL testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md). This provides the ability to drive and independently monitor random traffic via the TL host interface into the SYSRST_CTRL device. ### Alert_agents -SYSRST_CTRL testbench instantiates (already handled in CIP base env) [alert_agents]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}}): +SYSRST_CTRL testbench instantiates (already handled in CIP base env) [alert_agents](../../../dv/sv/alert_esc_agent/README.md): [list alert names]. The alert_agents provide the ability to drive and independently monitor alert handshakes via alert interfaces in SYSRST_CTRL device. ### UVM RAL Model -The SYSRST_CTRL RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The SYSRST_CTRL RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -103,14 +103,14 @@ The `sysrst_ctrl_scoreboard` is primarily used for end to end checking. #### Assertions -* TLUL assertions: The `sva/sysrst_ctrl_bind.sv` file binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `sva/sysrst_ctrl_bind.sv` file binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. * Assertions in `tb.sv` * CheckFlashWrProtRst: Checks flash_wp_l output pin is asserted active low which it is in reset. * CheckEcPwrOnRst: Checks ec_rst_l_o is asserted active low when it is in reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/tlul/README.md b/hw/ip/tlul/README.md index 6c3d10d..3eb750d 100644 --- a/hw/ip/tlul/README.md +++ b/hw/ip/tlul/README.md
@@ -52,7 +52,7 @@ described later in this document. These primitives can be combined to form a flexible crossbar of any M hosts to any N devices. As of this writing, these crossbars are generated programmatically through usage of configuration files. -See the [tlgen reference manual]({{< relref "doc/rm/crossbar_tool" >}}) for more details. +See the [tlgen reference manual](../../../util/tlgen/README.md) for more details. ## Compatibility @@ -135,7 +135,7 @@ has a requirement on TL-UL hosts ("masters" in TileLink terminology) that "`valid` signals must be driven LOW for at least 100 cycles while reset is asserted." The TL-UL collateral within this library does **not** have this requirement on its TL-UL host drivers. TL-UL devices within the library can tolerate shorter reset windows. -(See the reset section of the [Comportability Specification]({{< relref "doc/rm/comportability_specification" >}}) +(See the reset section of the [Comportability Specification](../../../doc/contributing/hw/comportability/README.md) for details on reset requirements.) ### Signal and Struct Definitions @@ -363,7 +363,7 @@ - Inactive lanes must be marked with `'b0` in `a_mask`, - `PutFullData` must mark all active lanes with a `'b1` in `a_mask`, 3. Non-contiguous mask may lead to an error, depending on the device support (see previous section), -4. Register files always assume aligned 32bit accesses, see also [register tool manual]({{< relref "doc/rm/register_tool/index.md#error-responses" >}}), +4. Register files always assume aligned 32bit accesses, see also [register tool manual](../../../util/reggen/README.md#error-responses), 5. Accesses to non-existent addresses. On the host side, orphaned responses (i.e. responses that do not have a valid request counterpart) and responses with the wrong opcode will be discarded. @@ -372,7 +372,7 @@ Note that the above checks also cover cases which are in principle allowed by the TL-UL spec, but are not supported by the hosts and devices within this project. Further, devices and hosts may implement additional more restrictive checks, if needed. -The remaining, basic properties as specified in the TL-UL spec are enforced at design time using assertions, and hence no additional hardware checkers are implemented to check for those properties (see also [TL-UL Protocol Checker Specification]({{< relref "./TlulProtocolChecker" >}})). +The remaining, basic properties as specified in the TL-UL spec are enforced at design time using assertions, and hence no additional hardware checkers are implemented to check for those properties (see also [TL-UL Protocol Checker Specification](./doc/TlulProtocolChecker.md)). The interconnect does not possess additional hardware mechanisms to detect and handle interconnect deadlocks due to malicious tampering attempts. The reasons for this are that @@ -556,7 +556,7 @@ The diagram below shows the dataflow of the `tlul_socket_1n` and how the `tlul_fifo_sync` modules are allocated. - + In this diagram, the full socket (`1:4` in this case) is shown, with its single host port and four device ports. Also shown is the critical @@ -616,7 +616,7 @@ The diagram below shows the dataflow of `tlul_socket_m1` for `4:1` case and how the `tlul_fifo_sync` modules are allocated. - + Requests coming from each host ports are arbitrated in the socket based on round-robin scheme. `tlul_socket_m1`, unlike the `1:N` socket, doesn't @@ -639,7 +639,7 @@ ### `tlul_xbar` -For details of the `tlul_xbar`, please refer to the [tlgen reference manual]({{< relref "doc/rm/crossbar_tool" >}}). +For details of the `tlul_xbar`, please refer to the [tlgen reference manual](../../../util/tlgen/README.md). In general, tlgen stitches together various components described in the previous sections to create a full blown fabric switch. Specifically, it implements the address to `dev_sel` steering logic and ensures the right connections are made from host to device. @@ -662,7 +662,7 @@ | rerror | `input` | Transaction read error from downstream | The diagram below is a block diagram that shows the construction of the adapter. - + All incoming transactions are checked for protocol errors and integrity. The transactions are then forwarded to the `tlul_sram_byte` module, which determines whether the incoming transaction is a write, and whether the write transaction must be transformed to a read-modified-write.
diff --git a/hw/ip/tlul/doc/dv/README.md b/hw/ip/tlul/doc/dv/README.md index 3ea736e..03141ab 100644 --- a/hw/ip/tlul/doc/dv/README.md +++ b/hw/ip/tlul/doc/dv/README.md
@@ -11,12 +11,12 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../../README.md) + * [HW development stages](../../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/keymgr/dv/latest/report.html) ## Design features -For detailed information on TLUL design features, please see the [TLUL design specification]({{< relref ".." >}}). +For detailed information on TLUL design features, please see the [TLUL design specification](../../README.md). Only following modules are verified in this testbench. * tlul_socket_1n, tlul_socket_m1 @@ -37,13 +37,13 @@ ### Top level testbench Top level testbench is located at `hw/ip/tlul/dv/tb/tb.sv`. It instantiates the XBAR DUT module `hw/top_earlgrey/ip/xbar/rtl/autogen/xbar_main.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../../dv/sv/tl_agent/README.md) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) +* [common_ifs](../../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../../dv/sv/dv_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -56,7 +56,7 @@ ``` ### TL agent -XBAR env instantiates [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) for each xbar host and device, +XBAR env instantiates [tl_agent](../../../../dv/sv/tl_agent/README.md) for each xbar host and device, which provides the ability to drive and independently monitor random traffic via TL host/device interface. * For host, source ID MSB 2 bits are tied to 0 and maximum number of outstanding request is 64 @@ -110,11 +110,11 @@ We set the source of expected item to 0 before put it into scoreboard queue and hack the source of actual item to 0 before comparison #### Assertions -* TLUL assertions: The `tb/xbar_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/xbar_bind.sv` binds the `tlul_assert` [assertions](../TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/uart/README.md b/hw/ip/uart/README.md index f59e7c3..ee66a15 100644 --- a/hw/ip/uart/README.md +++ b/hw/ip/uart/README.md
@@ -40,7 +40,7 @@ ## Block Diagram - + ## Hardware Interfaces
diff --git a/hw/ip/uart/doc/checklist.md b/hw/ip/uart/doc/checklist.md index d6d67aa..2451235 100644 --- a/hw/ip/uart/doc/checklist.md +++ b/hw/ip/uart/doc/checklist.md
@@ -2,10 +2,10 @@ title: "UART Checklist" --- -This checklist is for [Hardware Stage][] transitions for the [UART peripheral.](../) -All checklist items refer to the content in the [Checklist.]({{<relref "/doc/project/checklist.md">}}) +This checklist is for [Hardware Stage][] transitions for the [UART peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) -[Hardware Stage]: {{<relref "/doc/project/development_stages.md" >}} +[Hardware Stage]: ../../../../doc/project_governance/development_stages.md ## Design Checklist @@ -14,7 +14,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [UART Spec](../) +Documentation | [SPEC_COMPLETE][] | Done | [UART Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -25,15 +25,15 @@ Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D1 Exceptions @@ -62,24 +62,24 @@ Code Quality | [TIMING_CHECK][] | Done | Fmax 50MHz on NexysVideo Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -93,13 +93,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -119,15 +119,15 @@ Review | Reviewer(s) | Done | eunchan@ jeoong@ weicai@ awill@ Review | Signoff date | Done | 2022-06-16 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -135,8 +135,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [UART DV document]({{<relref "dv/index.md" >}}) -Documentation | [TESTPLAN_COMPLETED][] | Done | [UART Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [UART DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | Done | [UART Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -158,28 +158,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power, Debug) Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -206,26 +206,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Not Started | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -237,11 +237,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -263,19 +263,19 @@ Review | Reviewer(s) | Done | @eunchan @sjgitty @sriyerg Review | Signoff date | Done | 2019-11-01 -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending [common_cov_excl.el]:https://github.com/lowRISC/opentitan/blob/master/hw/dv/tools/vcs/common_cov_excl.el [uart_cov_excl.el]: https://github.com/lowRISC/opentitan/blob/04bb36e0ae1430262b048d400102b0fed43377ac/hw/ip/uart/dv/cov/uart_cov_excl.el
diff --git a/hw/ip/uart/dv/README.md b/hw/ip/uart/dv/README.md index f471ee5..ded2d30 100644 --- a/hw/ip/uart/dv/README.md +++ b/hw/ip/uart/dv/README.md
@@ -11,33 +11,33 @@ * Verify TileLink device protocol compliance with an SVA based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages.md" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/uart/dv/latest/report.html) ## Design features -For detailed information on UART design features, please see the [UART design specification]({{< relref ".." >}}). +For detailed information on UART design features, please see the [UART design specification](../README.md). ## Testbench architecture UART testbench has been constructed based on the -[CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +[CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/uart/dv/tb/tb.sv`. It instantiates the UART DUT module `hw/ip/uart/rtl/uart.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * UART IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [common_ifs]({{< relref "hw/dv/sv/common_ifs" >}}) -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [common_ifs](../../../dv/sv/common_ifs/README.md) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -47,19 +47,19 @@ ``` ### TL_agent -UART instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +UART instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into UART device. ### UART agent -[UART agent]({{< relref "hw/dv/sv/usb20_agent/doc" >}}) is used to drive and monitor UART items, which also provides basic coverage on +[UART agent](../../../dv/sv/usb20_agent/README.md) is used to drive and monitor UART items, which also provides basic coverage on data, parity, baud rate etc. These baud rates are supported: 9600, 115200, 230400, 1Mbps(1048576), 2Mbps(2097152) ### UVM RAL Model -The UART RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The UART RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Stimulus strategy #### Test sequences @@ -88,11 +88,11 @@ * uart_tx_fifo, uart_rx_fifo: These 2 fifos provides UART TX and RX item when its transfer completes #### Assertions -* TLUL assertions: The `tb/uart_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/uart_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip/usbdev/README.md b/hw/ip/usbdev/README.md index e84c373..d7e9af6 100644 --- a/hw/ip/usbdev/README.md +++ b/hw/ip/usbdev/README.md
@@ -6,7 +6,7 @@ This document specifies the USB device hardware IP functionality. This IP block implements a Full-Speed device according to the [USB 2.0 specification.](https://www.usb.org/document-library/usb-20-specification) -It is attached to the chip interconnect bus as a peripheral module and conforms to the [Comportable guideline for peripheral functionality.]({{< relref "doc/rm/comportability_specification" >}}) +It is attached to the chip interconnect bus as a peripheral module and conforms to the [Comportable guideline for peripheral functionality.](../../../doc/contributing/hw/comportability/README.md) ## Features @@ -107,7 +107,7 @@ | [Alt TX Data] | d_o | Data output used for encoding K and J, for interfacing with a USB transceiver. | | [TX Mode] | tx_use_d_se0_o | Indicates the selected TX interface: use dp_o and dn_o (0) or use d_o and se0_o (1). | -Note that according to the [Comportable guideline for peripheral functionality]({{< relref "doc/rm/comportability_specification" >}}), every output signal `name_o` has a dedicated output enable `name_en_o`. +Note that according to the [Comportable guideline for peripheral functionality](../../../doc/contributing/hw/comportability/README.md), every output signal `name_o` has a dedicated output enable `name_en_o`. For TX data, these separate signals `dp_en_o` and `dn_en_o` all correspond to the same TX or output enable signal (`OE` in the USB spec). The other signals listed are of the "intersignal" variety, and they do not go directly to pads or have dedicated output enable signals. @@ -381,7 +381,7 @@ The D+ and D- signals have 22R series resistors (in line with the USB spec) and there is a 1.5k pullup on D+ to the pullup enable signal. There is a resistive divider to set the sense pin at half of the VBUS voltage which enables detection on the FPGA without overvoltage on the pin. - + The PMOD PCB is [available from OSH Park](https://oshpark.com/shared_projects/xMKhTIHn).
diff --git a/hw/ip/usbdev/doc/checklist.md b/hw/ip/usbdev/doc/checklist.md index abdbe5e..755ffe0 100644 --- a/hw/ip/usbdev/doc/checklist.md +++ b/hw/ip/usbdev/doc/checklist.md
@@ -2,8 +2,8 @@ title: "USB Device Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [USB Device peripheral.]({{< relref "." >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [USB Device peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [USB Device Design Spec]({{<relref "." >}}) +Documentation | [SPEC_COMPLETE][] | Done | [USB Device Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,8 +125,8 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | In Progress | [USB Device DV document]({{<relref "dv" >}}) -Documentation | [TESTPLAN_COMPLETED][] | In Progress | [USB Device Testplan]({{<relref "dv/index.md#testplan" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | In Progress | [USB Device DV document](../dv/README.md) +Documentation | [TESTPLAN_COMPLETED][] | In Progress | [USB Device Testplan](../dv/README.md#testplan) Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | Testbench | [SIM_TB_ENV_CREATED][] | Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Not Started | Exception (?) Review | [V2_CHECKLIST_SCOPED][] | Not Started | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Not Started | Review | [V3_CHECKLIST_SCOPED][] | Not Started | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip/usbdev/dv/README.md b/hw/ip/usbdev/dv/README.md index 10bacf5..61341ea 100644 --- a/hw/ip/usbdev/dv/README.md +++ b/hw/ip/usbdev/dv/README.md
@@ -12,15 +12,15 @@ * Verify TileLink device protocol compliance with an SVA based testbench. ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/usbdev/dv/latest/report.html) ## Design features -For detailed information on USBDEV design features, please see the [USBDEV HWIP technical specification]({{< relref ".." >}}). +For detailed information on USBDEV design features, please see the [USBDEV HWIP technical specification](../README.md). ## Testbench architecture -USBDEV testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +USBDEV testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram  @@ -29,15 +29,15 @@ Top level testbench is located at `hw/ip/usbdev/dv/tb/tb.sv`. It instantiates the USBDEV DUT module `hw/ip/usbdev/rtl/usbdev.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface for the TL and USB domains]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface for the TL and USB domains](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * USBDEV IOs -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}}) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md) ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Compile-time configurations None for now. @@ -50,16 +50,16 @@ ``` ### TL_agent -USBDEV testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) which provides the ability to drive and independently monitor random traffic via TL host interface into USBDEV device. +USBDEV testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into USBDEV device. ### USB20 Agent -The [usb20_agent]({{< relref "hw/dv/sv/usb20_agent/doc" >}}) is currently a skeleton implementation. +The [usb20_agent](../../../dv/sv/usb20_agent/README.md) is currently a skeleton implementation. It does not offer any functionality yet. ### UVM RAL Model -The USBDEV RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The USBDEV RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}): +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md): ### Reference models There are no reference models in use currently. @@ -85,12 +85,12 @@ * TBD #### Assertions -* TLUL assertions: The `tb/usbdev_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/usbdev_bind.sv` binds the `tlul_assert` [assertions](../../tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. * TBD ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip_templates/alert_handler/README.md b/hw/ip_templates/alert_handler/README.md index 0ec9a3c..e9d9e6a 100644 --- a/hw/ip_templates/alert_handler/README.md +++ b/hw/ip_templates/alert_handler/README.md
@@ -6,7 +6,7 @@ # Overview This document specifies the functionality of the alert handler mechanism. -The alert handler is a module that is a peripheral on the chip interconnect bus, and thus follows the [Comportability Specification]({{< relref "doc/rm/comportability_specification" >}}). +The alert handler is a module that is a peripheral on the chip interconnect bus, and thus follows the [Comportability Specification](../../../doc/contributing/hw/comportability/README.md). It gathers alerts - defined as interrupt-type signals from other peripherals that are designated as potential security threats - throughout the design, and converts them to interrupts that the processor can handle. If the processor does not handle them, the alert handler mechanism provides hardware responses to handle the threat. @@ -78,7 +78,7 @@ In this diagram, there are seven sources of alerts: three sources from external modules (two from `periph0` and one from `periph1`), and four local sources (`alert_ping_fail`, `alert_sig_int`, `esc_ping_fail`, `esc_sig_int`). The local sources represent alerts that are created by this module itself. See the later section on special local alerts. - + Also shown are internal modules for classification, interrupt generation, accumulation, escalation, ping generation and alert-channel low-power control. These are described later in the document. @@ -153,7 +153,7 @@ #### Low-power Indication Signals -The `lpg_cg_en_i` and `lpg_rst_en_i` are two arrays with multibit indication signals from the [clock]({{< relref "hw/ip/clkmgr/doc/" >}}) and [reset managers]({{< relref "hw/ip/rstmgr/doc" >}}). +The `lpg_cg_en_i` and `lpg_rst_en_i` are two arrays with multibit indication signals from the [clock](../../ip/clkmgr/README.md) and [reset managers](../../ip/rstmgr/README.md). These indication signals convey whether a specific group of alert senders are either clock gated or in reset. As explained in [more detail below]({{< relref "#low-power-management-of-alert-channels" >}}), this information is used to temporarily halt the ping timer mechanism on channels that are in a low-power state in order to prevent false positives. @@ -199,7 +199,7 @@ Each alert sender is connected to the corresponding alert receiver via the 3 differential pairs `alert_tx_i/o.alert_p/n`, `alert_rx_i/o.ack_p/n` and `alert_rx_i/o.ping_p/n`, as illustrated below: - + Alerts are encoded differentially and signaled using a full handshake on the `alert_tx_i/o.alert_p/n` and `alert_rx_i/o.ack_p/n` wires. The use of a full handshake protocol allows this mechanism to be used with an asynchronous clocking strategy, where peripherals may reside in a different clock domain than the alert handler. @@ -372,7 +372,7 @@ Further, this ping timer also randomly selects a particular alert line to be pinged (escalation senders are always pinged in-order due to the [ping monitoring mechanism]({{< relref "#monitoring-of-pings-at-the-escalation-receiver-side" >}}) on the escalation side). That should make it more difficult to predict the next ping occurrence based on past observations. -The ping timer is implemented using an [LFSR-based PRNG of Galois type]({{< relref "hw/ip/prim/doc/prim_lfsr.md" >}}). +The ping timer is implemented using an [LFSR-based PRNG of Galois type](../../ip/prim/doc/prim_lfsr.md). This ping timer is reseeded with fresh entropy from EDN roughly every 500k cycles which corresponds to around 16 ping operations on average. The LFSR is 32bits wide, but only 24bits of its state are actually being used to generate the random timer count and select the alert line to be pinged. I.e., the 32bits first go through a fixed permutation function, and then bits `[23:16]` are used to determine which alert line to ping. @@ -583,7 +583,7 @@ As illustrated in the following block diagram, a sender-receiver pair is connected with two differential lines, one going from sender to receiver and the other going from receiver to sender. - + Upon receiving an escalation enable pulse of width N > 0 at the `esc_req_i` input, the escalation sender encodes that signal as a differential pulse of width N+1 on `esc_tx.esc_p/n`. The receiver decodes that message and asserts the `esc_req_o` output after one cycle of delay. @@ -735,7 +735,7 @@ The following diagram shows a typical arrangement of alert sender (TX) and receiver (RX) pairs. - + It is assumed that: @@ -782,7 +782,7 @@ The mechanism is illustrated below for a single LPG (in practice, this logic is replicated for each LPG that is identified in the system): - + The clock gating enable (`lpg_cg_en`) and reset enable (`lpg_rst_en`) indications are routed as multibit signals to the alert handler, where they are synchronized to the alert handler clock and logically combined using an OR function to form a combined low-power indication signal that is multibit encoded. @@ -790,7 +790,7 @@ To that end, two extra *init states* are added to the alert receiver FSMs to perform this in-band reset, as indicated in the state diagram below: - + Whenever the `init_trig` multibit signal of an LPG is asserted, all corresponding sender FSMs are moved into the `InitReq` state. In that state, the alert receivers immediately acknowledge ping requests from the ping mechanism, and ignore alert events from the sender side. @@ -868,7 +868,7 @@ Note however that the LPGs inherit the security properties of the associated clock groups and resets. This means that the low-power state of certain alerts can be controlled by SW by means of clock gating or block reset. For example, certain crypto blocks are located in a transactional clock group which can be clock gated by SW - and this also affects the associated alerts of these crypto blocks. -See [clock]({{< relref "hw/ip/clkmgr/doc/" >}}) and [reset managers]({{< relref "hw/ip/rstmgr/doc" >}}) for more detail. +See [clock](../../ip/clkmgr/README.md) and [reset managers](../../ip/rstmgr/README.md) for more detail. ## Initialization
diff --git a/hw/ip_templates/alert_handler/doc/checklist.md b/hw/ip_templates/alert_handler/doc/checklist.md index 487d8a7..1e94ec1 100644 --- a/hw/ip_templates/alert_handler/doc/checklist.md +++ b/hw/ip_templates/alert_handler/doc/checklist.md
@@ -2,8 +2,8 @@ title: "Alert Handler Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Alert Handler peripheral.]({{< relref "./" >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Alert Handler peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|----------------------- |-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [Alert Handler spec]({{< relref "./" >}}) +Documentation | [SPEC_COMPLETE][] | Done | [Alert Handler spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Done | msf@ vogelpi@ chencindy@ ttrippel@ tjaychen@ Review | Signoff date | Done | 2022-07-11 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip_templates/alert_handler/dv/README.md b/hw/ip_templates/alert_handler/dv/README.md index 1a20a82..030e367 100644 --- a/hw/ip_templates/alert_handler/dv/README.md +++ b/hw/ip_templates/alert_handler/dv/README.md
@@ -13,35 +13,35 @@ * Verify alert_handler_esc_timer and alert_handler_ping_timer ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../README.md) + * [HW development stages](../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/alert_handler/dv/latest/results.html) ## Design features -For detailed information on ALERT_HANDLER design features, please see the [ALERT_HANDLER HWIP technical specification]({{< relref ".." >}}). +For detailed information on ALERT_HANDLER design features, please see the [ALERT_HANDLER HWIP technical specification](../README.md). ## Testbench architecture -ALERT_HANDLER testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +ALERT_HANDLER testbench has been constructed based on the [CIP testbench architecture](../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/alert_handler/dv/tb/tb.sv`. It instantiates the ALERT_HANDLER DUT module `hw/ip/alert_handler/rtl/alert_handler.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../dv/sv/tl_agent/README.md) * ALERT_HANDLER IOs -* Alerts and escalations([`alert_esc_if`]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}})) -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Alerts and escalations([`alert_esc_if`](../../../dv/sv/alert_esc_agent/README.md)) +* Interrupts ([`pins_if`](../../../dv/sv/common_ifs/README.md)) +* Devmode ([`pins_if`](../../../dv/sv/common_ifs/README.md)) The alert_handler testbench environment can be reused in chip level testing. ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -51,18 +51,18 @@ ``` ### TL_agent -ALERT_HANDLER testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +ALERT_HANDLER testbench instantiates (already handled in CIP base env) [tl_agent](../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into ALERT_HANDLER device. ### ALERT_ESC Agent -[ALERT_ESC agent]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}}) is used to drive and monitor transmitter and receiver pairs for the alerts and escalators. +[ALERT_ESC agent](../../../dv/sv/alert_esc_agent/README.md) is used to drive and monitor transmitter and receiver pairs for the alerts and escalators. Alert_handler DUT includes alert_receivers and esc_senders, so the alert_esc agent will drive output signals of the alert_senders and esc_receivers. ### UVM RAL Model -The ALERT_HANDLER RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The ALERT_HANDLER RAL model is created with the [`ralgen`](../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}). +It can be created manually by invoking [`regtool`](../../../../util/reggen/doc/setup_and_use.md). ### Stimulus strategy #### Test sequences @@ -106,11 +106,11 @@ The alert_handler scoreboard is parameterized to support different number of classes, alert pairs, and escalation pairs. #### Assertions -* TLUL assertions: The `tb/alert_handler_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/alert_handler_bind.sv` binds the `tlul_assert` [assertions](../../../ip/tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/ip_templates/rv_plic/README.md b/hw/ip_templates/rv_plic/README.md index 9e72df9..b6939c4 100644 --- a/hw/ip_templates/rv_plic/README.md +++ b/hw/ip_templates/rv_plic/README.md
@@ -6,7 +6,7 @@ This document specifies the Interrupt Controller (RV_PLIC) functionality. This module conforms to the -[Comportable guideline for peripheral functionality]({{< relref "doc/rm/comportability_specification" >}}). +[Comportable guideline for peripheral functionality](../../../doc/contributing/hw/comportability/README.md). See that document for integration overview within the broader top level system. @@ -31,7 +31,7 @@ ## Block Diagram - + ## Hardware Interfaces
diff --git a/hw/ip_templates/rv_plic/doc/checklist.md b/hw/ip_templates/rv_plic/doc/checklist.md index 0783d1b..cf796d1 100644 --- a/hw/ip_templates/rv_plic/doc/checklist.md +++ b/hw/ip_templates/rv_plic/doc/checklist.md
@@ -2,8 +2,8 @@ title: "RV_PLIC Checklist" --- -This checklist is for [Hardware Stage]({{<relref "/doc/project/development_stages.md" >}}) transitions for the [RV_PLIC peripheral](..). -All checklist items refer to the content in the [Checklist.]({{<relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../doc/project_governance/development_stages.md) transitions for the [RV_PLIC peripheral](../README.md). +All checklist items refer to the content in the [Checklist.](../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -21,17 +21,17 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[RV_PLIC Spec]: {{<relref ".">}} +[RV_PLIC Spec]: ../README.md -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -55,23 +55,23 @@ Security | [SEC_CM_DOCUMENTED][] | N/A | Security | [SEC_RND_CNST][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[FPGA_TIMING]: {{<relref "/doc/project/checklist.md#fpga_timing" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} -[SEC_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_rnd_cnst" >}} +[NEW_FEATURES]: ../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../doc/project_governance/checklist/README.md#doc_interface +[MISSING_FUNC]: ../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#feature_complete +[AREA_CHECK]: ../../../../doc/project_governance/checklist/README.md#area_check +[PORT_FROZEN]: ../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../doc/project_governance/checklist/README.md#style_x +[LINT_PASS]: ../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../doc/project_governance/checklist/README.md#cdc_setup +[FPGA_TIMING]: ../../../../doc/project_governance/checklist/README.md#fpga_timing +[CDC_SYNCMACRO]: ../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[SEC_CM_DOCUMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_documented +[SEC_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_rnd_cnst ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Done | eunchan@ gac@ chencindy@ ttrippel@ Review | Signoff date | Done | 2022-07-25 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,7 +125,7 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [rv_plic_fpv_plan]({{<relref "dv/index.md" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [rv_plic_fpv_plan](./dv/README.md) Documentation | [TESTPLAN_COMPLETED][] | Done | Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | N/A | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Not Started | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/ip_templates/rv_plic/doc/dv/README.md b/hw/ip_templates/rv_plic/doc/dv/README.md index 99d51d7..b7cfb53 100644 --- a/hw/ip_templates/rv_plic/doc/dv/README.md +++ b/hw/ip_templates/rv_plic/doc/dv/README.md
@@ -12,23 +12,23 @@ * Verify TileLink device protocol compliance with a FPV based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "/doc/project/development_stages" >}}) +* [Design & verification stage](../../../../README.md) + * [HW development stages](../../../../../doc/project_governance/development_stages.md) * FPV dashboard (link TBD) ## Design features For detailed information on RV_PLIC design features, please see the -[RV_PLIC design specification]({{< relref ".." >}}). +[RV_PLIC design specification](../../README.md). ## Testbench architecture RV_PLIC FPV testbench has been constructed based on the [formal -architecture]({{< relref "/hw/formal/doc" >}}). +architecture](../../../../formal/README.md). ### Block diagram  #### TLUL assertions -* The file `rv_plic_bind.sv` binds the `tlul_assert` [assertions]({{< relref "/hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) +* The file `rv_plic_bind.sv` binds the `tlul_assert` [assertions](../../../../ip/tlul/doc/TlulProtocolChecker.md) to rv_plic to ensure TileLink interface protocol compliance. * The `hw/rv_plic/fpv/tb/rv_plic_bind.sv` also binds the `rv_plic_csr_assert_fpv` under `fpv/vip/` to check if TileLink writes and reads correct @@ -44,7 +44,7 @@ declared two symbolic variables `src_sel` and `tgt_sel` to represent the index for interrupt source and interrupt target. Detailed explanation is listed in the -[Symbolic Variables]({{< relref "/hw/formal/doc#symbolic-variables" >}}) section. +[Symbolic Variables](../../../../formal/README.md#symbolic-variables) section. ## Testplan {{< incGenFromIpDesc "../../data/rv_plic_fpv_testplan.hjson" "testplan" >}}
diff --git a/hw/top_earlgrey/README.md b/hw/top_earlgrey/README.md index 446e941..eb20a54 100644 --- a/hw/top_earlgrey/README.md +++ b/hw/top_earlgrey/README.md
@@ -4,7 +4,7 @@ ## Specification -The specification of Earlgrey is located [here]({{< relref "doc" >}}). +The specification of Earlgrey is located [here](./doc/specification.md). ## Tool: TopGen
diff --git a/hw/top_earlgrey/doc/design/README.md b/hw/top_earlgrey/doc/design/README.md index 409f5f0..3a8bf5b 100644 --- a/hw/top_earlgrey/doc/design/README.md +++ b/hw/top_earlgrey/doc/design/README.md
@@ -3,15 +3,15 @@ --- This document describes the OpenTitan Earl Grey chip functionality in detail. -For an overview, refer to the [OpenTitan Earl Grey Chip Datasheet]({{< relref "../" >}}). +For an overview, refer to the [OpenTitan Earl Grey Chip Datasheet](../specification.md). # Theory of Operations The netlist `chip_earlgrey_asic` contains the features listed above and is intended for ASIC synthesis, whereas the netlist `chip_earlgrey_cw310` provides an emulation environment for the `cw310` FPGA board. -The code for Ibex is developed in its own [lowRISC repo](http://github.com/lowrisc/ibex), and is [*vendored in*]({{< relref "doc/ug/vendor_hw.md" >}}) to this repository. -Surrounding Ibex is a suite of *Comportable* peripherals that follow the [Comportability Guidelines]({{< relref "doc/rm/comportability_specification" >}}) for lowRISC peripheral IP. +The code for Ibex is developed in its own [lowRISC repo](http://github.com/lowrisc/ibex), and is [*vendored in*](../../../../doc/contributing/hw/vendor.md) to this repository. +Surrounding Ibex is a suite of *Comportable* peripherals that follow the [Comportability Guidelines](../../../../doc/contributing/hw/comportability/README.md) for lowRISC peripheral IP. Each of these IP has its own specification. -See the table produced in the [hardware documentation page]({{< relref "hw" >}}) for links to those specifications. +See the table produced in the [hardware documentation page](../../../README.md) for links to those specifications. ## Design Details @@ -21,7 +21,7 @@ ### Clocking and Reset -Clocks and resets are supplied from the Analog Sensor Top, referred to as [ast]({{< relref "hw/top_earlgrey/ip/ast/doc" >}})) from this point onwards in the document. +Clocks and resets are supplied from the Analog Sensor Top, referred to as [ast](../../ip/ast/README.md)) from this point onwards in the document. `ast` supplies a number of clocks into `top_earlgrey`. - sys: main jittery system clock used for higher performance blocks and security (processory, memory and crypto blocks). @@ -30,14 +30,14 @@ - aon: an always on, low frequency clock used for power management and low speed timers. These clocks are then divided down and distributed to the rest of the system. -See [clock manager]({{< relref "hw/ip/clkmgr/doc/" >}})) for more details. +See [clock manager](../../../ip/clkmgr/README.md)) for more details. `ast` also supplies a number of power-okay signals to `top_earlgrey`, and these are used as asynchronous root resets. - vcaon_pok: The always on domain of the system is ready. - vcmain_pok: The main operating domain of the system is ready. When one of these power-okay signals drop, the corresponding domain in `top_earlgrey` is reset. -Please refer to [reset manager]({{< relref "hw/ip/rstmgr/doc/" >}})) for more details. +Please refer to [reset manager](../../../ip/rstmgr/README.md)) for more details. Resets throughout the design are asynchronous active low as per the Comportability specification. Once reset, the reset vector begins in ROM, whose job is to validate code in the embedded flash before jumping to it. @@ -91,16 +91,16 @@ Device resets due to supply dropping below a specific threshold are commonly known as "brown-out". When this occurs, the flash memory must go through specialized sequencing to ensure the cells are not damaged. This process is handled exclusively between ast and the flash. -Please see the [relevant section]({{< relref "hw/top_earlgrey/ip/ast/doc/#main-vcc-power-detection-and-flash-protection" >}}) for more details. +Please see the [relevant section](../../ip/ast/README.md#main-vcc-power-detection-and-flash-protection) for more details. #### Reset due to Internal Request -When the device receives an internal request to reset (for example [aon_timer]({{< relref "hw/ip/aon_timer/doc/#aon-watchdog-timer" >}})), device power is kept on and the flash is directly reset. +When the device receives an internal request to reset (for example [aon_timer](../../../ip/aon_timer/README.md#aon-watchdog-timer)), device power is kept on and the flash is directly reset. It is assumed that the flash device, when powered, will be able to correctly handle such a sequence and properly protect itself. #### Reset due to Low Power Entry -When the device receives a low power entry request while flash activity is ongoing, the [pwrmgr]({{< relref "hw/ip/pwrmgr/doc/#abort-handling" >}})) is responsible for ensuring the entry request is aborted. +When the device receives a low power entry request while flash activity is ongoing, the [pwrmgr](../../../ip/pwrmgr/README.md#abort-handling)) is responsible for ensuring the entry request is aborted. ### Main processor (`core_ibex`) @@ -115,13 +115,13 @@ One feature available for Earl Grey processor core is debug access. By interfacing with JTAG pins, logic in the debug module allows the core to enter debug mode (per RISC-V 0.13 debug spec), and gives the design the ability to inject code either into the device - by emulating an instruction - or into memory. -Full details can be found in the [rv_dm specification]({{< relref "hw/ip/rv_dm/doc" >}}). +Full details can be found in the [rv_dm specification](../../../ip/rv_dm/README.md). #### Interrupt Controller Adjacent to the Ibex core is an interrupt controller that implements the RISC-V PLIC standard. This accepts a vector of interrupt sources within the device, and assigns leveling and priority to them before sending to the core for handling. -See the details in the [rv_plic specification]({{< relref "../../ip_autogen/rv_plic/doc" >}}). +See the details in the [rv_plic specification](../../ip_autogen/rv_plic/README.md). #### Performance @@ -181,7 +181,7 @@ ### Peripherals Earl Grey contains a suite of "peripherals", or subservient execution units connected to the Ibex processor by means of a bus interconnect. -Each of these peripherals follows an interface scheme dictated in the [Comportability Specification.]({{< relref "doc/rm/comportability_specification" >}}). +Each of these peripherals follows an interface scheme dictated in the [Comportability Specification.](../../../../doc/contributing/hw/comportability/README.md). That specification details how the processor communicates with the peripheral (via TLUL interconnect); how the peripheral communicates with the chip IO (via fixed or multiplexable IO); how the peripheral communicates with the processor (interrupts); and how the peripheral communicates security events (via alerts). See that specification for generic details on this scheme. @@ -196,21 +196,21 @@ Some pad attributes with analog characteristics like drive strength, slew rate and Open Drain technology are not supported on all platforms. The pin multiplexor is a peripheral on the TLUL bus, with collections of registers that provide software configurability. -See the [pinmux specification]({{< relref "hw/ip/pinmux/doc" >}}) for how to connect peripheral IO to chip IO and for information on pad control features. +See the [pinmux specification](../../../ip/pinmux/README.md) for how to connect peripheral IO to chip IO and for information on pad control features. ##### UART The chip contains one UART peripheral that implement single-lane duplex UART functionality. -The outputs and inputs can be configured to any chip IO via the [pinmux]({{< relref "hw/ip/pinmux/doc" >}}). +The outputs and inputs can be configured to any chip IO via the [pinmux](../../../ip/pinmux/README.md). -See the [UART specification]({{< relref "hw/ip/uart/doc" >}}) for more details on this peripheral. +See the [UART specification](../../../ip/uart/README.md) for more details on this peripheral. ##### GPIO The chip contains one GPIO peripheral that creates 32 bits of bidirectional communication with the outside world via the pinmux. Via pinmux any of the 32 pins of GPIO can be connected to any of the 32 MIO chip pins, in any direction. -See the [GPIO specification]({{< relref "hw/ip/gpio/doc" >}}) for more details on this peripheral. -See the [pinmux specification]({{< relref "hw/ip/pinmux/doc" >}}) for how to connect peripheral IO to chip IO. +See the [GPIO specification](../../../ip/gpio/README.md) for more details on this peripheral. +See the [pinmux specification](../../../ip/pinmux/README.md) for how to connect peripheral IO to chip IO. ##### SPI device @@ -232,14 +232,14 @@ Passthrough mode supports serial flash passthrough from an upstream SPI host to a downstream serial flash device. -See the [SPI device specification]({{< relref "hw/ip/spi_device/doc" >}}) for more details. +See the [SPI device specification](../../../ip/spi_device/README.md) for more details. ##### USB device The chip contains a single module that supports USB device mode at full speed. In addition to normal functionality, USB suspend / resume is supported alongside the chip's low power modes. -See the [USB device specification]({{< relref "hw/ip/usbdev/doc" >}}) for more details. +See the [USB device specification](../../../ip/usbdev/README.md) for more details. ##### I2C host @@ -261,7 +261,7 @@ The [GCM mode](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#GCM) is not implemented in hardware, but can be constructed using AES in counter mode. The integrity tag calculation can be implemented in Ibex and accelerated via bitmanip instructions. -Details on how to write key and data material into the peripheral, how to initiate encryption and decryption, and how to read out results, are available in the [AES specification]({{< relref "hw/ip/aes/doc" >}}). +Details on how to write key and data material into the peripheral, how to initiate encryption and decryption, and how to read out results, are available in the [AES specification](../../../ip/aes/README.md). ##### SHA-256/HMAC @@ -276,11 +276,11 @@ [HMAC](https://en.wikipedia.org/wiki/HMAC) is a message authentication protocol layered on top of a hashing function (in this case SHA-256), mixing in a secret key for cryptographic purposes. HMAC is a particular application of appending the secret key in a prescribed manner, twice, around the hashing (via SHA-256) of the message. -Details on how to write key and data material into the peripheral, how to initiate hashing / authentication, and how to read out results, are available in the [SHA/HMAC specification]({{< relref "hw/ip/hmac/doc" >}}). +Details on how to write key and data material into the peripheral, how to initiate hashing / authentication, and how to read out results, are available in the [SHA/HMAC specification](../../../ip/hmac/README.md). ##### Alert Handler -Alerts, as defined in the [Comportability Specification]({{< relref "doc/rm/comportability_specification" >}}), are defined as security-sensitive interrupts that need to be handled in a timely manner to respond to a security threat. +Alerts, as defined in the [Comportability Specification](../../../../doc/contributing/hw/comportability/README.md), are defined as security-sensitive interrupts that need to be handled in a timely manner to respond to a security threat. Unlike standard interrupts, they are not solely handled by software. Alerts trigger a first-stage request to be handled by software in the standard mode as interrupts, but trigger a second-stage response by the alert handler if software is not able to respond. This ensures that the underlying concern is guaranteed to be addressed if the processor is busy, wedged, or itself under attack. @@ -320,7 +320,7 @@ A second one acting as a watchdog timer that can be used to backstop the processor in the case of it being unresponsive (usually due to development code that is wedged, rather than for instance due to security attack) will be provided in the future. The goal is for both of these to be satisfied with the same timer module. -The specification for the timer can be found [here]({{< relref "hw/ip/rv_timer/doc" >}}). +The specification for the timer can be found [here](../../../ip/rv_timer/README.md). ##### Flash Controller @@ -348,12 +348,12 @@ Security is also a concern, since secret data can be stored in the flash. Some memory protection is provided by the flash controller. -For more details see the [flash controller module specification]({{< relref "hw/ip/flash_ctrl/doc" >}}). +For more details see the [flash controller module specification](../../../ip/flash_ctrl/README.md). ### Interconnection Interconnecting the processor and peripheral and memory units is a bus network built upon the TileLink-Uncached-Light protocol. -See the [OpenTitan bus specification]({{< relref "hw/ip/tlul/doc" >}}) for more details. +See the [OpenTitan bus specification](../../../ip/tlul/README.md) for more details. #### Topology `top_earlgrey` has a two-level hierarchy for its bus network.
diff --git a/hw/top_earlgrey/doc/specification.md b/hw/top_earlgrey/doc/specification.md index 734c774..87ab36c 100644 --- a/hw/top_earlgrey/doc/specification.md +++ b/hw/top_earlgrey/doc/specification.md
@@ -113,5 +113,5 @@ # Detailed Specification -For more detailed documentation including the pinout and system address map, see [OpenTitan Earl Grey Chip Specification]({{< relref "design" >}}). -The [OpenTitan Earl Grey Chip DV Document]({{< relref "dv" >}}) describes the chip-level DV environment and contains the chip-level test plan. +For more detailed documentation including the pinout and system address map, see [OpenTitan Earl Grey Chip Specification](./design/README.md). +The [OpenTitan Earl Grey Chip DV Document](../dv/README.md) describes the chip-level DV environment and contains the chip-level test plan.
diff --git a/hw/top_earlgrey/dv/README.md b/hw/top_earlgrey/dv/README.md index 891eb31..1f3a329 100644 --- a/hw/top_earlgrey/dv/README.md +++ b/hw/top_earlgrey/dv/README.md
@@ -16,15 +16,15 @@ * Check for leakage of secure data into unsecure locations / paths and vice-versa using the Cadence SPV tool. ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages.md" >}}) +* [Design & verification stage](../../README.md) + * [HW development stages](../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/top_earlgrey/dv/latest/results.html) ## Design features -For detailed information on `top_earlgrey` design features, please see the [Earl Grey Top Level Specification]({{< relref "hw/top_earlgrey/doc" >}}). +For detailed information on `top_earlgrey` design features, please see the [Earl Grey Top Level Specification](../doc/specification.md). ## Testbench architecture -The `top_earlgrey` chip level testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +The `top_earlgrey` chip level testbench has been constructed based on the [CIP testbench architecture](../../dv/sv/cip_lib/README.md). ### Block diagram TBD @@ -33,9 +33,9 @@ Top level testbench is located at `hw/ip/top_earlgrey/dv/tb/tb.sv`. It instantiates the `top_earlgrey` DUT module `hw/top_earlgrey/rtl/autogen/chip_earlgrey_asic.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) +* [Clock and reset interface](../../dv/sv/common_ifs/README.md) * Main clock as well as USB clock -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [TileLink host interface](../../dv/sv/tl_agent/README.md) * This is connected to the CPU's data port. * [JTAG interface]() * SPI interface @@ -50,8 +50,8 @@ ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in the `chip_env_pkg`. @@ -61,7 +61,7 @@ ``` ### TL_agent -The full chip testbench instantiates (already handled in CIP base env) the [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) which provides the ability to drive and independently monitor random traffic via TL host interface into CHIP device. +The full chip testbench instantiates (already handled in CIP base env) the [tl_agent](../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into CHIP device. ### UART Agent [Describe here or add link to its README] @@ -79,7 +79,7 @@ [Describe here or add link to its README] ### UVM RAL Model -The CHIP RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The CHIP RAL model is created with the [`ralgen`](../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. It can be created manually (separately) by running `make` in the the `hw/` area. @@ -118,7 +118,7 @@ <!-- explain inputs monitored, flow of data and outputs checked --> #### Assertions -* TLUL assertions: The `tb/chip_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/chip_bind.sv` binds the `tlul_assert` [assertions](../../ip/tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. * assert prop 1: * assert prop 2:
diff --git a/hw/top_earlgrey/ip/sensor_ctrl/README.md b/hw/top_earlgrey/ip/sensor_ctrl/README.md index 9daebb3..ee28c19 100644 --- a/hw/top_earlgrey/ip/sensor_ctrl/README.md +++ b/hw/top_earlgrey/ip/sensor_ctrl/README.md
@@ -5,7 +5,7 @@ # Overview This document specifies the functionality of the `sensor control` module. -The `sensor control` module is a comportable front-end to the [analog sensor top]({{< relref "hw/top_earlgrey/ip/ast/doc" >}}). +The `sensor control` module is a comportable front-end to the [analog sensor top](../ast/README.md). It provides basic alert functionality, pad debug hook ups, and a small amount of open source visible status readback. Long term, this is a module that can be absorbed directly into the `analog sensor top`.
diff --git a/hw/top_earlgrey/ip/sensor_ctrl/doc/checklist.md b/hw/top_earlgrey/ip/sensor_ctrl/doc/checklist.md index eead271..88c829a 100644 --- a/hw/top_earlgrey/ip/sensor_ctrl/doc/checklist.md +++ b/hw/top_earlgrey/ip/sensor_ctrl/doc/checklist.md
@@ -2,8 +2,8 @@ title: "SENSOR_CTRL Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [SENSOR_CTRL peripheral.](../) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../../doc/project_governance/development_stages.md) transitions for the [SENSOR_CTRL peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|--------------------------------|-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [SENSOR_CTRL Design Spec](../) +Documentation | [SPEC_COMPLETE][] | Done | [SENSOR_CTRL Design Spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Done | msf@ sriyer@ tjaychen@ a-will@ Review | Signoff date | Done | 2022-08-18 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist
diff --git a/hw/top_earlgrey/ip/xbar/doc/checklist.md b/hw/top_earlgrey/ip/xbar/doc/checklist.md index a02ddc7..b14bc7a 100644 --- a/hw/top_earlgrey/ip/xbar/doc/checklist.md +++ b/hw/top_earlgrey/ip/xbar/doc/checklist.md
@@ -2,8 +2,8 @@ title: "TL-UL Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [TL-UL component.]({{<relref "/hw/ip/tlul/doc">}}) -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Hardware Stage](../../../../../doc/project_governance/development_stages.md) transitions for the [TL-UL component.](../../../../ip/tlul/README.md) +All checklist items refer to the content in the [Checklist](../../../../../doc/project_governance/checklist/README.md). ## Design Checklist @@ -21,18 +21,18 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[TL-UL Spec]: {{<relref "/hw/ip/tlul/doc">}} -[crossbar_tool]: {{<relref "/doc/rm/crossbar_tool">}} +[TL-UL Spec]: ../../../../ip/tlul/README.md +[crossbar_tool]: ../../../../../util/tlgen/README.md -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -59,24 +59,24 @@ [#837]: https://github.com/lowRISC/opentitan/pull/837 -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -90,13 +90,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Not Started | Security | [SEC_CM_COUNCIL_REVIEWED][] | Not Started | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -114,15 +114,15 @@ Review | Reviewer(s) | Done | @weicaiyang @tjaychen Review | Signoff date | Done | 2019-11-07 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -150,28 +150,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Exception (Security, Power, Debug, Performance) Review | [V2_CHECKLIST_SCOPED][] | Done | -[XBAR DV document]: {{<relref "/hw/ip/tlul/doc/dv">}} -[XBAR Testplan]: {{<relref "/hw/ip/tlul/doc/dv/index.md#testplan">}} +[XBAR DV document]: ../../../../ip/tlul/doc/dv/README.md +[XBAR Testplan]: ../../../../ip/tlul/doc/dv/README.md#testplan -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv-doc-draft-completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan-completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb-top-created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary-assertion-checks-added" >}} -[TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#tb-env-created" >}} -[RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#ral-model-gen-automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb-gen-automated" >}} -[SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#smoke-test-passing" >}} -[CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#csr-mem-test-suite-passing" >}} -[ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#alt-tool-setup" >}} -[SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#smoke-regression-setup" >}} -[NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#nightly-regression-setup" >}} -[COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#coverage-model-added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre-verified-sub-modules-v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design-spec-reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan-reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std-test-categories-planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2-checklist-scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#dv-doc-draft-completed +[TESTPLAN_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#testplan-completed +[TB_TOP_CREATED]: ../../../../../doc/project_governance/checklist/README.md#tb-top-created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../../doc/project_governance/checklist/README.md#preliminary-assertion-checks-added +[TB_ENV_CREATED]: ../../../../../doc/project_governance/checklist/README.md#tb-env-created +[RAL_MODEL_GEN_AUTOMATED]: ../../../../../doc/project_governance/checklist/README.md#ral-model-gen-automated +[TB_GEN_AUTOMATED]: ../../../../../doc/project_governance/checklist/README.md#tb-gen-automated +[SMOKE_TEST_PASSING]: ../../../../../doc/project_governance/checklist/README.md#smoke-test-passing +[CSR_MEM_TEST_SUITE_PASSING]: ../../../../../doc/project_governance/checklist/README.md#csr-mem-test-suite-passing +[ALT_TOOL_SETUP]: ../../../../../doc/project_governance/checklist/README.md#alt-tool-setup +[SMOKE_REGRESSION_SETUP]: ../../../../../doc/project_governance/checklist/README.md#smoke-regression-setup +[NIGHTLY_REGRESSION_SETUP]: ../../../../../doc/project_governance/checklist/README.md#nightly-regression-setup +[COVERAGE_MODEL_ADDED]: ../../../../../doc/project_governance/checklist/README.md#coverage-model-added +[TB_LINT_SETUP]: ../../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../../doc/project_governance/checklist/README.md#pre-verified-sub-modules-v1 +[DESIGN_SPEC_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#design-spec-reviewed +[TESTPLAN_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#testplan-reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../../doc/project_governance/checklist/README.md#std-test-categories-planned +[V2_CHECKLIST_SCOPED]: ../../../../../doc/project_governance/checklist/README.md#v2-checklist-scoped ### V2 @@ -198,26 +198,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Not Started | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -229,11 +229,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -255,18 +255,18 @@ Review | Reviewer(s) | Done | @eunchan @sriyerg Review | Signoff date | Done | 2019-11-07 -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../../doc/project_governance/checklist/README.md#no_issues_pending [xbar_cov_excl.el]: https://github.com/weicaiyang/opentitan/blob/6cd55ad23aac96374bfa0bec315b904c6ffbdb8f/hw/ip/tlul/dv/cov/xbar_cov_excl.el
diff --git a/hw/top_earlgrey/ip_autogen/alert_handler/README.md b/hw/top_earlgrey/ip_autogen/alert_handler/README.md index 0ec9a3c..33bc75b 100644 --- a/hw/top_earlgrey/ip_autogen/alert_handler/README.md +++ b/hw/top_earlgrey/ip_autogen/alert_handler/README.md
@@ -6,7 +6,7 @@ # Overview This document specifies the functionality of the alert handler mechanism. -The alert handler is a module that is a peripheral on the chip interconnect bus, and thus follows the [Comportability Specification]({{< relref "doc/rm/comportability_specification" >}}). +The alert handler is a module that is a peripheral on the chip interconnect bus, and thus follows the [Comportability Specification](../../../../doc/contributing/hw/comportability/README.md). It gathers alerts - defined as interrupt-type signals from other peripherals that are designated as potential security threats - throughout the design, and converts them to interrupts that the processor can handle. If the processor does not handle them, the alert handler mechanism provides hardware responses to handle the threat. @@ -78,7 +78,7 @@ In this diagram, there are seven sources of alerts: three sources from external modules (two from `periph0` and one from `periph1`), and four local sources (`alert_ping_fail`, `alert_sig_int`, `esc_ping_fail`, `esc_sig_int`). The local sources represent alerts that are created by this module itself. See the later section on special local alerts. - + Also shown are internal modules for classification, interrupt generation, accumulation, escalation, ping generation and alert-channel low-power control. These are described later in the document. @@ -153,7 +153,7 @@ #### Low-power Indication Signals -The `lpg_cg_en_i` and `lpg_rst_en_i` are two arrays with multibit indication signals from the [clock]({{< relref "hw/ip/clkmgr/doc/" >}}) and [reset managers]({{< relref "hw/ip/rstmgr/doc" >}}). +The `lpg_cg_en_i` and `lpg_rst_en_i` are two arrays with multibit indication signals from the [clock](../../../ip/clkmgr/README.md) and [reset managers](../../../ip/rstmgr/README.md). These indication signals convey whether a specific group of alert senders are either clock gated or in reset. As explained in [more detail below]({{< relref "#low-power-management-of-alert-channels" >}}), this information is used to temporarily halt the ping timer mechanism on channels that are in a low-power state in order to prevent false positives. @@ -199,7 +199,7 @@ Each alert sender is connected to the corresponding alert receiver via the 3 differential pairs `alert_tx_i/o.alert_p/n`, `alert_rx_i/o.ack_p/n` and `alert_rx_i/o.ping_p/n`, as illustrated below: - + Alerts are encoded differentially and signaled using a full handshake on the `alert_tx_i/o.alert_p/n` and `alert_rx_i/o.ack_p/n` wires. The use of a full handshake protocol allows this mechanism to be used with an asynchronous clocking strategy, where peripherals may reside in a different clock domain than the alert handler. @@ -372,7 +372,7 @@ Further, this ping timer also randomly selects a particular alert line to be pinged (escalation senders are always pinged in-order due to the [ping monitoring mechanism]({{< relref "#monitoring-of-pings-at-the-escalation-receiver-side" >}}) on the escalation side). That should make it more difficult to predict the next ping occurrence based on past observations. -The ping timer is implemented using an [LFSR-based PRNG of Galois type]({{< relref "hw/ip/prim/doc/prim_lfsr.md" >}}). +The ping timer is implemented using an [LFSR-based PRNG of Galois type](../../../ip/prim/doc/prim_lfsr.md). This ping timer is reseeded with fresh entropy from EDN roughly every 500k cycles which corresponds to around 16 ping operations on average. The LFSR is 32bits wide, but only 24bits of its state are actually being used to generate the random timer count and select the alert line to be pinged. I.e., the 32bits first go through a fixed permutation function, and then bits `[23:16]` are used to determine which alert line to ping. @@ -583,7 +583,7 @@ As illustrated in the following block diagram, a sender-receiver pair is connected with two differential lines, one going from sender to receiver and the other going from receiver to sender. - + Upon receiving an escalation enable pulse of width N > 0 at the `esc_req_i` input, the escalation sender encodes that signal as a differential pulse of width N+1 on `esc_tx.esc_p/n`. The receiver decodes that message and asserts the `esc_req_o` output after one cycle of delay. @@ -735,7 +735,7 @@ The following diagram shows a typical arrangement of alert sender (TX) and receiver (RX) pairs. - + It is assumed that: @@ -782,7 +782,7 @@ The mechanism is illustrated below for a single LPG (in practice, this logic is replicated for each LPG that is identified in the system): - + The clock gating enable (`lpg_cg_en`) and reset enable (`lpg_rst_en`) indications are routed as multibit signals to the alert handler, where they are synchronized to the alert handler clock and logically combined using an OR function to form a combined low-power indication signal that is multibit encoded. @@ -790,7 +790,7 @@ To that end, two extra *init states* are added to the alert receiver FSMs to perform this in-band reset, as indicated in the state diagram below: - + Whenever the `init_trig` multibit signal of an LPG is asserted, all corresponding sender FSMs are moved into the `InitReq` state. In that state, the alert receivers immediately acknowledge ping requests from the ping mechanism, and ignore alert events from the sender side. @@ -868,7 +868,7 @@ Note however that the LPGs inherit the security properties of the associated clock groups and resets. This means that the low-power state of certain alerts can be controlled by SW by means of clock gating or block reset. For example, certain crypto blocks are located in a transactional clock group which can be clock gated by SW - and this also affects the associated alerts of these crypto blocks. -See [clock]({{< relref "hw/ip/clkmgr/doc/" >}}) and [reset managers]({{< relref "hw/ip/rstmgr/doc" >}}) for more detail. +See [clock](../../../ip/clkmgr/README.md) and [reset managers](../../../ip/rstmgr/README.md) for more detail. ## Initialization
diff --git a/hw/top_earlgrey/ip_autogen/alert_handler/doc/checklist.md b/hw/top_earlgrey/ip_autogen/alert_handler/doc/checklist.md index 487d8a7..cede5ba 100644 --- a/hw/top_earlgrey/ip_autogen/alert_handler/doc/checklist.md +++ b/hw/top_earlgrey/ip_autogen/alert_handler/doc/checklist.md
@@ -2,8 +2,8 @@ title: "Alert Handler Checklist" --- -This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Alert Handler peripheral.]({{< relref "./" >}}) -All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../../doc/project_governance/development_stages.md) transitions for the [Alert Handler peripheral.](../README.md) +All checklist items refer to the content in the [Checklist.](../../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -11,7 +11,7 @@ Type | Item | Resolution | Note/Collaterals --------------|----------------------- |-------------|------------------ -Documentation | [SPEC_COMPLETE][] | Done | [Alert Handler spec]({{< relref "./" >}}) +Documentation | [SPEC_COMPLETE][] | Done | [Alert Handler spec](../README.md) Documentation | [CSR_DEFINED][] | Done | RTL | [CLKRST_CONNECTED][] | Done | RTL | [IP_TOP][] | Done | @@ -21,15 +21,15 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -54,24 +54,24 @@ Code Quality | [TIMING_CHECK][] | Done | Security | [SEC_CM_DOCUMENTED][] | Done | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[DOC_INTEGRATION_GUIDE]: {{<relref "/doc/project/checklist.md#doc_integration_guide" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[RDC_SETUP]: {{<relref "/doc/project/checklist.md#rdc_setup" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[TIMING_CHECK]: {{<relref "/doc/project/checklist.md#timing_check" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} +[NEW_FEATURES]: ../../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../../doc/project_governance/checklist/README.md#doc_interface +[DOC_INTEGRATION_GUIDE]: ../../../../../doc/project_governance/checklist/README.md#doc_integration_guide +[MISSING_FUNC]: ../../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#feature_complete +[PORT_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../../doc/project_governance/checklist/README.md#style_x +[CDC_SYNCMACRO]: ../../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[LINT_PASS]: ../../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../../doc/project_governance/checklist/README.md#cdc_setup +[RDC_SETUP]: ../../../../../doc/project_governance/checklist/README.md#rdc_setup +[AREA_CHECK]: ../../../../../doc/project_governance/checklist/README.md#area_check +[TIMING_CHECK]: ../../../../../doc/project_governance/checklist/README.md#timing_check +[SEC_CM_DOCUMENTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_documented ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | Done | Security | [SEC_CM_COUNCIL_REVIEWED][] | Done | -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Done | msf@ vogelpi@ chencindy@ ttrippel@ tjaychen@ Review | Signoff date | Done | 2022-07-11 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | Done | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Done | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Done | Review | [SEC_CM_DV_REVIEWED][] | Done | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/top_earlgrey/ip_autogen/alert_handler/dv/README.md b/hw/top_earlgrey/ip_autogen/alert_handler/dv/README.md index 1a20a82..577731c 100644 --- a/hw/top_earlgrey/ip_autogen/alert_handler/dv/README.md +++ b/hw/top_earlgrey/ip_autogen/alert_handler/dv/README.md
@@ -13,35 +13,35 @@ * Verify alert_handler_esc_timer and alert_handler_ping_timer ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "doc/project/development_stages" >}}) +* [Design & verification stage](../../../../README.md) + * [HW development stages](../../../../../doc/project_governance/development_stages.md) * [Simulation results](https://reports.opentitan.org/hw/ip/alert_handler/dv/latest/results.html) ## Design features -For detailed information on ALERT_HANDLER design features, please see the [ALERT_HANDLER HWIP technical specification]({{< relref ".." >}}). +For detailed information on ALERT_HANDLER design features, please see the [ALERT_HANDLER HWIP technical specification](../README.md). ## Testbench architecture -ALERT_HANDLER testbench has been constructed based on the [CIP testbench architecture]({{< relref "hw/dv/sv/cip_lib/doc" >}}). +ALERT_HANDLER testbench has been constructed based on the [CIP testbench architecture](../../../../dv/sv/cip_lib/README.md). ### Block diagram - + ### Top level testbench Top level testbench is located at `hw/ip/alert_handler/dv/tb/tb.sv`. It instantiates the ALERT_HANDLER DUT module `hw/ip/alert_handler/rtl/alert_handler.sv`. In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into `uvm_config_db`: -* [Clock and reset interface]({{< relref "hw/dv/sv/common_ifs" >}}) -* [TileLink host interface]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +* [Clock and reset interface](../../../../dv/sv/common_ifs/README.md) +* [TileLink host interface](../../../../dv/sv/tl_agent/README.md) * ALERT_HANDLER IOs -* Alerts and escalations([`alert_esc_if`]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}})) -* Interrupts ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) -* Devmode ([`pins_if`]({{< relref "hw/dv/sv/common_ifs" >}})) +* Alerts and escalations([`alert_esc_if`](../../../../dv/sv/alert_esc_agent/README.md)) +* Interrupts ([`pins_if`](../../../../dv/sv/common_ifs/README.md)) +* Devmode ([`pins_if`](../../../../dv/sv/common_ifs/README.md)) The alert_handler testbench environment can be reused in chip level testing. ### Common DV utility components The following utilities provide generic helper tasks and functions to perform activities that are common across the project: -* [dv_utils_pkg]({{< relref "hw/dv/sv/dv_utils/doc" >}}) -* [csr_utils_pkg]({{< relref "hw/dv/sv/csr_utils/doc" >}}) +* [dv_utils_pkg](../../../../dv/sv/dv_utils/README.md) +* [csr_utils_pkg](../../../../dv/sv/csr_utils/README.md) ### Global types & methods All common types and methods defined at the package level can be found in @@ -51,18 +51,18 @@ ``` ### TL_agent -ALERT_HANDLER testbench instantiates (already handled in CIP base env) [tl_agent]({{< relref "hw/dv/sv/tl_agent/doc" >}}) +ALERT_HANDLER testbench instantiates (already handled in CIP base env) [tl_agent](../../../../dv/sv/tl_agent/README.md) which provides the ability to drive and independently monitor random traffic via TL host interface into ALERT_HANDLER device. ### ALERT_ESC Agent -[ALERT_ESC agent]({{< relref "hw/dv/sv/alert_esc_agent/doc" >}}) is used to drive and monitor transmitter and receiver pairs for the alerts and escalators. +[ALERT_ESC agent](../../../../dv/sv/alert_esc_agent/README.md) is used to drive and monitor transmitter and receiver pairs for the alerts and escalators. Alert_handler DUT includes alert_receivers and esc_senders, so the alert_esc agent will drive output signals of the alert_senders and esc_receivers. ### UVM RAL Model -The ALERT_HANDLER RAL model is created with the [`ralgen`]({{< relref "hw/dv/tools/ralgen/doc" >}}) FuseSoC generator script automatically when the simulation is at the build stage. +The ALERT_HANDLER RAL model is created with the [`ralgen`](../../../../dv/tools/ralgen/README.md) FuseSoC generator script automatically when the simulation is at the build stage. -It can be created manually by invoking [`regtool`]({{< relref "util/reggen/doc" >}}). +It can be created manually by invoking [`regtool`](../../../../../util/reggen/doc/setup_and_use.md). ### Stimulus strategy #### Test sequences @@ -106,11 +106,11 @@ The alert_handler scoreboard is parameterized to support different number of classes, alert pairs, and escalation pairs. #### Assertions -* TLUL assertions: The `tb/alert_handler_bind.sv` binds the `tlul_assert` [assertions]({{< relref "hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) to the IP to ensure TileLink interface protocol compliance. +* TLUL assertions: The `tb/alert_handler_bind.sv` binds the `tlul_assert` [assertions](../../../../ip/tlul/doc/TlulProtocolChecker.md) to the IP to ensure TileLink interface protocol compliance. * Unknown checks on DUT outputs: The RTL has assertions to ensure all outputs are initialized to known values after coming out of reset. ## Building and running tests -We are using our in-house developed [regression tool]({{< relref "hw/dv/tools/doc" >}}) for building and running our tests and regressions. +We are using our in-house developed [regression tool](../../../../../util/dvsim/README.md) for building and running our tests and regressions. Please take a look at the link for detailed information on the usage, capabilities, features and known issues. Here's how to run a smoke test: ```console
diff --git a/hw/top_earlgrey/ip_autogen/rv_plic/README.md b/hw/top_earlgrey/ip_autogen/rv_plic/README.md index 9e72df9..b7b2011 100644 --- a/hw/top_earlgrey/ip_autogen/rv_plic/README.md +++ b/hw/top_earlgrey/ip_autogen/rv_plic/README.md
@@ -6,7 +6,7 @@ This document specifies the Interrupt Controller (RV_PLIC) functionality. This module conforms to the -[Comportable guideline for peripheral functionality]({{< relref "doc/rm/comportability_specification" >}}). +[Comportable guideline for peripheral functionality](../../../../doc/contributing/hw/comportability/README.md). See that document for integration overview within the broader top level system. @@ -31,7 +31,7 @@ ## Block Diagram - + ## Hardware Interfaces
diff --git a/hw/top_earlgrey/ip_autogen/rv_plic/doc/checklist.md b/hw/top_earlgrey/ip_autogen/rv_plic/doc/checklist.md index 0783d1b..0a31427 100644 --- a/hw/top_earlgrey/ip_autogen/rv_plic/doc/checklist.md +++ b/hw/top_earlgrey/ip_autogen/rv_plic/doc/checklist.md
@@ -2,8 +2,8 @@ title: "RV_PLIC Checklist" --- -This checklist is for [Hardware Stage]({{<relref "/doc/project/development_stages.md" >}}) transitions for the [RV_PLIC peripheral](..). -All checklist items refer to the content in the [Checklist.]({{<relref "/doc/project/checklist.md" >}}) +This checklist is for [Hardware Stage](../../../../../doc/project_governance/development_stages.md) transitions for the [RV_PLIC peripheral](../README.md). +All checklist items refer to the content in the [Checklist.](../../../../../doc/project_governance/checklist/README.md) ## Design Checklist @@ -21,17 +21,17 @@ RTL | [ASSERT_KNOWN_ADDED][] | Done | Code Quality | [LINT_SETUP][] | Done | -[RV_PLIC Spec]: {{<relref ".">}} +[RV_PLIC Spec]: ../README.md -[SPEC_COMPLETE]: {{<relref "/doc/project/checklist.md#spec_complete" >}} -[CSR_DEFINED]: {{<relref "/doc/project/checklist.md#csr_defined" >}} -[CLKRST_CONNECTED]: {{<relref "/doc/project/checklist.md#clkrst_connected" >}} -[IP_TOP]: {{<relref "/doc/project/checklist.md#ip_top" >}} -[IP_INSTANTIABLE]: {{<relref "/doc/project/checklist.md#ip_instantiable" >}} -[PHYSICAL_MACROS_DEFINED_80]: {{<relref "/doc/project/checklist.md#physical_macros_defined_80" >}} -[FUNC_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#func_implemented" >}} -[ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert_known_added" >}} -[LINT_SETUP]: {{<relref "/doc/project/checklist.md#lint_setup" >}} +[SPEC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#spec_complete +[CSR_DEFINED]: ../../../../../doc/project_governance/checklist/README.md#csr_defined +[CLKRST_CONNECTED]: ../../../../../doc/project_governance/checklist/README.md#clkrst_connected +[IP_TOP]: ../../../../../doc/project_governance/checklist/README.md#ip_top +[IP_INSTANTIABLE]: ../../../../../doc/project_governance/checklist/README.md#ip_instantiable +[PHYSICAL_MACROS_DEFINED_80]: ../../../../../doc/project_governance/checklist/README.md#physical_macros_defined_80 +[FUNC_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#func_implemented +[ASSERT_KNOWN_ADDED]: ../../../../../doc/project_governance/checklist/README.md#assert_known_added +[LINT_SETUP]: ../../../../../doc/project_governance/checklist/README.md#lint_setup ### D2 @@ -55,23 +55,23 @@ Security | [SEC_CM_DOCUMENTED][] | N/A | Security | [SEC_RND_CNST][] | N/A | -[NEW_FEATURES]: {{<relref "/doc/project/checklist.md#new_features" >}} -[BLOCK_DIAGRAM]: {{<relref "/doc/project/checklist.md#block_diagram" >}} -[DOC_INTERFACE]: {{<relref "/doc/project/checklist.md#doc_interface" >}} -[MISSING_FUNC]: {{<relref "/doc/project/checklist.md#missing_func" >}} -[FEATURE_FROZEN]: {{<relref "/doc/project/checklist.md#feature_frozen" >}} -[FEATURE_COMPLETE]: {{<relref "/doc/project/checklist.md#feature_complete" >}} -[AREA_CHECK]: {{<relref "/doc/project/checklist.md#area_check" >}} -[PORT_FROZEN]: {{<relref "/doc/project/checklist.md#port_frozen" >}} -[ARCHITECTURE_FROZEN]: {{<relref "/doc/project/checklist.md#architecture_frozen" >}} -[REVIEW_TODO]: {{<relref "/doc/project/checklist.md#review_todo" >}} -[STYLE_X]: {{<relref "/doc/project/checklist.md#style_x" >}} -[LINT_PASS]: {{<relref "/doc/project/checklist.md#lint_pass" >}} -[CDC_SETUP]: {{<relref "/doc/project/checklist.md#cdc_setup" >}} -[FPGA_TIMING]: {{<relref "/doc/project/checklist.md#fpga_timing" >}} -[CDC_SYNCMACRO]: {{<relref "/doc/project/checklist.md#cdc_syncmacro" >}} -[SEC_CM_DOCUMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_documented" >}} -[SEC_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_rnd_cnst" >}} +[NEW_FEATURES]: ../../../../../doc/project_governance/checklist/README.md#new_features +[BLOCK_DIAGRAM]: ../../../../../doc/project_governance/checklist/README.md#block_diagram +[DOC_INTERFACE]: ../../../../../doc/project_governance/checklist/README.md#doc_interface +[MISSING_FUNC]: ../../../../../doc/project_governance/checklist/README.md#missing_func +[FEATURE_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#feature_frozen +[FEATURE_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#feature_complete +[AREA_CHECK]: ../../../../../doc/project_governance/checklist/README.md#area_check +[PORT_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#port_frozen +[ARCHITECTURE_FROZEN]: ../../../../../doc/project_governance/checklist/README.md#architecture_frozen +[REVIEW_TODO]: ../../../../../doc/project_governance/checklist/README.md#review_todo +[STYLE_X]: ../../../../../doc/project_governance/checklist/README.md#style_x +[LINT_PASS]: ../../../../../doc/project_governance/checklist/README.md#lint_pass +[CDC_SETUP]: ../../../../../doc/project_governance/checklist/README.md#cdc_setup +[FPGA_TIMING]: ../../../../../doc/project_governance/checklist/README.md#fpga_timing +[CDC_SYNCMACRO]: ../../../../../doc/project_governance/checklist/README.md#cdc_syncmacro +[SEC_CM_DOCUMENTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_documented +[SEC_RND_CNST]: ../../../../../doc/project_governance/checklist/README.md#sec_rnd_cnst ### D2S @@ -85,13 +85,13 @@ Security | [SEC_CM_RTL_REVIEWED][] | N/A | Security | [SEC_CM_COUNCIL_REVIEWED][] | N/A | This block only contains the bus-integrity CM. -[SEC_CM_ASSETS_LISTED]: {{<relref "/doc/project/checklist.md#sec_cm_assets_listed" >}} -[SEC_CM_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#sec_cm_implemented" >}} -[SEC_CM_RND_CNST]: {{<relref "/doc/project/checklist.md#sec_cm_rnd_cnst" >}} -[SEC_CM_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec_cm_non_reset_flops" >}} -[SEC_CM_SHADOW_REGS]: {{<relref "/doc/project/checklist.md#sec_cm_shadow_regs" >}} -[SEC_CM_RTL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_rtl_reviewed" >}} -[SEC_CM_COUNCIL_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_council_reviewed" >}} +[SEC_CM_ASSETS_LISTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_assets_listed +[SEC_CM_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_implemented +[SEC_CM_RND_CNST]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_rnd_cnst +[SEC_CM_NON_RESET_FLOPS]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_non_reset_flops +[SEC_CM_SHADOW_REGS]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_shadow_regs +[SEC_CM_RTL_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_rtl_reviewed +[SEC_CM_COUNCIL_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_council_reviewed ### D3 @@ -109,15 +109,15 @@ Review | Reviewer(s) | Done | eunchan@ gac@ chencindy@ ttrippel@ Review | Signoff date | Done | 2022-07-25 -[NEW_FEATURES_D3]: {{<relref "/doc/project/checklist.md#new_features_d3" >}} -[TODO_COMPLETE]: {{<relref "/doc/project/checklist.md#todo_complete" >}} -[LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#lint_complete" >}} -[CDC_COMPLETE]: {{<relref "/doc/project/checklist.md#cdc_complete" >}} -[RDC_COMPLETE]: {{<relref "/doc/project/checklist.md#rdc_complete" >}} -[REVIEW_RTL]: {{<relref "/doc/project/checklist.md#review_rtl" >}} -[REVIEW_DELETED_FF]: {{<relref "/doc/project/checklist.md#review_deleted_ff" >}} -[REVIEW_SW_CHANGE]: {{<relref "/doc/project/checklist.md#review_sw_change" >}} -[REVIEW_SW_ERRATA]: {{<relref "/doc/project/checklist.md#review_sw_errata" >}} +[NEW_FEATURES_D3]: ../../../../../doc/project_governance/checklist/README.md#new_features_d3 +[TODO_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#todo_complete +[LINT_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#lint_complete +[CDC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#cdc_complete +[RDC_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#rdc_complete +[REVIEW_RTL]: ../../../../../doc/project_governance/checklist/README.md#review_rtl +[REVIEW_DELETED_FF]: ../../../../../doc/project_governance/checklist/README.md#review_deleted_ff +[REVIEW_SW_CHANGE]: ../../../../../doc/project_governance/checklist/README.md#review_sw_change +[REVIEW_SW_ERRATA]: ../../../../../doc/project_governance/checklist/README.md#review_sw_errata ## Verification Checklist @@ -125,7 +125,7 @@ Type | Item | Resolution | Note/Collaterals --------------|---------------------------------------|-------------|------------------ -Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [rv_plic_fpv_plan]({{<relref "dv/index.md" >}}) +Documentation | [DV_DOC_DRAFT_COMPLETED][] | Done | [rv_plic_fpv_plan](./dv/README.md) Documentation | [TESTPLAN_COMPLETED][] | Done | Testbench | [TB_TOP_CREATED][] | Done | Testbench | [PRELIMINARY_ASSERTION_CHECKS_ADDED][]| Done | @@ -148,28 +148,28 @@ Review | [STD_TEST_CATEGORIES_PLANNED][] | N/A | Review | [V2_CHECKLIST_SCOPED][] | Done | -[DV_DOC_DRAFT_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_draft_completed" >}} -[TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#testplan_completed" >}} -[TB_TOP_CREATED]: {{<relref "/doc/project/checklist.md#tb_top_created" >}} -[PRELIMINARY_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#preliminary_assertion_checks_added" >}} -[SIM_TB_ENV_CREATED]: {{<relref "/doc/project/checklist.md#sim_tb_env_created" >}} -[SIM_RAL_MODEL_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#sim_ral_model_gen_automated" >}} -[CSR_CHECK_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#csr_check_gen_automated" >}} -[TB_GEN_AUTOMATED]: {{<relref "/doc/project/checklist.md#tb_gen_automated" >}} -[SIM_SMOKE_TEST_PASSING]: {{<relref "/doc/project/checklist.md#sim_smoke_test_passing" >}} -[SIM_CSR_MEM_TEST_SUITE_PASSING]: {{<relref "/doc/project/checklist.md#sim_csr_mem_test_suite_passing" >}} -[FPV_MAIN_ASSERTIONS_PROVEN]: {{<relref "/doc/project/checklist.md#fpv_main_assertions_proven" >}} -[SIM_ALT_TOOL_SETUP]: {{<relref "/doc/project/checklist.md#sim_alt_tool_setup" >}} -[SIM_SMOKE_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_smoke_regression_setup" >}} -[SIM_NIGHTLY_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_setup" >}} -[FPV_REGRESSION_SETUP]: {{<relref "/doc/project/checklist.md#fpv_regression_setup" >}} -[SIM_COVERAGE_MODEL_ADDED]: {{<relref "/doc/project/checklist.md#sim_coverage_model_added" >}} -[TB_LINT_SETUP]: {{<relref "/doc/project/checklist.md#tb_lint_setup" >}} -[PRE_VERIFIED_SUB_MODULES_V1]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v1" >}} -[DESIGN_SPEC_REVIEWED]: {{<relref "/doc/project/checklist.md#design_spec_reviewed" >}} -[TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#testplan_reviewed" >}} -[STD_TEST_CATEGORIES_PLANNED]: {{<relref "/doc/project/checklist.md#std_test_categories_planned" >}} -[V2_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v2_checklist_scoped" >}} +[DV_DOC_DRAFT_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#dv_doc_draft_completed +[TESTPLAN_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#testplan_completed +[TB_TOP_CREATED]: ../../../../../doc/project_governance/checklist/README.md#tb_top_created +[PRELIMINARY_ASSERTION_CHECKS_ADDED]: ../../../../../doc/project_governance/checklist/README.md#preliminary_assertion_checks_added +[SIM_TB_ENV_CREATED]: ../../../../../doc/project_governance/checklist/README.md#sim_tb_env_created +[SIM_RAL_MODEL_GEN_AUTOMATED]: ../../../../../doc/project_governance/checklist/README.md#sim_ral_model_gen_automated +[CSR_CHECK_GEN_AUTOMATED]: ../../../../../doc/project_governance/checklist/README.md#csr_check_gen_automated +[TB_GEN_AUTOMATED]: ../../../../../doc/project_governance/checklist/README.md#tb_gen_automated +[SIM_SMOKE_TEST_PASSING]: ../../../../../doc/project_governance/checklist/README.md#sim_smoke_test_passing +[SIM_CSR_MEM_TEST_SUITE_PASSING]: ../../../../../doc/project_governance/checklist/README.md#sim_csr_mem_test_suite_passing +[FPV_MAIN_ASSERTIONS_PROVEN]: ../../../../../doc/project_governance/checklist/README.md#fpv_main_assertions_proven +[SIM_ALT_TOOL_SETUP]: ../../../../../doc/project_governance/checklist/README.md#sim_alt_tool_setup +[SIM_SMOKE_REGRESSION_SETUP]: ../../../../../doc/project_governance/checklist/README.md#sim_smoke_regression_setup +[SIM_NIGHTLY_REGRESSION_SETUP]: ../../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_setup +[FPV_REGRESSION_SETUP]: ../../../../../doc/project_governance/checklist/README.md#fpv_regression_setup +[SIM_COVERAGE_MODEL_ADDED]: ../../../../../doc/project_governance/checklist/README.md#sim_coverage_model_added +[TB_LINT_SETUP]: ../../../../../doc/project_governance/checklist/README.md#tb_lint_setup +[PRE_VERIFIED_SUB_MODULES_V1]: ../../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v1 +[DESIGN_SPEC_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#design_spec_reviewed +[TESTPLAN_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#testplan_reviewed +[STD_TEST_CATEGORIES_PLANNED]: ../../../../../doc/project_governance/checklist/README.md#std_test_categories_planned +[V2_CHECKLIST_SCOPED]: ../../../../../doc/project_governance/checklist/README.md#v2_checklist_scoped ### V2 @@ -196,26 +196,26 @@ Review | [DV_DOC_TESTPLAN_REVIEWED][] | Not Started | Review | [V3_CHECKLIST_SCOPED][] | Done | -[DESIGN_DELTAS_CAPTURED_V2]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v2" >}} -[DV_DOC_COMPLETED]: {{<relref "/doc/project/checklist.md#dv_doc_completed" >}} -[FUNCTIONAL_COVERAGE_IMPLEMENTED]: {{<relref "/doc/project/checklist.md#functional_coverage_implemented" >}} -[ALL_INTERFACES_EXERCISED]: {{<relref "/doc/project/checklist.md#all_interfaces_exercised" >}} -[ALL_ASSERTION_CHECKS_ADDED]: {{<relref "/doc/project/checklist.md#all_assertion_checks_added" >}} -[SIM_TB_ENV_COMPLETED]: {{<relref "/doc/project/checklist.md#sim_tb_env_completed" >}} -[SIM_ALL_TESTS_PASSING]: {{<relref "/doc/project/checklist.md#sim_all_tests_passing" >}} -[FPV_ALL_ASSERTIONS_WRITTEN]: {{<relref "/doc/project/checklist.md#fpv_all_assertions_written" >}} -[FPV_ALL_ASSUMPTIONS_REVIEWED]: {{<relref "/doc/project/checklist.md#fpv_all_assumptions_reviewed" >}} -[SIM_FW_SIMULATED]: {{<relref "/doc/project/checklist.md#sim_fw_simulated" >}} -[SIM_NIGHTLY_REGRESSION_V2]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_v2" >}} -[SIM_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_code_coverage_v2" >}} -[SIM_FUNCTIONAL_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#sim_functional_coverage_v2" >}} -[FPV_CODE_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_v2" >}} -[FPV_COI_COVERAGE_V2]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_v2" >}} -[PRE_VERIFIED_SUB_MODULES_V2]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v2" >}} -[NO_HIGH_PRIORITY_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_high_priority_issues_pending" >}} -[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:{{<relref "/doc/project/checklist.md#all_low_priority_issues_root_caused" >}} -[DV_DOC_TESTPLAN_REVIEWED]: {{<relref "/doc/project/checklist.md#dv_doc_testplan_reviewed" >}} -[V3_CHECKLIST_SCOPED]: {{<relref "/doc/project/checklist.md#v3_checklist_scoped" >}} +[DESIGN_DELTAS_CAPTURED_V2]: ../../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v2 +[DV_DOC_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#dv_doc_completed +[FUNCTIONAL_COVERAGE_IMPLEMENTED]: ../../../../../doc/project_governance/checklist/README.md#functional_coverage_implemented +[ALL_INTERFACES_EXERCISED]: ../../../../../doc/project_governance/checklist/README.md#all_interfaces_exercised +[ALL_ASSERTION_CHECKS_ADDED]: ../../../../../doc/project_governance/checklist/README.md#all_assertion_checks_added +[SIM_TB_ENV_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#sim_tb_env_completed +[SIM_ALL_TESTS_PASSING]: ../../../../../doc/project_governance/checklist/README.md#sim_all_tests_passing +[FPV_ALL_ASSERTIONS_WRITTEN]: ../../../../../doc/project_governance/checklist/README.md#fpv_all_assertions_written +[FPV_ALL_ASSUMPTIONS_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#fpv_all_assumptions_reviewed +[SIM_FW_SIMULATED]: ../../../../../doc/project_governance/checklist/README.md#sim_fw_simulated +[SIM_NIGHTLY_REGRESSION_V2]: ../../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_v2 +[SIM_CODE_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#sim_code_coverage_v2 +[SIM_FUNCTIONAL_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_v2 +[FPV_CODE_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_v2 +[FPV_COI_COVERAGE_V2]: ../../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_v2 +[PRE_VERIFIED_SUB_MODULES_V2]: ../../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v2 +[NO_HIGH_PRIORITY_ISSUES_PENDING]: ../../../../../doc/project_governance/checklist/README.md#no_high_priority_issues_pending +[ALL_LOW_PRIORITY_ISSUES_ROOT_CAUSED]:../../../../../doc/project_governance/checklist/README.md#all_low_priority_issues_root_caused +[DV_DOC_TESTPLAN_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#dv_doc_testplan_reviewed +[V3_CHECKLIST_SCOPED]: ../../../../../doc/project_governance/checklist/README.md#v3_checklist_scoped ### V2S @@ -227,11 +227,11 @@ Coverage | [SIM_COVERAGE_REVIEWED][] | Not Started | Review | [SEC_CM_DV_REVIEWED][] | Not Started | -[SEC_CM_TESTPLAN_COMPLETED]: {{<relref "/doc/project/checklist.md#sec_cm_testplan_completed" >}} -[FPV_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#fpv_sec_cm_verified" >}} -[SIM_SEC_CM_VERIFIED]: {{<relref "/doc/project/checklist.md#sim_sec_cm_verified" >}} -[SIM_COVERAGE_REVIEWED]: {{<relref "/doc/project/checklist.md#sim_coverage_reviewed" >}} -[SEC_CM_DV_REVIEWED]: {{<relref "/doc/project/checklist.md#sec_cm_dv_reviewed" >}} +[SEC_CM_TESTPLAN_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_testplan_completed +[FPV_SEC_CM_VERIFIED]: ../../../../../doc/project_governance/checklist/README.md#fpv_sec_cm_verified +[SIM_SEC_CM_VERIFIED]: ../../../../../doc/project_governance/checklist/README.md#sim_sec_cm_verified +[SIM_COVERAGE_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sim_coverage_reviewed +[SEC_CM_DV_REVIEWED]: ../../../../../doc/project_governance/checklist/README.md#sec_cm_dv_reviewed ### V3 @@ -253,16 +253,16 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DESIGN_DELTAS_CAPTURED_V3]: {{<relref "/doc/project/checklist.md#design_deltas_captured_v3" >}} -[X_PROP_ANALYSIS_COMPLETED]: {{<relref "/doc/project/checklist.md#x_prop_analysis_completed" >}} -[FPV_ASSERTIONS_PROVEN_AT_V3]: {{<relref "/doc/project/checklist.md#fpv_assertions_proven_at_v3" >}} -[SIM_NIGHTLY_REGRESSION_AT_V3]: {{<relref "/doc/project/checklist.md#sim_nightly_regression_at_v3" >}} -[SIM_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#sim_code_coverage_at_100" >}} -[SIM_FUNCTIONAL_COVERAGE_AT_100]:{{<relref "/doc/project/checklist.md#sim_functional_coverage_at_100" >}} -[FPV_CODE_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_code_coverage_at_100" >}} -[FPV_COI_COVERAGE_AT_100]: {{<relref "/doc/project/checklist.md#fpv_coi_coverage_at_100" >}} -[ALL_TODOS_RESOLVED]: {{<relref "/doc/project/checklist.md#all_todos_resolved" >}} -[NO_TOOL_WARNINGS_THROWN]: {{<relref "/doc/project/checklist.md#no_tool_warnings_thrown" >}} -[TB_LINT_COMPLETE]: {{<relref "/doc/project/checklist.md#tb_lint_complete" >}} -[PRE_VERIFIED_SUB_MODULES_V3]: {{<relref "/doc/project/checklist.md#pre_verified_sub_modules_v3" >}} -[NO_ISSUES_PENDING]: {{<relref "/doc/project/checklist.md#no_issues_pending" >}} +[DESIGN_DELTAS_CAPTURED_V3]: ../../../../../doc/project_governance/checklist/README.md#design_deltas_captured_v3 +[X_PROP_ANALYSIS_COMPLETED]: ../../../../../doc/project_governance/checklist/README.md#x_prop_analysis_completed +[FPV_ASSERTIONS_PROVEN_AT_V3]: ../../../../../doc/project_governance/checklist/README.md#fpv_assertions_proven_at_v3 +[SIM_NIGHTLY_REGRESSION_AT_V3]: ../../../../../doc/project_governance/checklist/README.md#sim_nightly_regression_at_v3 +[SIM_CODE_COVERAGE_AT_100]: ../../../../../doc/project_governance/checklist/README.md#sim_code_coverage_at_100 +[SIM_FUNCTIONAL_COVERAGE_AT_100]:../../../../../doc/project_governance/checklist/README.md#sim_functional_coverage_at_100 +[FPV_CODE_COVERAGE_AT_100]: ../../../../../doc/project_governance/checklist/README.md#fpv_code_coverage_at_100 +[FPV_COI_COVERAGE_AT_100]: ../../../../../doc/project_governance/checklist/README.md#fpv_coi_coverage_at_100 +[ALL_TODOS_RESOLVED]: ../../../../../doc/project_governance/checklist/README.md#all_todos_resolved +[NO_TOOL_WARNINGS_THROWN]: ../../../../../doc/project_governance/checklist/README.md#no_tool_warnings_thrown +[TB_LINT_COMPLETE]: ../../../../../doc/project_governance/checklist/README.md#tb_lint_complete +[PRE_VERIFIED_SUB_MODULES_V3]: ../../../../../doc/project_governance/checklist/README.md#pre_verified_sub_modules_v3 +[NO_ISSUES_PENDING]: ../../../../../doc/project_governance/checklist/README.md#no_issues_pending
diff --git a/hw/top_earlgrey/ip_autogen/rv_plic/doc/dv/README.md b/hw/top_earlgrey/ip_autogen/rv_plic/doc/dv/README.md index 99d51d7..4f79dc3 100644 --- a/hw/top_earlgrey/ip_autogen/rv_plic/doc/dv/README.md +++ b/hw/top_earlgrey/ip_autogen/rv_plic/doc/dv/README.md
@@ -12,23 +12,23 @@ * Verify TileLink device protocol compliance with a FPV based testbench ## Current status -* [Design & verification stage]({{< relref "hw" >}}) - * [HW development stages]({{< relref "/doc/project/development_stages" >}}) +* [Design & verification stage](../../../../../README.md) + * [HW development stages](../../../../../../doc/project_governance/development_stages.md) * FPV dashboard (link TBD) ## Design features For detailed information on RV_PLIC design features, please see the -[RV_PLIC design specification]({{< relref ".." >}}). +[RV_PLIC design specification](../../README.md). ## Testbench architecture RV_PLIC FPV testbench has been constructed based on the [formal -architecture]({{< relref "/hw/formal/doc" >}}). +architecture](../../../../../formal/README.md). ### Block diagram  #### TLUL assertions -* The file `rv_plic_bind.sv` binds the `tlul_assert` [assertions]({{< relref "/hw/ip/tlul/doc/TlulProtocolChecker.md" >}}) +* The file `rv_plic_bind.sv` binds the `tlul_assert` [assertions](../../../../../ip/tlul/doc/TlulProtocolChecker.md) to rv_plic to ensure TileLink interface protocol compliance. * The `hw/rv_plic/fpv/tb/rv_plic_bind.sv` also binds the `rv_plic_csr_assert_fpv` under `fpv/vip/` to check if TileLink writes and reads correct @@ -44,7 +44,7 @@ declared two symbolic variables `src_sel` and `tgt_sel` to represent the index for interrupt source and interrupt target. Detailed explanation is listed in the -[Symbolic Variables]({{< relref "/hw/formal/doc#symbolic-variables" >}}) section. +[Symbolic Variables](../../../../../formal/README.md#symbolic-variables) section. ## Testplan {{< incGenFromIpDesc "../../data/rv_plic_fpv_testplan.hjson" "testplan" >}}
diff --git a/site/docs/doxygen/main_page.md b/site/docs/doxygen/main_page.md index d7bcacd..d44cb92 100644 --- a/site/docs/doxygen/main_page.md +++ b/site/docs/doxygen/main_page.md
@@ -6,6 +6,6 @@ The documentation can be browsed using the tabs above, or there are API listings for the relevant DIFs in each Comportable Hardware IP specification. -[Return to OpenTitan Software Documentation](..) +[Return to OpenTitan Software Documentation](../README.md) [Return to OpenTitan Documentation](../..) \ No newline at end of file
diff --git a/sw/README.md b/sw/README.md index 53b6496..3398c5d 100644 --- a/sw/README.md +++ b/sw/README.md
@@ -3,7 +3,7 @@ --- This is the landing spot for software documentation within the OpenTitan project. -More description and information can be found within the [Reference Manual]({{< relref "doc/rm" >}}) and [User Guide]({{< relref "doc/ug" >}}) areas. +More description and information can be found within the [Reference Manual](../util/README.md) and [User Guide]({{< relref "doc/ug" >}}) areas. There are three major parts to the OpenTitan software stack: @@ -51,7 +51,7 @@ The [OpenTitan Software API Documentation](/sw/apis/) contains automatically generated documentation for the public software APIs. This includes the Device Interface Functions (DIFs). -All DIFs are also documented on their respective [Hardware IP Specification]({{< relref "hw" >}}) +All DIFs are also documented on their respective [Hardware IP Specification](../hw/README.md) ## Vendored in Code
diff --git a/sw/device/README.md b/sw/device/README.md index 5b5d43b..b152f68 100644 --- a/sw/device/README.md +++ b/sw/device/README.md
@@ -9,14 +9,14 @@ The Reference Firmware Images are, in boot order: -1. The [ROM]({{< relref "sw/device/silicon_creator/rom/docs" >}}) (in `sw/device/silicon_creator/rom`), executed at chip reset; +1. The [ROM](./silicon_creator/rom/README.md) (in `sw/device/silicon_creator/rom`), executed at chip reset; 2. The ROM_EXT (in `sw/device/silicon_creator/rom_ext`), the second stage Silicon Creator code, executed from flash; and ### Testing-only Images There are also some other standalone firmware images in the repository, which are only used for testing. -- [`sw/device/tests`]({{< relref "sw/device/tests/index.md" >}}) contains several categories of chip-level tests, including smoke, IP integration, and system-level (use case) tests. +- [`sw/device/tests`](./tests/README.md) contains several categories of chip-level tests, including smoke, IP integration, and system-level (use case) tests. - [`sw/device/benchmarks/coremark`](https://github.com/lowRISC/opentitan/tree/master/sw/device/benchmarks/coremark) contains infrastructure for running the [CoreMark](https://github.com/eembc/coremark) benchmark suite on the OpenTitan device. - `sw/device/riscv_compliance_support` contains infrastructure so we can run the [RISC-V Compliance](https://github.com/riscv/riscv-compliance) tests on the OpenTitan core.
diff --git a/sw/device/lib/README.md b/sw/device/lib/README.md index 427c595..81292f8 100644 --- a/sw/device/lib/README.md +++ b/sw/device/lib/README.md
@@ -14,14 +14,14 @@ contains the Base Libraries, including [freestanding C library headers](https://github.com/lowRISC/opentitan/tree/master/sw/device/lib/base/freestanding). The Base Libraries are simple libraries that can be used by any other OpenTitan device software libraries. -- [`sw/device/lib/dif`]({{< relref "sw/device/lib/dif" >}}) - contains the [Device Interface Functions]({{< relref "doc/rm/device_interface_functions.md" >}}). +- [`sw/device/lib/dif`](./dif/README.md) + contains the [Device Interface Functions](../../../doc/contributing/sw/device_interface_functions.md). - `sw/device/lib/arch` contains the libraries to be used on specific device configurations (for instance FPGA, Simulation, etc.). - [`sw/device/lib/runtime`](https://github.com/lowRISC/opentitan/tree/master/sw/device/lib/runtime) contains general libraries for more advanced on-device functionality (including logging, printing, and interacting with the RISC-V core). -- [`sw/device/lib/testing`]({{< relref "sw/device/lib/testing/_index.md" >}}) +- [`sw/device/lib/testing`](./testing/README.md) contains test library code. Test library code is any (reusable) code that could aid in the writing of smoke, IP integration, or system-level tests, that is a layer of above the DIFs. In other words, this code may make use
diff --git a/sw/device/lib/dif/README.md b/sw/device/lib/dif/README.md index 3b8c632..95290c1 100644 --- a/sw/device/lib/dif/README.md +++ b/sw/device/lib/dif/README.md
@@ -56,7 +56,7 @@ ## Checklists This directory also contains checklists for each DIF, in markdown format. They -are linked to from the [Hardware Dashboard]({{< relref "hw" >}}), in the +are linked to from the [Hardware Dashboard](../../../../hw/README.md), in the Development Stage column. ## DIF Style Guide
diff --git a/sw/device/lib/dif/dif_adc_ctrl.md b/sw/device/lib/dif/dif_adc_ctrl.md index 8920507..91a3930 100644 --- a/sw/device/lib/dif/dif_adc_ctrl.md +++ b/sw/device/lib/dif/dif_adc_ctrl.md
@@ -2,8 +2,8 @@ title: "ADC Controller DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [ADC Controller DIF]({{< relref "hw/ip/adc_ctrl/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [ADC Controller DIF](../../../../hw/ip/adc_ctrl/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,26 +15,26 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> Type | Item | Resolution | Note/Collaterals ---------------|----------------------------------|-------------|------------------ -Coordination | [DIF_HW_DESIGN_COMPLETE][] | Not Started | [HW Dashboard]({{< relref "hw" >}}) -Coordination | [DIF_HW_VERIFICATION_COMPLETE][] | Not Started | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_DESIGN_COMPLETE][] | Not Started | [HW Dashboard](../../../../hw/README.md) +Coordination | [DIF_HW_VERIFICATION_COMPLETE][] | Not Started | [HW Dashboard](../../../../hw/README.md) Documentation | [DIF_DOC_HW][] | Not Started | Code Quality | [DIF_CODE_STYLE][] | Not Started | Tests | [DIF_TEST_UNIT][] | Done | @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_aes.md b/sw/device/lib/dif/dif_aes.md index 87bfd41..de291ed 100644 --- a/sw/device/lib/dif/dif_aes.md +++ b/sw/device/lib/dif/dif_aes.md
@@ -2,8 +2,8 @@ title: "AES DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [AES DIF]({{< relref "hw/ip/aes/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [AES DIF](../../../../hw/ip/aes/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,26 +15,26 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> Type | Item | Resolution | Note/Collaterals ---------------|----------------------------------|-------------|------------------ -Coordination | [DIF_HW_DESIGN_COMPLETE][] | Not Started | [HW Dashboard]({{< relref "hw" >}}) -Coordination | [DIF_HW_VERIFICATION_COMPLETE][] | Not Started | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_DESIGN_COMPLETE][] | Not Started | [HW Dashboard](../../../../hw/README.md) +Coordination | [DIF_HW_VERIFICATION_COMPLETE][] | Not Started | [HW Dashboard](../../../../hw/README.md) Documentation | [DIF_DOC_HW][] | Not Started | Code Quality | [DIF_CODE_STYLE][] | Not Started | Tests | [DIF_TEST_UNIT][] | Not Started | @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_alert_handler.md b/sw/device/lib/dif/dif_alert_handler.md index 0aec703..f48daeb 100644 --- a/sw/device/lib/dif/dif_alert_handler.md +++ b/sw/device/lib/dif/dif_alert_handler.md
@@ -2,8 +2,8 @@ title: "Alert Handler DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Alert Handler DIF]({{< relref "hw/top_earlgrey/ip_autogen/alert_handler/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Alert Handler DIF](../../../../hw/top_earlgrey/ip_autogen/alert_handler/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_aon_timer.md b/sw/device/lib/dif/dif_aon_timer.md index 6038454..ad368e4 100644 --- a/sw/device/lib/dif/dif_aon_timer.md +++ b/sw/device/lib/dif/dif_aon_timer.md
@@ -2,8 +2,8 @@ title: "Always-On Timer DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Always-On Timer DIF]({{< relref "hw/ip/aon_timer/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Always-On Timer DIF](../../../../hw/ip/aon_timer/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_clkmgr.md b/sw/device/lib/dif/dif_clkmgr.md index abe112c..6fb6346 100644 --- a/sw/device/lib/dif/dif_clkmgr.md +++ b/sw/device/lib/dif/dif_clkmgr.md
@@ -2,8 +2,8 @@ title: "Clock Manager DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Clock Manager DIF]({{< relref "hw/ip/clkmgr/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Clock Manager DIF](../../../../hw/ip/clkmgr/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_csrng.md b/sw/device/lib/dif/dif_csrng.md index b40bc8b..650e082 100644 --- a/sw/device/lib/dif/dif_csrng.md +++ b/sw/device/lib/dif/dif_csrng.md
@@ -2,8 +2,8 @@ title: "CSRNG DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [CSRNG DIF]({{< relref "hw/ip/csrng/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [CSRNG DIF](../../../../hw/ip/csrng/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_edn.md b/sw/device/lib/dif/dif_edn.md index 4c77f4b..09867a1 100644 --- a/sw/device/lib/dif/dif_edn.md +++ b/sw/device/lib/dif/dif_edn.md
@@ -2,8 +2,8 @@ title: "Entropy Distribution Network DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Entropy Distribution Network DIF]({{< relref "hw/ip/edn/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Entropy Distribution Network DIF](../../../../hw/ip/edn/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_entropy_src.md b/sw/device/lib/dif/dif_entropy_src.md index 11f3d1c..1367d88 100644 --- a/sw/device/lib/dif/dif_entropy_src.md +++ b/sw/device/lib/dif/dif_entropy_src.md
@@ -2,8 +2,8 @@ title: "Entropy Source DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Entropy Source DIF]({{< relref "hw/ip/entropy_src/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Entropy Source DIF](../../../../hw/ip/entropy_src/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_flash_ctrl.md b/sw/device/lib/dif/dif_flash_ctrl.md index 93fdd8d..0cd8da2 100644 --- a/sw/device/lib/dif/dif_flash_ctrl.md +++ b/sw/device/lib/dif/dif_flash_ctrl.md
@@ -2,8 +2,8 @@ title: "Flash Controller DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Flash Controller DIF]({{< relref "hw/ip/flash_ctrl/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Flash Controller DIF](../../../../hw/ip/flash_ctrl/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_gpio.md b/sw/device/lib/dif/dif_gpio.md index 89f0d94..d023030 100644 --- a/sw/device/lib/dif/dif_gpio.md +++ b/sw/device/lib/dif/dif_gpio.md
@@ -2,8 +2,8 @@ title: "GPIO DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [GPIO DIF]({{< relref "hw/ip/gpio/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [GPIO DIF](../../../../hw/ip/gpio/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_hmac.md b/sw/device/lib/dif/dif_hmac.md index 7b55383..6b0480e 100644 --- a/sw/device/lib/dif/dif_hmac.md +++ b/sw/device/lib/dif/dif_hmac.md
@@ -2,8 +2,8 @@ title: "HMAC DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [HMAC DIF]({{< relref "hw/ip/hmac/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [HMAC DIF](../../../../hw/ip/hmac/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_i2c.md b/sw/device/lib/dif/dif_i2c.md index 1ece3b8..8977800 100644 --- a/sw/device/lib/dif/dif_i2c.md +++ b/sw/device/lib/dif/dif_i2c.md
@@ -2,8 +2,8 @@ title: "I2C DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [I2C DIF]({{< relref "hw/ip/i2c/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [I2C DIF](../../../../hw/ip/i2c/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_keymgr.md b/sw/device/lib/dif/dif_keymgr.md index 5aa4d08..af93d25 100644 --- a/sw/device/lib/dif/dif_keymgr.md +++ b/sw/device/lib/dif/dif_keymgr.md
@@ -2,8 +2,8 @@ title: "Key Manager DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Key Manager DIF]({{< relref "hw/ip/keymgr/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Key Manager DIF](../../../../hw/ip/keymgr/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_kmac.md b/sw/device/lib/dif/dif_kmac.md index 0e46336..12cacfb 100644 --- a/sw/device/lib/dif/dif_kmac.md +++ b/sw/device/lib/dif/dif_kmac.md
@@ -2,8 +2,8 @@ title: "KMAC DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [KMAC DIF]({{< relref "hw/ip/kmac/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [KMAC DIF](../../../../hw/ip/kmac/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_lc_ctrl.md b/sw/device/lib/dif/dif_lc_ctrl.md index a37a17f..4ede965 100644 --- a/sw/device/lib/dif/dif_lc_ctrl.md +++ b/sw/device/lib/dif/dif_lc_ctrl.md
@@ -2,8 +2,8 @@ title: "Lifecycle Controller DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Lifecycle Controller DIF]({{< relref "hw/ip/lc_ctrl/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Lifecycle Controller DIF](../../../../hw/ip/lc_ctrl/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_otbn.md b/sw/device/lib/dif/dif_otbn.md index 6193f99..0093c6f 100644 --- a/sw/device/lib/dif/dif_otbn.md +++ b/sw/device/lib/dif/dif_otbn.md
@@ -2,8 +2,8 @@ title: "OTBN DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [OTBN DIF]({{< relref "hw/ip/otbn/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [OTBN DIF](../../../../hw/ip/otbn/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_otp_ctrl.md b/sw/device/lib/dif/dif_otp_ctrl.md index e424002..51ce7f3 100644 --- a/sw/device/lib/dif/dif_otp_ctrl.md +++ b/sw/device/lib/dif/dif_otp_ctrl.md
@@ -2,8 +2,8 @@ title: "OTP Controller DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [OTP Controller DIF]({{< relref "hw/ip/otp_ctrl/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [OTP Controller DIF](../../../../hw/ip/otp_ctrl/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_pattgen.md b/sw/device/lib/dif/dif_pattgen.md index 2c7b753..3f74bc4 100644 --- a/sw/device/lib/dif/dif_pattgen.md +++ b/sw/device/lib/dif/dif_pattgen.md
@@ -2,8 +2,8 @@ title: "Pattern Generator DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Pattern Generator DIF]({{< relref "hw/ip/pattgen/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Pattern Generator DIF](../../../../hw/ip/pattgen/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_pinmux.md b/sw/device/lib/dif/dif_pinmux.md index 8d2bcc5..6440f06 100644 --- a/sw/device/lib/dif/dif_pinmux.md +++ b/sw/device/lib/dif/dif_pinmux.md
@@ -2,8 +2,8 @@ title: "Pin Multiplexer DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Pin Multiplexer DIF]({{< relref "hw/ip/pinmux/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Pin Multiplexer DIF](../../../../hw/ip/pinmux/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_pwm.md b/sw/device/lib/dif/dif_pwm.md index c6a16b3..f911d0b 100644 --- a/sw/device/lib/dif/dif_pwm.md +++ b/sw/device/lib/dif/dif_pwm.md
@@ -2,8 +2,8 @@ title: "PWM DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [PWM DIF]({{< relref "hw/ip/pwm/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [PWM DIF](../../../../hw/ip/pwm/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_pwrmgr.md b/sw/device/lib/dif/dif_pwrmgr.md index 6451b3c..51b60df 100644 --- a/sw/device/lib/dif/dif_pwrmgr.md +++ b/sw/device/lib/dif/dif_pwrmgr.md
@@ -2,8 +2,8 @@ title: "Power Manager DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Power Manager DIF]({{< relref "hw/ip/pwrmgr/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Power Manager DIF](../../../../hw/ip/pwrmgr/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_rom_ctrl.md b/sw/device/lib/dif/dif_rom_ctrl.md index 01cba08..e585d7f 100644 --- a/sw/device/lib/dif/dif_rom_ctrl.md +++ b/sw/device/lib/dif/dif_rom_ctrl.md
@@ -2,8 +2,8 @@ title: "ROM Controller DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [ROM Controller DIF]({{< relref "hw/ip/rom_ctrl/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [ROM Controller DIF](../../../../hw/ip/rom_ctrl/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_rstmgr.md b/sw/device/lib/dif/dif_rstmgr.md index 2f6c05a..d58ddda 100644 --- a/sw/device/lib/dif/dif_rstmgr.md +++ b/sw/device/lib/dif/dif_rstmgr.md
@@ -2,8 +2,8 @@ title: "Reset Manager DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Reset Manager DIF]({{< relref "hw/ip/rstmgr/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Reset Manager DIF](../../../../hw/ip/rstmgr/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_rv_core_ibex.md b/sw/device/lib/dif/dif_rv_core_ibex.md index b7c25ba..d8d3b22 100644 --- a/sw/device/lib/dif/dif_rv_core_ibex.md +++ b/sw/device/lib/dif/dif_rv_core_ibex.md
@@ -2,8 +2,8 @@ title: "Rv core ibex DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Rv core ibex DIF]({{< relref "hw/ip/rv_core_ibex/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Rv core ibex DIF](../../../../hw/ip/rv_core_ibex/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_rv_plic.md b/sw/device/lib/dif/dif_rv_plic.md index 73cd4cf..3923d29 100644 --- a/sw/device/lib/dif/dif_rv_plic.md +++ b/sw/device/lib/dif/dif_rv_plic.md
@@ -2,8 +2,8 @@ title: "PLIC DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [PLIC DIF]({{< relref "hw/top_earlgrey/ip_autogen/rv_plic/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [PLIC DIF](../../../../hw/top_earlgrey/ip_autogen/rv_plic/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_rv_timer.md b/sw/device/lib/dif/dif_rv_timer.md index 6b9fa55..d527ad4 100644 --- a/sw/device/lib/dif/dif_rv_timer.md +++ b/sw/device/lib/dif/dif_rv_timer.md
@@ -2,8 +2,8 @@ title: "RV Timer DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [RV Timer DIF]({{< relref "hw/ip/rv_timer/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [RV Timer DIF](../../../../hw/ip/rv_timer/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_sensor_ctrl.md b/sw/device/lib/dif/dif_sensor_ctrl.md index 2791508..0aaf497 100644 --- a/sw/device/lib/dif/dif_sensor_ctrl.md +++ b/sw/device/lib/dif/dif_sensor_ctrl.md
@@ -2,8 +2,8 @@ title: "Sensor Controller DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [Sensor Controller DIF]({{< relref "hw/top_earlgrey/ip/sensor_ctrl/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [Sensor Controller DIF](../../../../hw/top_earlgrey/ip/sensor_ctrl/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Not Started | Tests | [DIF_TEST_ON_DEVICE][] | Not Started | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | In Progress | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_spi_device.md b/sw/device/lib/dif/dif_spi_device.md index 10e011d..3a6d07a 100644 --- a/sw/device/lib/dif/dif_spi_device.md +++ b/sw/device/lib/dif/dif_spi_device.md
@@ -2,8 +2,8 @@ title: "SPI Device DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [SPI Device DIF]({{< relref "hw/ip/spi_device/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SPI Device DIF](../../../../hw/ip/spi_device/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_spi_host.md b/sw/device/lib/dif/dif_spi_host.md index 127edaf..d1f4429 100644 --- a/sw/device/lib/dif/dif_spi_host.md +++ b/sw/device/lib/dif/dif_spi_host.md
@@ -2,8 +2,8 @@ title: "SPI Host DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [SPI Host DIF]({{< relref "hw/ip/spi_host/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SPI Host DIF](../../../../hw/ip/spi_host/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_sram_ctrl.md b/sw/device/lib/dif/dif_sram_ctrl.md index ecf874d..2bf014d 100644 --- a/sw/device/lib/dif/dif_sram_ctrl.md +++ b/sw/device/lib/dif/dif_sram_ctrl.md
@@ -2,8 +2,8 @@ title: "SRAM Controller DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [SRAM Controller DIF]({{< relref "hw/ip/sram_ctrl/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [SRAM Controller DIF](../../../../hw/ip/sram_ctrl/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_sysrst_ctrl.md b/sw/device/lib/dif/dif_sysrst_ctrl.md index 34c6f37..51e70ad 100644 --- a/sw/device/lib/dif/dif_sysrst_ctrl.md +++ b/sw/device/lib/dif/dif_sysrst_ctrl.md
@@ -2,8 +2,8 @@ title: "System Reset Controller DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [System Reset Controller DIF]({{< relref "hw/ip/sysrst_ctrl/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [System Reset Controller DIF](../../../../hw/ip/sysrst_ctrl/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_uart.md b/sw/device/lib/dif/dif_uart.md index 5edbb40..612f689 100644 --- a/sw/device/lib/dif/dif_uart.md +++ b/sw/device/lib/dif/dif_uart.md
@@ -2,8 +2,8 @@ title: "UART DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [UART DIF]({{< relref "hw/ip/uart/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [UART DIF](../../../../hw/ip/uart/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/dif/dif_usbdev.md b/sw/device/lib/dif/dif_usbdev.md index 0c1c2d1..7910277 100644 --- a/sw/device/lib/dif/dif_usbdev.md +++ b/sw/device/lib/dif/dif_usbdev.md
@@ -2,8 +2,8 @@ title: "USB Device DIF Checklist" --- -This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [USB Device DIF]({{< relref "hw/ip/usbdev/doc" >}}). -All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). +This checklist is for [Development Stage](../../../../doc/project_governance/development_stages.md) transitions for the [USB Device DIF](../../../../hw/ip/usbdev/README.md). +All checklist items refer to the content in the [Checklist](../../../../doc/project_governance/checklist/README.md). <h2>DIF Checklist</h2> @@ -15,19 +15,19 @@ Implementation | [DIF_USED_IN_TREE][] | Done | Tests | [DIF_TEST_ON_DEVICE][] | Done | -[DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif_exists" >}} -[DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif_used_in_tree" >}} -[DIF_TEST_ON_DEVICE]: {{< relref "/doc/project/checklist.md#dif_test_on_device" >}} +[DIF_EXISTS]: ../../../../doc/project_governance/checklist/README.md#dif_exists +[DIF_USED_IN_TREE]: ../../../../doc/project_governance/checklist/README.md#dif_used_in_tree +[DIF_TEST_ON_DEVICE]: ../../../../doc/project_governance/checklist/README.md#dif_test_on_device <h3>S2</h3> Type | Item | Resolution | Note/Collaterals ---------------|-----------------------------|-------------|------------------ -Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard]({{< relref "hw" >}}) +Coordination | [DIF_HW_FEATURE_COMPLETE][] | Done | [HW Dashboard](../../../../hw/README.md) Implementation | [DIF_FEATURES][] | Done | -[DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_feature_complete" >}} -[DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif_features" >}} +[DIF_HW_FEATURE_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_feature_complete +[DIF_FEATURES]: ../../../../doc/project_governance/checklist/README.md#dif_features <h3>S3</h3> @@ -42,9 +42,9 @@ Review | Reviewer(s) | Not Started | Review | Signoff date | Not Started | -[DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_design_complete" >}} -[DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_hw_verification_complete" >}} -[DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif_doc_hw" >}} -[DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif_code_style" >}} -[DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif_test_unit" >}} -[DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif_todo_complete" >}} +[DIF_HW_DESIGN_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_design_complete +[DIF_HW_VERIFICATION_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_hw_verification_complete +[DIF_DOC_HW]: ../../../../doc/project_governance/checklist/README.md#dif_doc_hw +[DIF_CODE_STYLE]: ../../../../doc/project_governance/checklist/README.md#dif_code_style +[DIF_TEST_UNIT]: ../../../../doc/project_governance/checklist/README.md#dif_test_unit +[DIF_TODO_COMPLETE]: ../../../../doc/project_governance/checklist/README.md#dif_todo_complete
diff --git a/sw/device/lib/testing/README.md b/sw/device/lib/testing/README.md index c38c326..65e3d49 100644 --- a/sw/device/lib/testing/README.md +++ b/sw/device/lib/testing/README.md
@@ -4,20 +4,20 @@ # Overview -This subtree contains _test library code_ that could aid in the writing of [chip-level tests]({{< relref "sw/device/tests/index.md" >}}). +This subtree contains _test library code_ that could aid in the writing of [chip-level tests](../../tests/README.md). Test library code consists of two components: 1. `testutils` libraries, and -2. the [on-device test framework]({{< relref "sw/device/lib/testing/test_framework/index.md" >}}). +2. the [on-device test framework](./test_framework/README.md). Functions in `testutils` libraries are designed to wrap several DIF invocations that are commonly used together across many chip-level tests. They are _not_ designed to wrap a single DIF call. -The [on-device test framework]({{< relref "sw/device/lib/testing/test_framework/index.md" >}}) provides a generic platform for writing chip-level tests. +The [on-device test framework](./test_framework/README.md) provides a generic platform for writing chip-level tests. # Style Guide - All `testutils` libraries should be placed in `sw/device/lib/testing/*` -- The [on-device test framework]({{< relref "sw/device/lib/testing/test_framework/index.md" >}}) +- The [on-device test framework](./test_framework/README.md) code will live in: `sw/device/lib/testing/test\_framework`. - `testutils` libraries will be named: `<IP or functionality name>_testutils.<h,c>` - All `testutils` function names should take on the following format: `<IP or functionality name>_testutils_<function name>()`. @@ -31,6 +31,6 @@ - Pass-through `sw/device/lib/dif_base.h` types where appropriate. This allows testutils functions to easily mix with DIFs within chip-level tests. - Avoid defining testutils that call a single DIF, and use the DIF directly. - If a DIF does not exist for your needs, create one by following the [DIF development guide]({{< relref "sw/device/lib/dif" >}}). + If a DIF does not exist for your needs, create one by following the [DIF development guide](../dif/README.md). {{% sectionContent %}}
diff --git a/sw/device/lib/testing/test_framework/README.md b/sw/device/lib/testing/test_framework/README.md index 09e4527..754cf78 100644 --- a/sw/device/lib/testing/test_framework/README.md +++ b/sw/device/lib/testing/test_framework/README.md
@@ -6,13 +6,13 @@  -[Chip-level tests]({{< relref "sw/device/tests/index.md" >}}) are designed to be executed across all OpenTitan verification targets DV simulation, Verilator simulation, FPGA, and (eventually) silicon, using host-side test initiation tools, and an on-device test framework, as shown in the figure above. +[Chip-level tests](../../../tests/README.md) are designed to be executed across all OpenTitan verification targets DV simulation, Verilator simulation, FPGA, and (eventually) silicon, using host-side test initiation tools, and an on-device test framework, as shown in the figure above. On the _host_ side, two main tools are used to initiate tests on the device. For the DV simulation target, the [dvsim.py](https://github.com/lowRISC/opentitan/blob/master/util/dvsim/dvsim.py) tool is used, while for Verilator and FPGA targets, Bazel (and `opentitantool`) is used. Focusing on the _device_ side, for all three targets, the [on-device test framework](https://github.com/lowRISC/opentitan/blob/master/sw/device/lib/testing/test_framework/test_main.c) is used to provide a uniform execution environment for chip-level tests. The [on-device test framework](https://github.com/lowRISC/opentitan/blob/master/sw/device/lib/testing/test_framework/test_main.c) provides boilerplate setup code that configures the UART for communicating messages and test results back to the host. # Writing a Chip-Level Test -To write a chip-level test that uses this framework, one must create a new C file for the test (see [Chip-Level Tests]({{< relref "sw/device/tests/index.md">}}) for where to place this test) and follow the steps below. +To write a chip-level test that uses this framework, one must create a new C file for the test (see [Chip-Level Tests](../../../tests/README.md) for where to place this test) and follow the steps below. ## Test Setup Each chip-level test must contain the following boilerplate setup code:
diff --git a/sw/device/silicon_creator/rom/README.md b/sw/device/silicon_creator/rom/README.md index 5cd3ca3..394e740 100644 --- a/sw/device/silicon_creator/rom/README.md +++ b/sw/device/silicon_creator/rom/README.md
@@ -269,5 +269,5 @@ <!-- Links --> -[csm-secure-boot]: {{< relref "doc/security/specs/secure_boot" >}} -[rom-ext-manifest]: {{< relref "sw/device/silicon_creator/rom_ext/docs/manifest" >}} +[csm-secure-boot]: ../../../../doc/security/specs/secure_boot/README.md +[rom-ext-manifest]: ../rom_ext/doc/manifest.md
diff --git a/sw/device/tests/README.md b/sw/device/tests/README.md index 4aef402..c378b60 100644 --- a/sw/device/tests/README.md +++ b/sw/device/tests/README.md
@@ -4,7 +4,7 @@ # Overview -This subtree contains three types of chip-level tests that are capable of running across all OpenTitan verification targets, using the [on-device test framework]({{< relref "sw/device/lib/testing/test_framework/index.md" >}}). +This subtree contains three types of chip-level tests that are capable of running across all OpenTitan verification targets, using the [on-device test framework](../lib/testing/test_framework/README.md). These targets include: DV simulation, Verilator simulation, FPGA, and eventually silicon. # Test Types @@ -36,13 +36,13 @@ ### Subfoldering Target-Specific Tests Ideally all smoke, IP integration, and system-level tests should be target agnostic. However, some tests require emulation of host capabilities, such as an external SPI or I2C host, an external host to encrypt/decrypt data, or an external host that toggles GPIO pins. -Eventually, host-side test initiation tools and the [on-device test framework]({{< relref "sw/device/lib/testing/test_framework/index.md" >}}) will make host emulation opaque to each chip-level test. +Eventually, host-side test initiation tools and the [on-device test framework](../lib/testing/test_framework/README.md) will make host emulation opaque to each chip-level test. However, until then, host emulation depends on the target (e.g., DV vs. Verilator simulation). Therefore, chip-level tests that require external stimulation from the host, will be subfoldered by target, under the appropriate toplevel folder above. One example of such a test is the [`sw/device/tests/sim_dv/gpio_test.c`](https://github.com/lowRISC/opentitan/blob/master/sw/device/tests/sim_dv/gpio_test.c), which is subfoldered under `../sim_dv/` to indicate it is a target-specific test. # Writing a Chip-Level Test -For instructions on how to write a chip-level test, refer to the [on-device test framework]({{< relref "sw/device/lib/testing/test_framework/index.md" >}}) page. +For instructions on how to write a chip-level test, refer to the [on-device test framework](../lib/testing/test_framework/README.md) page. # List of Tests
diff --git a/sw/doc/build_software.md b/sw/doc/build_software.md index b1af82e..062fe66 100644 --- a/sw/doc/build_software.md +++ b/sw/doc/build_software.md
@@ -11,4 +11,4 @@ bazel test --test_output=streamed //sw/device/tests:uart_smoketest_sim_verilator ``` -The resulting binaries will be located under `bazel-out/`. For more information, check out [the Building Software guide]({{< relref "doc/getting_started/build_sw" >}}). +The resulting binaries will be located under `bazel-out/`. For more information, check out [the Building Software guide](../../doc/guides/getting_started/src/build_sw.md).
diff --git a/util/README.md b/util/README.md index 71f9378..e62e78c 100644 --- a/util/README.md +++ b/util/README.md
@@ -2,13 +2,13 @@ title: "Reference Manuals" --- -* [Comportability Definition and Specification]({{< relref "comportability_specification" >}}) -* [Device Interface Function (DIF) Specification]({{< relref "device_interface_functions" >}}) +* [Comportability Definition and Specification](../doc/contributing/hw/comportability/README.md) +* [Device Interface Function (DIF) Specification](../doc/contributing/sw/device_interface_functions.md) * Tool Guides - * [Topgen Tool]({{< relref "topgen_tool" >}}): Describes `topgen.py` and its Hjson format source. Used to generate rtl and validation files for top specific modules such as PLIC, Pinmux and crossbar. - * [Register Tool]({{< relref "register_tool" >}}): Describes `regtool.py` and its Hjson format source. Used to generate documentation, rtl, header files and validation files for IP Registers and toplevel. - * [Ipgen Tool]({{< relref "ipgen_tool" >}}): Describes `ipgen.py` and its Hjson control file. Used to generate IP blocks from IP templates. - * [Crossbar Tool]({{< relref "crossbar_tool" >}}): Describes `tlgen.py` and its Hjson format source. Used to generate self-documentation, rtl files of the crossbars at the toplevel. - * [Vendor-In Tool]({{< relref "vendor_in_tool" >}}): Describes `util/vendor.py` and its Hjson control file. Used to pull a local copy of code maintained in other upstream repositories and apply local patch sets. -* [FPGA Reference Manual]({{< relref "ref_manual_fpga.md" >}}) + * [Topgen Tool](./topgen/README.md): Describes `topgen.py` and its Hjson format source. Used to generate rtl and validation files for top specific modules such as PLIC, Pinmux and crossbar. + * [Register Tool](./reggen/README.md): Describes `regtool.py` and its Hjson format source. Used to generate documentation, rtl, header files and validation files for IP Registers and toplevel. + * [Ipgen Tool](./ipgen/README.md): Describes `ipgen.py` and its Hjson control file. Used to generate IP blocks from IP templates. + * [Crossbar Tool](./tlgen/README.md): Describes `tlgen.py` and its Hjson format source. Used to generate self-documentation, rtl files of the crossbars at the toplevel. + * [Vendor-In Tool](./doc/vendor.md): Describes `util/vendor.py` and its Hjson control file. Used to pull a local copy of code maintained in other upstream repositories and apply local patch sets. +* [FPGA Reference Manual](../doc/contributing/fpga/ref_manual_fpga.md) * [OpenTitan Continuous Integration]({{< relref "continuous_integration.md" >}})
diff --git a/util/check_links.py b/util/check_links.py new file mode 100755 index 0000000..cec0094 --- /dev/null +++ b/util/check_links.py
@@ -0,0 +1,653 @@ +#!/usr/bin/env python3 +# Copyright lowRISC contributors. +# Licensed under the Apache License, Version 2.0, see LICENSE for details. +# SPDX-License-Identifier: Apache-2.0 + +from pathlib import Path +import tomli +import re +import argparse + + +parser = argparse.ArgumentParser() +parser.add_argument("--debug", + help = "print debugging information (very verbose)", + action="store_true") +parser.add_argument("--debug-only-file", + help = "only process a particular file (helpful to debug)",) +parser.add_argument("--debug-only-line", + help = "only process a particular file (helpful to debug)",) +parser.add_argument("--apply-suggestions", + help = "apply all the fixes suggested by the tools", + action="store_true") +parser.add_argument("--pedantic-reldir", + help = "be especially pedantic about relative path using ./", + action="store_true") +parser.add_argument("root_doc", + help = "path to the root of documentation") +parser.add_argument("--warn-internal-weblinks", + help = "warn about links to internal documentation using docs.opentitan.org URLs", + action=argparse.BooleanOptionalAction, + default = True) +parser.add_argument("--warn-unlisted-files", + help = "warn about md files that are not listed in SUMMARY.md", + action=argparse.BooleanOptionalAction, + default = True) +parser.add_argument("--warn-hugo-links", + help = "warn about links using the old Hugo format", + action=argparse.BooleanOptionalAction, + default = True) +parser.add_argument("--move-list-file", + help = "provide a list of moved files to help fix the links") +parser.add_argument("--ignore-book", + help = "do not search for mdbook and just check all markdown files in a directory", + action="store_true") +g_args = parser.parse_args() + + +def debug(msg): + if g_args.debug: + print("[debug] " + msg) + + +def parse_move_list_file(path): + if not path.exists() or not path.is_file(): + print(f"error: move file list {path} does not exist or is not a file") + return None + with path.open() as f: + res = {} + line_nr = 0 + for line in f: + line_nr += 1 + if line.strip() == "": + continue + # ignore empty lines and split at whitespace + arr = line.strip().split() + if len(arr) != 2: + print("move file list f{path}: f{line_nr} has the wrong format and will be ignored") + continue + res[arr[0]] = arr[1] + return res + + +g_move_list_file = None +if g_args.move_list_file: + g_move_list_file = parse_move_list_file(Path(g_args.move_list_file)) + + +class Book: + """ + Represents an mdbook + """ + + def __init__(self, path): + """ + Load a book by pointing to the directory containing a book.toml + This is will build the list of files listed in SUMMARY.md + and also build the list of all md files under this directory + """ + self.path = path.resolve() + self.mdbook_defaults = ["README.md", "index.md"] + self.site_url = "NO_URL" + global g_args + if g_args.ignore_book: + # create a fake book + self.srcdir = path + else: + self._load_book(path) + # build list of all files that appear in the subdirectory + # for each file we will eventually set to True if they are listed in summary + self.allmdfiles = {} + + def addfile(f): + name = self.local_name(f) + self.allmdfiles[name] = False + self.apply_to_all_files(addfile) + # load summary + if not g_args.ignore_book: + self._load_summary() + + def _load_book(self, path): + toml = self.path / "book.toml" + assert toml.exists(), "there is not book.toml" + toml_dict = tomli.loads(toml.read_bytes().decode("utf-8")) + self.srcdir = (path / toml_dict["book"]["src"]).resolve() + if "output" in toml_dict and "html" in toml_dict["output"]: + self.site_url = toml_dict["output"]["html"].get("site-url", self.site_url) + + def _load_summary(self): + # load summary and mark all links as true, ignore all errors for now + for (line, _, link) in Book.list_links_in_file(self.srcdir / "SUMMARY.md"): + name = self.local_name(self.srcdir / link) + # we only check .md files, SUMMARY.md can include more types of files + # with preprocessors + if name.name.endswith(".md"): + # if ever SUMMARY.md contains an invalid link, ignore it (it will reported by the general check) + if name in self.allmdfiles: + # assert name in self.allmdfiles, f"book at {self.path}: link {link} in summary is invalid (normalized to {str(name)})" + self.allmdfiles[name] = True + + def __repr__(self): + return f"Book({repr(self.path)})" + + def __str__(self): + return f"book at {str(self.path)}, src at {str(self.srcdir)}, url at {str(self.site_url)}" + + def local_name(self, abspath): + """ + Given an absolute Path to a file under the source directory of the book, + return a relative Path to the source directory, return None in case of error + """ + try: + return abspath.resolve().relative_to(self.srcdir) + except ValueError: + return None + + def apply_to_all_files(self, fn): + """ + List all files under the directory of the book and call a function on each one + """ + def apply_rec(path): + for child in path.iterdir(): + if child.name.endswith(".md"): + fn(child) + if child.is_dir(): + apply_rec(child.resolve()) + apply_rec(self.path) + + def list_links_in_file(abspath): + """ + Return a list of all the links in a file (given by its absolute Path) + Each entry is a tuple of the form (line_nr, (start, end), link) + indicating the line number, the character range within the line and the link itself + """ + cm_re = r"\[[^\]]*\]\(\s*(?P<url>[^)]*)\s*\)" + # we also look for non-markdown-but-Hugo-relref + hugo_relref_re = r"(?P<hugo>\{\{<\s*relref\s*\"[^\"]*\"\s*>\}\})" + prog = re.compile(f"{cm_re}|{hugo_relref_re}") + links = [] + with abspath.open() as f: + line_nr = 0 + for line in f: + line_nr += 1 + for x in prog.finditer(line): + grp = "url" if x.group("url") is not None else "hugo" + posrange = (x.start(grp), x.end(grp)) + links.append((line_nr, posrange, x[grp])) + return links + + def is_file_in_summary(self, path): + """ + Check whether a file (given by its absolute Path) is in the SUMMARY.md file of the book + """ + # if the file does not exists, it cannot be in summary + if not path.exists() or not path.is_file(): + return False + local_name = self.local_name(path) + # if it points to an md file, it must be in the summary + assert path.name.endswith(".md"), f"this function only works for md files, called on {path}" + assert local_name in self.allmdfiles, f"link to \"{path}\" normalised to {local_name} not in list" + return self.allmdfiles[local_name] + + def path_exists_or_was_moved(self, path, reverse_move=False): + """ + This function takes a Path and returns a Path to the file, which could be potentially + different if the file was moved. This function handles file moves as recorded in the + move file list. It returns None if it cannot resolve it to an *existing* file or directory. + """ + global g_move_list_file + move_list_file = g_move_list_file + if move_list_file is None: + move_list_file = {} + # reverse map if asked + if reverse_move: + res = {} + for (from_, to) in move_list_file.items(): + res[to] = from_ + move_list_file = res + # first check if it was moved because it could be that a file was moved + # and later replaced by another file with different content: the move takes priority + local_name = self.local_name(path) + debug(f"CHECK MOVE {path}, normalized to {local_name}, exists {path.exists()}, reverse {reverse_move}, moved {str(local_name) in move_list_file}") + if local_name is None: + return None + if str(local_name) in move_list_file: + moved_to = move_list_file[str(local_name)] + assert moved_to[0] != '/', "the target of a move cannot be an absolute path" + newpath = self.srcdir / moved_to + # we only check new path existence for non-reverse moved + if reverse_move or newpath.exists(): + debug(f"move detected {path}, normalize to {local_name}, now {newpath}") + return newpath + if path.exists(): + return path + return None + + def _resolve_existing_path(self, path, report): + """ + Given a Path to an existing file/directory, figure out what is the intended markdown target. + This handles for example a link to a directory that contains an README.md. + This returns a Path to the intended markdown file, or None if none could be found. + When retuning None, it will report the error using the report function. + """ + # if it points to a directory, we try to resolve it to README.md or index.md + if path.is_dir(): + for subfile in self.mdbook_defaults: + if (path / subfile).exists(): + return path / subfile + report( + f"link to directory \"{self.local_name(path)}\" but cannot find a valid subfile, tried {self.mdbook_defaults}") + return None + else: + return path + + def resolve_relative_link(self, local_filename, link, relative_to, report): + """ + Given a link (a string) in a file (represented by its relative Path to the source directory), + try to find the Path to the intended markdown target and return it. + If none can be found, returns None. Any error/warning will reporting via the report function. + This function will handle things like pointing to directories, using index.html instead of README.md + and other oddities. + """ + # if the link starts with a '/', this will mess with pathlib because bla / link will just produce bla + # but we want the link to relative to what was specified, so remove the initial '/' if needed + while len(link) > 0 and link[0] == '/': + link = link[1:] + debug(f"resolving {link} relative to {local_filename}") + # there are several cases: + # - points to a file + # - points to a directory + path = (relative_to / link).resolve() + if (newpath := self.path_exists_or_was_moved(path)) is not None: + return self._resolve_existing_path(newpath, report) + debug("direct resolution to a moved file has failed") + # if the link ends with index.html, and the corresponding index.md or README.md file exists + # then resolve it to that file + index_html = "index.html" + if link.endswith(index_html): + for subfile in self.mdbook_defaults: + new_link = link[:-len(index_html)] + subfile + path = (relative_to / new_link).resolve() + if (newpath := self.path_exists_or_was_moved(path)) is not None: + # FIXME should we check that this is in the summary? + report( + f"link to HTML file \"{link}\", resolved to \"{self.local_name(newpath)}\", which is a local file") + return path + # no solution found + report( + f"link to \"{link}\", resolved to \"{self.local_name(path)}\", which does not exists") + return None + + def resolve_local_link(self, local_filename, link, report): + return self.resolve_relative_link(local_filename, link, (self.srcdir / local_filename).parent, report) + + def resolve_global_link(self, local_filename, link, report): + return self.resolve_relative_link(local_filename, link, self.srcdir, report) + + +def find_all_books(path): + """ + Return a list of Book constructed from the book.toml files that can be + found under path (recursively). + """ + books = [] + for child in path.iterdir(): + if child.is_dir(): + books.extend(find_all_books(child)) + if child.is_file() and child.name == "book.toml": + books.append(Book(path)) + return books + + +def relative_link_to(relpath, relative_to_dir): + """ + Given an absolute Path to a file (or directory) and an absolute Path to a directory, + return a relative path to reach the file from the directory. + For example relative_link_to(/path/to/some/very/deep/file/hello.md, /path/to/a/shallow/dir) + returns ../../../some/very/deep/file/hello.md + """ + parent = relative_to_dir.resolve() + pref = "./" + while True: + try: + out = relpath.relative_to(parent) + return pref + str(out) + except ValueError: + parent = parent.parent + if pref == "./": + pref = "../" + else: + pref += "../" + print( + f"ERROR couldn't create link for {relpath} relative to {relative_to_dir.resolve()}, this should never happen") + return None + +# decide when to suggest a link rewriting +# the main to detect here is that some links are of theform x +# but the canonical link would be just "./x" +# at this stage we don't want to bother the use with such nonsense + + +def should_rewrite_link(newlink, oldlink): + if oldlink == newlink: + return False + if newlink == "./" + oldlink and not g_args.pedantic_reldir: + return False + return True + + +def try_several_resolutions(book, local_filename, link, process_list, report): + """ + This function tries to resolve a link is several different ways by + calling the various functions in the processing list. To make the + user output readable, it will not forward any of the report/suggestions + unless the list has size 1 or the function suceeds. If no function suceeds, + it will print error message saying that + no rule applied. + """ + if (process_list) == 1: + return process_list[0](book, local_filename, link, report) + # try them one by one + for fn in process_list: + action_list = [] + + def store_report(*args): + action_list.append(("report", *args)) + out = fn(book, local_filename, link, store_report) + if out is None: + continue + # do actions + for act in action_list: + if act[0] == "report": + report(*act[1:]) + else: + assert False + return out + report(f"could not resolve \"{link}\"") + return None + + +def process_path(book, local_filename, path, report): + # check that path is in the summary (for md files) + global g_args + if path.name.endswith(".md") and not book.is_file_in_summary(path) and not g_args.ignore_book: + report(f"link to \"{book.local_name(path)}\", which is not listed in SUMMARY.md") + # at the moment, report the error but consider this a good link nonetheless + return path # this link is ok + + +def _process_relative_link(book, local_filename, link, report): + # at this point, we know this is a local link and we want to check it + # but also suggest some changes if we can figure out how to fix/lint it + # the following function tries to resolve where this link should point to + # then we compute how it should be written in the file + # and if the result is different from the original, we suggest a rewrite + debug(f"processing local link {link}") + + path = book.resolve_local_link(local_filename, link, report) + debug(f"local link resolution gave {path}") + if path is None: + # cannot resolve link, assume that resolve_local_link reported the error + return + return process_path(book, local_filename, path, report) + + +def __process_hugo_relref(book, local_filename, link, report, local_search): + # relref can either be relative path to this file or relative path + # to the root of the documentation + + debug(f"internal processing hugo link {link}") + + if local_search: + if link.startswith('/'): + return None + return _process_relative_link(book, local_filename, link, report) + else: + debug(f"try to resolve global link {link}") + path = book.resolve_global_link(local_filename, link, report) + if path is None: + # cannot resolve link, assume that resolve_global_link reported the error + return None + return process_path(book, local_filename, path, report) + + +def _process_hugo_relref(book, local_filename, link, report): + # Hugo references can do things like pointing to a file bla.md just by writing bla + # this is makes it quite tricky since when we start mixing this up with move file + # rewriting or guess of directories, there is no easy way to detect when we should + # add .md to the link; similarly a link can point to a directory x/ in which case + # it should be understood as pointing to x/_index.md or x/index.md + # the solution is just to try with and without it + debug(f"processing hugo relref {link}") + + def add_md(book, local_filename, link, report, local_search): + if link.endswith(".md"): + return None + return __process_hugo_relref(book, local_filename, link + ".md", report, local_search) + + def add_subfile(book, local_filename, link, report, subfile, local_search): + if link.endswith(".md"): + return None + suff = subfile if link.endswith('/') else '/' + subfile + return __process_hugo_relref(book, local_filename, link + suff, report, local_search) + # not that we try add .md only if the first (normal) resolution fails + # following Hugo's documentation, we first try to resolve it relatively + # to this file and then relatively to the repo (unless it starts with / + # in which case it cannot be a relative link) + processes = [ + # LOCAL search + lambda *arg: __process_hugo_relref(*arg, True), # normal processing + lambda *arg: add_md(*arg, True), # try to add .md add the end + lambda *arg: add_subfile(*arg, "index.md", True), # try to add /index.md + lambda *arg: add_subfile(*arg, "_index.md", True), # try to add /_index.md + # GLOBAL search + lambda *arg: __process_hugo_relref(*arg, False), # normal processing + lambda *arg: add_md(*arg, False), # try to add .md add the end + lambda *arg: add_subfile(*arg, "index.md", False), # try to add /index.md + lambda *arg: add_subfile(*arg, "_index.md", False), # try to add /_index.md + ] + return try_several_resolutions(book, local_filename, link, processes, report) + + +def split_anchor_and(book, local_filename, link, process, report): + arr = link.split("#") + if len(arr) > 2: + report(f"link \"{link}\" is weird, giving up on that one") + return + base = arr[0] + anchor = "#" + arr[1] if len(arr) == 2 else '' + if base == "": + return + debug(f"split link to base \"{base}\" and fragment \"{anchor}\"") + path = process(book, local_filename, base, report) + if path is None: + return None + else: + return (path, anchor) + + +def process_relative_link(book, local_filename, link, report): + return split_anchor_and(book, local_filename, link, _process_relative_link, report) + + +def process_hugo_relref(book, local_filename, link, report): + return split_anchor_and(book, local_filename, link, _process_hugo_relref, report) + + +def show_unlisted_files(book): + print(f"#### {book.path} ####") + # check files not in summary + header_printed = False + for (name, in_summary) in book.allmdfiles.items(): + # obviously ignore SUMMARY.md + if not in_summary and name.name != "SUMMARY.md": + if not header_printed: + print("Files not listed in SUMMARY.md:") + header_printed = True + print(f"- {name}") + + +# we will store the list of all suggestions and rewrite everything at the end +# for extra safety, when recording a suggestion, we not only memorize what +# we should change to, but also what we are changing from +# when doing the changes, we will check that this matches +g_suggestions = {} + + +def add_suggestion(path, line_nr, pos_range, oldvalue, newvalue): + path = path.resolve() + ff = g_suggestions.get(path, {}) + ll = ff.get(line_nr, {}) + ll[pos_range] = (oldvalue, newvalue) + ff[line_nr] = ll + g_suggestions[path] = ff + +# apply all suggestions in a file + + +def apply_suggestions(filename, suggestions): + out_content = "" + with filename.open() as f: + print(filename) + line_nr = 0 + for line in f: + line_nr += 1 + if line_nr in suggestions: + pos_delta = 0 + for ((start, end), (oldvalue, newvalue)) in sorted(suggestions[line_nr].items(), key=lambda x: x[0][0]): + # adjust + start += pos_delta + end += pos_delta + # we make sure that the bit that we are replacing matches what it is supposed to replace + # this is just for extra safety, if there is no bug this assert will always hold + assert line[start: + end] == oldvalue, f"mismatch between expected old value ({oldvalue}) and actual old value ({line[start:end]})" + line = line[:start] + newvalue + line[end:] + # change delta + pos_delta += len(newvalue) - len(oldvalue) + out_content += line + filename.write_text(out_content) + + +def check_all_links(book): + global g_args + hugo_relref_prog = re.compile(r"^\{\{<\s*relref\s*\"(?P<url>[^\"]*)\"\s*>\}\}$") + print(f"#### {book.path} ####") + # for all listed file, check links + for (name, in_summary) in book.allmdfiles.items(): + # debugging check + if g_args.debug_only_file is not None: + local_only_name = book.local_name(Path(g_args.debug_only_file)) + if local_only_name != name: + continue # skip file + # we ignore files that are not in the summary (but we do check SUMMARY.md for bad links) + # warning: the check for SUMMARY.md needs to be sure to only consider SUMMARY.md at the root + # of the book, there could be others SUMMARY.md in the tree that are unrelated, we don't want to + # include those if they are not listed + if not g_args.ignore_book and not in_summary and name == Path("SUMMARY.md"): + continue # skip file + # get links + header_printed = False + for (line_nr, posrange, link) in Book.list_links_in_file(book.srcdir / name): + # debugging check + oldname = None + if g_args.debug_only_line is not None: + only_line = int(g_args.debug_only_line) + if line_nr != only_line: + continue # skip line + + def suggest(newvalue): + add_suggestion(book.srcdir / name, line_nr, posrange, link, newvalue) + + def report(msg): + # it's global because the whole code is not in a function and nonlocal does not work in this case + nonlocal header_printed + if not header_printed: + if oldname is not None and oldname != name: + print(f"In {name} (previously {oldname}):") + else: + print(f"In {name}:") + header_printed = True + print(f"- line {line_nr}: {msg}") + + def maybe_suggest_rewrite(res): + if res is None: + return + (path, fragment) = res + # this link is good but maybe it is not written in the canonical way, warn about that + relpath = relative_link_to(path, (book.srcdir / name).parent) + newlink = str(relpath) + fragment + if should_rewrite_link(newlink, link): + report(f"link \"{link}\" resolved to \"{newlink}\"") + report(f"SUGGEST rewrite link to \"{newlink}\"") + suggest(newlink) + # link to internal doc that use the opentitan url + if link.startswith("https://docs.opentitan.org/"): + if g_args.warn_internal_weblinks: + report(f"link {link} points to internal document, use URL_ROOT or local link") + continue + # if this file was moved, we need to make sure that the relative links that we compute + # are relative to the old position of the file + oldname = book.local_name(book.path_exists_or_was_moved(book.srcdir / name, True)) + if oldname != name: + debug(f"file {name} was previously {oldname}") + # old Hugo links + if link.startswith("{{<") or link.startswith("{{%"): + # this tool only understands a tiny subset of those + x = hugo_relref_prog.match(link) + if x is not None: + res = process_hugo_relref(book, oldname, x["url"], report) + maybe_suggest_rewrite(res) + elif g_args.warn_hugo_links: + report(f"link \"{link}\" uses old Hugo syntax") + continue + # URL outside of our doc or mailto + if link.startswith("https://") or link.startswith("mailto:"): + # ignore + continue + # unsecure url + if link.startswith("http://"): + report(f"url {link} is not secure") + continue + # cross-book links, not checking those yet + if link.startswith("{{URL_ROOT}}"): + report(f"link \"{link}\" NOT CHECKED") + continue + + # try to resolve the path and suggest a rewriting if necessary + res = process_relative_link(book, oldname, link, report) + maybe_suggest_rewrite(res) + + +g_root_doc = Path(g_args.root_doc).resolve() +# if root doc is a link to a book.toml file, just open this one +if g_root_doc.is_file(): + assert g_root_doc.name == "book.toml", "you must give a path a book.toml file or a directory" + g_book_list = [Book(g_root_doc.parent)] +elif g_args.ignore_book: + # create a fake book that contains everything + g_book_list = [Book(g_root_doc)] +else: + g_book_list = find_all_books(g_root_doc) +print("books:") +for p in g_book_list: + print("- {}".format(p)) + +# find all md files in the tree that are not listed in any SUMMARY.md +if not g_args.ignore_book and g_args.warn_unlisted_files: + for book in g_book_list: + show_unlisted_files(book) + +for book in g_book_list: + check_all_links(book) + +print("### Summary of suggestions ###") +for (filename, per_file) in g_suggestions.items(): + print(f"In {filename}:") + for (line_nr, per_line) in per_file.items(): + for (posrange, (oldvalue, newvalue)) in per_line.items(): + print(f"- line {line_nr},{posrange[0]}-{posrange[1]}: \"{oldvalue}\" -> \"{newvalue}\"") + +if g_args.apply_suggestions: + for (filename, per_file) in g_suggestions.items(): + apply_suggestions(filename, per_file)
diff --git a/util/container/README.md b/util/container/README.md index 3ee2943..f560fee 100644 --- a/util/container/README.md +++ b/util/container/README.md
@@ -2,7 +2,7 @@ Docker container based on Ubuntu 18.04 LTS containing various hardware and software development tools for OpenTitan, as listed in the -[OpenTitan documentation]({{< relref "doc/getting_started" >}}). +[OpenTitan documentation](../../doc/guides/getting_started/src/README.md). ## Local Build Instructions
diff --git a/util/dvsim/README.md b/util/dvsim/README.md index 44bcdbb..855130d 100644 --- a/util/dvsim/README.md +++ b/util/dvsim/README.md
@@ -6,7 +6,7 @@ * Expanding the testplan inline within the DV document as a table; * Annotating the simulation results with testplan entries for a document driven DV execution; -Please see [DV methodology]({{< relref "doc/ug/dv_methodology/index.md#documentation" >}}) for more details on the rationale and motivation for writing and maintaining testplans in a machine-parseable format (`Hjson`). +Please see [DV methodology](../../doc/contributing/dv/methodology/README.md#documentation) for more details on the rationale and motivation for writing and maintaining testplans in a machine-parseable format (`Hjson`). This document will focus on the anatomy of an Hjson testplan, the list of features supported and some of the ways of using the tool. ## Hjson testplan @@ -17,7 +17,7 @@ A testpoint is an entry in the testplan representing a planned test. Each testpoint maps one-to-one to a unique feature of the design. -Additionally, a testpoint for each of the [key areas of focus]({{< relref "doc/ug/dv_methodology/index.md#key-test-focus-areas" >}}) (whichever ones are applicable) is also captured in the testplan. +Additionally, a testpoint for each of the [key areas of focus](../../doc/contributing/dv/methodology/README.md#key-test-focus-areas) (whichever ones are applicable) is also captured in the testplan. The following attributes are used to define each testpoint, at minimum: * **name: testpoint name** @@ -38,11 +38,11 @@ A multi-line string that briefly describes the intent of the test. It is recommended, but not always necessary to add a high level goal, stimulus, and the checking procedure so that the reader gets a clear idea of what and how the said feature is going to be tested. - Full [Markdown]({{< relref "doc/sg/markdown_usage_style" >}}) syntax is supported when writing the description. + Full [Markdown](../../doc/contributing/style_guides/markdown_usage_style.md) syntax is supported when writing the description. * **tests: list of written test(s) for this testpoint** - The testplan is written in the initial work stage of the verification [life-cycle]({{< relref "doc/project/development_stages#hardware-verification-stages" >}}). + The testplan is written in the initial work stage of the verification [life-cycle](../../doc/project_governance/development_stages.md#hardware-verification-stages). Later, when the DV engineer writes the tests, they may not map one-to-one to a testpoint - it may be possible that a written test satisfactorily addresses multiple testpoints; OR it may also be possible that a testpoint needs to be split into multiple smaller tests. To cater to these needs, we provide the ability to set a list of written tests for each testpoint. It is used to not only indicate the current progress so far into each verification stage, but also map the simulation results to the testpoints to generate the final report table. @@ -212,7 +212,7 @@ * **`common_testplan.hjson`**: shared testplan imported within the DUT testplan * **`foo_dv_doc.md`**: DUT testplan imported within the DV document doc in Markdown -In addition, see the [UART DV document]({{< relref "hw/ip/uart/doc/dv" >}}) for a 'production' example of inline expansion of an imported testplan as a table within the DV document. +In addition, see the [UART DV document](../../hw/ip/uart/dv/README.md) for a 'production' example of inline expansion of an imported testplan as a table within the DV document. The [UART testplan](https://github.com/lowRISC/opentitan/blob/master/hw/ip/uart/data/uart_testplan.hjson) imports some of the shared testplans located at `hw/dv/tools/dvsim/testplans` area. ### Limitations
diff --git a/util/ipgen/README.md b/util/ipgen/README.md index abddd1b..fb36b9e 100644 --- a/util/ipgen/README.md +++ b/util/ipgen/README.md
@@ -10,7 +10,7 @@ Ipgen is a command-line tool and a library. Users wishing to instantiate an IP template or query it for template parameters will find the command-line application useful. -For use in higher-level scripting, e.g. within [topgen](topgen_tool.md) using ipgen as Python library is recommended. +For use in higher-level scripting, e.g. within [topgen](../topgen/README.md) using ipgen as Python library is recommended. ## Anatomy of an IP template
diff --git a/util/reggen/README.md b/util/reggen/README.md index 7e03aec..e3b385e 100644 --- a/util/reggen/README.md +++ b/util/reggen/README.md
@@ -22,14 +22,14 @@ The tool input is an Hjson file containing the Comportable description of the IP block and its registers. -A description of Hjson (a variant of JSON) and the recommended style is in the [Hjson Usage and Style Guide]({{< relref "doc/sg/hjson_usage_style.md" >}}). +A description of Hjson (a variant of JSON) and the recommended style is in the [Hjson Usage and Style Guide](../../doc/contributing/style_guides/hjson_usage_style.md). The tables below describe valid keys for each context. It is an error if *required* keys are missing from the input JSON. *Optional* keys may be provided in the input file as needed, as noted in the tables the tool may insert them (with default or computed values) during validation so the output generators do not have to special case them. Keys marked as "inserted by tool" should not be in the input JSON (they will be silently overwritten if they are there), they are derived by the tool during validation of the input and available to the output generators. -For more detail on the non-register entries of the Hjson configuration file, see [this section]({{< relref "doc/rm/comportability_specification/index.md#configuration-description-hjson" >}}) of the Comportability Specification. +For more detail on the non-register entries of the Hjson configuration file, see [this section](../../doc/contributing/hw/comportability/README.md#configuration-description-hjson) of the Comportability Specification. {{% selfdoc "reggen" %}} @@ -190,7 +190,7 @@ Current `tags` supports: * CSR tests exclusions: Simulation based verification will run four CSR tests (if applicable to the module) through automation. - Detailed description of this methodology is documented in [CSR utilities]({{< relref "hw/dv/sv/csr_utils/doc" >}}). + Detailed description of this methodology is documented in [CSR utilities](../../hw/dv/sv/csr_utils/README.md). The tag name is `excl`, and items are enum values for what CSR tests to exclude from, and what type of exclusions. The enum types for exclusion test are: ```systemverilog @@ -223,7 +223,7 @@ This section details the register generation for hardware instantiation. The input to the tool for this generation is the same `.hjson` file described above. -The output is two Verilog files that can be instantiated by a peripheral that follows the [Comportability Guidelines]({{< relref "doc/rm/comportability_specification" >}}). +The output is two Verilog files that can be instantiated by a peripheral that follows the [Comportability Guidelines](../../doc/contributing/hw/comportability/README.md). The register generation tool will generate the RTL if it is invoked with the `-r` flag. The `-t <directory>` flag is used to specify the output directory where the two files will be written. @@ -272,7 +272,7 @@ The diagram below gives an overview of the register module, `name_reg_top`. - + In this diagram, the TL-UL bus is shown on the left. Logic then breaks down individual write requests and read requests based upon the assigned address of the bus requests. @@ -420,7 +420,7 @@ This uses the `prim_subreg` with the connections shown. The connectivity to the hardware struct bundles are a function of the `hwaccess` and `hwqe` attributes, and will be discussed here as well. - + In this diagram, the maximum connection for subreg_rw is shown. @@ -457,7 +457,7 @@ The storage register is shown in the custom portion of the logic. Finally, note that no `de` input is required from the rest of the peripheral hardware, only the `d` is added to the struct bundle. - + Note the timing of `qe` is one cycle earlier in this model than in the non-hwext model. @@ -491,11 +491,11 @@ Type `R0W1C` not shown is just a special case of `RW1C` where the q output is not sent back to the software read response mux, but the value `0` is sent instead. Note the `qe` is removed for readability but is available with the hwqe attribute. - + - + - + #### Simultaneous SW and HW access @@ -557,7 +557,7 @@ The diagram below visualizes the internals of the `prim_subreg_shadow` module used to implement shadow registers. - + When compared to a normal register, the `prim_subreg_shadow` module is comprised of two additional storage components, giving three storage flops in total. The **staged** register holds a written value before being committed. @@ -565,7 +565,7 @@ And the the standard storage register holds the **committed** value. Under the hood, these registers are implemented using the `prim_subreg` module. -This means a shadow register can implement any of the types described in [this section]({{< relref "doc/rm/register_tool/index.md#register-definitions-per-type" >}}). +This means a shadow register can implement any of the types described in [this section](./README.md#register-definitions-per-type). The general behavior of updating a shadow register is as follows: 1. Software performs a first write to the register. @@ -623,7 +623,7 @@ It is thus **highly recommended** to use non-permissive reset values and use software for configuring more permissive values. - Error hook-ups: - - Storage errors signaled to the hardware in `err_storage` are fatal, and should be hooked up directly into the [alert system]({{< relref "hw/top_earlgrey/ip_autogen/alert_handler/doc" >}}). + - Storage errors signaled to the hardware in `err_storage` are fatal, and should be hooked up directly into the [alert system](../../hw/top_earlgrey/ip_autogen/alert_handler/README.md). - Update errors signaled to the hardware in `err_update` may be software errors and do not affect the current committed value; thus they can be considered informational bugs that are collected into error status or interrupts, and optionally alerts. They do not generate error responses on the TL-UL system bus interface. @@ -680,7 +680,7 @@ Depending on the design, the reset propagation **may** be multi-cycle, and thus it is possible for the shadow register and committed register to not be reset at the same time when resets are asserted. This may manifest as an issue if the reset skews are **not** balanced, and may cause register outputs to change on the opposite sides of a clock edge for the receiving domain. It is thus important to ensure the skews of the committed and shadow reset lines to be roughly balanced and/or downstream logic to correctly ignore errors when this happens. - Note that a module may need to be reset during operation of the system, i.e., when the [alert system]({{< relref "hw/top_earlgrey/ip_autogen/alert_handler/doc" >}}) is running. + Note that a module may need to be reset during operation of the system, i.e., when the [alert system](../../hw/top_earlgrey/ip_autogen/alert_handler/README.md) is running. Software-controllable resets should be avoided. If a single reset bit drives both normal and shadow resets, then the problem is simply moved to a different place.
diff --git a/util/reggen/doc/setup_and_use.md b/util/reggen/doc/setup_and_use.md index 8ab8bd7..028eecf 100644 --- a/util/reggen/doc/setup_and_use.md +++ b/util/reggen/doc/setup_and_use.md
@@ -22,7 +22,7 @@ ### Register JSON Format For details on the register JSON format, see the -[register tool documentation]({{< relref "doc/rm/register_tool/index.md" >}}). +[register tool documentation](../README.md). To ensure things stay up to date, the register JSON format information is documented by the tool itself. The documentation can be generated by running the following commands: @@ -39,7 +39,7 @@ Normally for documentation the `build_docs.py` tool will automatically use `reggen`. The script `regtool.py` provides a standalone way to run `reggen`. See the -[register tool documentation]({{< relref "doc/rm/register_tool/index.md" >}}) +[register tool documentation](../README.md) for details about how to invoke the tool. The following shows an example of how to generate RTL from a register
diff --git a/util/tlgen/README.md b/util/tlgen/README.md index 9f03d73..f795a59 100644 --- a/util/tlgen/README.md +++ b/util/tlgen/README.md
@@ -6,7 +6,7 @@ It can be used standalone or invoked as part of top module generation process (details of top generation forthcoming). The RTL files found `hw/top_earlgrey/ip/xbar/rtl/autogen` are generated with the crossbar tool. This document does not specify the details of the internal blocks. -See the [bus specification]({{< relref "hw/ip/tlul/doc" >}}) for details on the protocol and the components used in the crossbar. +See the [bus specification](../../hw/ip/tlul/README.md) for details on the protocol and the components used in the crossbar. ## Standalone tlgen.py @@ -35,13 +35,13 @@ If the tool is used in the process of top generation (`topgen.py`, details forthcoming), a few fields are derived from the top Hjson configuration module structure. -A description of Hjson and the recommended style is in the [Hjson Usage and Style Guide]({{< relref "doc/sg/hjson_usage_style" >}}). +A description of Hjson and the recommended style is in the [Hjson Usage and Style Guide](../../doc/contributing/style_guides/hjson_usage_style.md). An item in the `nodes` list corresponds to a host or device interface on an instantiated IP block. The name of such a node should be of the form `<instance_name>.<interface_name>`, so the `my_if` interface on the instance `my_instance` would be denoted `my_instance.my_if`. However, many instances have a single, unnamed, device interface. For these devices, the node should just be named with the name of the instance (just `my_instance` in the example above). -For details of how interfaces are defined using the register tool, see the [Bus Interfaces]({{< relref "doc/rm/comportability_specification#bus-interfaces" >}}) section of the Comportability Specification. +For details of how interfaces are defined using the register tool, see the [Bus Interfaces](../../doc/contributing/hw/comportability/README.md#bus-interfaces) section of the Comportability Specification. Edges in the DAG are specified in the `connections` map. This uses an adjacency list format. @@ -97,14 +97,14 @@ Below shows an example of 2 Hosts and 2 Devices connectivity. - + Each circle represents a Node and an arrow represents an Edge that has downward direction. The tool starts from `H0` Node. As the Node has two downstream Edges and not Socket `1:N`, the tool creates Socket `1:N` based on the condition #5 above. Then repeat the process from Socket `1:N` Node's children Nodes, `D0` and `D1`. - + For `D0`, the tool creates Socket `M:1` based on the condition #4. It then visit its downstream Node, `D0` again. @@ -113,18 +113,18 @@ Then it visits `D1`. It repeats the same step (condition #4) as `D0`, which creates another Socket `M:1`. - + As all Nodes from `H0` have been visited, the tool repeats all steps from `H1`. It applies condition #3 above as `H1` has a peripheral clock rather than main clock. So the tool creates an Async FIFO and moves the pointer to the Node and repeats. - + The tool applies rule #5 as Async FIFO has multiple downstream Nodes (Edges) and it is not Socket `1:N`. The tool creates a Socket `1:N` and visits every downstream Node. - + Both Nodes have been processed, so no condition is hit. The tool completes traversing.
diff --git a/util/uvmdvgen/README.md b/util/uvmdvgen/README.md index 66751f6..62c51f7 100644 --- a/util/uvmdvgen/README.md +++ b/util/uvmdvgen/README.md
@@ -13,7 +13,7 @@ exercise to replicate an existing UVM testbench code to the current one and has to go through several debug cycles to get it working. This tool aims to eliminate that. Also, as a part of our -[DV methodology]({{< relref "doc/ug/dv_methodology#code-reuse" >}}), +[DV methodology](../../doc/contributing/dv/methodology/README.md#code-reuse), we provide utilities and base class structures that contain several pieces of common code which can be reused when setting up a new DV environment. @@ -78,7 +78,7 @@ ### Generating UVM agent The boilerplate code for a UVM agent for an interface can be generated using the `-a` switch. This results in the generation of complete agent with classes that -extend from the [DV library]({{< relref "hw/dv/sv/dv_lib/doc" >}}). Please see +extend from the [DV library](../../hw/dv/sv/dv_lib/README.md). Please see that description for more details. The tool generates an interface, item, cfg, cov, monitor, driver and sequence @@ -160,9 +160,9 @@ ### Generating UVM environment & testbench The boilerplate code for a UVM environment and the testbench for a DUT can be generated using the `-e` switch. This results in the generation of classes that -extend from [DV base library]({{< relref "hw/dv/sv/dv_lib/doc" >}}). +extend from [DV base library](../../hw/dv/sv/dv_lib/README.md). If the `-c` switch is passed, it extends from -[CIP base library]({{< relref "hw/dv/sv/cip_lib/doc" >}}). With `-ea` switch, +[CIP base library](../../hw/dv/sv/cip_lib/README.md). With `-ea` switch, user can provide a list of downstream agents to create within the environment. Please see description for more details. @@ -196,7 +196,7 @@ This is the UVM reg based RAL model. This is created for completeness. The actual RAL model needs to be generated prior to running simulations using the - [regtool]({{< relref "util/reggen/doc" >}}). + [regtool](../reggen/doc/setup_and_use.md). * `env/i2c_host_scoreboard`