ThunderScopeOscilloscope.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef ThunderScopeOscilloscope_h
#define ThunderScopeOscilloscope_h
 
#include "RemoteBridgeOscilloscope.h"
#include "../xptools/HzClock.h"
 
class ThunderScopeOscilloscope : public RemoteBridgeOscilloscope
{
public:
    ThunderScopeOscilloscope(SCPITransport* transport);
    virtual ~ThunderScopeOscilloscope();
 
    //not copyable or assignable
    ThunderScopeOscilloscope(const ThunderScopeOscilloscope& rhs) =delete;
    ThunderScopeOscilloscope& operator=(const ThunderScopeOscilloscope& rhs) =delete;
 
public:
 
    //Device information
    virtual unsigned int GetInstrumentTypes() const override;
    virtual void FlushConfigCache() override;
 
    //Channel configuration
    virtual std::vector<OscilloscopeChannel::CouplingType> GetAvailableCouplings(size_t i) override;
    virtual double GetChannelAttenuation(size_t i) override;
    virtual void SetChannelAttenuation(size_t i, double atten) override;
    virtual unsigned int GetChannelBandwidthLimit(size_t i) override;
    virtual void SetChannelBandwidthLimit(size_t i, unsigned int limit_mhz) override;
    virtual std::vector<unsigned int> GetChannelBandwidthLimiters(size_t i) override;
    virtual OscilloscopeChannel* GetExternalTrigger() override;
    virtual bool CanEnableChannel(size_t i) override;
    virtual uint32_t GetInstrumentTypesForChannel(size_t i) const override;
    virtual void SetChannelCoupling(size_t i, OscilloscopeChannel::CouplingType type) override;
    virtual void EnableChannel(size_t i) override;
    virtual bool IsHighRateOffsetCapable(size_t i) override;
 
    //Triggering
    virtual void BackgroundProcessing() override;
    virtual Oscilloscope::TriggerMode PollTrigger() override;
    virtual bool AcquireData() override;
    virtual void PushEdgeTrigger(EdgeTrigger* trig) override;
 
    // Captures
    virtual void Start() override;
    virtual void StartSingleTrigger() override;
    virtual void Stop() override;
    virtual void ForceTrigger() override;
 
    //Timebase
    virtual std::vector<uint64_t> GetSampleRatesNonInterleaved() override;
    virtual std::vector<uint64_t> GetSampleRatesInterleaved() override;
    virtual std::set<InterleaveConflict> GetInterleaveConflicts() override;
    virtual std::vector<uint64_t> GetSampleDepthsNonInterleaved() override;
    virtual std::vector<uint64_t> GetSampleDepthsInterleaved() override;
    virtual bool IsInterleaving() override;
    virtual bool SetInterleaving(bool combine) override;
    virtual bool CanInterleave() override;
    virtual bool HasInterleavingControls() override;
    void SetSampleDepth(uint64_t depth) override;
    void SetSampleRate(uint64_t rate) override;
 
    //ADC modes
    virtual bool IsADCModeConfigurable() override;
    virtual std::vector<std::string> GetADCModeNames(size_t channel) override;
    virtual size_t GetADCMode(size_t channel) override;
    virtual void SetADCMode(size_t channel, size_t mode) override;
 
protected:
    void ResetPerCaptureDiagnostics();
    void RefreshSampleRate();
    bool DoAcquireData(bool keep);
 
    void PushPendingWaveformsIfReady();
 
    void FlushAllPendingWaveforms()
    {
        while(!m_wipWaveforms.empty())
            PushPendingWaveformsIfReady();
    }
 
    std::string GetChannelColor(size_t i);
 
    size_t m_analogChannelCount;
 
    std::map<size_t, double> m_channelAttenuations;
 
    FilterParameter m_diag_hardwareWFMHz;
 
    FilterParameter m_diag_receivedWFMHz;
 
    FilterParameter m_diag_totalWFMs;
 
    FilterParameter m_diag_droppedWFMs;
 
    FilterParameter m_diag_droppedPercent;
 
    HzClock m_receiveClock;
 
    std::vector<std::unique_ptr<AcceleratorBuffer<int16_t> > > m_analogRawWaveformBuffers;
 
    unsigned int m_nextWaveformWriteBuffer;
 
    std::unique_ptr<ComputePipeline> m_conversion8BitPipeline;
 
    std::unique_ptr<ComputePipeline> m_conversion16BitPipeline;
 
    AcceleratorBuffer<uint32_t> m_clippingBuffer;
 
    std::vector<unsigned int> m_bandwidthLimits;
 
    enum ADCMode
    {
        MODE_8BIT,
        MODE_12BIT
    } m_adcMode;
 
    uint32_t m_lastSeq;
 
    uint32_t m_dropUntilSeq;
 
    std::recursive_mutex m_wipWaveformMutex;
 
    SequenceSet m_wipWaveforms;
 
public:
 
    //This is intentionally not virtual since it's a static method used by enumeration
    //cppcheck-suppress duplInheritedMember
    static std::vector<SCPIInstrumentModel> GetDriverSupportedModels()
    {
        return
        {
            {"TS0xxx", {{ SCPITransportType::TRANSPORT_TWINLAN, "localhost:5025:5026" }}}
        };
    }
 
    static std::string GetDriverNameInternal();
    OSCILLOSCOPE_INITPROC(ThunderScopeOscilloscope);
};
 
#endif