UartTrigger.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 UartTrigger_h
#define UartTrigger_h
 
#include "SerialTrigger.h"
 
#ifdef _WIN32
//Our parity type definitions are also found in windows.h!
//Undefine those so we can use ours instead.
#undef PARITY_NONE
#undef PARITY_ODD
#undef PARITY_EVEN
#undef PARITY_MARK
#undef PARITY_SPACE
#endif
 
class UartTrigger : public SerialTrigger
{
public:
    UartTrigger(Oscilloscope* scope);
    virtual ~UartTrigger();
 
    enum ParityType
    {
        PARITY_NONE,
 
        PARITY_ODD,
 
        PARITY_EVEN,
 
        PARITY_MARK,
 
        PARITY_SPACE
    };
 
    void SetParityType(ParityType type)
    { m_parity.SetIntVal(type); }
 
    ParityType GetParityType()
    { return (ParityType) m_parity.GetIntVal(); }
 
    enum MatchType
    {
        TYPE_DATA,
 
        TYPE_PARITY_ERR,
 
        TYPE_START,
 
        TYPE_STOP
    };
 
    void SetMatchType(MatchType type)
    { m_matchtype.SetIntVal(type); }
 
    MatchType GetMatchType()
    { return (MatchType) m_matchtype.GetIntVal(); }
 
    enum Polarity
    {
        IDLE_HIGH,
 
        IDLE_LOW
    };
 
    void SetPolarity(Polarity type)
    { m_polarity.SetIntVal(type); }
 
    Polarity GetPolarity()
    { return (Polarity) m_polarity.GetIntVal(); }
 
    int64_t GetBitRate()
    { return m_baudrate.GetIntVal(); }
 
    void SetBitRate(int64_t t)
    { m_baudrate.SetIntVal(t); }
 
    float GetStopBits()
    { return m_stoptype.GetFloatVal(); }
 
    void SetStopBits(float n)
    { m_stoptype.SetFloatVal(n); }
 
    virtual bool ValidateChannel(size_t i, StreamDescriptor stream) override;
 
    static std::string GetTriggerName();
    TRIGGER_INITPROC(UartTrigger);
 
protected:
 
    FilterParameter& m_baudrate;
 
    FilterParameter& m_parity;
 
    FilterParameter& m_matchtype;
 
    FilterParameter& m_stoptype;
 
    FilterParameter& m_polarity;
};
 
#endif