AES DV Plan
- Verify all AES IP features by running dynamic simulations with a SV/UVM based testbench
- Develop and run all tests based on the testplan below towards closing code and functional coverage on the IP.
- Verify TileLink device protocol compliance with an SVA based testbench
For detailed information on AES design features, please see the AES HWIP Technical Specification.
AES testbench has been constructed based on the CIP testbench architecture.
Top level testbench
Top level testbench is located at
It instantiates the AES DUT module
In addition, it instantiates the following interfaces, connects them to the DUT and sets their handle into
Common DV utility components
The following utilities provide generic helper tasks and functions to perform activities that are common across the project:
Global types & methods
All common types and methods defined at the package level can be found in
Some of them in use are:
parameter uint AES_ADDR_MAP_SIZE = 128;
AES 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 AES device.
UVM RAL model
The AES RAL model is created with the
ralgen FuseSoC generator script automatically when the simulation is at the build stage.
It can be created manually (separately) by running
make in the the
All test sequences reside in
aes_base_vseq virtual sequence is extended from
cip_base_vseq and serves as a starting point.
All test sequences are extended from
aes_base_vseq 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:
- aes_init: Initialize the AES module from the randomized environment variables in the config.
- set_op: Set AES operation to encrypt or decrypt.
- write_key: Write initial key to AES init key registers.
- add_data: Add the next 128 block to the input registers.
- read_output: Poll the status register for data ready bit and read the result from AES output registers.
- clear_reg: Based on the input this function clears data input-, data output- or key-registers or any combination of these.
- set_manual_trigger: Chooses between AES auto start and manual start.
- trigger_start: Set the start bit to trigger a new encryption/decryption.
To ensure high quality constrained random stimulus, it is necessary to develop a functional coverage model. The following cover groups have been developed to prove that the test intent has been adequately met.
WORK IN PROGRESS WILL COME WITH V2.
aes_scoreboard is primarily used for end to end checking.
It creates the following analysis FIFOs to retrieve the data monitored by corresponding interface agents:
- tl_a_chan_fifo: tl address channel
- tl_d_chan_fifo: tl data channel
These 2 FIFOs provide transaction items at the end of the address channel and data channel respectively. Each FIFO is monitored and incoming transactions are stored. Whenever a transaction is finished the sequence item is handed over to a reference model that will generate the expected response. At the same time the scoreboard is waiting for the result of the AES module to compute. Once complete the result is scored against the prediction made by the reference model.
The reference model is selected to be either a C-implementation or an SSL-library selected on a random basis with the default distribution of 80% OpenSSL/BoringSSL and 20% C-model.
The default behavior for the verification is that the scoreboard wait until the complete message has been encrypted/decrypted before checking the result against the reference model.
The scoreboard has a step through mode where the scoring is done after each 128bit block. This setting is only available when using the C-model as reference and is controlled with a knob.
- TLUL assertions: The
tlul_assertassertions 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 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 basic sanity test:
$ cd hw/ip/aes/dv $ make TEST_NAME=aes_sanity
Here's how to run a basic test without DPI calls:
$ cd hw/ip/aes/dv $ make TEST_NAME=aes_wakeup_test
|V1||wake_up||<p>Basic hello world, encrypt a plain text read it back - decrypt and compare to input.</p>||aes_wake_up<br>|
|V1||sanity||<p>Encrypt a plain text read it back - decrypt and compare to input but use reference model to compare after both encryption and decryption.</p>||aes_sanity<br>|
|V1||csr_hw_reset||<p>Verify the reset values as indicated in the RAL specification.</p> <ul> <li>Write all CSRs with a random value.</li> <li>Apply reset to the DUT as well as the RAL model.</li> <li>Read each CSR and compare it against the reset value. it is mandatory to replicate this test for each reset that affects all or a subset of the CSRs.</li> <li>It is mandatory to run this test for all available interfaces the CSRs are accessible from.</li> <li>Shuffle the list of CSRs first to remove the effect of ordering.</li> </ul>||aes_csr_hw_reset<br>|
|V1||csr_rw||<p>Verify accessibility of CSRs as indicated in the RAL specification.</p> <ul> <li>Loop through each CSR to write it with a random value.</li> <li>Read the CSR back and check for correctness while adhering to its access policies.</li> <li>It is mandatory to run this test for all available interfaces the CSRs are accessible from.</li> <li>Shuffle the list of CSRs first to remove the effect of ordering.</li> </ul>||aes_csr_rw<br>|
|V1||csr_bit_bash||<p>Verify no aliasing within individual bits of a CSR.</p> <ul> <li>Walk a 1 through each CSR by flipping 1 bit at a time.</li> <li>Read the CSR back and check for correctness while adhering to its access policies.</li> <li>This verify that writing a specific bit within the CSR did not affect any of the other bits.</li> <li>It is mandatory to run this test for all available interfaces the CSRs are accessible from.</li> <li>Shuffle the list of CSRs first to remove the effect of ordering.</li> </ul>||aes_csr_bit_bash<br>|
|V1||csr_aliasing||<p>Verify no aliasing within the CSR address space.</p> <ul> <li>Loop through each CSR to write it with a random value</li> <li>Shuffle and read ALL CSRs back.</li> <li>All CSRs except for the one that was written in this iteration should read back the previous value.</li> <li>The CSR that was written in this iteration is checked for correctness while adhering to its access policies.</li> <li>It is mandatory to run this test for all available interfaces the CSRs are accessible from.</li> <li>Shuffle the list of CSRs first to remove the effect of ordering.</li> </ul>||aes_csr_aliasing<br>|
|V1||csr_mem_rw_with_rand_reset||<p>Verify random reset during CSR/memory access.</p> <ul> <li>Run csr_rw sequence to randomly access CSRs</li> <li>If memory exists, run mem_partial_access in parallel with csr_rw</li> <li>Randomly issue reset and then use hw_reset sequence to check all CSRs are reset to default value</li> <li>It is mandatory to run this test for all available interfaces the CSRs are accessible from.</li> </ul>||aes_csr_mem_rw_with_rand_reset<br>|
|V2||algorithm||<p>Compare cypher text from DUT with the output of a C model using same key and data.</p>||aes_sanity<br>|
|V2||key_length||<p>Randomly select key length to verify all supported key lengths are working.</p>|
|V2||back2back||<p>Randomly select the spacing between consecutive messages and blocks from 0 - n clock cycles. The distribution will be weighted toward no and small gaps (0-10 cycles) but will also cover larger gaps.</p>|
|V2||backpressure||<p>Try to write data to registers without offloading the DUT output to verify Stall functionality.</p>|
|V2||multi_message||<p>Run multiple messages in a random mix of encryption / decryption. Each message should select its mode randomly.</p>|
|V2||failure_test||<ul> <li>Tests what happens if a register is written a the wrong time? If a key does not match the key setting etc. Will the DUT ignore or fail gracefully.</li> <li>Enter a 256bit key but set DUT to use 128bit for encryption. Then enter the 128bit of the key and use for decryption. Will result match plain text and vice.</li> <li>Write unsupported configurations (Key length and mode are 1 hot, what happens if more than one bit is set.)</li> </ul>|
|V2||trigger_clear_test||<p>Exercise trigger and clear registers at random times to make sure we handle the different cornercases correctly. Example of a cornercases clearing data input or data output before the data is consumed or the DUT finishes an operation.</p>|
|V2||nist_test_vectors||<p>Verify that the DUT handles the NIST test vectors correctly.</p>|
|V2||performance||<p>Verify that the DUT performs as specified for each key length in terms of latency and throughput. This testpoint will use automode (this will feed input data and offload output data as fast as the DUT can support it.)</p>|
|V2||reset_recovery||<p>Pull reset at random times, make sure DUT recover/resets correctly and there is no residual data left in the registers.</p>|
|V2||stress||<p>This will combine the other individual testpoints to ensure we stress test everything across the board.</p>|
|V2||deinitialization||<p>Make sure that there is no residual data from latest operation.</p>|
|V2||oob_addr_access||<p>Access out of bounds address and verify correctness of response / behavior</p>||aes_tl_errors<br>|
|V2||illegal_access||<p>Drive unsupported requests via TL interface and verify correctness of response / behavior</p>||aes_tl_errors<br>|
|V2||outstanding_access||<p>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.</p>||aes_csr_hw_reset<br> aes_csr_rw<br> aes_csr_aliasing<br> aes_same_csr_outstanding<br>|
|V2||partial_access||<p>Do partial accesses.</p>||aes_csr_hw_reset<br> aes_csr_rw<br> aes_csr_aliasing<br>|