coldfire/cpu/MCF5441X/include/ethervars.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _ETHER_VARS_H
#define _EHTER_VARS_H
 
// PHY ID Register #3 bits with the last 4 revision number bits being don't cares
#define MICREL_ID (0x1610)
#define MICREL8041_ID (0x1510)
#define DAVICOM_ID (0xB880)
#define AMD_ID (0x5610)
#define NATIONAL_ID (0x5C90)
#define NATIONAL_IEEE1588_ID (0x5CE0)
#define MICREL8081_ID (0x1560)
 
#if (defined MCF5272)
#define CORE72
#else
#define CORE70
#endif
 
// PHY Register addresses
#define PHY_REG_BASIC_CTL 0x00
#define PHY_REG_BASIC_ST 0x01
#define PHY_REG_ID_1 0x02
#define PHY_REG_ID_2 0x03
#define PHY_REG_A_NEG_ADVERT 0x04
#define PHY_REG_A_NEG_LPA 0x05
#define PHY_REG_A_NEG_EXP 0x06
#define PHY_REG_A_NEG_NEXT_PG 0x07
#define PHY_REG_LP_NEXT_PG_ABIL 0x08
#define PHY_AFE_CTL_1 0x10
#define PHY_REG_MILL_CTL 0x14
#define PHY_RXER_CNTR 0x15
#define PHY_MODE_STRAP_OVER 0x16
#define PHY_MODE_STRAP_STATUS 0x17
#define PHY_EXPANDED_CTL 0x18
#define PHY_REG_IRQ_CTL_ST 0x1B
#define PHY_REG_PHY_CTL_1 0x1E
#define PHY_REG_PHY_CTL_2 0x1F
 
// PHY Register masks
#define PHY_LINK_STAT 0x0004
#define PHY_A_NEG_COMP 0x0020
#define PHY_IRQ_DOWN_EN 0x0400
#define PHY_IRQ_UP_EN 0x0100
 
#define IP_20uint8_t_ID (0x4500)
#define ETHER_TYPE_IP (0x0800)
#define ETHER_TYPE_ARP (0x0806)
 
#define NUM_TX_BD (3)
 
#ifdef _DEBUG
/*******************WARNING ***********************/
// This number must be a power of 2 and match the mask value
// OK to mess with the non debug value, leave the debug value alone.
#define NUM_RX_BD (8)
#define NUM_DEBUG_RX_BUFF (8)
#define DB_RX_MASK (0x07)
/*******************WARNING ***********************/
 
#else
 
#define NUM_RX_BD (10)
 
#endif
 
#define FEC_RMII_10T_MODE (0x00000200)
 
#include <netinterface.h>
#include <sim5441x.h>
 
typedef enum
{
    PORT1_WAITING = 0,
    PORT1_INITED = 1,
    PORT1_SWITCH = 2
} Port1_State;
 
class EthernetVars : public EtherLikeInterface
{
   public:
    int fecn;   // FEC(Freescale Ethernet Controller) number
    bool inited;
    uint8_t supMacInUse;   // Bitmask indicating which Supplemental MACs are in use
 
    OS_SEM SemSend;
 
    int nTx;   // TX and RX counters
    int nRx;
    uint32_t TxIsrCnt;
    uint32_t RxIsrCnt;
    uint32_t LrnIsrCnt;
 
    // Place for all the buffers
    volatile EtherBD TxBD[NUM_TX_BD] __attribute__((aligned(16)));
    volatile EtherBD RxBD[NUM_RX_BD] __attribute__((aligned(16)));
 
    volatile PoolPtr RxBDpp[NUM_RX_BD] __attribute__((aligned(4)));
    volatile PoolPtr TxBDpp[NUM_TX_BD] __attribute__((aligned(4)));
 
    volatile uint8_t RxBDFlag[NUM_RX_BD] __attribute__((aligned(4)));
    volatile uint8_t TxBDFlag[NUM_RX_BD] __attribute__((aligned(4)));
 
    int last_rxbd;
 
    uint32_t LastIsrStatus;
 
    volatile uint32_t RxPosts;
    volatile uint32_t TxcPosts;
    volatile uint32_t RxReject;
 
    // Current link status
    BOOL bEthLink;   /* do we have link? */
    BOOL bEthDuplex; /* Are we set-up for duplex? */
    BOOL bEth100Mb;  /* Are we 100Mb? */
    BOOL bPromisc;   /* Are we in Promiscuous Mode? */
 
    // Discovered PHY data
    BOOL RMII;
    uint8_t PHY_addr;
    uint16_t PHY_ID;
 
    // Phy forcing modes
    BOOL SetEthDuplex;
    BOOL SetEth100Mb;
    BOOL AutoNeg;
 
    // Link status info
    BOOL bNewLink;
    BOOL bNewDuplex;
    BOOL bEverHadLink;        /*Have we ever had link */
    bool bDescriptorsReadied; /* Have we readied the buffer descriptors? */
 
    volatile uint32_t phy_data_pd;
    volatile uint32_t phy_data;
 
    uint32_t last_phy_read;
 
    uint32_t AutoTimeOut;   // Link but no Auto Negotiation counter
 
    // Real public interface
    EthernetVars(int fec, const char *name);
 
    void ManualEthernetConfig(BOOL Speed100, BOOL FullDuplex, BOOL AutoNegotiate);
 
    void SetPromiscuous(BOOL promisc);
    inline void EnablePromiscuous() { SetPromiscuous(TRUE); }
    inline void DisablePromiscuous() { SetPromiscuous(FALSE); }
    void EnablePHY();
    void DisablePHY();
 
    virtual void send_func(PoolPtr poolPtr);
    virtual void kill_if();
    virtual void EnableMulticast(MACADR macAddress, BOOL addAddress);
    virtual bool LinkActive();
    virtual bool LinkDuplex();
    virtual int LinkSpeed();
    virtual const char *GetInterfaceName();
 
    void InitializeEthernet(bool bRegisterInterface);
 
    uint32_t GetMII(uint8_t addr);
    uint32_t GetMII(uint8_t mii_dev, uint8_t addr);
    uint32_t SetMII(uint8_t addr, uint16_t value);
    uint32_t SetMII(uint8_t mii_dev, uint8_t addr, uint16_t value);
 
    // Internal processing functions
    void DoRX(PoolPtr pp, uint16_t length);
    int ProcessRxBuffer(PoolPtr pp);
    void ResetEnet();
    void ResetEnetPart2();
    void ReadyDescriptors();
    void WarmEnetReset();
    void ProcessDuplexStatus(uint16_t phyStat);
    void RxIsrProc(volatile uint32_t &isr, uint32_t frameMask, uint32_t bufferMask);
    void TxIsrProc(volatile uint32_t &isr, uint32_t frameMask, uint32_t bufferMask);
 
    // Info display functions
    void ShowLinkStatus();
    void ShowMII(uint8_t mii_dev, uint8_t addr, PCSTR name, uint16_t mask);
    void ShowFECRegisters();
    void ShowPhyterMII();
#ifdef _DEBUG
    void DebugEthernetTx(PoolPtr pb);   // Transmits a buffer and frees it afterword.
    void NMIEthernetYield(volatile uint32_t &isr, uint32_t frameMask, uint32_t bufferMask);
    void NMI_Eth_Transmit(PoolPtr pb);
#endif
};
 
void SetPromiscuous(BOOL promisc);
inline void EnablePromiscuous()
{
    SetPromiscuous(TRUE);
}
inline void DisablePromiscuous()
{
    SetPromiscuous(FALSE);
}
void ShowESWRegisters();
 
extern "C"
{
    void DoDumpEnet();
}
 
extern EthernetVars enet0;
extern EthernetVars enet1;
 
// Set to true save config and reboot to enter switch mode.
extern config_bool DoEtherSwitch;
 
#ifdef _DEBUG
#define DEBUG_INTERFACE_MAGIC_IFNUM (0x80)
#endif
 
#endif