eth_sw_vlan.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/eth_plugin.h>
 
namespace satcat5 {
    namespace eth {
        class SwitchVlanEgress : public satcat5::eth::PluginPort {
        public:
            explicit SwitchVlanEgress(satcat5::eth::SwitchPort* port)
                : PluginPort(port) {}
 
            // Implement the required PluginPort API.
            void egress(PluginPacket& pkt) override;
        };
 
        class SwitchVlanInner
            : public satcat5::eth::PluginCore
            , public satcat5::poll::Timer
        {
        public:
            // Implement the required PluginCore API.
            void query(PluginPacket& pkt) override;
 
            void vlan_reset(bool lockdown = false);
            SATCAT5_PMASK_TYPE vlan_get_mask(u16 vid);
            void vlan_set_mask(u16 vid, SATCAT5_PMASK_TYPE mask);
            VtagPolicy vlan_get_port(unsigned port) const;
            void vlan_set_port(const VtagPolicy& cfg);
            void vlan_join(u16 vid, unsigned port);
            void vlan_leave(u16 vid, unsigned port);
            void vlan_set_rate(u16 vid, const satcat5::eth::VlanRate& cfg);
 
        protected:
            // Data structure for the internal configuration tables.
            struct VlanPolicy {
                satcat5::eth::VlanRate vrate;   // Rate-limiter policy
                SATCAT5_PMASK_TYPE pmask;       // Connected ports mask
                u32 tcount;                     // Token-bucket counter
 
                VlanPolicy() = default;
                VlanPolicy(const VlanPolicy& t) = default;
                VlanPolicy& operator=(const VlanPolicy& t) = default;
            };
 
            // Configure this object and link to the working buffer.
            SwitchVlanInner(
                satcat5::eth::SwitchCore* sw,
                VlanPolicy* vptr, unsigned vmax, bool lockdown);
 
            // Timer-event handler for updating rate-limiter state.
            void timer_event() override;
 
            // Store VLAN policy and rate-limiter state for each VID.
            VlanPolicy* const m_policy;         // Table of VLAN states
            const unsigned m_vmax;              // Supported VIDs = [1..N]
        };
 
        template <unsigned VMAX = 4095>
        class SwitchVlan : public satcat5::eth::SwitchVlanInner
        {
        public:
            explicit SwitchVlan(satcat5::eth::SwitchCore* sw, bool lockdown = false)
                : SwitchVlanInner(sw, m_vtable, VMAX, lockdown) {}
        protected:
            satcat5::eth::SwitchVlanInner::VlanPolicy m_vtable[VMAX];
        };
    }
}