uhd: added multi usrp skeleton and added deprecation note to other headers

9 files changed, 340 insertions, 4 deletions

diff --git a/gr-uhd/lib/Makefile.am b/gr-uhd/lib/Makefile.am
index 69a41e788..d9a296c75 100644
--- a/gr-uhd/lib/Makefile.am
+++ b/gr-uhd/lib/Makefile.am
@@ -31,6 +31,8 @@ lib_LTLIBRARIES = libgnuradio-uhd.la
 libgnuradio_uhd_la_SOURCES = \
 	uhd_mimo_source.cc \
 	uhd_mimo_sink.cc \
+	uhd_multi_usrp_source.cc \
+	uhd_multi_usrp_sink.cc \
 	uhd_simple_source.cc \
 	uhd_simple_sink.cc \
 	uhd_single_usrp_source.cc \
@@ -43,10 +45,8 @@ libgnuradio_uhd_la_LIBADD = \
 libgnuradio_uhd_la_LDFLAGS = $(LTVERSIONFLAGS)
 
 grinclude_HEADERS = \
-	uhd_mimo_source.h \
-	uhd_mimo_sink.h \
-	uhd_simple_source.h \
-	uhd_simple_sink.h \
+	uhd_multi_usrp_source.h \
+	uhd_multi_usrp_sink.h \
 	uhd_single_usrp_source.h \
 	uhd_single_usrp_sink.h
 
diff --git a/gr-uhd/lib/uhd_mimo_sink.h b/gr-uhd/lib/uhd_mimo_sink.h
index 46679d973..a0a30381c 100644
--- a/gr-uhd/lib/uhd_mimo_sink.h
+++ b/gr-uhd/lib/uhd_mimo_sink.h
@@ -34,6 +34,9 @@ boost::shared_ptr<uhd_mimo_sink> uhd_make_mimo_sink(
     const uhd::io_type_t::tid_t &type
 );
 
+/***********************************************************************
+ * DEPRECATED
+ **********************************************************************/
 class uhd_mimo_sink : public gr_sync_block{
 public:
 
diff --git a/gr-uhd/lib/uhd_mimo_source.h b/gr-uhd/lib/uhd_mimo_source.h
index fbd7f2c42..f6f18eedc 100644
--- a/gr-uhd/lib/uhd_mimo_source.h
+++ b/gr-uhd/lib/uhd_mimo_source.h
@@ -34,6 +34,9 @@ boost::shared_ptr<uhd_mimo_source> uhd_make_mimo_source(
     const uhd::io_type_t::tid_t &type
 );
 
+/***********************************************************************
+ * DEPRECATED
+ **********************************************************************/
 class uhd_mimo_source : public gr_sync_block{
 public:
 
diff --git a/gr-uhd/lib/uhd_multi_usrp_sink.cc b/gr-uhd/lib/uhd_multi_usrp_sink.cc
new file mode 100644
index 000000000..6854649c3
--- /dev/null
+++ b/gr-uhd/lib/uhd_multi_usrp_sink.cc
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ */
+
+#include <uhd_multi_usrp_sink.h>
+#include <gr_io_signature.h>
+#include <stdexcept>
diff --git a/gr-uhd/lib/uhd_multi_usrp_sink.h b/gr-uhd/lib/uhd_multi_usrp_sink.h
new file mode 100644
index 000000000..b29657e94
--- /dev/null
+++ b/gr-uhd/lib/uhd_multi_usrp_sink.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_SINK_H
+#define INCLUDED_UHD_MULTI_USRP_SINK_H
+
+#include <gr_sync_block.h>
+#include <uhd/usrp/multi_usrp.hpp>
+
+class uhd_multi_usrp_sink;
+
+boost::shared_ptr<uhd_multi_usrp_sink> uhd_make_multi_usrp_sink(
+    const std::string &args,
+    const uhd::io_type_t::tid_t &type,
+    size_t num_channels
+);
+
+class uhd_multi_usrp_sink : public gr_sync_block{
+public:
+
+    /*!
+     * Set the IO signature for this block.
+     * \param sig the input signature
+     */
+    uhd_multi_usrp_sink(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_SINK_H */
diff --git a/gr-uhd/lib/uhd_multi_usrp_source.cc b/gr-uhd/lib/uhd_multi_usrp_source.cc
new file mode 100644
index 000000000..27caffbfc
--- /dev/null
+++ b/gr-uhd/lib/uhd_multi_usrp_source.cc
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ */
+
+#include <uhd_multi_usrp_source.h>
+#include <gr_io_signature.h>
+#include <stdexcept>
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 000000000..b2c4a3ac1
--- /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 */
diff --git a/gr-uhd/lib/uhd_simple_sink.h b/gr-uhd/lib/uhd_simple_sink.h
index 0abf30681..44b868698 100644
--- a/gr-uhd/lib/uhd_simple_sink.h
+++ b/gr-uhd/lib/uhd_simple_sink.h
@@ -33,6 +33,9 @@ boost::shared_ptr<uhd_simple_sink> uhd_make_simple_sink(
     const uhd::io_type_t::tid_t &type
 );
 
+/***********************************************************************
+ * DEPRECATED
+ **********************************************************************/
 class uhd_simple_sink : public gr_sync_block{
 public:
 
diff --git a/gr-uhd/lib/uhd_simple_source.h b/gr-uhd/lib/uhd_simple_source.h
index b95c0cfd9..4e79afa21 100644
--- a/gr-uhd/lib/uhd_simple_source.h
+++ b/gr-uhd/lib/uhd_simple_source.h
@@ -33,6 +33,9 @@ boost::shared_ptr<uhd_simple_source> uhd_make_simple_source(
     const uhd::io_type_t::tid_t &type
 );
 
+/***********************************************************************
+ * DEPRECATED
+ **********************************************************************/
 class uhd_simple_source : public gr_sync_block{
 public: