BERTInputChannel.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2024 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 BERTInputChannel_h
#define BERTInputChannel_h
 
class BERT;
#include "EyeMask.h"
 
class BERTInputChannel : public OscilloscopeChannel
{
public:
 
    BERTInputChannel(
        const std::string& hwname,
        std::weak_ptr<BERT> bert,
        const std::string& color = "#808080",
        size_t index = 0);
 
    virtual ~BERTInputChannel();
 
    virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue) override;
    virtual bool ValidateChannel(size_t i, StreamDescriptor stream) override;
 
    std::weak_ptr<BERT> GetBERT() const
    { return m_bert; }
 
    // All of these inline accessors don't null-check because the channel is contained by the parent BERT
    // (and thus it's impossible for us to outlive it)
 
    bool GetInvert()
    { return m_bert.lock()->GetRxInvert(GetIndex()); }
 
    void SetInvert(bool invert)
    { m_bert.lock()->SetRxInvert(GetIndex(), invert); }
 
    bool GetCdrLockState()
    { return m_bert.lock()->GetRxCdrLockState(GetIndex()); }
 
    void SetPattern(BERT::Pattern pattern)
    { m_bert.lock()->SetRxPattern(GetIndex(), pattern); }
 
    BERT::Pattern GetPattern()
    { return m_bert.lock()->GetRxPattern(GetIndex()); }
 
    std::vector<BERT::Pattern> GetAvailablePatterns()
    { return m_bert.lock()->GetAvailableRxPatterns(GetIndex()); }
 
    int64_t GetScanDepth()
    { return m_bert.lock()->GetScanDepth(GetIndex()); }
 
    std::vector<int64_t> GetScanDepths()
    { return m_bert.lock()->GetScanDepths(GetIndex()); }
 
    void SetScanDepth(int64_t depth)
    { m_bert.lock()->SetScanDepth(GetIndex(), depth); }
 
    enum StreamIDs
    {
        STREAM_HBATHTUB     = 0,
 
        STREAM_EYE          = 1,
 
        STREAM_BER          = 2,
 
        STREAM_MASKHITRATE  = 3
    };
 
    StreamDescriptor GetHBathtubStream()
    { return StreamDescriptor(this, STREAM_HBATHTUB); }
 
    StreamDescriptor GetEyeStream()
    { return StreamDescriptor(this, STREAM_EYE); }
 
    StreamDescriptor GetBERStream()
    { return StreamDescriptor(this, STREAM_BER); }
 
    bool HasCTLE()
    { return m_bert.lock()->HasRxCTLE(); }
 
    std::vector<float> GetCTLEGainSteps()
    { return m_bert.lock()->GetRxCTLEGainSteps(); }
 
    size_t GetCTLEGainStep()
    { return m_bert.lock()->GetRxCTLEGainStep(GetIndex()); }
 
    void SetCTLEGainStep(size_t step)
    { m_bert.lock()->SetRxCTLEGainStep(GetIndex(), step); }
 
    void SetBERSamplingPoint(int64_t dx, float dy)
    { m_bert.lock()->SetBERSamplingPoint(GetIndex(), dx, dy); }
 
    void GetBERSamplingPoint(int64_t& dx, float& dy)
    { m_bert.lock()->GetBERSamplingPoint(GetIndex(), dx, dy); }
 
    int64_t GetDataRate()
    { return m_bert.lock()->GetDataRate(GetIndex()); }
 
    void SetDataRate(int64_t rate)
    { m_bert.lock()->SetDataRate(GetIndex(), rate); }
 
    const std::string& GetMaskFile()
    { return m_maskFile; }
 
    void SetMaskFile(const std::string& fname);
 
    EyeMask& GetMask()
    { return m_mask; }
 
    virtual PhysicalConnector GetPhysicalConnector() override;
 
    int64_t GetExpectedBathtubCaptureTime()
    { return m_bert.lock()->GetExpectedBathtubCaptureTime(GetIndex()); }
 
    int64_t GetExpectedEyeCaptureTime()
    { return m_bert.lock()->GetExpectedEyeCaptureTime(GetIndex()); }
 
    bool IsEyeScanInProgress()
    { return m_bert.lock()->IsEyeScanInProgress(GetIndex()); }
 
    float GetScanProgress()
    { return m_bert.lock()->GetScanProgress(GetIndex()); }
 
    bool IsHBathtubScanInProgress()
    { return m_bert.lock()->IsHBathtubScanInProgress(GetIndex()); }
 
    // Vertical scaling and stream management
 
public:
    virtual void ClearStreams() override;
    virtual size_t AddStream(Unit yunit, const std::string& name, Stream::StreamType stype, uint8_t flags = 0) override;
 
    virtual float GetVoltageRange(size_t stream) override;
    virtual void SetVoltageRange(float range, size_t stream) override;
 
    virtual float GetOffset(size_t stream) override;
    virtual void SetOffset(float offset, size_t stream) override;
 
protected:
 
    std::vector<float> m_ranges;
 
    std::vector<float> m_offsets;
 
    std::string m_maskFile;
 
    EyeMask m_mask;
 
protected:
 
    std::weak_ptr<BERT> m_bert;
};
 
#endif