CR-1160311 xbflash2 tool doc update #7716
Merged
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
Signed-off-by: vboggara <[email protected]>
Signed-off-by: vboggara <[email protected]>
imrickysu
approved these changes
Sep 22, 2023
|
Build Passed! |
chvamshi-xilinx
approved these changes
Sep 22, 2023
Signed-off-by: vboggara <[email protected]>
imrickysu
approved these changes
Sep 22, 2023
|
Build Passed! |
uday610
approved these changes
Sep 22, 2023
|
Please cherry-pick to 2023.2 |
keryell
reviewed
Sep 23, 2023
|
|
||
| This tool doesn't come with XRT package, it comes as separate xbflash package. | ||
| This tool doesn't require XRT Package and it doesn't come with XRT package, it comes as separate xbflash package. |
There was a problem hiding this comment.
It does not. It comes in a xrt-xbflash2 package:
i xrt-xbflash2 - Xilinx RunTime stack for use with Xilinx FPGA platforms
Note that the package description is rather wrong because it copies the one from XRT.
vboggara-xilinx
added a commit
to vboggara-xilinx/XRT
that referenced
this pull request
Sep 24, 2023
* CR-1160311 xbflash2 tool doc update Signed-off-by: vboggara <[email protected]> * CR-1160311 xbflash2 tool doc update Signed-off-by: vboggara <[email protected]> * CR-1160311 xbflash2 tool doc update Signed-off-by: vboggara <[email protected]> --------- Signed-off-by: vboggara <[email protected]> (cherry picked from commit 3c356f4)
chvamshi-xilinx
pushed a commit
that referenced
this pull request
Sep 25, 2023
* CR-1160311 xbflash2 tool doc update Signed-off-by: vboggara <[email protected]> * CR-1160311 xbflash2 tool doc update Signed-off-by: vboggara <[email protected]> * CR-1160311 xbflash2 tool doc update Signed-off-by: vboggara <[email protected]> --------- Signed-off-by: vboggara <[email protected]> (cherry picked from commit 3c356f4)
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.
Problem solved by the commit
CR-1160311 xbflash2 tool doc update
Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered
https://jira.xilinx.com/browse/CR-1160311
How problem was solved, alternative solutions (if any) and why they were rejected
Improve xbflash2 documentation by:
Defining the software requirements. From the xbflash2 XRT doc page xbflash2 — XRT Master documentation (xilinx.github.io), it's not clear whether xbflash2 requires XRT or not. It only says xbflash2 package doesn't include XRT.
Provide link to download xbflash2, or mention generally where one can get it -> currently in the Alveo Lounge, however this may become public under the respective card pages.
Define all supported cards - currently it is strangely worded - "This tool supported for all Alveo platforms, U2 and U30 platforms.".
Be clear on supported platforms and suggested to reference UG1120. Current wording is ambiguous and refers to designs instead of platforms - "This tool is verified and supported only on XDMA PCIe DMA designs."
It mentions golden image - recommend to provide link to these images
Define how to obtain the BAR offset
Provide an example of 'xbflash dump' option
Risks (if any) associated the changes in the commit
Low
What has been tested and how, request additional testing if necessary
Documentation update
Documentation impact (if any)
Yes