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.

Sign up for GitHub

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

Jump to bottom

docs/library/axi_ltc2387: Add doc. & update IP GUI #1450

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

docs/library/axi_ltc2387: Add doc. & update IP GUI #1450

wants to merge 2 commits into from
+1,778 −24

Conversation

IuliaCMoldovan
Copy link
Contributor

@IuliaCMoldovan IuliaCMoldovan commented Sep 9, 2024 •
edited
Loading

PR Description

  • docs/library/axi_ltc2387: Added the documentation
  • library/axi_ltc2387/axi_ltc2387_ip.tcl: Updated the GUI by adding TWOLANES as a parameter. This is needed for the hdl-interface directive to get the right value range for this parameter. Also I updated the way the other 2 parameters are instantiated (ADC_RES and OUT_RES)

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • Breaking change (has dependencies in other repos or will cause CI to fail)

PR Checklist

  • I have followed the code style guidelines
  • I have performed a self-review of changes
  • I have compiled all hdl projects and libraries affected by this PR
  • I have tested in hardware affected projects, at least on relevant boards
  • 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/Critical Warnings on compilation
  • I have added new hdl testbenches or updated existing ones

@IuliaCMoldovan IuliaCMoldovan marked this pull request as draft September 30, 2024 09:10
@IuliaCMoldovan IuliaCMoldovan force-pushed the doc_ltc2387 branch 2 times, most recently from b05ab33 to 7d6f0d8 Compare October 4, 2024 14:34
@IuliaCMoldovan IuliaCMoldovan marked this pull request as ready for review October 4, 2024 14:35
@IuliaCMoldovan IuliaCMoldovan force-pushed the doc_ltc2387 branch 3 times, most recently from 75f130f to 2997734 Compare October 4, 2024 14:43
@IuliaCMoldovan
Copy link
Contributor Author

Updated the format of the block diagram

gastmaier
gastmaier previously approved these changes Oct 4, 2024
View reviewed changes
@IuliaCMoldovan IuliaCMoldovan changed the title docs: Add documentation & update IP GUI for AXI LTC2387 docs/library/axi_ltc2387: Add doc. & update IP GUI Oct 8, 2024
@IuliaCMoldovan IuliaCMoldovan force-pushed the doc_ltc2387 branch 2 times, most recently from d6957a3 to c886519 Compare October 8, 2024 13:40
@IuliaCMoldovan
docs/library: Add axi_ltc2387 IP documentation
722ad87 
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
@IuliaCMoldovan
library/axi_ltc2387: Update GUI
b28feeb 
 * Added TWOLANES to the GUI
 * Changed the way these 3 parameters are created and displayed
   (ADC_RES, OUT_RES, TWOLANES)
 * ADC_RES and TWOLANES are user-selectable, but OUT_RES depends on
   ADC_RES, so a warning was added in the IP GUI
 * Fixed the default values on parameters (ADC_RES=18, OUT_RES=32, TWOLANES=1)

Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
@IuliaCMoldovan
Copy link
Contributor Author

  • Fixed the default value for the parameters in the modules (doesn't affect the functionality, because these are set in the CN0577 project)
  • Updated the GUI to be more suggestive

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StancaPop StancaPop Awaiting requested review from StancaPop StancaPop is a code owner

@LBFFilho LBFFilho Awaiting requested review from LBFFilho LBFFilho is a code owner

@acostina acostina Awaiting requested review from acostina acostina is a code owner

@AndreiGrozav AndreiGrozav Awaiting requested review from AndreiGrozav AndreiGrozav is a code owner

@PopPaul2021 PopPaul2021 Awaiting requested review from PopPaul2021 PopPaul2021 is a code owner

@sarpadi sarpadi Awaiting requested review from sarpadi sarpadi is a code owner

@gastmaier gastmaier Awaiting requested review from gastmaier gastmaier is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
doc enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@IuliaCMoldovan @gastmaier