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 ad7616 doc #169

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

docs: Add ad7616 doc #169

wants to merge 2 commits into from

Conversation

StancaPop
Copy link
Collaborator

PR Description

Add ad7616 testbench documentation.

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

@StancaPop StancaPop added the documentation Improvements or additions to documentation label Feb 7, 2025
docs/testbenches/project_based/ad7616/index.rst Outdated Show resolved Hide resolved
docs/testbenches/project_based/ad7616/index.rst Outdated Show resolved Hide resolved
docs/testbenches/project_based/ad7616/index.rst Outdated Show resolved Hide resolved
docs/testbenches/project_based/ad7616/index.rst Outdated Show resolved Hide resolved
Data Acquisition Test
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Start teh spi clk generator
Copy link
Contributor

Choose a reason for hiding this comment

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

Standardize upper and lowercases throughout the documentation

docs/testbenches/project_based/ad7616/index.rst Outdated Show resolved Hide resolved
- ---
* - SYSID_ROM
- :git-hdl:`library/sysid_rom`
- :external+hdl:ref:`here <axi_sysid>`
Copy link
Contributor

Choose a reason for hiding this comment

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

Update the shown link naming to the IPs name

:widths: 30 45 25
:header-rows: 1

* - SV dependency name
Copy link
Contributor

Choose a reason for hiding this comment

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

Add missing dependencies: ex. ADI_REGMAP_AXI_AD7617_PKG

:widths: 30 45 25
:header-rows: 1

* - SV dependency name
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a legend to denote which packages are used in which testbenches

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