docs/library/jesd204/xgt_wizard: Add FPGAs Tranceivers documentation #1643
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hadarauelena
requested review from
IuliaCMoldovan,
gastmaier,
StancaPop and
LBFFilho
as code owners
StancaPop
requested changes
Apr 4, 2025
|
|
||
| .. warning:: | ||
|
|
||
| Please note that if you used the GUI method to instantiate the wizard, the paring script will not work |
There was a problem hiding this comment.
Please revise the entire doc - try to wrap the text lines to 80 characters, if possible.
IuliaCMoldovan
requested changes
Apr 8, 2025
Comment on lines
115
to
120
| Location of the **COMMON** instance: | ||
| * <project_name>/<project_name>.gen/sources_1/ip/<component_name>/<component_name>_common.v | ||
| Location of the **CHANNEL** instance: | ||
| * <project_name>/<project_name>.gen/sources_1/ip/<component_name>/<component_name>_gt.v |
There was a problem hiding this comment.
Suggested change
| Location of the **COMMON** instance: | |
| * <project_name>/<project_name>.gen/sources_1/ip/<component_name>/<component_name>_common.v | |
| Location of the **CHANNEL** instance: | |
| * <project_name>/<project_name>.gen/sources_1/ip/<component_name>/<component_name>_gt.v | |
| - Location of the **COMMON** instance: | |
| <project_name>/<project_name>.gen/sources_1/ip/<component_name>/<component_name>_common.v | |
| - Location of the **CHANNEL** instance: | |
| <project_name>/<project_name>.gen/sources_1/ip/<component_name>/<component_name>_gt.v |
Comment on lines
120
to
126
| :: | ||
|
|
||
| [~] less daq2_zc706.gen/sources_1/ip/gtwizard_0/gtwizard_0_common.v | ||
| [~] less daq2_zc706.gen/sources_1/ip/gtwizard_0/gtwizard_0_gt.v |
There was a problem hiding this comment.
All the code blocks should be with the .. code-block:: directive, and all terminal commands should be with .. shell:: bash directive.
Suggested change
| :: | |
| [~] less daq2_zc706.gen/sources_1/ip/gtwizard_0/gtwizard_0_common.v | |
| [~] less daq2_zc706.gen/sources_1/ip/gtwizard_0/gtwizard_0_gt.v | |
| .. shell: bash | |
| /hdl/projects | |
| $less daq2_zc706.gen/sources_1/ip/gtwizard_0/gtwizard_0_common.v | |
| $less daq2_zc706.gen/sources_1/ip/gtwizard_0/gtwizard_0_gt.v |
| [~] less daq2_zc706.gen/sources_1/ip/gtwizard_0/gtwizard_0_common.v | ||
| [~] less daq2_zc706.gen/sources_1/ip/gtwizard_0/gtwizard_0_gt.v | ||
|
|
||
| This instances should be compared with the COMMON and CHANNEL instances used in :git-hdl:`util_adxcvr_xcm.v <library/xilinx/util_adxcvr/util_adxcvr_xcm.v>` |
There was a problem hiding this comment.
Suggested change
| This instances should be compared with the COMMON and CHANNEL instances used in :git-hdl:`util_adxcvr_xcm.v <library/xilinx/util_adxcvr/util_adxcvr_xcm.v>` | |
| These instances should be compared with the COMMON and CHANNEL instances used in :git-hdl:`util_adxcvr_xcm.v <library/xilinx/util_adxcvr/util_adxcvr_xcm.v>` |
| This instances should be compared with the COMMON and CHANNEL instances used in :git-hdl:`util_adxcvr_xcm.v <library/xilinx/util_adxcvr/util_adxcvr_xcm.v>` | ||
| and :git-hdl:`util_adxcvr_xch.v <library/xilinx/util_adxcvr/util_adxcvr_xch.v>` . | ||
|
|
||
| Ultrascale and Ultrascale+ FPGAs Transceiver Wizard |
There was a problem hiding this comment.
Suggested change
| Ultrascale and Ultrascale+ FPGAs Transceiver Wizard | |
| UltraScale FPGAs Transceiver Wizard |
For simplicity, leave it like this
Comment on lines
159
to
171
| Location of the **COMMON** instance: | ||
| * <project_name>/<project_name>.gen/sources_1/ip/<component_name>/synth/gtwizard_ultrascale_v1_7_gthe4_common.v | ||
| Location of the **COMMON** wrapper: | ||
| * <project_name>/<project_name>.gen/sources_1/ip/<component_name>/synth/<component_name>_gthe4_common_wrapper.v | ||
| Location of the **CHANNEL** instance: | ||
| * <project_name>/<project_name>.gen/sources_1/ip/<component_name>/synth/gtwizard_ultrascale_v1_7_gthe4_channel.v | ||
| Location of the **CHANNEL** instance: | ||
| * <project_name>/<project_name>.gen/sources_1/ip/<component_name>/synth/<component_name>_gthe4_channel_wrapper.v |
There was a problem hiding this comment.
Restructure like in the previous comment.
Also, - lists should be used over * lists.
Comment on lines
194
to
205
| :: | ||
|
|
||
| source ../../scripts/gtwizard_generator.tcl |
There was a problem hiding this comment.
Suggested change
| :: | |
| source ../../scripts/gtwizard_generator.tcl | |
| .. code-block:: tcl | |
| source ../../scripts/gtwizard_generator.tcl |
This applies to all the code blocks.
hadarauelena
force-pushed
the
xcvr_migrate_doc
branch
from
1b0c259 to
5506bb6
Compare
Signed-off-by: Elena-Hadarau_adi <[email protected]>
hadarauelena
force-pushed
the
xcvr_migrate_doc
branch
from
5506bb6 to
b381722
Compare
13 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
Added documentation for the Xilinx FPGA Transceivers Wizard to GitHubIO.
PR Type
PR Checklist