BERT.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 BERT_h
#define BERT_h
 
class BERT : public virtual Instrument
{
public:
    BERT();
    virtual ~BERT();
 
    virtual unsigned int GetInstrumentTypes() const override;
 
    enum Pattern
    {
        PATTERN_PRBS7,
 
        PATTERN_PRBS9,
 
        PATTERN_PRBS11,
 
        PATTERN_PRBS15,
 
        PATTERN_PRBS23,
 
        PATTERN_PRBS31,
 
        PATTERN_CUSTOM,
 
        PATTERN_CLOCK_DIV2,
 
        PATTERN_CLOCK_DIV32,
 
        PATTERN_AUTO
    };
 
    // TX pattern generator configuration
 
    static std::string GetPatternName(Pattern pat);
    static Pattern GetPatternOfName(std::string name);
 
    virtual Pattern GetTxPattern(size_t i) =0;
 
    virtual void SetTxPattern(size_t i, Pattern pattern) =0;
 
    virtual std::vector<Pattern> GetAvailableTxPatterns(size_t i) =0;
 
    virtual bool IsCustomPatternPerChannel() =0;
 
    virtual size_t GetCustomPatternLength() =0;
 
    virtual void SetGlobalCustomPattern(uint64_t pattern) =0;
 
    virtual uint64_t GetGlobalCustomPattern() =0;
 
 
    // TX driver configuration
 
    virtual bool GetTxInvert(size_t i) =0;
 
 
    virtual void SetTxInvert(size_t i, bool invert) =0;
 
    virtual std::vector<float> GetAvailableTxDriveStrengths(size_t i) =0;
 
    virtual float GetTxDriveStrength(size_t i) =0;
 
    virtual void SetTxDriveStrength(size_t i, float drive) =0;
 
    virtual void SetTxEnable(size_t i, bool enable) =0;
 
    virtual bool GetTxEnable(size_t i) =0;
 
    virtual float GetTxPreCursor(size_t i) =0;
 
    virtual void SetTxPreCursor(size_t i, float precursor) =0;
 
    virtual float GetTxPostCursor(size_t i) =0;
 
    virtual void SetTxPostCursor(size_t i, float postcursor) =0;
 
    // RX input buffer configuration
 
    virtual bool GetRxInvert(size_t i) =0;
 
 
    virtual void SetRxInvert(size_t i, bool invert) =0;
 
    virtual bool GetRxCdrLockState(size_t i) =0;
 
    virtual bool HasRxCTLE() =0;
 
    virtual std::vector<float> GetRxCTLEGainSteps() =0;
 
    virtual size_t GetRxCTLEGainStep(size_t i) =0;
 
    virtual void SetRxCTLEGainStep(size_t i, size_t step) =0;
 
    // RX pattern checker configuration
 
    virtual Pattern GetRxPattern(size_t i) =0;
 
    virtual void SetRxPattern(size_t i, Pattern pattern) =0;
 
    virtual std::vector<Pattern> GetAvailableRxPatterns(size_t i) =0;
 
    // RX data readout
 
    virtual int64_t GetExpectedBathtubCaptureTime(size_t i);
 
    virtual int64_t GetExpectedEyeCaptureTime(size_t i);
 
    virtual void MeasureHBathtub(size_t i) =0;
 
    virtual void MeasureEye(size_t i) =0;
 
    virtual void SetBERIntegrationLength(int64_t uis) =0;
 
    virtual int64_t GetBERIntegrationLength() =0;
 
    virtual void SetBERSamplingPoint(size_t i, int64_t dx, float dy) =0;
 
    virtual void GetBERSamplingPoint(size_t i, int64_t& dx, float& dy) =0;
 
    // RX capture status
 
    virtual bool IsHBathtubScanInProgress(size_t i);
 
    virtual bool IsEyeScanInProgress(size_t i);
 
    virtual float GetScanProgress(size_t i);
 
    // RX integration depth control
 
    virtual bool HasConfigurableScanDepth();
 
    virtual std::vector<int64_t> GetScanDepths(size_t i);
 
    virtual int64_t GetScanDepth(size_t i);
 
    virtual void SetScanDepth(size_t i, int64_t depth);
 
    // Reference clock control
 
    virtual bool HasRefclkIn() =0;
 
    virtual bool HasRefclkOut() =0;
 
    virtual size_t GetRefclkOutMux() =0;
 
    virtual void SetRefclkOutMux(size_t i) =0;
 
    virtual std::vector<std::string> GetRefclkOutMuxNames() =0;
 
    virtual int64_t GetRefclkOutFrequency() =0;
 
    virtual int64_t GetRefclkInFrequency() =0;
 
    // Timebase
 
    virtual bool IsDataRatePerChannel() =0;
 
    virtual int64_t GetDataRate(size_t i) =0;
 
    virtual void SetDataRate(size_t i, int64_t rate) =0;
 
    virtual std::vector<int64_t> GetAvailableDataRates() =0;
 
    virtual void SetUseExternalRefclk(bool external) =0;
 
    virtual bool GetUseExternalRefclk() =0;
 
    // Configuration storage
 
protected:
    void DoSerializeConfiguration(YAML::Node& node, IDTable& table);
 
    void DoLoadConfiguration(int version, const YAML::Node& node, IDTable& idmap);
 
    void DoPreLoadConfiguration(int version, const YAML::Node& node, IDTable& idmap, ConfigWarningList& list);
};
 
#include "BERTInputChannel.h"
#include "BERTOutputChannel.h"
 
#endif