search

EttusResearch / uhd

The USRP™ Hardware Driver Repository
http://uhd.ettus.com
Other
995 stars 666 forks source link

Update Gen3 USRP FPGA Build Instructions with more information #600

Closed zminot closed 2 years ago

zminot commented 2 years ago

Issue Description

Ran through the x410 (x400) setup recently, and there were a couple things that I felt could be added to the documentation to help devs get through the process.

One of the main things was that the x410 actually requires 2019.1.1_AR73068, not just 2019.1. The 2019.1.1 is pretty self-explanatory, but finding that patch for AR73068 was a bit construed and we could just directly link it there (link to the patch).

Also, one needs to make sure they install RFSoC XCZU28DR when installing Xilinx as it does not come by default (you have to select it).

Might want to also include which operating systems are supported by the required versions of Xilinx (not necessary).

Not necessary for it to be specifically Python 3.5, but Python ~3.9+~ 3.5+ (afaik).

I think as well the documentation seems like it needs a reorganization as it constantly switches between Xilinx ISE and Vivado. Realistically, I think it would be easier to read if you found which program you needed to use via the SDR you're working with, then find the operating system you are planning to user, and then finally you get all of the directions for it.

Setup Details

Open https://github.com/EttusResearch/uhd/blob/master/fpga/docs/usrp3/build_instructions.md

Expected Behavior

To include the above.

Actual Behaviour

It isn't haha.

Steps to reproduce the problem

Read ig

Additional Information

Planning on making a pull request to update this a bit. Let me know if we should include anything else.

Also, would making this pull request sync this documentation page?

wordimont commented 2 years ago

@zminot Thanks for the feedback.

I agree regarding the AR and which families to install.

Regarding Python version, I think it should just say Python 3.5+ instead of just Python 3.5, right? Or are you saying 3.9 is the minimum?

I'm not sure how to fix the "switches between Xilinx ISE and Vivado" issue. Maybe we could put the instructions for the ISE-based devices in a separate page.

Yes, when we merge a pull request for the manual, the online manual automatically updates. Automation is great. 😄

zminot commented 2 years ago

Sorry! I meant Python 3.5+ is fine.

I'm not sure how to fix the "switches between Xilinx ISE and Vivado" issue. Maybe we could put the instructions for the ISE-based devices in a separate page.

This would work, or we just have one one half of the doc discuss Vivado the other discuss ISE rather than sort of zipped as it is now.

wordimont commented 2 years ago

Fixed by https://github.com/EttusResearch/uhddev/pull/6198