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

Jesd204 doc2 #2

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

Jesd204 doc2 #2

wants to merge 3 commits into from

Conversation

gastmaier
Copy link
Collaborator

PR Description

Please replace this comment with summary, motivation and context of the changes.
List any dependencies required for this change.

You can check the checkboxes below by inserting a 'x' between square brackets
(without any other characters or spaces) or just check them after publishing the PR.

If there is a breaking change, specify dependent PRs in description and
try to push all related PRs at the same time.

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

@caosjr caosjr force-pushed the jesd204_doc2 branch 2 times, most recently from b28cbe1 to 64c51bc Compare February 13, 2024 20:26
gastmaier
gastmaier commented Feb 15, 2024
View reviewed changes
Copy link
Collaborator Author

@gastmaier gastmaier left a comment •
edited
Loading

Choose a reason for hiding this comment

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

  1. Please resolve in a new commit all mismatching parameters, signal and buses.
    Investigate in the IP source code to understand and resolve these mismatches.

Log:

WARNING: PN31_ENABLE defined in the parameters directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_adc/component.xml)!
WARNING: Signal S_AXI defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_adc/component.xml)!
WARNING: Signal Link defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_adc/component.xml)!
WARNING: Signal LINK_DATA defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_adc/component.xml)!
WARNING: Signal Application defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_adc/component.xml)!
WARNING: Signal Configuration defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_dac/component.xml)!
WARNING: Signal S_AXI defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_dac/component.xml)!
WARNING: Signal Link defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_dac/component.xml)!
WARNING: Signal LINK_DATA defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_dac/component.xml)!
WARNING: Signal Application defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_dac/component.xml)!
WARNING: TPL_DATA_PATH_WIDTH defined in the parameters directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: ASYNC_CLK defined in the parameters directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal S_AXI defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal clk defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal reset defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal RX_DATA defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal sync[m-1:0] defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal sysref defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal RX_PHYn defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal phy_en_char_align defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal phy_ready defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: TPL_DATA_PATH_WIDTH defined in the parameters directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: ASYNC_CLK defined in the parameters directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal S_AXI defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal clk defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal reset defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal TX_DATA defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal sync[m-1:0] defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal sysref defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal TX_PHYn defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
/mnt/wsl/data/repos/hdl/docs/library/jesd204/axi_jesd204_tx/index.rst:: ERROR: Anonymous hyperlink mismatch: 1 references but 0 targets.
See "backrefs" attribute for IDs.
WARNING: TPL_DATA_PATH_WIDTH defined in the parameters directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: ASYNC_CLK defined in the parameters directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal S_AXI defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal clk defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal reset defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal RX_DATA defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal sync[m-1:0] defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal sysref defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal RX_PHYn defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal phy_en_char_align defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: Signal phy_ready defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_rx/component.xml)!
WARNING: TPL_DATA_PATH_WIDTH defined in the parameters directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: ASYNC_CLK defined in the parameters directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal S_AXI defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal clk defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal reset defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal TX_DATA defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal sync[m-1:0] defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal sysref defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
WARNING: Signal TX_PHYn defined in the interface directive does not exist in the IP-XACT (library/jesd204/axi_jesd204_tx/component.xml)!
/mnt/wsl/data/repos/hdl/docs/library/jesd204/axi_jesd204_tx/index.rst:: ERROR: Anonymous hyperlink mismatch: 1 references but 0 targets.
See "backrefs" attribute for IDs.
WARNING: Signal Configuration defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_dac/component.xml)!
WARNING: Signal S_AXI defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_dac/component.xml)!
WARNING: Signal Link defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_dac/component.xml)!
WARNING: Signal LINK_DATA defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_dac/component.xml)!
WARNING: Signal Application defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_dac/component.xml)!
WARNING: PN31_ENABLE defined in the parameters directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_adc/component.xml)!
WARNING: Signal S_AXI defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_adc/component.xml)!
WARNING: Signal Link defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_adc/component.xml)!
WARNING: Signal LINK_DATA defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_adc/component.xml)!
WARNING: Signal Application defined in the interface directive does not exist in the IP-XACT (library/jesd204/ad_ip_jesd204_tpl_adc/component.xml)!
  1. See the changes on my review commit.
  2. Make the remaining images smaller, just like I did in the commit review.

docs/library/jesd204/axi_jesd204_tx/index.rst Outdated
``TPL_DATA_PATH_WIDTH``
* - device_reset
- Reset active high synchronous with the `Device clock
<jesd204_glossary#clocks>`__.
Copy link
Collaborator Author

@gastmaier gastmaier Feb 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

  1. Please import jesd204/jesd204_glossary and fix all broken references related to this.
    On the compile log, it shows as:
/hdl/docs/library/jesd204/axi_jesd204_tx/index.rst:: ERROR: Anonymous hyperlink mismatch: 1 references but 0 targets.
/hdl/docs/library/jesd204/axi_jesd204_tx/index.rst:: ERROR: Anonymous hyperlink mismatch: 1 references but 0 targets.

@caosjr caosjr force-pushed the jesd204_doc2 branch 2 times, most recently from 1db4351 to 79e00d6 Compare February 22, 2024 19:56
@gastmaier
docs: Adds JESD204 documentation in pandoc
bbec9a0 
Deletes python scripts in extension folder. It is using doctools
developed by Jorge Marques

Fixes image size of the svg files
Fixes links to ADI products
Fixes links inside adi_regmap_xcvr.txt
Several cosmetic changes

TODO:
	* fix regmap generator
	* fix axi_adxcvr regmap for Intel. Several descriptions for Xilinx
	* fix regmap register access types
	* fix wavedrom output size

Signed-off-by: Carlos Souza <[email protected]>
Signed-off-by: Jorge Marques <[email protected]>
@gastmaier
docs: Minor JESD204 changes
ff991aa 
Implicit path to library when the doc is hierarchically coherent with the
library.

Signed-off-by: Jorge Marques <[email protected]>
gastmaier
gastmaier commented Feb 22, 2024
View reviewed changes
docs/library/xilinx/util_adxcvr/index.rst Outdated
* - Pin
- Type
- Description
* - ``up_ch_*``
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Isn't this up_rx_* and up_tx_* ?

Copy link
Owner

Choose a reason for hiding this comment

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

it is, but I think they decided to put up_ch_* in the original dokuwiki to make it as generic as possible. I can change it if you think it is more descriptive.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Please change it. I favor consistency with the IP implementation.

@gastmaier gastmaier changed the base branch from main to fix_vcu118_eth February 22, 2024 22:07
@gastmaier gastmaier changed the base branch from fix_vcu118_eth to main February 22, 2024 22:07
@caosjr
docs: fixes semantic issues
c6c08ed 
Fixes several semantic texts over the JESD204 doc
Cosmetic changes

Signed-off-by: Carlos Souza <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@caosjr caosjr caosjr left review comments

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

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