aboutsummaryrefslogtreecommitdiffstats
path: root/host/include
diff options
context:
space:
mode:
authorNick Foster <nick@nerdnetworks.org>2010-10-12 14:46:41 -0700
committerNick Foster <nick@nerdnetworks.org>2010-10-12 14:46:41 -0700
commit5982ec4ee2c6f9efca1c5068e42dc38b822df7dc (patch)
tree6b15ce5f837ea57cc5c9fdf79e45fdbd2f44d9de /host/include
parent3df994e1c784d7037e869610f1417fe64e0e89a8 (diff)
downloaduhd-5982ec4ee2c6f9efca1c5068e42dc38b822df7dc.tar.gz
uhd-5982ec4ee2c6f9efca1c5068e42dc38b822df7dc.tar.bz2
uhd-5982ec4ee2c6f9efca1c5068e42dc38b822df7dc.zip
USRP2P: This is surprisingly involved. Adding a consistent interface to deal with hardware revisions.
Diffstat (limited to 'host/include')
-rw-r--r--host/include/uhd/usrp/mboard_rev.hpp90
1 files changed, 90 insertions, 0 deletions
diff --git a/host/include/uhd/usrp/mboard_rev.hpp b/host/include/uhd/usrp/mboard_rev.hpp
new file mode 100644
index 000000000..5307d80c1
--- /dev/null
+++ b/host/include/uhd/usrp/mboard_rev.hpp
@@ -0,0 +1,90 @@
+//
+// 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_MBOARD_REV_HPP
+#define INCLUDED_UHD_USRP_MBOARD_REV_HPP
+
+#include <uhd/config.hpp>
+#include <boost/cstdint.hpp>
+#include <boost/operators.hpp>
+#include <string>
+
+namespace uhd{ namespace usrp{
+
+ class UHD_API mboard_rev_t : boost::equality_comparable<mboard_rev_t>{
+ public:
+ /*!
+ * Create a mboard rev from an integer.
+ * \param rev the integer representation
+ */
+ mboard_rev_t(boost::uint16_t rev = 0xffff);
+
+ /*!
+ * Obtain a mboard rev that represents an invalid/uninit mboard ID
+ * \return the mboard rev with the 0xffff rev.
+ */
+ static mboard_rev_t none(void);
+
+ /*!
+ * Create a new mboard rev from an integer representation.
+ * \param uint16 an unsigned 16 bit integer
+ * \return a new mboard rev containing the integer
+ */
+ static mboard_rev_t from_uint16(boost::uint16_t uint16);
+
+ /*!
+ * Get the mboard rev represented as an integer.
+ * \return an unsigned 16 bit integer representation
+ */
+ boost::uint16_t to_uint16(void) const;
+
+ /*!
+ * Create a new mboard rev from a string representation.
+ * If the string has a 0x prefix, it will be parsed as hex.
+ * \param string a numeric string, possibly hex
+ * \return a new dboard id containing the integer
+ */
+ static mboard_rev_t from_string(const std::string &string);
+
+ /*!
+ * Get the mboard rev represented as an integer.
+ * \return a hex string representation with 0x prefix
+ */
+ std::string to_string(void) const;
+
+ /*!
+ * Get the pretty print representation of this mboard rev.
+ * \return a string with the mboard name and rev number
+ */
+ std::string to_pp_string(void) const;
+
+ private:
+ boost::uint16_t _rev; //internal representation
+ };
+
+ /*!
+ * Comparator operator overloaded for mboard rev.
+ * The boost::equality_comparable provides the !=.
+ * \param lhs the dboard id to the left of the operator
+ * \param rhs the dboard id to the right of the operator
+ * \return true when the mboard revs are equal
+ */
+ UHD_API bool operator==(const mboard_rev_t &lhs, const mboard_rev_t &rhs);
+
+}} //namespace
+
+#endif /* INCLUDED_UHD_USRP_MBOARD_REV_HPP */