router2_stack.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/igmp_server.h>
#include <satcat5/ip_stack.h>
#include <satcat5/router2_deferfwd.h>
#include <satcat5/router2_dispatch.h>
#include <satcat5/router2_offload.h>
#include <satcat5/router2_table.h>
 
namespace satcat5 {
    namespace router2 {
        class StackCommon {
        public:
            // Enable or disable specific ports.
            inline void port_enable(const SATCAT5_PMASK_TYPE& mask)
                { m_dispatch.port_enable(mask); }
            inline void port_disable(const SATCAT5_PMASK_TYPE& mask)
                { m_dispatch.port_disable(mask); }
 
            // Other accessors.
            inline satcat5::eth::Dispatch* eth()
                { return &m_eth; }
            inline satcat5::ip::Dispatch* ip()
                { return &m_ip; }
            inline satcat5::ip::Addr ipaddr() const
                { return m_ip.ipaddr(); }
            inline satcat5::eth::MacAddr macaddr() const
                { return m_eth.macaddr(); }
            inline satcat5::router2::Dispatch* router()
                { return &m_dispatch; }
            inline satcat5::ip::Table* table()
                { return m_ip.table(); }
            inline satcat5::udp::Dispatch* udp()
                { return &m_udp; }
            inline void set_ipaddr(const satcat5::ip::Addr& addr)
                { return m_dispatch.set_ipaddr(addr); }
 
        protected:
            StackCommon(
                const satcat5::eth::MacAddr& local_mac, // Local MAC address
                const satcat5::ip::Addr& local_ip,      // Local IP address
                satcat5::ip::Table* table,              // Routing table
                u8* buff, unsigned nbytes)              // Internal working buffer
                : m_dispatch(buff, nbytes)
                , m_fwd(&m_dispatch)
                , m_eth(local_mac, m_dispatch.get_local_wr(), m_dispatch.get_local_rd())
                , m_ip(local_ip, &m_eth, table)
                , m_udp(&m_ip)
            {
                m_dispatch.set_defer_fwd(&m_fwd);
                m_dispatch.set_local_iface(&m_ip);
            }
 
            ~StackCommon() {}
 
            // Router logic.
            satcat5::router2::Dispatch m_dispatch;      // Incoming packet processing
            satcat5::router2::DeferFwdStatic<> m_fwd;   // Deferred-fowarding buffer
 
            // Internal IP stack.
            satcat5::eth::Dispatch      m_eth;          // Ethernet layer
            satcat5::ip::Dispatch       m_ip;           // IPv4 and ICMP layer
            satcat5::udp::Dispatch      m_udp;          // UDP layer
        };
 
        template <unsigned BSIZE = 8192>
        class StackGateware : public satcat5::router2::StackCommon {
        public:
            StackGateware(
                const satcat5::eth::MacAddr& local_mac, // Local MAC address
                const satcat5::ip::Addr& local_ip,      // Local IP address
                satcat5::cfg::ConfigBusMmap* cfg,       // ConfigBus interface
                unsigned devaddr,                       // ConfigBus address
                unsigned hw_ports)                      // Number of hardware ports
                : StackCommon(local_mac, local_ip, &m_table, m_buff, BSIZE)
                , m_offload(cfg, devaddr, &m_dispatch, hw_ports)
                , m_table(cfg, devaddr)
            {
                m_dispatch.set_offload(&m_offload);
            }
 
            // Additional accessors.
            inline satcat5::router2::Offload* offload()
                { return &m_offload; }
 
        protected:
            // Internal variables.
            satcat5::router2::Offload m_offload;
            satcat5::router2::Table m_table;
            u8 m_buff[BSIZE];
        };
 
        template <unsigned BSIZE = 16384>
        class StackSoftware : public satcat5::router2::StackCommon {
        public:
            StackSoftware(
                const satcat5::eth::MacAddr& local_mac, // Local MAC address
                const satcat5::ip::Addr& local_ip)      // Local IP address
                : StackCommon(local_mac, local_ip, &m_table, m_buff, BSIZE)
                , m_igmp(&m_dispatch, &m_ip)
                , m_table()
                {}  // Nothing else to initialize.
 
            inline satcat5::igmp::Server* igmp()
                { return &m_igmp; }
 
        protected:
            // Internal variables.
            satcat5::igmp::ServerStatic<64> m_igmp;
            satcat5::ip::Table m_table;
            u8 m_buff[BSIZE];
        };
    }
}