Created device interface for discovery, access, configuration...

3 files changed, 77 insertions, 34 deletions

diff --git a/include/usrp_uhd.hpp b/include/usrp_uhd.hpp
index 1cbd064b7..deaf6e0c6 100644
--- a/include/usrp_uhd.hpp
+++ b/include/usrp_uhd.hpp
@@ -5,39 +5,7 @@
 #ifndef INCLUDED_USRP_UHD_HPP
 #define INCLUDED_USRP_UHD_HPP
 
-#include <usrp_uhd/device_addr.hpp>
-#include <usrp_uhd/wax.hpp>
-#include <boost/shared_ptr.hpp>
-#include <boost/function.hpp>
-#include <vector>
-#include <sys/uio.h>
-
-namespace usrp_uhd{
-
-    class usrp_uhd{
-
-    public:
-        typedef boost::shared_ptr<usrp_uhd> sptr;
-        typedef boost::function<bool(void *data, size_t len)> recv_hdlr_t;
-        usrp_uhd(device_addr_t device_addr);
-        ~usrp_uhd(void);
-
-        //the io interface
-        void send(const std::vector<iovec> &iovs);
-        void send(void* data, size_t len); //wrapper
-        void recv(const recv_hdlr_t &recv_hdlr);
-        void recv(void* &data, size_t &len); //wrapper
-
-        //connect dsps and subdevs
-        void connect(const wax::type &src, const wax::type &sink);
-
-        //the properties interface
-        wax::proxy props(void);
-
-    private:
-        wax::type d_mboard;
-    };
-
-} //namespace usrp_uhd
+//include convenience headers
+#include <usrp_uhd/device.hpp>
 
 #endif /* INCLUDED_USRP_UHD_HPP */
diff --git a/include/usrp_uhd/Makefile.am b/include/usrp_uhd/Makefile.am
index 9d12f2097..02a129484 100644
--- a/include/usrp_uhd/Makefile.am
+++ b/include/usrp_uhd/Makefile.am
@@ -8,5 +8,6 @@ SUBDIRS = usrp quadradio
 
 this_includedir = $(includedir)/usrp_uhd
 this_include_HEADERS = \
+	device.hpp \
 	device_addr.hpp \
 	wax.hpp
diff --git a/include/usrp_uhd/device.hpp b/include/usrp_uhd/device.hpp
new file mode 100644
index 000000000..9d70b9ac3
--- /dev/null
+++ b/include/usrp_uhd/device.hpp
@@ -0,0 +1,74 @@
+//
+// Copyright 2010 Ettus Research LLC
+//
+
+#ifndef INCLUDED_USRP_UHD_DEVICE_HPP
+#define INCLUDED_USRP_UHD_DEVICE_HPP
+
+#include <usrp_uhd/device_addr.hpp>
+#include <usrp_uhd/wax.hpp>
+#include <boost/shared_ptr.hpp>
+#include <boost/function.hpp>
+#include <vector>
+#include <sys/uio.h>
+
+namespace usrp_uhd{
+
+/*!
+ * The usrp device interface represents the usrp hardware.
+ * The api allows for discovery, configuration, and streaming.
+ */
+class device{
+
+public:
+    typedef boost::shared_ptr<device> sptr;
+    typedef boost::function<bool(void *data, size_t len)> recv_hdlr_t;
+
+    /*!
+     * \brief Discover usrp devices attached to the host.
+     *
+     * The hint device address should be used to narrow down the search
+     * to particular transport types and/or transport arguments.
+     *
+     * \param hint a partially (or fully) filled in device address
+     * \return a vector of device addresses for all usrps on the system
+     */
+    static std::vector<device_addr_t> discover(const device_addr_t& hint);
+
+    /*!
+     * \brief Create a new usrp device from the device address hint.
+     *
+     * The make routine will call discover and pick one of the results.
+     * By default, the first result will be used to create a new device.
+     * Use the which parameter as an index into the list of results.
+     *
+     * \param hint a partially (or fully) filled in device address
+     * \param which which address to use when multiple are discovered
+     * \return a shared pointer to a new device instance
+     */
+    static sptr make(const device_addr_t& hint, size_t which = 0);
+
+    /*!
+     * Deconstructor: called automatically by the shared pointer.
+     */
+    ~device(void);
+
+    //the io interface
+    void send_raw(const std::vector<iovec> &iovs);
+    void recv_raw(const recv_hdlr_t &recv_hdlr);
+
+    //connect dsps and subdevs
+    void connect(const wax::type &src, const wax::type &sink);
+
+    //the properties interface
+    wax::proxy props(void);
+
+private:
+    device(const device_addr_t& hint);
+
+    wax::type d_mboard;
+};
+
+} //namespace usrp_uhd
+
+#endif /* INCLUDED_USRP_UHD_DEVICE_HPP */