testbenches/ip/spi_engine: Upgrade spi_engine testbench for SDO extension by caosjr · Pull Request #240 · analogdevicesinc/testbenches

caosjr · 2025-07-07T18:30:39Z

It changes spi_vip and spi_engine driver so it can support the new testbench for the SPI Engine. Several tasks and functions were changed due to this modification.
This modification requires this spi engine version: analogdevicesinc/hdl#1808

PR Type

Bug fix (change that fixes an issue)
New feature (change that adds new functionality)
New test (change that adds new test program and/or testbench)
Breaking change (has dependencies in other repositories/testbenches)
Documentation (change that adds or modifies documentation)

PR Checklist

I have followed the code style guidelines
I have performed a self-review of changes
I have ran all testbenches affected by this PR
I have commented my code, at least hard-to-understand parts
I have signed off all commits from this PR
I have updated the documentation (wiki pages, ReadMe files, Copyright etc)
I have not introduced new Warnings/Errors on compilation/elaboration/simulation
I have set the verbosity level to none for the test program

IstvanZsSzekely

Initial review.
The projects that have updated documentation: AD463x, AD738x, AD7606 have broken testbenches. It seems that the HDL block design is out of date.

IstvanZsSzekely

Triggered another CI run to check the current status of the PR with the changes from HDL and TB PRs. The AD463x, AD7606x, AD7616 (parallel mode) projects have build issues in the testbenches, while AD57xx has issues when compiling the simulation files.

IstvanZsSzekely · 2025-11-14T09:43:34Z

Please rebase the branch on the current main to solve the conflicts.

https://analogdevicesinc.github.io/testbenches/pull/240

IstvanZsSzekely · 2026-06-04T10:29:21Z

From what I gathered looking at the code, the MOSI and MISO_LANE_MASK are calculated based on the NUM_OF_MOSI and MISO. These values are not needed for anything other than the simulation VIPs, which already know of the NUM_OF_x values, and hence the x_LANE_MASK parameters become redundant. If this is the case, then please remove the redundant parts of the code.

The MISO_LANE_MASK and MOSI_LANE_MASK parameters are not redundant. While the current config files compute them as (1 << NUM_OF_x) - 1 (contiguous lanes), the masks provide flexibility that NUM_OF_x alone cannot:

Non-contiguous lane selection - A mask can enable specific lanes (e.g., MISO_LANE_MASK = 0x05 enables lanes 0 and 2, skipping lane 1), whereas NUM_OF_MISO only indicates the total count.

Decoupled concerns - NUM_OF_MISO/MOSI defines the physical bus width (how many lanes exist), while x_LANE_MASK defines which of those lanes are active in a given test scenario.

The VIP uses the mask directly - In adi_spi_vip_pkg.sv:164, $countones(vif.get_param_MISO_LANE_MASK) determines how many lanes to drive. This allows testing configurations where not all physical lanes are used.

The current configs happen to always enable all lanes (mask = 2^N - 1), but the parameters should remain to preserve the ability to test partial/non-contiguous lane configurations in the future.

Thank you for the explanation! Now if someone will have the same question at any point, the reference for the answer will be here.

Updates SPI VIP, Driver, and regmaps to support n lanes. In this new SPI Engine Version, it is possible to mask up to 8 serial lanes. * Update to support n lanes for the SDI and SDO; * Insert SDI lane mask instruction; * Insert SDO lane mask instruction; * Update major version to SPI Engine 2.0. It is not backwards compatible; * Update NUM_OF_SDI parameter to NUM_OF_SDIO. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

Updated from NUM_OF_SDI to NUM_OF_SDIO parameter in the documentation of the following projects: * ad463x; * ad738x; * ad7606; * pulsar_adc. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

Several changes to support more than one lane for SDI and SDO. Fixed and updated all methods to work with the latest framework: * Update config files. All config files have 4 lanes now; * Insert a new test for lane mask. * Possible to use different lane mask for offload as long as it is changed before executing it; Signed-off-by: Carlos Souza <carlos.souza@analog.com>

Testbench was updated to use the new features related to the spi lane mask. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

Fixes sdo_data type. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

Using the latest framework for the tests. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

Update to the latest multilane SPI Engine, using the latest framework. Removed the manual axi reads/writes and using the current APIs. Inserted a SPI VIP for the test_program_si.sv. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

IstvanZsSzekely

The testbench and the documentation looks good from the standard point of view.
A CI build has been started to check for any issues.
Please ask for a review from someone who knows more about the projects to review the testbench process itself.

IstvanZsSzekely

CI finished the simulations, everything is green.
Please ask for a review from someone who knows more about the projects to review the testbench process itself.

caosjr force-pushed the spi_n_lanes branch from d4158f8 to 0da6752 Compare July 10, 2025 18:16

caosjr marked this pull request as ready for review August 7, 2025 19:19

caosjr requested review from a team as code owners August 7, 2025 19:19

caosjr mentioned this pull request Aug 7, 2025

library/spi_engine: SDO Extension upgrade analogdevicesinc/hdl#1808

Merged

13 tasks

IstvanZsSzekely requested changes Aug 8, 2025

View reviewed changes

LBFFilho reviewed Aug 8, 2025

View reviewed changes

caosjr force-pushed the spi_n_lanes branch from b0e8b40 to a38872e Compare August 8, 2025 17:31

LBFFilho reviewed Aug 8, 2025

View reviewed changes

Comment thread library/vip/adi/spi_vip/adi_spi_vip.sv Outdated

LBFFilho reviewed Aug 8, 2025

View reviewed changes

Comment thread library/vip/adi/spi_vip/adi_spi_vip_if_base_pkg.sv Outdated

caosjr force-pushed the spi_n_lanes branch from 9119cec to 63b423c Compare August 11, 2025 19:27

IstvanZsSzekely requested changes Sep 5, 2025

View reviewed changes

github-actions Bot added a commit that referenced this pull request Sep 23, 2025

deploy: 7c55eeb #240 (synchronize)

aa38b8c

caosjr force-pushed the spi_n_lanes branch from 353863c to 9de5afa Compare September 23, 2025 19:29

github-actions Bot added a commit that referenced this pull request Sep 23, 2025

deploy: 1b95267 #240 (synchronize)

a619086

caosjr force-pushed the spi_n_lanes branch from aa24c2e to 2220584 Compare March 6, 2026 19:40

github-actions Bot added a commit that referenced this pull request Mar 6, 2026

deploy: 359287b #240 (synchronize)

f388a00

https://analogdevicesinc.github.io/testbenches/pull/240

caosjr force-pushed the spi_n_lanes branch from 2220584 to 768932e Compare March 24, 2026 15:12

github-actions Bot added a commit that referenced this pull request Mar 24, 2026

deploy: d91f23f #240 (synchronize)

f580651

https://analogdevicesinc.github.io/testbenches/pull/240

caosjr force-pushed the spi_n_lanes branch 8 times, most recently from 3bd3111 to 343af37 Compare March 24, 2026 19:32

IstvanZsSzekely requested changes Mar 25, 2026

View reviewed changes

Comment thread library/vip/adi/spi_vip/adi_spi_vip_pkg.sv Outdated

Comment thread library/vip/adi/spi_vip/adi_spi_vip_pkg.sv Outdated

caosjr force-pushed the spi_n_lanes branch from 67a620b to 8eb7487 Compare May 4, 2026 19:51

LBFFilho previously approved these changes Jun 3, 2026

View reviewed changes

IstvanZsSzekely requested changes Jun 4, 2026

View reviewed changes

caosjr dismissed LBFFilho’s stale review via 0c8a62b June 5, 2026 13:02

caosjr force-pushed the spi_n_lanes branch 2 times, most recently from 7bbd948 to 0ef69b4 Compare June 5, 2026 13:10

caosjr added 2 commits June 5, 2026 10:10

docs/testbenches/project_based: Updated to NUM_OF_SDIO parameter

d070ebd

Updated from NUM_OF_SDI to NUM_OF_SDIO parameter in the documentation of the following projects: * ad463x; * ad738x; * ad7606; * pulsar_adc. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

caosjr force-pushed the spi_n_lanes branch from 0ef69b4 to 443e8f6 Compare June 5, 2026 13:10

caosjr requested a review from IstvanZsSzekely June 5, 2026 13:10

caosjr added 8 commits June 5, 2026 10:45

testbenches/project/ad738x: Update ad738x

938a269

Testbench was updated to use the new features related to the spi lane mask. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

testbenches/project/cn0363: Update cn0363

e783433

Fixes sdo_data type. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

testbenches/project/ltc2378: Update ltc2378

3483528

Fixes sdo_data type. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

testbenches/project/ad57xx: Update ad57xx

ac10bac

Using the latest framework for the tests. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

testbenches/project/ad463x: Update ad463x

6069a14

Using the latest framework for the tests. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

testbenches/project/ad7606x: Update ad7606x

4bcf2e2

Update to the latest multilane SPI Engine, using the latest framework. Removed the manual axi reads/writes and using the current APIs. Inserted a SPI VIP for the test_program_si.sv. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

testbenches/project/ad7616: Update ad7616

4aa08d1

Update to the latest multilane SPI Engine, using the latest framework. Removed the manual axi reads/writes and using the current APIs. Inserted a SPI VIP for the test_program_si.sv. Signed-off-by: Carlos Souza <carlos.souza@analog.com>

caosjr force-pushed the spi_n_lanes branch from 527f4f9 to 4aa08d1 Compare June 5, 2026 13:46

caosjr requested a review from LBFFilho June 5, 2026 13:48

IstvanZsSzekely reviewed Jun 5, 2026

View reviewed changes

caosjr mentioned this pull request Jun 8, 2026

testbenches/project/quad_adaq77681: Insert QUAD-ADAQ77681 #287

Open

14 tasks

IstvanZsSzekely approved these changes Jun 8, 2026

View reviewed changes

PIoandan self-requested a review June 9, 2026 12:26

PIoandan approved these changes Jun 9, 2026

View reviewed changes

sarpadi self-requested a review June 10, 2026 06:17

sarpadi approved these changes Jun 10, 2026

View reviewed changes

caosjr merged commit 748614f into main Jun 10, 2026
4 checks passed

caosjr deleted the spi_n_lanes branch June 10, 2026 11:29

github-actions Bot added a commit that referenced this pull request Jun 10, 2026

deploy: 748614f #240 (closed)

3afd388

Uh oh!

Conversation

caosjr commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Type

PR Checklist

Uh oh!

IstvanZsSzekely left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

IstvanZsSzekely left a comment

Choose a reason for hiding this comment

Uh oh!

IstvanZsSzekely commented Nov 14, 2025

Uh oh!

Uh oh!

Uh oh!

IstvanZsSzekely commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

IstvanZsSzekely left a comment

Choose a reason for hiding this comment

Uh oh!

IstvanZsSzekely left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

caosjr commented Jul 7, 2025 •

edited

Loading

IstvanZsSzekely commented Jun 4, 2026 •

edited

Loading