I2CDecoder.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopeprotocols                                                                                                    *
*                                                                                                                      *
* Copyright (c) 2012-2022 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 I2CDecoder_h
#define I2CDecoder_h
 
#include "../scopehal/PacketDecoder.h"
 
class I2CSymbol
{
public:
    enum stype
    {
        TYPE_START,
        TYPE_RESTART,
        TYPE_STOP,
        TYPE_DATA,
        TYPE_ACK,
        TYPE_ERROR,
        TYPE_ADDRESS,
        TYPE_NONE
    };
 
    I2CSymbol()
    {}
 
    I2CSymbol(stype t,uint8_t d)
     : m_stype(t)
     , m_data(d)
    {}
 
    stype m_stype;
    uint8_t m_data;
 
    bool operator== (const I2CSymbol& s) const
    {
        return (m_stype == s.m_stype) && (m_data == s.m_data);
    }
};
 
class I2CWaveform : public SparseWaveform<I2CSymbol>
{
public:
    I2CWaveform () : SparseWaveform<I2CSymbol>() {};
    virtual std::string GetText(size_t) override;
    virtual std::string GetColor(size_t) override;
};
 
class I2CDecoder : public PacketDecoder
{
public:
    I2CDecoder(const std::string& color);
 
    virtual void Refresh() override;
 
    std::vector<std::string> GetHeaders() override;
 
    static std::string GetProtocolName();
 
    virtual bool ValidateChannel(size_t i, StreamDescriptor stream) override;
 
    PROTOCOL_DECODER_INITPROC(I2CDecoder)
 
protected:
    template<class T, class U> void InnerLoop(T* sda, U* scl, I2CWaveform* cap);
};
 
#endif