CLKMGR DV document
Goals
- DV
- Verify all CLKMGR IP features by running dynamic simulations with a SV/UVM based testbench.
- Develop and run all tests based on the DV plan below towards closing code and functional coverage on the IP and all of its sub-modules.
- FPV
- Verify TileLink device protocol compliance with an SVA based testbench.
Current status
Design features
The detailed information on CLKMGR design features at the CLKMGR HWIP technical specification is obsolete.
Testbench architecture
CLKMGR testbench has been constructed based on the CIP testbench architecture.
Block diagram
Top level testbench
Top level testbench is located at hw/ip/clkmgr/dv/tb.sv
. It instantiates the CLKMGR DUT module hw/ip/clkmgr/rtl/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
- TileLink host interface
- CLKMGR IOs
- Interrupts (
pins_if
) - Alerts (
pins_if
) - Devmode (
pins_if
) - Pwrmgr interface: “hw/ip/clkmgr/dv/env/clkmgr_pwrmgr_if.sv”
- Idle interface: “hw/ip/clkmgr/dv/env/clkmgr_idle_if.sv”
Common DV utility components
The following utilities provide generic helper tasks and functions to perform activities that are common across the project:
Compile-time configurations
[list compile time configurations, if any and what are they used for]
Global types & methods
All common types and methods defined at the package level can be found in
clkmgr_env_pkg
. Some of them in use are:
typedef virtual clkmgr_pwrmgr_if clkmgr_pwrmgr_vif;
typedef virtual clkmgr_idle_if clkmgr_idle_vif;
typedef virtual clk_rst_if clk_rst_vif;
typedef enum int {io_div4, io_div2, usb} peri_e;
typedef enum int {aes, hmac, kmac, otbn} trans_e;
TL_agent
CLKMGR testbench instantiates (already handled in CIP base env) tl_agent which provides the ability to drive and independently monitor random traffic via TL host interface into CLKMGR device.
UVC/agent 1
[Describe here or add link to its README]
UVC/agent 2
[Describe here or add link to its README]
UVM RAL Model
The CLKMGR RAL model is created with the ralgen
FuseSoC generator script automatically when the simulation is at the build stage.
It can be created manually by invoking regtool
:
Reference models
[Describe reference models in use if applicable, example: SHA256/HMAC]
Stimulus strategy
Test sequences
All test sequences reside in hw/ip/clkmgr/dv/env/seq_lib
.
The clkmgr_base_vseq
virtual sequence is extended from cip_base_vseq
and serves as a starting point.
All test sequences are extended from clkmgr_base_vseq
.
It provides commonly used handles, variables, functions and tasks that the test sequences can simple use / call.
Some of the most commonly used tasks / functions are as follows:
- task 1:
- task 2:
Functional coverage
To ensure high quality constrained random stimulus, it is necessary to develop a functional coverage model. The following covergroups have been developed to prove that the test intent has been adequately met:
- cg1:
- cg2:
Self-checking strategy
Scoreboard
The clkmgr_scoreboard
is primarily used for end to end checking.
It creates the following analysis ports to retrieve the data monitored by corresponding interface agents:
- analysis port1:
- analysis port2:
Assertions
- TLUL assertions: The
tb/clkmgr_bind.sv
binds thetlul_assert
assertions 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 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:
$ $REPO_TOP/util/dvsim/dvsim.py $REPO_TOP/hw/ip/clkmgr/dv/clkmgr_sim_cfg.hjson -i clkmgr_smoke
DV plan
Milestone | Name | Description | Tests |
---|---|---|---|
V1 | smoke | Smoke test accessing a major datapath within the clkmgr. Stimulus:
Checks:
| clkmgr_smoke |
V1 | feature1 | Add more test entries here like above. | |
V1 | csr_hw_reset | Verify the reset values as indicated in the RAL specification.
| clkmgr_csr_hw_reset |
V1 | csr_rw | Verify accessibility of CSRs as indicated in the RAL specification.
| clkmgr_csr_rw |
V1 | csr_bit_bash | Verify no aliasing within individual bits of a CSR.
| clkmgr_csr_bit_bash |
V1 | csr_aliasing | Verify no aliasing within the CSR address space.
| clkmgr_csr_aliasing |
V1 | csr_mem_rw_with_rand_reset | Verify random reset during CSR/memory access.
| clkmgr_csr_mem_rw_with_rand_reset |
V2 | tl_d_oob_addr_access | Access out of bounds address and verify correctness of response / behavior | clkmgr_tl_errors |
V2 | tl_d_illegal_access | Drive unsupported requests via TL interface and verify correctness of response / behavior. Below error cases are tested
| clkmgr_tl_errors |
V2 | tl_d_outstanding_access | Drive back-to-back requests without waiting for response to ensure there is one transaction outstanding within the TL device. Also, verify one outstanding when back- to-back accesses are made to the same address. | clkmgr_csr_hw_reset clkmgr_csr_rw clkmgr_csr_aliasing clkmgr_same_csr_outstanding |
V2 | tl_d_partial_access | Access CSR with one or more bytes of data For read, expect to return all word value of the CSR For write, enabling bytes should cover all CSR valid fields | clkmgr_csr_hw_reset clkmgr_csr_rw clkmgr_csr_aliasing clkmgr_same_csr_outstanding |