port_adapter.h

Go to the documentation of this file.

// Copyright 2024-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/codec_cobs.h>
#include <satcat5/codec_slip.h>
#include <satcat5/eth_checksum.h>
#include <satcat5/eth_switch.h>
#include <satcat5/eth_sw_vlan.h>
#include <satcat5/io_core.h>
 
namespace satcat5 {
    namespace port {
        class VlanAdapter : public satcat5::eth::SwitchPort {
        public:
            VlanAdapter(
                satcat5::eth::SwitchCore* sw,
                satcat5::io::Writeable* vdst);
 
        protected:
            satcat5::eth::SwitchVlanEgress m_vport;
        };
 
        class MailAdapter final : public satcat5::port::VlanAdapter {
        public:
            MailAdapter(
                satcat5::eth::SwitchCore* sw,
                satcat5::io::Readable* src,
                satcat5::io::Writeable* dst);
 
        protected:
            satcat5::io::BufferedCopy m_rx_copy;    // Push/pull adapter
        };
 
        class CobsAdapter final : public satcat5::port::VlanAdapter {
        public:
            CobsAdapter(
                satcat5::eth::SwitchCore* sw,
                satcat5::io::Readable* src,
                satcat5::io::Writeable* dst);
 
            inline satcat5::io::EventListener* listen()
                { return &m_rx_copy; }
 
            inline satcat5::io::TrafficStats stats()
                { return satcat5::io::TrafficStats::query(m_rx_fcs, m_tx_fcs); }
 
        protected:
            satcat5::io::BufferedCopy m_rx_copy;    // Push/pull adapter
            satcat5::io::CobsDecoder m_rx_cobs;     // COBS decoder
            satcat5::eth::ChecksumRx m_rx_fcs;      // Checksum verification
            satcat5::eth::ChecksumTx m_tx_fcs;      // Checksum calculation
            satcat5::io::CobsEncoder m_tx_cobs;     // COBS encoder
        };
 
        class SlipAdapter final : public satcat5::port::VlanAdapter {
        public:
            SlipAdapter(
                satcat5::eth::SwitchCore* sw,
                satcat5::io::Readable* src,
                satcat5::io::Writeable* dst);
 
            inline satcat5::io::EventListener* listen()
                { return &m_rx_copy; }
 
            inline satcat5::io::TrafficStats stats()
                { return satcat5::io::TrafficStats::query(m_rx_fcs, m_tx_fcs); }
 
        protected:
            satcat5::io::BufferedCopy m_rx_copy;    // Push/pull adapter
            satcat5::io::SlipDecoder m_rx_slip;     // SLIP decoder
            satcat5::eth::ChecksumRx m_rx_fcs;      // Checksum verification
            satcat5::eth::ChecksumTx m_tx_fcs;      // Checksum calculation
            satcat5::io::SlipEncoder m_tx_slip;     // SLIP encoder
        };
 
        class NullAdapter
            : public satcat5::eth::SwitchPort
            , public satcat5::io::ReadableRedirect {
        public:
            explicit NullAdapter(satcat5::eth::SwitchCore* sw);
        };
 
        template <unsigned SIZE = 4096>
        class BufferAdapter
            : public satcat5::port::VlanAdapter
            , public satcat5::io::ReadableRedirect {
        public:
            explicit BufferAdapter(satcat5::eth::SwitchCore* sw)
                : VlanAdapter(sw, &m_buff)
                , ReadableRedirect(&m_buff)
                , m_buff() {}
 
        protected:
            satcat5::io::PacketBufferStatic<SIZE> m_buff;
        };
 
        class SwitchAdapter {
        public:
            SwitchAdapter(
                satcat5::eth::SwitchCore* swa,
                satcat5::eth::SwitchCore* swb);
 
        protected:
            satcat5::port::VlanAdapter m_a2b, m_b2a;
        };
    }
}