aboutsummaryrefslogtreecommitdiffstats
path: root/host
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2020-02-04 12:38:41 -0800
committeratrnati <54334261+atrnati@users.noreply.github.com>2020-02-07 09:04:58 -0600
commitc1c13ca8b095da212c2e642d67a32e5f31e19194 (patch)
tree38560dd7283ae51d73e4790eeb8fca82a0b449c2 /host
parentb746819769e6a960f8227981ea10c7ed9c3d826a (diff)
downloaduhd-c1c13ca8b095da212c2e642d67a32e5f31e19194.tar.gz
uhd-c1c13ca8b095da212c2e642d67a32e5f31e19194.tar.bz2
uhd-c1c13ca8b095da212c2e642d67a32e5f31e19194.zip
rfnoc: registry: Fix Doxygen for register_block_direct()
Diffstat (limited to 'host')
-rw-r--r--host/include/uhd/rfnoc/registry.hpp12
1 files changed, 12 insertions, 0 deletions
diff --git a/host/include/uhd/rfnoc/registry.hpp b/host/include/uhd/rfnoc/registry.hpp
index 7110c3fe4..d4256b542 100644
--- a/host/include/uhd/rfnoc/registry.hpp
+++ b/host/include/uhd/rfnoc/registry.hpp
@@ -66,6 +66,18 @@ public:
* \param device_id The 16-bit Device-ID for this block
* (ANY_DEVICE for device agnostic blocks).
* \param block_name The name used for the block ID (e.g. "Radio").
+ * \param mb_access Set this to true to request full access to the
+ * motherboard in the block controller. Radio blocks, for
+ * example, require this. If set, UHD may grant access to
+ * the underlying motherboard controller to the block.
+ * See also uhd::rfnoc::noc_block_base::get_mb_controller().
+ * \param timebase_clock The name of the clock that is used for time
+ * reference on timed commands. Blocks that derive
+ * time from the graph (e.g. DDC, DUC blocks) should
+ * set this to uhd::rfnoc::CLOCK_KEY_GRAPH.
+ * \param ctrlport_clock The name of the clock that is driving the control
+ * port. This is device-dependent. A typical value
+ * is `"bus_clk"`.
* \param factory_fn A factory function that returns a reference to the
* block.
*/