Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add ip_based dma_flock testbench #154

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

gastmaier
Copy link
Contributor

PR Description

Merge after #153

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)

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

Most merge conflicts are just the inclusion at the toctree in
alphabetical order, by using glob, we can mitigate them.
To not include the orphan templates, rename them to _index.

Also remove dangling orphan empty project ad7616.

Signed-off-by: Jorge Marques <[email protected]>
Signed-off-by: Jorge Marques <[email protected]>
Base automatically changed from doc-glob-ip-proj to main January 10, 2025 08:02
* Two DMAs, one with the role of writer (stream to memory-mapped)
and the other with the role of reader (memory-mapped to stream).
* Two AXI4Stream VIPs, to produce and consume the generated test pattern.
* One AXI VIP, to emulate a DDR memory between the DMAs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The DDR memory is already inside the test harness.

Configuration files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The following are the available configuration files along with their
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you try to put the configuration lists into a table?

Comment on lines +111 to +112
The cfg1 is compatbile with test_program and cfg2_fsync and cfg3_fsync_autorun
are compatible with test_program_frame_delay.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make more sense to have a list or table for each test program with the compatible configurations?

- Generate synchronisation stimulus (if enabled).
- Wait the number of frames are generated.

* Stops the watchdog
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The testbench doesn't contain any watchdog

* Do single tests on variant number of frames, distance and clock frequencies:

- Remove backpressure at AXIS destination and DDR.
- Obtain randomized DMA sequencers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obtain randomized DMA sequences.
I'm guessing that you meant a DMA sequence here, since a sequencer processes sequences; in our case it creates them

- Obtain randomized DMA sequencers.
- Enable sequencer test data generation.
- Configure control and flags of the DMA.
- Submit the DMA sequencers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as previous

depending on the clock ratios between the writer and reader.
Then asserts if all bytes in the frame are equal to the first byte.

The test bench may end before the last frame is fully transferred at the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add an Info directive to it, as it is something that should be highlighted.


Testbenches related dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the HDL related dependencies as well.

@IstvanZsSzekely IstvanZsSzekely added the documentation Improvements or additions to documentation label Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants