Add USRP device support.

2026-06-07 16:34:45 -04:00 · 2020-10-02 22:45:28 +01:00
parent ad55211abb
commit d4aa5d75b5
427 changed files with 10621 additions and 378 deletions
@@ -0,0 +1,250 @@
+///////////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2017 Edouard Griffiths, F4EXB                                   //
+// Copyright (C) 2020 Jon Beniston, M7RCE                                        //
+//                                                                               //
+// 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 as 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 V3 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 PLUGINS_SAMPLESOURCE_USRPINPUT_USRPINPUT_H_
+#define PLUGINS_SAMPLESOURCE_USRPINPUT_USRPINPUT_H_
+
+#include <stdint.h>
+
+#include <QString>
+#include <QByteArray>
+#include <QNetworkRequest>
+
+#include <uhd/usrp/multi_usrp.hpp>
+
+#include "dsp/devicesamplesource.h"
+#include "usrp/deviceusrpshared.h"
+#include "usrpinputsettings.h"
+
+class DeviceAPI;
+class USRPInputThread;
+class QNetworkAccessManager;
+class QNetworkReply;
+
+class USRPInput : public DeviceSampleSource
+{
+    Q_OBJECT
+public:
+    class MsgConfigureUSRP : public Message {
+        MESSAGE_CLASS_DECLARATION
+
+    public:
+        const USRPInputSettings& getSettings() const { return m_settings; }
+        bool getForce() const { return m_force; }
+
+        static MsgConfigureUSRP* create(const USRPInputSettings& settings, bool force)
+        {
+            return new MsgConfigureUSRP(settings, force);
+        }
+
+    private:
+        USRPInputSettings m_settings;
+        bool m_force;
+
+        MsgConfigureUSRP(const USRPInputSettings& settings, bool force) :
+            Message(),
+            m_settings(settings),
+            m_force(force)
+        { }
+    };
+
+    class MsgGetStreamInfo : public Message {
+        MESSAGE_CLASS_DECLARATION
+
+    public:
+        static MsgGetStreamInfo* create()
+        {
+            return new MsgGetStreamInfo();
+        }
+
+    private:
+        MsgGetStreamInfo() :
+            Message()
+        { }
+    };
+
+    class MsgGetDeviceInfo : public Message {
+        MESSAGE_CLASS_DECLARATION
+
+    public:
+        static MsgGetDeviceInfo* create()
+        {
+            return new MsgGetDeviceInfo();
+        }
+
+    private:
+        MsgGetDeviceInfo() :
+            Message()
+        { }
+    };
+
+    class MsgReportStreamInfo : public Message {
+        MESSAGE_CLASS_DECLARATION
+
+    public:
+        bool     getSuccess() const { return m_success; }
+        bool     getActive() const { return m_active; }
+        uint32_t getOverruns() const { return m_overruns; }
+        uint32_t getTimeouts() const { return m_timeouts; }
+
+        static MsgReportStreamInfo* create(
+                bool     success,
+                bool     active,
+                uint32_t overruns,
+                uint32_t timeouts
+                )
+        {
+            return new MsgReportStreamInfo(
+                    success,
+                    active,
+                    overruns,
+                    timeouts
+                    );
+        }
+
+    private:
+        bool     m_success;
+        bool     m_active;
+        uint32_t m_overruns; //!< FIFO overrun count
+        uint32_t m_timeouts; //!< Number of dropped packets by HW
+
+        MsgReportStreamInfo(
+                bool     success,
+                bool     active,
+                uint32_t overruns,
+                uint32_t timeouts
+                ) :
+            Message(),
+            m_success(success),
+            m_active(active),
+            m_overruns(overruns),
+            m_timeouts(timeouts)
+        { }
+    };
+
+    class MsgStartStop : public Message {
+        MESSAGE_CLASS_DECLARATION
+
+    public:
+        bool getStartStop() const { return m_startStop; }
+
+        static MsgStartStop* create(bool startStop) {
+            return new MsgStartStop(startStop);
+        }
+
+    protected:
+        bool m_startStop;
+
+        MsgStartStop(bool startStop) :
+            Message(),
+            m_startStop(startStop)
+        { }
+    };
+
+    USRPInput(DeviceAPI *deviceAPI);
+    virtual ~USRPInput();
+    virtual void destroy();
+
+    virtual void init();
+    virtual bool start();
+    virtual void stop();
+
+    virtual QByteArray serialize() const;
+    virtual bool deserialize(const QByteArray& data);
+
+    virtual void setMessageQueueToGUI(MessageQueue *queue) { m_guiMessageQueue = queue; }
+    virtual const QString& getDeviceDescription() const;
+    virtual int getSampleRate() const;
+    virtual void setSampleRate(int sampleRate) { (void) sampleRate; }
+    virtual quint64 getCenterFrequency() const;
+    virtual void setCenterFrequency(qint64 centerFrequency);
+
+    virtual bool handleMessage(const Message& message);
+
+    virtual int webapiSettingsGet(
+                SWGSDRangel::SWGDeviceSettings& response,
+                QString& errorMessage);
+
+    virtual int webapiSettingsPutPatch(
+                bool force,
+                const QStringList& deviceSettingsKeys,
+                SWGSDRangel::SWGDeviceSettings& response, // query + response
+                QString& errorMessage);
+
+    virtual int webapiReportGet(
+            SWGSDRangel::SWGDeviceReport& response,
+            QString& errorMessage);
+
+    virtual int webapiRunGet(
+            SWGSDRangel::SWGDeviceState& response,
+            QString& errorMessage);
+
+    virtual int webapiRun(
+            bool run,
+            SWGSDRangel::SWGDeviceState& response,
+            QString& errorMessage);
+
+    static void webapiFormatDeviceSettings(
+            SWGSDRangel::SWGDeviceSettings& response,
+            const USRPInputSettings& settings);
+
+    static void webapiUpdateDeviceSettings(
+            USRPInputSettings& settings,
+            const QStringList& deviceSettingsKeys,
+            SWGSDRangel::SWGDeviceSettings& response);
+
+    std::size_t getChannelIndex();
+    void getLORange(float& minF, float& maxF) const;
+    void getSRRange(float& minF, float& maxF) const;
+    void getLPRange(float& minF, float& maxF) const;
+    void getGainRange(float& minF, float& maxF) const;
+    QStringList getRxAntennas() const;
+    QStringList getRxGainNames() const;
+    QStringList getClockSources() const;
+
+private:
+    DeviceAPI *m_deviceAPI;
+    QMutex m_mutex;
+    USRPInputSettings m_settings;
+    USRPInputThread* m_usrpInputThread;
+    QString m_deviceDescription;
+    bool m_running;
+    DeviceUSRPShared m_deviceShared;
+    bool m_channelAcquired;
+    uhd::rx_streamer::sptr m_streamId;
+    QNetworkAccessManager *m_networkManager;
+    QNetworkRequest m_networkRequest;
+
+    bool openDevice();
+    void closeDevice();
+    bool acquireChannel();
+    void releaseChannel();
+    void suspendRxBuddies();
+    void resumeRxBuddies();
+    void suspendTxBuddies();
+    void resumeTxBuddies();
+    bool applySettings(const USRPInputSettings& settings, bool force = false);
+    void webapiFormatDeviceReport(SWGSDRangel::SWGDeviceReport& response);
+    void webapiReverseSendSettings(QList<QString>& deviceSettingsKeys, const USRPInputSettings& settings, bool force);
+    void webapiReverseSendStartStop(bool start);
+
+private slots:
+    void networkManagerFinished(QNetworkReply *reply);
+};
+
+#endif /* PLUGINS_SAMPLESOURCE_USRPINPUT_USRPINPUT_H_ */