rfnoc: Added clock_iface to convey info about clocks

The inteface provides a mechanism for users of clocks to query
information such as the running status or rate

1 files changed, 64 insertions, 0 deletions

diff --git a/host/lib/include/uhdlib/rfnoc/clock_iface.hpp b/host/lib/include/uhdlib/rfnoc/clock_iface.hpp
new file mode 100644
index 000000000..807382f13
--- /dev/null
+++ b/host/lib/include/uhdlib/rfnoc/clock_iface.hpp
@@ -0,0 +1,64 @@
+//
+// Copyright 2019 Ettus Research, a National Instruments Company
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
+//
+
+#ifndef INCLUDED_UHD_RFNOC_CLOCK_IFACE_HPP
+#define INCLUDED_UHD_RFNOC_CLOCK_IFACE_HPP
+
+#include <uhd/config.hpp>
+#include <atomic>
+#include <string>
+
+namespace uhd { namespace rfnoc {
+
+class clock_iface
+{
+public:
+    clock_iface(const std::string& name) : _name(name)
+    {
+        _is_running = false;
+        _freq       = 0.0;
+    }
+
+    clock_iface()                       = delete;
+    clock_iface(const clock_iface& rhs) = delete;
+    clock_iface(clock_iface&& rhs)      = delete;
+
+    clock_iface& operator=(const clock_iface& fraction) = delete;
+
+    inline const std::string& get_name() const
+    {
+        return _name;
+    }
+
+    inline bool is_running() const
+    {
+        return _is_running;
+    }
+
+    inline void set_running(bool is_running)
+    {
+        _is_running = is_running;
+    }
+
+    inline double get_freq() const
+    {
+        return _freq;
+    }
+
+    inline void set_freq(double freq)
+    {
+        _freq = freq;
+    }
+
+private:
+    const std::string _name;
+    std::atomic<bool> _is_running;
+    std::atomic<double> _freq;
+};
+
+}} // namespace uhd::rfnoc
+
+#endif /* INCLUDED_UHD_RFNOC_CLOCK_IFACE_HPP */