cfgbus_remote.h

// Copyright 2021-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
// Controller for a remote ConfigBus, connected over network
 
#pragma once
 
#include <satcat5/cfgbus_core.h>
#include <satcat5/eth_dispatch.h>
#include <satcat5/net_core.h>
#include <satcat5/polling.h>
#include <satcat5/udp_core.h>
 
namespace satcat5 {
    namespace cfg {
        class ConfigBusRemote
            : public satcat5::cfg::ConfigBus
            , public satcat5::net::Protocol
            , public satcat5::poll::Timer
        {
        public:
            satcat5::cfg::IoStatus read(unsigned regaddr, u32& rdval) override;
            satcat5::cfg::IoStatus write(unsigned regaddr, u32 wrval) override;
 
            satcat5::cfg::IoStatus read_array(
                unsigned regaddr, unsigned count, u32* result) override;
            satcat5::cfg::IoStatus read_repeat(
                unsigned regaddr, unsigned count, u32* result) override;
            satcat5::cfg::IoStatus write_array(
                unsigned regaddr, unsigned count, const u32* data) override;
            satcat5::cfg::IoStatus write_repeat(
                unsigned regaddr, unsigned count, const u32* data) override;
 
            void set_timeout_rd(unsigned usec) {m_timeout_rd = usec;}
            void set_timeout_wr(unsigned usec) {m_timeout_wr = usec;}
 
            void set_irq_polling(unsigned msec) {timer_every(msec);}
 
        protected:
            ConfigBusRemote(
                satcat5::net::Address* dst,             // Remote iface + address
                const satcat5::net::Type& ack);         // Ack type parameter
            ~ConfigBusRemote() SATCAT5_OPTIONAL_DTOR;
 
            // Callback for incoming reply frames.
            void frame_rcvd(satcat5::io::LimitedRead& src) override;
 
            // Callback for timer events.
            void timer_event() override;
 
            satcat5::cfg::IoStatus send_and_wait(
                u8 opcode, unsigned addr,
                unsigned len, const u32* ptr, unsigned timeout);
 
            bool send_command(
                u8 opcode, unsigned addr,
                unsigned len, const u32* ptr);
 
            satcat5::cfg::IoStatus wait_response(unsigned timeout);
 
            satcat5::net::Address* const m_dst;
 
            // Timer for measuring timeouts.
            unsigned m_timeout_rd;
            unsigned m_timeout_wr;
 
            // Stored state for pending responses.
            u32 m_status;
            u8 m_sequence;
            u8 m_response_opcode;
            u32* m_response_ptr;
            unsigned m_response_len;
            satcat5::cfg::IoStatus m_response_status;
        };
    }
 
    namespace eth {
        // Remote ConfigBus operation over Ethernet.
        class ConfigBus final
            : protected satcat5::eth::AddressContainer
            , public satcat5::cfg::ConfigBusRemote
        {
        public:
            ConfigBus(satcat5::eth::Dispatch* iface);   // Network interface
 
            void connect(const satcat5::eth::MacAddr& dst);
 
            inline void close()             {m_addr.close();}
            inline bool ready() const       {return m_addr.ready();}
        };
    }
 
    namespace udp {
        // Remote ConfigBus operation over UDP.
        class ConfigBus final
            : protected satcat5::udp::AddressContainer
            , public satcat5::cfg::ConfigBusRemote
        {
        public:
            explicit ConfigBus(
                satcat5::udp::Dispatch* udp);           // UDP interface
 
            void connect(
                const satcat5::ip::Addr& dstaddr);      // Remote address
 
            inline void close()             {m_addr.close();}
            inline bool ready() const       {return m_addr.ready();}
        };
    }
}