uhd/host/examples/rfnoc-example
Wade Fife ada6a4e467 examples: Add IP to OOT RFNoC gain example
This updates the gain example to show how to use RFNoC IP, in-tree
Xilinx IP, and out-of-tree Xilinx IP in a custom RFNoC block.
2021-03-17 17:46:06 -05:00
..
apps Examples: Fix install paths in OOT RFNoC example 2020-09-13 09:48:11 -07:00
blocks Examples: Fix install paths in OOT RFNoC example 2020-09-13 09:48:11 -07:00
cmake examples: Add example out-of-tree module for RFNoC modules 2019-11-26 12:21:32 -08:00
fpga examples: Add IP to OOT RFNoC gain example 2021-03-17 17:46:06 -05:00
icores rfnoc-example: Removed DRAM from image core 2020-05-05 08:04:50 -05:00
include/rfnoc/example examples: Add example out-of-tree module for RFNoC modules 2019-11-26 12:21:32 -08:00
lib uhd: Apply clang-format against all .cpp and .hpp files in host/ 2020-03-03 08:51:32 -06:00
.gitignore examples: Add example out-of-tree module for RFNoC modules 2019-11-26 12:21:32 -08:00
CMakeLists.txt Examples: Fix install paths in OOT RFNoC example 2020-09-13 09:48:11 -07:00
README.md examples: Add example out-of-tree module for RFNoC modules 2019-11-26 12:21:32 -08:00

RFNoC: An example out-of-tree module

This directory contains a fully functional out-of-tree module with a gain block. It serves as an example for OOT modules with UHD 4.0 and above.

Directory Structure

  • blocks: This directory contains all the block definitions. These block definitions can be read by the RFNoC tools, and will get installed into the system for use by other out-of-tree modules.

  • cmake: This directory only needs to be modified if this OOT module will come with its own custom CMake modules.

  • fpga: This directory contains the source code for the HDL modules of the individual RFNoC blocks, along with their testbenches, and additional modules required to build the blocks. There is one subdirectory for every block.

  • include/rfnoc/example: Here, all the header files for the block controllers are stored, along with any other include files that should be installed when installing this OOT module.

  • lib: Here, all the non-header source files for the block controllers are stored, along with any other include file that should be installed when installing this OOT module. This includes the block controller cpp files.

  • apps: This contains an example application that links against UHD and this OOT module. The app does not get installed, it resides in the build directory.