summaryrefslogtreecommitdiff
path: root/gr-uhd/lib/uhd_multi_usrp_source.h
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2010-10-18 12:18:13 -0700
committerJosh Blum <josh@joshknows.com>2010-10-18 12:18:13 -0700
commit4ac5545625d3d6df9881695f764c9c94049edb7b (patch)
tree2d09ccd00c383497e1468ecdb042558aac921b39 /gr-uhd/lib/uhd_multi_usrp_source.h
parent5e9908fbec19ce9309c12ea61c0303e6666e981a (diff)
uhd: added multi usrp skeleton and added deprecation note to other headers
Diffstat (limited to 'gr-uhd/lib/uhd_multi_usrp_source.h')
-rw-r--r--gr-uhd/lib/uhd_multi_usrp_source.h138
1 files changed, 138 insertions, 0 deletions
diff --git a/gr-uhd/lib/uhd_multi_usrp_source.h b/gr-uhd/lib/uhd_multi_usrp_source.h
new file mode 100644
index 0000000000..b2c4a3ac17
--- /dev/null
+++ b/gr-uhd/lib/uhd_multi_usrp_source.h
@@ -0,0 +1,138 @@
+/*
+ * Copyright 2010 Free Software Foundation, Inc.
+ *
+ * This file is part of GNU Radio
+ *
+ * GNU Radio is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * GNU Radio is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GNU Radio; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef INCLUDED_UHD_MULTI_USRP_SOURCE_H
+#define INCLUDED_UHD_MULTI_USRP_SOURCE_H
+
+#include <gr_sync_block.h>
+#include <uhd/usrp/multi_usrp.hpp>
+
+class uhd_multi_usrp_source;
+
+boost::shared_ptr<uhd_multi_usrp_source> uhd_make_multi_usrp_source(
+ const std::string &args,
+ const uhd::io_type_t::tid_t &type,
+ size_t num_channels
+);
+
+class uhd_multi_usrp_source : public gr_sync_block{
+public:
+
+ /*!
+ * Set the IO signature for this block.
+ * \param sig the output signature
+ */
+ uhd_multi_usrp_source(gr_io_signature_sptr sig);
+
+ /*!
+ * Set the subdevice specification.
+ * \param spec the subdev spec markup string
+ */
+ virtual void set_subdev_spec(const std::string &spec, size_t mboard) = 0;
+
+ /*!
+ * Set the sample rate for the usrp device.
+ * \param rate a new rate in Sps
+ */
+ virtual void set_samp_rate(double rate) = 0;
+
+ /*!
+ * Get the sample rate for the usrp device.
+ * This is the actual sample rate and may differ from the rate set.
+ * \return the actual rate in Sps
+ */
+ virtual double get_samp_rate(void) = 0;
+
+ /*!
+ * Tune the usrp device to the desired center frequency.
+ * \param freq the desired frequency in Hz
+ * \return a tune result with the actual frequencies
+ */
+ virtual uhd::tune_result_t set_center_freq(double freq, size_t chan = 0) = 0;
+
+ /*!
+ * Get the tunable frequency range.
+ * \return the frequency range in Hz
+ */
+ virtual uhd::freq_range_t get_freq_range(size_t chan = 0) = 0;
+
+ /*!
+ * Set the gain for the dboard.
+ * \param gain the gain in dB
+ */
+ virtual void set_gain(float gain, size_t chan = 0) = 0;
+
+ /*!
+ * Get the actual dboard gain setting.
+ * \return the actual gain in dB
+ */
+ virtual float get_gain(size_t chan = 0) = 0;
+
+ /*!
+ * Get the settable gain range.
+ * \return the gain range in dB
+ */
+ virtual uhd::gain_range_t get_gain_range(size_t chan = 0) = 0;
+
+ /*!
+ * Set the antenna to use.
+ * \param ant the antenna string
+ */
+ virtual void set_antenna(const std::string &ant, size_t chan = 0) = 0;
+
+ /*!
+ * Get the antenna in use.
+ * \return the antenna string
+ */
+ virtual std::string get_antenna(size_t chan = 0) = 0;
+
+ /*!
+ * Get a list of possible antennas.
+ * \return a vector of antenna strings
+ */
+ virtual std::vector<std::string> get_antennas(size_t chan = 0) = 0;
+
+ /*!
+ * Set the clock configuration.
+ * \param clock_config the new configuration
+ */
+ virtual void set_clock_config(const uhd::clock_config_t &clock_config, size_t mboard) = 0;
+
+ /*!
+ * Get the current time registers.
+ * \return the current usrp time
+ */
+ virtual uhd::time_spec_t get_time_now(void) = 0;
+
+ /*!
+ * Set the time registers at the next pps.
+ * \param time_spec the new time
+ */
+ virtual void set_time_next_pps(const uhd::time_spec_t &time_spec) = 0;
+
+ /*!
+ * Get access to the underlying uhd device object.
+ * \return the multi usrp device object
+ */
+ virtual uhd::usrp::multi_usrp::sptr get_device(void) = 0;
+};
+
+#endif /* INCLUDED_UHD_MULTI_USRP_SOURCE_H */