ether_phy.h

#ifndef  __ETHER_PHYS_H
#define  __ETHER_PHYS_H
/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
#include <predef.h>
#include <stdint.h>
#include <nettypes.h>
#include <ether_consts.h>
 
class EthernetVars;
 
class EtherPhy {
    static EthernetVars *allocatingStruct; // for use by the class 'new'
    void * operator new(size_t size);
protected:
    EthernetVars &eth;
    uint32_t currentPage;
    uint32_t driver_state; // Storage for a generic phy driver state. Not necessarily used.
public:
    EtherPhy();
    inline uint32_t  getState() { return driver_state; }
    virtual uint16_t ProcessIRQ();
    virtual eLinkState_t SetLinkMode(eLinkMode_t mode);
    virtual eLinkMode_t  GetLinkMode();
    virtual eLinkState_t GetLink();
    virtual eLinkState_t GetMacLink(); // This is the link state needed for the MAC
                                       // configuration. For a normal PHY, it's the same as
                                       // 'GetLink', but for a smart NIC or switch
                                       // it may not be.
    virtual void     SetMIIMode(eMIIMode_t mode);
    virtual void     IRQMask(uint16_t IRQMask, bool setNotClr);
    virtual void     Enable();
    virtual void     Disable();
 
    virtual void FinalizeFrame(PoolPtr pb, int64_t egress_port_mask, int qos, bool force);
    virtual bool DoRx(PoolPtr pb, uint16_t *rx_len, int *logical_rx_ifnum); // rx_len and ifnum may be modified by DoRx, do not pass non-frame-specific variables
 
    virtual void ShowMII();
 
    friend class EthernetVars;
};
 
 
#define _PUSH_PHY_CLASS _Pragma("push_macro(\"_PHY_CLASS\")")
#define _POP_PHY_CLASS _Pragma("pop_macro(\"_PHY_CLASS\")")
 
class Phy_KSZ8041 : public EtherPhy {
public:
    Phy_KSZ8041();
 
    virtual eLinkState_t SetLinkMode(eLinkMode_t mode) override;
    virtual eLinkMode_t  GetLinkMode() override;
    virtual eLinkState_t GetLink() override;
    virtual void Disable() override;
    virtual void Enable() override;
};
#define _PHY_CLASS Phy_KSZ8041
 
class Phy_KSZ8081 : public EtherPhy {
public:
    Phy_KSZ8081();
 
    virtual eLinkState_t SetLinkMode(eLinkMode_t mode) override;
    virtual eLinkMode_t  GetLinkMode() override;
    virtual eLinkState_t GetLink() override;
    virtual void SetMIIMode(eMIIMode_t mode) override;
    virtual void Disable() override;
    virtual void Enable() override;
};
_PUSH_PHY_CLASS
#undef _PHY_CLASS
#define _PHY_CLASS _POP_PHY_CLASS _PHY_CLASS, Phy_KSZ8081
 
class Phy_AMD : public EtherPhy {
public:
    Phy_AMD();
    virtual eLinkState_t GetLink() override;
};
_PUSH_PHY_CLASS
#undef _PHY_CLASS
#define _PHY_CLASS _POP_PHY_CLASS _PHY_CLASS, Phy_AMD
 
class Phy_National : public EtherPhy {
public:
    Phy_National();
    virtual eLinkState_t GetLink() override;
};
_PUSH_PHY_CLASS
#undef _PHY_CLASS
#define _PHY_CLASS _POP_PHY_CLASS _PHY_CLASS, Phy_National
 
class Phy_DP83825I : public EtherPhy {
public:
    Phy_DP83825I();
    virtual void ShowMII() override;
    virtual uint16_t ProcessIRQ() override;
    virtual eLinkState_t GetLink() override;
    virtual eLinkState_t SetLinkMode(eLinkMode_t mode) override;
    virtual eLinkMode_t  GetLinkMode() override;
    virtual void IRQMask(uint16_t mask, bool setNotClr) override;
    virtual void Disable() override;
    virtual void Enable() override;
};
_PUSH_PHY_CLASS
#undef _PHY_CLASS
#define _PHY_CLASS _POP_PHY_CLASS _PHY_CLASS, Phy_DP83825I
 
class Phy_RTL8211 : public EtherPhy {
public:
    Phy_RTL8211();
    virtual uint16_t ProcessIRQ() override;
    virtual eLinkState_t GetLink() override;
    virtual eLinkState_t SetLinkMode(eLinkMode_t mode) override;
    virtual eLinkMode_t  GetLinkMode() override;
    virtual void IRQMask(uint16_t mask, bool setNotClr) override;
    virtual void Disable() override;
    virtual void Enable() override;
};
_PUSH_PHY_CLASS
#undef _PHY_CLASS
#define _PHY_CLASS _POP_PHY_CLASS _PHY_CLASS, Phy_RTL8211
 
#include <ether_phy_ksz9893.h>
 
#include <algorithm>
template<typename... Ts>
struct _max_sizeof : std::integral_constant<std::size_t, std::max({sizeof(Ts)...})> {};
 
 
static constexpr size_t ETHER_PHY_MAX_SIZE =
    _max_sizeof<_PHY_CLASS>();
 
#endif   /* ----- #ifndef __ETHER_PHYS_H  ----- */