Merge branch 'codec_gains' of git@ettus.sourcerepo.com:ettus/uhdpriv into usrp2p2

8 files changed, 135 insertions, 112 deletions

diff --git a/host/include/uhd/usrp/CMakeLists.txt b/host/include/uhd/usrp/CMakeLists.txt
index 6f8c1a2d8..bdb4b90a8 100644
--- a/host/include/uhd/usrp/CMakeLists.txt
+++ b/host/include/uhd/usrp/CMakeLists.txt
@@ -18,6 +18,7 @@
 
 INSTALL(FILES
     #### props headers ###
+    codec_props.hpp
     dboard_props.hpp
     device_props.hpp
     dsp_props.hpp
diff --git a/host/include/uhd/usrp/codec_props.hpp b/host/include/uhd/usrp/codec_props.hpp
new file mode 100644
index 000000000..ab09b1703
--- /dev/null
+++ b/host/include/uhd/usrp/codec_props.hpp
@@ -0,0 +1,42 @@
+//
+// Copyright 2010 Ettus Research LLC
+//
+// This program 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 of the License, or
+// (at your option) any later version.
+//
+// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+#ifndef INCLUDED_UHD_USRP_CODEC_PROPS_HPP
+#define INCLUDED_UHD_USRP_CODEC_PROPS_HPP
+
+#include <uhd/utils/props.hpp>
+
+namespace uhd{ namespace usrp{
+
+    /*!
+    * Possible device codec properties:
+    *   A codec is expected to have a rate and gain elements.
+    *   Other properties can be discovered through the others prop.
+    */
+    enum codec_prop_t{
+        CODEC_PROP_NAME           = 'n', //ro, std::string
+        CODEC_PROP_OTHERS         = 'o', //ro, prop_names_t
+        CODEC_PROP_GAIN_I         = 'i', //rw, float
+        CODEC_PROP_GAIN_Q         = 'q', //rw, float
+        CODEC_PROP_GAIN_RANGE     = 'r', //ro, gain_range_t
+        CODEC_PROP_GAIN_NAMES     = 'G'  //ro, prop_names_t
+    };
+
+
+}} //namespace
+
+#endif /* INCLUDED_UHD_USRP_CODEC_PROPS_HPP */
diff --git a/host/include/uhd/usrp/dboard_props.hpp b/host/include/uhd/usrp/dboard_props.hpp
index 4d5c5efbd..e2c0f9c7b 100644
--- a/host/include/uhd/usrp/dboard_props.hpp
+++ b/host/include/uhd/usrp/dboard_props.hpp
@@ -23,7 +23,9 @@
 namespace uhd{ namespace usrp{
 
     /*!
-     * Possible device dboard properties
+     * Possible device dboard properties:
+     *    A dboard has an id, one or more subdevices, and a codec.
+     *    A dboard is considered to be unidirectional (RX or TX).
      */
     enum dboard_prop_t{
         DBOARD_PROP_NAME         = 'n', //ro, std::string
@@ -31,8 +33,9 @@ namespace uhd{ namespace usrp{
         DBOARD_PROP_SUBDEV_NAMES = 'S', //ro, prop_names_t
         DBOARD_PROP_USED_SUBDEVS = 'u', //ro, prop_names_t
         DBOARD_PROP_DBOARD_ID    = 'i', //rw, dboard_id_t
-        DBOARD_PROP_DBOARD_IFACE = 'f'  //ro, dboard_iface::sptr
-        //DBOARD_PROP_CODEC              //ro, wax::obj //----> not sure, dont have to deal with yet
+        DBOARD_PROP_DBOARD_IFACE = 'f', //ro, dboard_iface::sptr
+        DBOARD_PROP_CODEC        = 'c', //ro, wax::obj
+        DBOARD_PROP_GAIN_GROUP   = 'g'  //ro, gain_group
     }; 
 
 }} //namespace
diff --git a/host/include/uhd/usrp/device_props.hpp b/host/include/uhd/usrp/device_props.hpp
index 983bcb672..346eec179 100644
--- a/host/include/uhd/usrp/device_props.hpp
+++ b/host/include/uhd/usrp/device_props.hpp
@@ -34,22 +34,6 @@ namespace uhd{ namespace usrp{
         DEVICE_PROP_MBOARD_NAMES   = 'M'  //ro, prop_names_t
     };
 
-    ////////////////////////////////////////////////////////////////////////
-    /*! ------ not dealing with yet, commented out ------------
-    * Possible device codec properties:
-    *   A codec is expected to have a rate and gain elements.
-    *   Other properties can be discovered through the others prop.
-    */
-    /*enum codec_prop_t{
-        CODEC_PROP_NAME,               //ro, std::string
-        CODEC_PROP_OTHERS,             //ro, prop_names_t
-        CODEC_PROP_GAIN,               //rw, gain_t
-        CODEC_PROP_GAIN_RANGE,         //ro, gain_range_t
-        CODEC_PROP_GAIN_NAMES,         //ro, prop_names_t
-        //CODEC_PROP_CLOCK_RATE          //ro, freq_t //----> not sure we care to know
-    };*/
-
-
 }} //namespace
 
 #endif /* INCLUDED_UHD_USRP_DEVICE_PROPS_HPP */
diff --git a/host/include/uhd/usrp/subdev_props.hpp b/host/include/uhd/usrp/subdev_props.hpp
index f7bdcd161..cd07cb7a8 100644
--- a/host/include/uhd/usrp/subdev_props.hpp
+++ b/host/include/uhd/usrp/subdev_props.hpp
@@ -53,8 +53,6 @@ namespace uhd{ namespace usrp{
         SUBDEV_PROP_ANTENNA_NAMES     = 'A', //ro, prop_names_t
         SUBDEV_PROP_LO_LOCKED         = 'L', //ro, bool
         SUBDEV_PROP_CONNECTION        = 'c', //ro, subdev_conn_t
-        //SUBDEV_PROP_QUADRATURE        = 'q', //ro, bool
-        //SUBDEV_PROP_IQ_SWAPPED        = 'i', //ro, bool
         SUBDEV_PROP_USE_LO_OFFSET     = 'l', //ro, bool
         SUBDEV_PROP_RSSI              = 'R', //ro, float
         SUBDEV_PROP_BANDWIDTH         = 'B'  //rw, double
diff --git a/host/include/uhd/utils/CMakeLists.txt b/host/include/uhd/utils/CMakeLists.txt
index d484788b2..f7feab5a8 100644
--- a/host/include/uhd/utils/CMakeLists.txt
+++ b/host/include/uhd/utils/CMakeLists.txt
@@ -22,7 +22,7 @@ INSTALL(FILES
     byteswap.hpp
     byteswap.ipp
     exception.hpp
-    gain_handler.hpp
+    gain_group.hpp
     pimpl.hpp
     props.hpp
     safe_main.hpp
diff --git a/host/include/uhd/utils/gain_group.hpp b/host/include/uhd/utils/gain_group.hpp
new file mode 100644
index 000000000..3955dfa9a
--- /dev/null
+++ b/host/include/uhd/utils/gain_group.hpp
@@ -0,0 +1,85 @@
+//
+// Copyright 2010 Ettus Research LLC
+//
+// This program 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 of the License, or
+// (at your option) any later version.
+//
+// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+#ifndef INCLUDED_UHD_UTILS_GAIN_GROUP_HPP
+#define INCLUDED_UHD_UTILS_GAIN_GROUP_HPP
+
+#include <uhd/config.hpp>
+#include <uhd/types/ranges.hpp>
+#include <boost/shared_ptr.hpp>
+#include <boost/function.hpp>
+#include <boost/utility.hpp>
+
+namespace uhd{
+
+/*!
+ * A set of function to control a gain element.
+ */
+struct UHD_API gain_fcns_t{
+    boost::function<gain_range_t(void)> get_range;
+    boost::function<float(void)>        get_value;
+    boost::function<void(float)>        set_value;
+};
+
+class UHD_API gain_group : boost::noncopyable{
+public:
+    typedef boost::shared_ptr<gain_group> sptr;
+
+    /*!
+     * Get the overall gain range for this group.
+     * Overall step is defined as the minimum step size.
+     * \return a gain range with overall min, max, step
+     */
+    virtual gain_range_t get_range(void) = 0;
+
+    /*!
+     * Get the overall gain value for this group.
+     * \return a summation of all the gain values
+     */
+    virtual float get_value(void) = 0;
+
+    /*!
+     * Set the overall gain value for this group.
+     * The power will be distributed across individual gain elements.
+     * The semantics of how to do this are determined by the priority.
+     * \param gain the gain to set across the group
+     */
+    virtual void set_value(float gain) = 0;
+
+    /*!
+     * Register a set of gain functions into this group.
+     * Priority determines how power will be distributed
+     * with higher priorities getting the power first,
+     * and lower priorities getting the remainder power.
+     * \param gain_fcns the set of gain functions
+     * \param priority the priority of the gain element
+     */
+    virtual void register_fcns(
+        const gain_fcns_t &gain_fcns, size_t priority = 0
+    ) = 0;
+
+    /*!
+     * Make a new empty gain group.
+     * \return a gain group object.
+     */
+    static sptr make(void);
+};
+
+} //namespace uhd
+
+#endif /* INCLUDED_UHD_UTILS_GAIN_GROUP_HPP */
+
diff --git a/host/include/uhd/utils/gain_handler.hpp b/host/include/uhd/utils/gain_handler.hpp
deleted file mode 100644
index f4629e6a7..000000000
--- a/host/include/uhd/utils/gain_handler.hpp
+++ /dev/null
@@ -1,90 +0,0 @@
-//
-// Copyright 2010 Ettus Research LLC
-//
-// This program 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 of the License, or
-// (at your option) any later version.
-//
-// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
-//
-
-#ifndef INCLUDED_UHD_UTILS_GAIN_HANDLER_HPP
-#define INCLUDED_UHD_UTILS_GAIN_HANDLER_HPP
-
-#include <uhd/config.hpp>
-#include <uhd/wax.hpp>
-#include <boost/shared_ptr.hpp>
-#include <boost/function.hpp>
-
-namespace uhd{
-
-class UHD_API gain_handler{
-public:
-    typedef boost::shared_ptr<gain_handler> sptr;
-    typedef boost::function<bool(const wax::obj &, const wax::obj &)> is_equal_t;
-
-    /*!
-     * A set of properties for dealing with gains.
-     */
-    struct UHD_API props_t{
-        wax::obj value, range, names;
-        props_t(void); //default constructor
-    };
-
-    /*!
-     * Make a new gain handler.
-     * The construction arguments are agnostic to the property type.
-     * It is up to the caller to provide an "is_equal" function that
-     * can tell weather two properties (in a wax obj) are equal.
-     * \param link a link to the wax obj with properties
-     * \param props a struct of properties keys
-     * \param is_equal the function that tests for equal properties
-     */
-    static sptr make(
-        const wax::obj &link,
-        const props_t &props,
-        is_equal_t is_equal
-    );
-
-    /*!
-     * Intercept gets for overall gain, min, max, step.
-     * Ensures that the gain name is valid.
-     * \return true for handled, false to pass on
-     */
-    virtual bool intercept_get(const wax::obj &key, wax::obj &val) = 0;
-
-    /*!
-     * Intercept sets for overall gain.
-     * Ensures that the gain name is valid.
-     * Ensures that the new gain is within range.
-     * \return true for handled, false to pass on
-     */
-    virtual bool intercept_set(const wax::obj &key, const wax::obj &val) = 0;
-
-    /*!
-     * Function template to test if two wax types are equal:
-     * The constructor will bind an instance of this for a specific type.
-     * This bound equals functions allows the intercept methods to be non-templated.
-     */
-    template <class T> static bool is_equal(const wax::obj &a, const wax::obj &b){
-        try{
-            return a.as<T>() == b.as<T>();
-        }
-        catch(const wax::bad_cast &){
-            return false;
-        }
-    }
-
-};
-
-} //namespace uhd
-
-#endif /* INCLUDED_UHD_UTILS_GAIN_HANDLER_HPP */
-