aboutsummaryrefslogtreecommitdiffstats
path: root/host
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2022-03-10 17:37:47 +0100
committerAaron Rossetto <aaron.rossetto@ni.com>2022-03-14 15:46:08 -0500
commitb14480265ddeb1e6b4ad9d52c11b4c39e36fd379 (patch)
tree44a09f1cb9cfb899a9d9f51622121dc26e9c5054 /host
parent2bf225bf50d3859a4fa622d15b6606688a00065f (diff)
downloaduhd-b14480265ddeb1e6b4ad9d52c11b4c39e36fd379.tar.gz
uhd-b14480265ddeb1e6b4ad9d52c11b4c39e36fd379.tar.bz2
uhd-b14480265ddeb1e6b4ad9d52c11b4c39e36fd379.zip
docs: Fix reference to RFNoC documentation
This fixes links to RFNoC docs in the "Coding to the API" section.
Diffstat (limited to 'host')
-rw-r--r--host/docs/coding.dox8
1 files changed, 7 insertions, 1 deletions
diff --git a/host/docs/coding.dox b/host/docs/coding.dox
index e5016ab04..a51aa858b 100644
--- a/host/docs/coding.dox
+++ b/host/docs/coding.dox
@@ -12,7 +12,11 @@ setup. See the documentation for uhd::usrp::multi_usrp.
\subsection coding_api_hilevel_rfnoc High-Level: The RFNoC API
-\li \subpage page_properties
+This is a more granular API than the Multi-USRP API, and can directly interact
+with RFNoC blocks in a device, and the RFNoC graph. This is available for all
+Generation-3 USRPs and above.
+
+For more information on RFNoC, see \ref rfnoc_docs.
\subsection coding_api_hilevelclock High-Level: The Multi-USRP-Clock
@@ -27,6 +31,8 @@ by default in all UHD builds. More information can be found \subpage page_c_api
\subsection coding_api_lowlevel Low-Level: The device API
+This is an older API for pre-RFNoC devices (N2xx, B2xx, B100, USRP1).
+
A device is an abstraction for hardware that is connected to the host
system. For a USRP device, this means that the motherboard and
everything on it would be considered to be a "device". For a clock device, the