From b3978e828d8628e76852e97c3a9f486e5338985d Mon Sep 17 00:00:00 2001 From: Neeraj Krishnan K <9nkrish@gmail.com> Date: Mon, 17 Oct 2022 04:04:32 +0530 Subject: [PATCH] [docs] Clean up line breaks #1191 Reformat verification.rst to ensure everything is 1 sentence per line --- doc/03_reference/verification.rst | 133 +++++++++--------------------- 1 file changed, 39 insertions(+), 94 deletions(-) diff --git a/doc/03_reference/verification.rst b/doc/03_reference/verification.rst index b27260a4b5..277e974ef4 100644 --- a/doc/03_reference/verification.rst +++ b/doc/03_reference/verification.rst @@ -12,16 +12,12 @@ Overview ^^^^^^^^ This is a SV/UVM testbench for verification of the Ibex core, located in `dv/uvm/core_ibex`. -At a high level, this testbench uses the open source `RISCV-DV random instruction generator -`_ to generate compiled instruction binaries, loads them into a -simple memory model, stimulates the Ibex core to run this program in memory, and then compares the -core trace log against a golden model ISS trace log to check for correctness of execution. +At a high level, this testbench uses the open source `RISCV-DV random instruction generator `_ to generate compiled instruction binaries, loads them into a simple memory model, stimulates the Ibex core to run this program in memory, and then compares the core trace log against a golden model ISS trace log to check for correctness of execution. Testbench Architecture ^^^^^^^^^^^^^^^^^^^^^^ -As previously mentioned, this testbench has been constructed based on its usage of the RISCV-DV -random instruction generator developed by Google. +As previously mentioned, this testbench has been constructed based on its usage of the RISCV-DV random instruction generator developed by Google. A block diagram of the testbench is below. .. figure:: images/tb.svg @@ -32,52 +28,35 @@ A block diagram of the testbench is below. Memory Interface Agents """"""""""""""""""""""" -The code can be found in the `dv/uvm/core_ibex/common/ibex_mem_intf_agent -`_ directory. -Two of these agents are instantiated within the testbench, one for the instruction fetch interface, -and the second for the LSU interface. -These agents run slave sequences that wait for memory requests from the core, and then grant the -requests for instructions or for data. +The code can be found in the `dv/uvm/core_ibex/common/ibex_mem_intf_agent `_ directory. +Two of these agents are instantiated within the testbench, one for the instruction fetch interface, and the second for the LSU interface. +These agents run slave sequences that wait for memory requests from the core, and then grant the requests for instructions or for data. Interrupt Interface Agent """"""""""""""""""""""""" -The code can be found in the -`dv/uvm/core_ibex/common/irq_agent `_ directory. -This agent is used to drive stimulus onto the Ibex core's interrupt pins randomly during test -execution. +The code can be found in the `dv/uvm/core_ibex/common/irq_agent `_ directory. +This agent is used to drive stimulus onto the Ibex core's interrupt pins randomly during test execution. Memory Model """""""""""" -The code is vendored from OpenTitan and can be found in the -`vendor/lowrisc_ip/dv/sv/mem_model `_ -directory. -The testbench instantiates a single instance of this memory model that it loads the compiled -assembly test program into at the beginning of each test. -This acts as a unified instruction/data memory that serves all requests from both of the -memory interface agents. +The code is vendored from OpenTitan and can be found in the `vendor/lowrisc_ip/dv/sv/mem_model `_ directory. +The testbench instantiates a single instance of this memory model that it loads the compiled assembly test program into at the beginning of each test. +This acts as a unified instruction/data memory that serves all requests from both of the memory interface agents. Test and Sequence Library """"""""""""""""""""""""" -The code can be found in the -`dv/uvm/core_ibex/tests `_ directory. -The tests here are the main sources of external stimulus generation and checking for this testbench, -as the memory interface slave sequences simply serve the core's memory requests. -The tests here are all extended from ``core_ibex_base_test``, and coordinate the entire flow for a -single test, from loading the compiled assembly binary program into the testbench memory model, to -checking the Ibex core status during the test and dealing with test timeouts. +The code can be found in the `dv/uvm/core_ibex/tests `_ directory. +The tests here are the main sources of external stimulus generation and checking for this testbench, as the memory interface slave sequences simply serve the core's memory requests. +The tests here are all extended from ``core_ibex_base_test``, and coordinate the entire flow for a single test, from loading the compiled assembly binary program into the testbench memory model, to checking the Ibex core status during the test and dealing with test timeouts. The sequences here are used to drive interrupt and debug stimulus into the core. Testplan """""""" -The goal of this bench is to fully verify the Ibex core with 100% -coverage. This includes testing all RV32IMCB instructions, privileged -spec compliance, exception and interrupt testing, Debug Mode operation etc. -The complete test list can be found in the file `dv/uvm/core_ibex/riscv_dv_extension/testlist.yaml -`_. +The goal of this bench is to fully verify the Ibex core with 100% coverage. This includes testing all RV32IMCB instructions, privileged spec compliance, exception and interrupt testing, Debug Mode operation etc.uThe complete test list can be found in the file `dv/uvm/core_ibex/riscv_dv_extension/testlist.yaml `_. For details on coverage see the :ref:`coverage-plan`. Please note that verification is still a work in progress. @@ -117,8 +96,7 @@ In order to run the co-simulation flow, you'll need: For the latter, the Bitmanip patches have to be manually installed to enable support for the Bitmanip draft extension. For further information, checkout the `Bitmanip Extension on GitHub `_ and `how we create the pre-built toolchains `_. -Once these are installed, you need to set some environment variables -to tell the RISCV-DV code where to find them: +Once these are installed, you need to set some environment variables to tell the RISCV-DV code where to find them: :: @@ -143,40 +121,20 @@ End-to-end RTL/ISS co-simulation flow RTL/ISS co-simulation flow chart The last stage in this flow handles log comparisons to determine correctness of a given simulation. -To do this, both the trace log produced by the core and the trace log produced by the chosen golden -model ISS are parsed to collect information about all register writebacks that occur. -These two sets of register writeback data are then compared to verify that the core is writing the -correct data to the correct registers in the correct order. - -However, this checking model quickly falls apart once situations involving external stimulus (such -as interrupts and debug requests) start being tested, as while ISS models can simulate traps due to -exceptions, they cannot model traps due to external stimulus. -In order to provide support for these sorts of scenarios to verify if the core has entered the -proper interrupt handler, entered Debug Mode properly, updated any CSRs correctly, and so on, the -handshaking mechanism provided by the RISCV-DV instruction generator is heavily used, which -effectively allows the core to send status information to the testbench during program execution for -any analysis that is required to increase verification effectiveness. +To do this, both the trace log produced by the core and the trace log produced by the chosen golden model ISS are parsed to collect information about all register writebacks that occur. +These two sets of register writeback data are then compared to verify that the core is writing the correct data to the correct registers in the correct order. + +However, this checking model quickly falls apart once situations involving external stimulus (such as interrupts and debug requests) start being tested, as while ISS models can simulate traps due to exceptions, they cannot model traps due to external stimulus. +In order to provide support for these sorts of scenarios to verify if the core has entered the proper interrupt handler, entered Debug Mode properly, updated any CSRs correctly, and so on, the handshaking mechanism provided by the RISCV-DV instruction generator is heavily used, which effectively allows the core to send status information to the testbench during program execution for any analysis that is required to increase verification effectiveness. This mechanism is explained in detail at https://github.com/google/riscv-dv/blob/master/docs/source/handshake.rst. As a sidenote, the signature address that this testbench uses for the handshaking is ``0x8ffffffc``. -Additionally, as is mentioned in the RISCV-DV documentation of this handshake, a small set of API -tasks are provided in `dv/uvm/core_ibex/tests/core_ibex_base_test.sv -`_ to enable easy -and efficient integration and usage of this mechanism in this test environment. -To see how this handshake is used during real simulations, look in -`dv/uvm/core_ibex/tests/core_ibex_test_lib.sv -`_. -As can be seen, this mechanism is extensively used to provide runtime verification for situations involving external debug -requests, interrupt assertions, and memory faults. -To add another layer of correctness checking to the checking already provided by the handshake -mechanism, a modified version of the trace log comparison is used, as comparing every register write -performed during the entire simulation will lead to an incorrect result since the ISS trace log will -not contain any execution information in the debug ROM or in any interrupt handler code. -As a result, only the final values contained in every register at the end of the test are compared -against each other, since any code executed in the debug ROM and trap handlers should not corrupt -register state in the rest of the program. - -The entirety of this flow is controlled by the Makefile found at -`dv/uvm/core_ibex/Makefile `_; here is a list of frequently used commands: +Additionally, as is mentioned in the RISCV-DV documentation of this handshake, a small set of API tasks are provided in `dv/uvm/core_ibex/tests/core_ibex_base_test.sv `_ to enable easy and efficient integration and usage of this mechanism in this test environment. +To see how this handshake is used during real simulations, look in `dv/uvm/core_ibex/tests/core_ibex_test_lib.sv `_. +As can be seen, this mechanism is extensively used to provide runtime verification for situations involving external debug requests, interrupt assertions, and memory faults. +To add another layer of correctness checking to the checking already provided by the handshake mechanism, a modified version of the trace log comparison is used, as comparing every register write performed during the entire simulation will lead to an incorrect result since the ISS trace log will not contain any execution information in the debug ROM or in any interrupt handler code. +As a result, only the final values contained in every register at the end of the test are compared against each other, since any code executed in the debug ROM and trap handlers should not corrupt register state in the rest of the program. + +The entirety of this flow is controlled by the Makefile found at `dv/uvm/core_ibex/Makefile `_; here is a list of frequently used commands: .. code-block:: bash @@ -230,27 +188,16 @@ Instruction Cache Overview ^^^^^^^^ -Due to the complexity of the instruction cache, a separate testbench is used to -ensure that full verification and coverage closure is performed on this module. -This testbench is located at `dv/uvm/icache/dv -`_. - -As Icache verification is being carried out as part of the OpenTitan open-source -project, the testbench derives from the `dv_lib UVM class library -`_, which is a set of extended UVM -classes that provides basic UVM testbench functionality and components. - -This DV environment will be compiled and simulated using the `dvsim simulation tool -`_. -The master ``.hjson`` file that controls simulation with ``dvsim`` can be found -at `dv/uvm/icache/dv/ibex_icache_sim_cfg.hjson -`_. -The associated testplan ``.hjson`` file is located at `dv/uvm/icache/data/ibex_icache_testplan.hjson -`_. -As this testbench is still in its infancy, it is currently only able to be compiled, as no tests or -sequences are implemented, nor are there any entries in the testplan file. -To build the testbench locally using the VCS simulator, run the following command from the root of -the Ibex repository: +Due to the complexity of the instruction cache, a separate testbench is used to ensure that full verification and coverage closure is performed on this module. +This testbench is located at `dv/uvm/icache/dv `_. + +As Icache verification is being carried out as part of the OpenTitan open-source project, the testbench derives from the `dv_lib UVM class library `_, which is a set of extended UVM classes that provides basic UVM testbench functionality and components. + +This DV environment will be compiled and simulated using the `dvsim simulation tool `_. +The master ``.hjson`` file that controls simulation with ``dvsim`` can be found at `dv/uvm/icache/dv/ibex_icache_sim_cfg.hjson `_. +The associated testplan ``.hjson`` file is located at `dv/uvm/icache/data/ibex_icache_testplan.hjson `_. +As this testbench is still in its infancy, it is currently only able to be compiled, as no tests or sequences are implemented, nor are there any entries in the testplan file. +To build the testbench locally using the VCS simulator, run the following command from the root of the Ibex repository: .. code-block:: bash @@ -258,7 +205,5 @@ the Ibex repository: --skip-ral --purge --sr sim_out Specify the intended output directory using either the ``--sr`` or ``-scratch-root`` option. -The ``--skip-ral`` option is mandatory for building/simulating the Icache testbench, as it does not -have any CSRs, excluding this option will lead to build errors. -``--purge`` directs the tool to ``rm -rf`` the output directory before running the tool, this can be -removed if not desired. +The ``--skip-ral`` option is mandatory for building/simulating the Icache testbench, as it does not have any CSRs, excluding this option will lead to build errors. +``--purge`` directs the tool to ``rm -rf`` the output directory before running the tool, this can be removed if not desired.