aboutsummaryrefslogtreecommitdiffstats
path: root/host/include
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2021-08-26 10:39:23 +0200
committerAaron Rossetto <aaron.rossetto@ni.com>2021-08-30 12:31:23 -0500
commit919043f305efdd29fbdf586e9cde95d9507150e8 (patch)
tree383215c83bd3d91949d3d84e9e6fd07608c1f829 /host/include
parent7c794c4bd384bbcae051e024086f2293457ddd65 (diff)
downloaduhd-919043f305efdd29fbdf586e9cde95d9507150e8.tar.gz
uhd-919043f305efdd29fbdf586e9cde95d9507150e8.tar.bz2
uhd-919043f305efdd29fbdf586e9cde95d9507150e8.zip
rfnoc: ddc: Improve unit tests and documentation
The previous commit fixed a bug in the DUC, where get_frequency_range() reported incorrect values. The DDC did not have this bug, but we port the updates to the unit tests and the documentation from the DUC to the DDC for consistency's sake.
Diffstat (limited to 'host/include')
-rw-r--r--host/include/uhd/rfnoc/ddc_block_control.hpp7
1 files changed, 7 insertions, 0 deletions
diff --git a/host/include/uhd/rfnoc/ddc_block_control.hpp b/host/include/uhd/rfnoc/ddc_block_control.hpp
index 834fa0aa3..053b78c4c 100644
--- a/host/include/uhd/rfnoc/ddc_block_control.hpp
+++ b/host/include/uhd/rfnoc/ddc_block_control.hpp
@@ -79,6 +79,13 @@ public:
/*! Return the range of frequencies that \p chan can be set to.
*
+ * The frequency shifter is the first component in the DDC, and thus can
+ * shift frequencies (digitally) between -get_input_rate()/2
+ * and +get_input_rate()/2.
+ *
+ * The returned values are in Hz (not normalized frequencies) and are valid
+ * inputs for set_freq().
+ *
* \return The range of frequencies that the DDC can shift the input by
*/
virtual uhd::freq_range_t get_frequency_range(const size_t chan) const = 0;