ClockRecoveryFilter.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopeprotocols                                                                                                    *
*                                                                                                                      *
* 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 ClockRecoveryFilter_h
#define ClockRecoveryFilter_h
 
#include "../scopehal/LevelCrossingDetector.h"
 
class ClockRecoveryConstants
{
public:
    int64_t     initialPeriod;
    int64_t     fnyquist;
    int64_t     tend;
    int64_t     timescale;
    int64_t     triggerPhase;
    uint32_t    nedges;
    uint32_t    numEdgesPerThread;
    uint32_t    maxOffsetsPerThread;
    uint32_t    maxInputSamples;
};
 
class ClockRecoveryFilter : public Filter
{
public:
    ClockRecoveryFilter(const std::string& color);
    virtual ~ClockRecoveryFilter();
 
    virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue) override;
 
    static std::string GetProtocolName();
 
    PROTOCOL_DECODER_INITPROC(ClockRecoveryFilter)
 
    
    AcceleratorBuffer<int64_t>& GetZeroCrossings()
    { return m_detector.GetResults(); }
 
    float GetThreshold()
    { return m_threshold.GetFloatVal(); }
 
protected:
    void FillSquarewaveGeneric(SparseDigitalWaveform& cap);
 
    void InnerLoopWithGating(
        SparseDigitalWaveform& cap,
        AcceleratorBuffer<int64_t>& edges,
        size_t nedges,
        int64_t tend,
        int64_t initialPeriod,
        int64_t halfPeriod,
        int64_t fnyquist,
        WaveformBase* gate,
        SparseDigitalWaveform* sgate,
        UniformDigitalWaveform* ugate);
 
    void InnerLoopWithNoGating(
        SparseDigitalWaveform& cap,
        AcceleratorBuffer<int64_t>& edges,
        size_t nedges,
        int64_t tend,
        int64_t initialPeriod,
        int64_t halfPeriod,
        int64_t fnyquist);
 
#ifdef __x86_64__
    void FillSquarewaveAVX2(SparseDigitalWaveform& cap);
#endif
 
    FilterParameter& m_baudRate;
 
    FilterParameter& m_threshold;
 
    enum MtModes
    {
        MT_SINGLE_THREAD,
        MT_GPU
    };
 
    FilterParameter& m_mtMode;
 
    LevelCrossingDetector m_detector;
 
    std::shared_ptr<ComputePipeline> m_fillSquarewaveAndDurationsComputePipeline;
 
    std::shared_ptr<ComputePipeline> m_firstPassComputePipeline;
 
    std::shared_ptr<ComputePipeline> m_secondPassComputePipeline;
 
    std::shared_ptr<ComputePipeline> m_finalPassComputePipeline;
 
    AcceleratorBuffer<int64_t> m_secondPassState;
 
    size_t m_lastIterationOutputCount;
};
 
#endif