summaryrefslogtreecommitdiffstats
path: root/host/include
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2011-10-12 09:59:41 -0700
committerJosh Blum <josh@joshknows.com>2011-11-03 20:37:12 -0700
commit9369259177e5517e2b0e775804224c5467e14eab (patch)
tree06b717dae712517e9acbb2e6bbbacce620c55f8e /host/include
parentc885da11389ee275f9c5206b9f8a2155a5393a8a (diff)
downloaduhd-9369259177e5517e2b0e775804224c5467e14eab.tar.gz
uhd-9369259177e5517e2b0e775804224c5467e14eab.tar.bz2
uhd-9369259177e5517e2b0e775804224c5467e14eab.zip
usrp: deprecated clock config, added time/clock source calls
Diffstat (limited to 'host/include')
-rw-r--r--host/include/uhd/deprecated.hpp1
-rw-r--r--host/include/uhd/types/clock_config.hpp5
-rw-r--r--host/include/uhd/usrp/multi_usrp.hpp53
3 files changed, 57 insertions, 2 deletions
diff --git a/host/include/uhd/deprecated.hpp b/host/include/uhd/deprecated.hpp
index e4112fa66..d918836f1 100644
--- a/host/include/uhd/deprecated.hpp
+++ b/host/include/uhd/deprecated.hpp
@@ -243,3 +243,4 @@ namespace uhd{
#endif /* INCLUDED_UHD_TYPES_OTW_TYPE_HPP */
#include <uhd/types/io_type.hpp> //wish it was in here
+#include <uhd/types/clock_config.hpp> //wish it was in here
diff --git a/host/include/uhd/types/clock_config.hpp b/host/include/uhd/types/clock_config.hpp
index 24bd96d14..27b312245 100644
--- a/host/include/uhd/types/clock_config.hpp
+++ b/host/include/uhd/types/clock_config.hpp
@@ -23,10 +23,13 @@
namespace uhd{
/*!
- * Clock configuration settings:
+ * The DEPRECATED Clock configuration settings:
* The source for the 10MHz reference clock.
* The source and polarity for the PPS clock.
*
+ * Deprecated in favor of set time/clock source calls.
+ * Its still in this file for the sake of gr-uhd swig.
+ *
* Use the convenience functions external() and internal(),
* unless you have a special purpose and cannot use them.
*/
diff --git a/host/include/uhd/usrp/multi_usrp.hpp b/host/include/uhd/usrp/multi_usrp.hpp
index 72386204f..ee7bf8424 100644
--- a/host/include/uhd/usrp/multi_usrp.hpp
+++ b/host/include/uhd/usrp/multi_usrp.hpp
@@ -18,11 +18,13 @@
#ifndef INCLUDED_UHD_USRP_MULTI_USRP_HPP
#define INCLUDED_UHD_USRP_MULTI_USRP_HPP
+#define UHD_USRP_MULTI_USRP_REF_SOURCES_API
+
#include <uhd/config.hpp>
#include <uhd/device.hpp>
+#include <uhd/deprecated.hpp>
#include <uhd/types/ranges.hpp>
#include <uhd/types/stream_cmd.hpp>
-#include <uhd/types/clock_config.hpp>
#include <uhd/types/tune_request.hpp>
#include <uhd/types/tune_result.hpp>
#include <uhd/types/sensors.hpp>
@@ -31,6 +33,7 @@
#include <uhd/usrp/mboard_iface.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/utility.hpp>
+#include <string>
#include <vector>
namespace uhd{ namespace usrp{
@@ -235,6 +238,7 @@ public:
/*!
* Set the clock configuration for the usrp device.
+ * DEPRECATED in favor of set time and clock source calls.
* This tells the usrp how to get a 10Mhz reference and PPS clock.
* See the documentation for clock_config_t for more info.
* \param clock_config the clock configuration to set
@@ -243,6 +247,53 @@ public:
virtual void set_clock_config(const clock_config_t &clock_config, size_t mboard = ALL_MBOARDS) = 0;
/*!
+ * Set the time source for the usrp device.
+ * This sets the method of time synchronization,
+ * typically a pulse per second or an encoded time.
+ * Typical options for source: external, MIMO.
+ * \param source a string representing the time source
+ * \param mboard which motherboard to set the config
+ */
+ virtual void set_time_source(const std::string &source, const size_t mboard = ALL_MBOARDS) = 0;
+
+ /*!
+ * Get the currently set time source.
+ * \param mboard which motherboard to get the config
+ * \return the string representing the time source
+ */
+ virtual std::string get_time_source(const size_t mboard) = 0;
+
+ /*!
+ * Get a list of possible time sources.
+ * \param mboard which motherboard to get the list
+ * \return a vector of strings for possible settings
+ */
+ virtual std::vector<std::string> get_time_sources(const size_t mboard) = 0;
+
+ /*!
+ * Set the clock source for the usrp device.
+ * This sets the source for a 10 Mhz reference clock.
+ * Typical options for source: internal, external, MIMO.
+ * \param source a string representing the clock source
+ * \param mboard which motherboard to set the config
+ */
+ virtual void set_clock_source(const std::string &source, const size_t mboard = ALL_MBOARDS) = 0;
+
+ /*!
+ * Get the currently set clock source.
+ * \param mboard which motherboard to get the config
+ * \return the string representing the clock source
+ */
+ virtual std::string get_clock_source(const size_t mboard) = 0;
+
+ /*!
+ * Get a list of possible clock sources.
+ * \param mboard which motherboard to get the list
+ * \return a vector of strings for possible settings
+ */
+ virtual std::vector<std::string> get_clock_sources(const size_t mboard) = 0;
+
+ /*!
* Get the number of USRP motherboards in this configuration.
*/
virtual size_t get_num_mboards(void) = 0;