added byteswap routine to utils

4 files changed, 133 insertions, 0 deletions

diff --git a/host/include/uhd/utils/CMakeLists.txt b/host/include/uhd/utils/CMakeLists.txt
index 391e684c8..3684fd6e7 100644
--- a/host/include/uhd/utils/CMakeLists.txt
+++ b/host/include/uhd/utils/CMakeLists.txt
@@ -18,6 +18,7 @@
 INSTALL(FILES
     algorithm.hpp
     assert.hpp
+    byteswap.hpp
     exception.hpp
     gain_handler.hpp
     pimpl.hpp
diff --git a/host/include/uhd/utils/byteswap.hpp b/host/include/uhd/utils/byteswap.hpp
new file mode 100644
index 000000000..779b48ec9
--- /dev/null
+++ b/host/include/uhd/utils/byteswap.hpp
@@ -0,0 +1,92 @@
+//
+// 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_BYTESWAP_HPP
+#define INCLUDED_UHD_UTILS_BYTESWAP_HPP
+
+#include <uhd/config.hpp>
+#include <boost/cstdint.hpp>
+
+/*! \file byteswap.hpp
+ * Provide fast byteswaping routines for 16, 32, and 64 bit integers,
+ * by using the system's native routines/intrinsics when available.
+ */
+
+namespace uhd{
+
+    //! perform a byteswap on a 16 bit integer
+    boost::uint16_t byteswap(boost::uint16_t);
+
+    //! perform a byteswap on a 32 bit integer
+    boost::uint32_t byteswap(boost::uint32_t);
+
+    //! perform a byteswap on a 64 bit integer
+    boost::uint64_t byteswap(boost::uint64_t);
+
+} //namespace uhd
+
+/***********************************************************************
+ * Platform-specific implementation details for byteswap below:
+ **********************************************************************/
+#ifdef BOOST_MSVC //http://msdn.microsoft.com/en-us/library/a3140177%28VS.80%29.aspx
+    #include <stdlib.h>
+
+    UHD_INLINE boost::uint16_t uhd::byteswap(boost::uint16_t x){
+        return _byteswap_ushort(x);
+    }
+
+    UHD_INLINE boost::uint32_t uhd::byteswap(boost::uint32_t x){
+        return _byteswap_ulong(x);
+    }
+
+    UHD_INLINE boost::uint64_t uhd::byteswap(boost::uint64_t x){
+        return _byteswap_uint64(x);
+    }
+
+#elif defined(__GNUC__) && __GNUC__ >= 4 && __GNUC_MINOR__ >= 3
+    #include <byteswap.h>
+
+    UHD_INLINE boost::uint16_t uhd::byteswap(boost::uint16_t x){
+        return bswap_16(x); //no __builtin_bswap16
+    }
+
+    UHD_INLINE boost::uint32_t uhd::byteswap(boost::uint32_t x){
+        return __builtin_bswap32(x);
+    }
+
+    UHD_INLINE boost::uint64_t uhd::byteswap(boost::uint64_t x){
+        return __builtin_bswap64(x);
+    }
+
+#else
+    #include <byteswap.h>
+
+    UHD_INLINE boost::uint16_t uhd::byteswap(boost::uint16_t x){
+        return bswap_16(x);
+    }
+
+    UHD_INLINE boost::uint32_t uhd::byteswap(boost::uint32_t x){
+        return bswap_32(x);
+    }
+
+    UHD_INLINE boost::uint64_t uhd::byteswap(boost::uint64_t x){
+        return bswap_64(x);
+    }
+
+#endif
+
+#endif /* INCLUDED_UHD_UTILS_BYTESWAP_HPP */
diff --git a/host/test/CMakeLists.txt b/host/test/CMakeLists.txt
index 24778d13e..7fd3dd401 100644
--- a/host/test/CMakeLists.txt
+++ b/host/test/CMakeLists.txt
@@ -22,6 +22,7 @@ ADD_EXECUTABLE(main_test
     main_test.cpp
     addr_test.cpp
     buffer_test.cpp
+    byteswap_test.cpp
     dict_test.cpp
     error_test.cpp
     gain_handler_test.cpp
diff --git a/host/test/byteswap_test.cpp b/host/test/byteswap_test.cpp
new file mode 100644
index 000000000..3d50c9bfa
--- /dev/null
+++ b/host/test/byteswap_test.cpp
@@ -0,0 +1,39 @@
+//
+// 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/>.
+//
+
+#include <boost/test/unit_test.hpp>
+#include <uhd/utils/byteswap.hpp>
+
+BOOST_AUTO_TEST_CASE(test_byteswap16){
+    boost::uint16_t x = 0x0123;
+    boost::uint16_t y = 0x2301;
+    BOOST_CHECK_EQUAL(uhd::byteswap(x), y);
+}
+
+BOOST_AUTO_TEST_CASE(test_byteswap32){
+    boost::uint32_t x = 0x01234567;
+    boost::uint32_t y = 0x67452301;
+    BOOST_CHECK_EQUAL(uhd::byteswap(x), y);
+}
+
+BOOST_AUTO_TEST_CASE(test_byteswap64){
+    //split up 64 bit constants to avoid long-long compiler warnings
+    boost::uint64_t x = 0x01234567 | (boost::uint64_t(0x89abcdef) << 32);
+    boost::uint64_t y = 0xefcdab89 | (boost::uint64_t(0x67452301) << 32);
+    BOOST_CHECK_EQUAL(uhd::byteswap(x), y);
+}
+