uhd: Added pp routines for error codes and rx metadata

3 files changed, 108 insertions, 1 deletions

diff --git a/host/include/uhd/types/metadata.hpp b/host/include/uhd/types/metadata.hpp
index 6a79720d0..51a2b7c43 100644
--- a/host/include/uhd/types/metadata.hpp
+++ b/host/include/uhd/types/metadata.hpp
@@ -1,5 +1,5 @@
 //
-// Copyright 2010-2012 Ettus Research LLC
+// Copyright 2010-2012,2014 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
@@ -117,6 +117,20 @@ namespace uhd{
 
         //! Out of sequence.  The transport has either dropped a packet or received data out of order.
         bool out_of_sequence;
+
+        /*!
+         * Convert a rx_metadata_t into a pretty print string.
+	 *
+	 * \param compact Set to false for a more verbose output.
+         * \return a printable string representing the metadata.
+         */
+        std::string to_pp_string(bool compact=true) const;
+
+        /*!
+         * Similar to C's strerror() function, creates a std::string describing the error code.
+         * \return a printable string representing the error.
+         */
+	std::string strerror(void) const;
     };
 
     /*!
diff --git a/host/lib/types/CMakeLists.txt b/host/lib/types/CMakeLists.txt
index b69c8e487..7fc6bdd94 100644
--- a/host/lib/types/CMakeLists.txt
+++ b/host/lib/types/CMakeLists.txt
@@ -82,6 +82,7 @@ SET_SOURCE_FILES_PROPERTIES(
 LIBUHD_APPEND_SOURCES(
     ${CMAKE_CURRENT_SOURCE_DIR}/device_addr.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/mac_addr.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/metadata.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ranges.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/sensors.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/serial.cpp
diff --git a/host/lib/types/metadata.cpp b/host/lib/types/metadata.cpp
new file mode 100644
index 000000000..fec2ac564
--- /dev/null
+++ b/host/lib/types/metadata.cpp
@@ -0,0 +1,92 @@
+//
+// Copyright 2014 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 <string>
+#include <sstream>
+#include <boost/format.hpp>
+#include <uhd/exception.hpp>
+#include <uhd/types/metadata.hpp>
+#include <uhd/types/time_spec.hpp>
+
+using namespace uhd;
+
+std::string rx_metadata_t::to_pp_string(bool compact) const
+{
+    std::stringstream ss;
+
+    if (compact) {
+        if (has_time_spec) {
+            ss << "Time: " << time_spec.get_real_secs() << " s\n";
+        }
+        if (more_fragments) {
+            ss << "Fragmentation offset: " << fragment_offset << "\n";
+        }
+        if (start_of_burst) {
+            ss << "Start of burst.\n" << fragment_offset;
+        }
+        if (end_of_burst) {
+            ss << "End of burst.\n" << fragment_offset;
+        }
+        if (error_code != ERROR_CODE_NONE) {
+            ss << strerror() << "\n";
+        }
+    } else {
+        ss << "Has timespec: " << (has_time_spec ? "Yes" : "No")
+           << "\tTime of first sample: " << time_spec.get_real_secs()
+           << "\nFragmented: " << (more_fragments ? "Yes" : "No")
+           << "  Fragmentation offset: " << fragment_offset
+           << "\nStart of burst: " << (start_of_burst ? "Yes" : "No")
+           << "\tEnd of burst: " << (end_of_burst ? "Yes" : "No")
+           << "\nError Code: " << strerror()
+           << "\tOut of sequence: " << (out_of_sequence ? "Yes" : "No");
+    }
+
+    return ss.str();
+}
+
+std::string rx_metadata_t::strerror() const
+{
+    std::string errstr = "";
+    switch(this->error_code) {
+        case ERROR_CODE_NONE:
+            errstr = "ERROR_CODE_NONE";
+            break;
+        case ERROR_CODE_TIMEOUT:
+            errstr = "ERROR_CODE_TIMEOUT";
+            break;
+        case ERROR_CODE_LATE_COMMAND:
+            errstr = "ERROR_CODE_LATE_COMMAND";
+            break;
+        case ERROR_CODE_BROKEN_CHAIN:
+            errstr = "ERROR_CODE_BROKEN_CHAIN (Expected another stream command)";
+            break;
+        case ERROR_CODE_OVERFLOW:
+            errstr = "ERROR_CODE_OVERFLOW ";
+	    errstr += (this->out_of_sequence ? "(Out of sequence error)" : "(Overflow)");
+            break;
+        case ERROR_CODE_ALIGNMENT:
+            errstr = "ERROR_CODE_ALIGNMENT (Multi-channel alignment failed)";
+            break;
+        case ERROR_CODE_BAD_PACKET:
+            errstr = "ERROR_CODE_BAD_PACKET";
+            break;
+	default:
+            errstr = std::string(str(boost::format("Unknown error code: 0x%x") % error_code));
+    }
+
+    return errstr;
+}