temac.h

// Copyright 2021-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
// Interface wrappers for the Xilinx "Tri Mode Ethernet MAC" block (TEMAC)
 
#pragma once
 
#include <satcat5/interrupts.h>
#include <satcat5/pkt_buffer.h>
#include <satcat5/ptp_time.h>
#include <satcat5/ptp_tracking.h>
#include <satcat5/polling.h>
 
namespace satcat5 {
    namespace ublaze {
        struct TemacTime {
            TemacTime() = default;
            TemacTime(const TemacTime& t) = default;
            TemacTime& operator=(const TemacTime& t) = default;
 
            s64 sec;    // Positive or negative
            u32 nsec;   // Always 0 - 999,999,999
        };
 
        class Temac {
        public:
            explicit Temac(uintptr_t baseaddr);
 
        protected:
            volatile u32* const m_regs;
        };
 
        class TemacAvbTxCallback {
        public:
            virtual void tx_sync(const satcat5::ptp::Time& sync_egress) {}
            virtual void tx_delay_req(const satcat5::ptp::Time& delay_req_egress) {}
        };
 
        class TemacAvb
            : public satcat5::ublaze::Temac
            , public satcat5::io::ReadableRedirect
            , public satcat5::irq::Handler
            , public satcat5::poll::Always
            , public satcat5::ptp::TrackingClock
        {
        public:
            TemacAvb(uintptr_t baseaddr, int irq_idx);
 
            void set_tx_callback(TemacAvbTxCallback* tx_callback);
 
            satcat5::ublaze::TemacTime avb_get_time();
 
            void avb_set_rate(u32 incr);
 
            void avb_jump_by(const satcat5::ublaze::TemacTime& delta);
 
            void send_frame(const u8* buf, unsigned buflen);
 
            satcat5::ptp::Time clock_adjust(
                const satcat5::ptp::Time& amount) override;
            void clock_rate(s64 offset) override;
            satcat5::ptp::Time clock_now() override;
 
            static constexpr double CLOCK_SCALE = 0.125 / (1u << 20);
 
        private:
            void irq_event() override;
            void poll_always() override;
            void check_frames_waiting();
 
            satcat5::io::PacketBuffer m_txbuff; // TODO: Unused, but corrupts RX when removed. WHY?
            satcat5::io::PacketBuffer m_rxbuff;
            TemacAvbTxCallback* m_tx_callback;
            u32 m_prev_buf_idx;
            u8 m_frames_waiting;
            u8 m_txrawbuff[2048]; // TODO: see above
            u8 m_rxrawbuff[2048];
        };
    }
}