Question: XDMA Driver Install Guide vs ERRATA
- Dominant language
- SystemVerilog
- Stars
- 1.7k
- Forks
- 538
- PR merge metrics
- No merged PRs in 30d
Description
**Branch:** `f2`
Hi, I wanted to flag what appears to be a documentation inconsistency and ask for some clarification.
`ERRATA.md` states that XDMA Shell support is not available at this time and that CL builds using it will result in a build failure. However, `hdk/docs/XDMA-Install.rst` contains a complete step-by-step guide for installing the XDMA kernel driver with no mention of this limitation.
I was wondering if you could help clarify a few things:
1. Is `hdk/docs/XDMA-Install.rst` forward-looking documentation added ahead of actual shell support, or is there a supported XDMA path on F2 that I may be missing?
2. If XDMA shell support is not yet available, is there any indication of when it might be supported on F2?
3. Would it make sense to add a disclaimer to `hdk/docs/XDMA-Install.rst` noting that the XDMA Shell is not yet supported, similar to the ⚠️ warnings used elsewhere in the docs? That would help other developers avoid confusion.
For context, I arrived at this after looking for high-throughput host-to-FPGA transfer options on F2 and am currently planning to use the PCIS interface instead. Any clarification on the XDMA timeline would be really helpful for planning purposes. Thanks!
Contributor guide
Research direction
Start by comparing ERRATA.md with hdk/docs/XDMA-Install.rst for the F2 branch and identify the conflicting XDMA Shell support statements. Confirm the supported path and timeline with maintainers before changing either document. Done means the two documents no longer give contradictory guidance, with any required limitation clearly stated.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100