aboutsummaryrefslogtreecommitdiffstats
path: root/host/include
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2014-11-21 15:27:36 +0100
committerMartin Braun <martin.braun@ettus.com>2014-11-21 15:27:36 +0100
commit7866b66587c7570890a24a7ebc89330976a8d81b (patch)
tree35bc650e3364802be610f150a2a6d9c85511899d /host/include
parentacb76266a9470209128dcfe982bfd33c1545df97 (diff)
downloaduhd-7866b66587c7570890a24a7ebc89330976a8d81b.tar.gz
uhd-7866b66587c7570890a24a7ebc89330976a8d81b.tar.bz2
uhd-7866b66587c7570890a24a7ebc89330976a8d81b.zip
docs: Added notes on auto_tick_rate (B200)
Diffstat (limited to 'host/include')
-rw-r--r--host/include/uhd/usrp/multi_usrp.hpp5
1 files changed, 5 insertions, 0 deletions
diff --git a/host/include/uhd/usrp/multi_usrp.hpp b/host/include/uhd/usrp/multi_usrp.hpp
index 6fd22ff23..2362ebcd7 100644
--- a/host/include/uhd/usrp/multi_usrp.hpp
+++ b/host/include/uhd/usrp/multi_usrp.hpp
@@ -155,6 +155,11 @@ public:
* If the specified rate is not available, this method will throw.
* On other devices, this method notifies the software of the rate,
* but requires the the user has made the necessary hardware change.
+ *
+ * If the device has an 'auto clock rate' setting (e.g. B200, see also
+ * \ref b200_auto_mcr), this will get disabled and the clock rate will be
+ * fixed to \p rate.
+ *
* \param rate the new master clock rate in Hz
* \param mboard the motherboard index 0 to M-1
*/