cfgbus_mdio.h

// Copyright 2021-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
// ConfigBus MDIO interface
 
#pragma once
 
#include <satcat5/cfgbus_core.h>
#include <satcat5/polling.h>
#include <satcat5/types.h>
 
// Set default buffer size
#ifndef SATCAT5_MDIO_BUFFSIZE
#define SATCAT5_MDIO_BUFFSIZE   8
#endif
 
namespace satcat5 {
    namespace cfg {
        class MdioEventListener {
        public:
            virtual void mdio_done(u16 regaddr, u16 regval) = 0;
        protected:
            ~MdioEventListener() {}
        };
 
        class MdioLogger : public satcat5::cfg::MdioEventListener {
            void mdio_done(u16 regaddr, u16 regval) override;
        };
 
        class Mdio final : public satcat5::poll::Always {
        public:
            Mdio(satcat5::cfg::ConfigBus* cfg, unsigned devaddr,
                unsigned regaddr = satcat5::cfg::REGADDR_ANY);
            ~Mdio() {}
 
            inline bool can_read() const
                {return m_addr_rdcount < SATCAT5_MDIO_BUFFSIZE;}
 
            bool direct_write(unsigned phy, unsigned reg, unsigned data);
 
            bool direct_read(unsigned phy, unsigned reg, unsigned ref,
                    satcat5::cfg::MdioEventListener* callback);
 
        protected:
            // Poll hardware status.
            void poll_always();
 
            // Internal accessors.
            u32 hw_rd_status();
            bool hw_wr_command(u32 cmd);
 
            // Control register address.
            satcat5::cfg::Register m_ctrl_reg;
 
            // Queue for read callbacks and associated metadata.
            unsigned m_addr_rdcount;
            unsigned m_addr_rdidx;
            u16 m_addr_buff[SATCAT5_MDIO_BUFFSIZE];
            satcat5::cfg::MdioEventListener* m_callback[SATCAT5_MDIO_BUFFSIZE];
        };
 
        class MdioWrapper {
        public:
            MdioWrapper(satcat5::cfg::Mdio* mdio, unsigned phyaddr)
                : m_mdio(mdio), m_phy(phyaddr) {}
 
            virtual bool write(unsigned reg, unsigned data) = 0;
            virtual bool read(unsigned reg, satcat5::cfg::MdioEventListener* callback) = 0;
 
        protected:
            // Restricted access avoids need for virtual destructor.
            ~MdioWrapper() {}
 
            // Parameters for the wrapped interface.
            satcat5::cfg::Mdio* const m_mdio;
            const unsigned m_phy;
        };
 
        class MdioGenericMmd final : public satcat5::cfg::MdioWrapper {
        public:
            using satcat5::cfg::MdioWrapper::MdioWrapper;
            bool write(unsigned reg, unsigned data) override;
            bool read(unsigned reg, satcat5::cfg::MdioEventListener* callback) override;
        };
 
        class MdioMarvell final : public satcat5::cfg::MdioWrapper {
        public:
            using satcat5::cfg::MdioWrapper::MdioWrapper;
            bool write(unsigned reg, unsigned data) override;
            bool read(unsigned reg, satcat5::cfg::MdioEventListener* callback) override;
        };
    }
}