diff options
Diffstat (limited to 'fpga/README.md')
| -rw-r--r-- | fpga/README.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/fpga/README.md b/fpga/README.md new file mode 100644 index 000000000..3bc131307 --- /dev/null +++ b/fpga/README.md @@ -0,0 +1,57 @@ +Ettus Research USRP FPGA HDL Source +=================================== + +Welcome to the USRP FPGA HDL source code tree! This repository contains +free & open-source FPGA HDL for the Universal Software Radio Peripheral +(USRP™) SDR platform, created and sold by Ettus Research. A large +percentage of the source code is written in Verilog. + +## Product Generations + +This repository contains the FPGA source for the following generations of +USRP devices. + +### Generation 1 + +- Directory: __usrp1__ +- Devices: USRP Classic Only +- Tools: Quartus from Altera +- [Build Instructions](http://files.ettus.com/manual/md_usrp1_build_instructions.html) + +### Generation 2 + +- Directory: __usrp2__ +- Devices: USRP N2X0, USRP B100, USRP E1X0, USRP2 +- Tools: ISE from Xilinx, GNU make +- [Build Instructions](http://files.ettus.com/manual/md_usrp2_build_instructions.html) +- [Customization Instructions](http://files.ettus.com/manual/md_usrp2_customize_signal_chain.html) + +### Generation 3 + +- Directory: __usrp3__ +- Devices: USRP B2X0, USRP X Series, USRP E3X0, USRP N3xx +- Tools: Vivado from Xilinx, ISE from Xilinx, GNU make +- [Build Instructions](http://files.ettus.com/manual/md_usrp3_build_instructions.html) +- [Simulation](http://files.ettus.com/manual/md_usrp3_simulation.html) + + +## Pre-built FPGA Images + +Pre-built FPGA and Firmware images are not hosted here. Please visit the +[FPGA and Firmware manual page](http://files.ettus.com/manual/page_images.html) +for instructions on downloading and using pre-built images. In most cases, running the following +command will do the right thing. + + $ uhd_images_downloader + +## Building This Manual + +This FPGA manual is available on the web at http://files.ettus.com/manual/md_fpga.html for the most +recent stable version of UHD. If you wish to read documentation for a custom/unstable branch you will +need to build it and open it locally using a web browser. To do so please install +[Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html#srcbin) on your system and run the following commands: + + $ cd docs + $ make + $ sensible-browser html/index.html + |