EthernetProtocolDecoder.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 EthernetProtocolDecoder_h
#define EthernetProtocolDecoder_h
 
#include "../scopehal/PacketDecoder.h"
 
class EthernetFrameSegment
{
public:
    enum SegmentType
    {
        TYPE_INVALID,
        TYPE_PREAMBLE,
        TYPE_SFD,
        TYPE_DST_MAC,
        TYPE_SRC_MAC,
        TYPE_ETHERTYPE,
        TYPE_VLAN_TAG,
        TYPE_PAYLOAD,
        TYPE_FCS_GOOD,
        TYPE_FCS_BAD,
        TYPE_INBAND_STATUS, //RGMII or similar
        TYPE_NO_CARRIER,
        TYPE_REMOTE_FAULT,
        TYPE_LOCAL_FAULT,
        TYPE_LINK_INTERRUPTION,
        TYPE_TX_ERROR
    } m_type;
 
    uint64_t m_data;
 
    EthernetFrameSegment()
    {}
 
    EthernetFrameSegment(SegmentType type, uint8_t value)
        : m_type(type)
    { m_data = value; }
 
    bool operator==(const EthernetFrameSegment& rhs) const
    {
        return (m_data == rhs.m_data) && (m_type == rhs.m_type);
    }
};
 
class EthernetWaveform : public SparseWaveform<EthernetFrameSegment>
{
public:
    EthernetWaveform ()
        : SparseWaveform<EthernetFrameSegment>()
    {};
    virtual std::string GetText(size_t) override;
    virtual std::string GetColor(size_t) override;
 
    void PreCacheColors();
};
 
class EthernetProtocolDecoder : public PacketDecoder
{
public:
    EthernetProtocolDecoder(const std::string& color);
    virtual ~EthernetProtocolDecoder();
 
    virtual std::vector<std::string> GetHeaders() override;
 
    virtual std::string GetDecodedField(Packet* pack, size_t i) override;
 
protected:
    void BytesToFrames(
        std::vector<uint8_t>& bytes,
        std::vector<uint64_t>& starts,
        std::vector<uint64_t>& ends,
        EthernetWaveform* cap,
        bool suppressedPreambleAndFCS = false)
    {
        BytesToFrames(&bytes[0], &starts[0], &ends[0], bytes.size(), cap, suppressedPreambleAndFCS);
    }
 
    void BytesToFrames(
        uint8_t* bytes,
        uint64_t* starts,
        uint64_t* ends,
        size_t len,
        EthernetWaveform* cap,
        bool suppressedPreambleAndFCS = false,
        std::optional<uint32_t> offloadCRC = {}
        );
 
    void BytesToFramesUnitTimescale(
        uint8_t* bytes,
        uint64_t* starts,
        uint64_t* ends,
        size_t len,
        EthernetWaveform* cap,
        bool suppressedPreambleAndFCS = false,
        std::optional<uint32_t> offloadCRC = {});
 
    std::vector<std::string> m_headers;
 
    AcceleratorBuffer<uint32_t> m_crcTable;
};
 
#endif