U-BOOT DM9000驱动完全注释

时间:2022-05-18 17:12:35

#include "../include/dm9000x.h"

/* Board/System/Debug information/definition ---------------- */

#define DM9801_NOISE_FLOOR    0x08
#define DM9802_NOISE_FLOOR    0x05

/* #define CONFIG_DM9000_DEBUG */
#define DM9000_DBG(fmt,args...)
//*================================================================
//DM9000芯片的PHY层模式
//*================================================================
enum DM9000_PHY_mode { DM9000_10MHD = 0, DM9000_100MHD =
        1, DM9000_10MFD = 4, DM9000_100MFD = 5, DM9000_AUTO =
        8, DM9000_1M_HPNA = 0x10
};
//*================================================================
//DM9000芯片的网卡类型。NIC=network interface card
//*================================================================
enum DM9000_NIC_TYPE { FASTETHER_NIC = 0, HOMERUN_NIC = 1, LONGRUN_NIC = 2
};

//*================================================================
//DM9000芯片的数据结构
//*================================================================
typedef struct board_info {
    u32 runt_length_counter;        //接收报文长度小于64byte的计数器
    u32 long_length_counter;        // 接收报文长度大于1514byte 的计数器
    u32 reset_counter;                //复位计数
    u32 reset_tx_timeout;            // 由发送超时引起的复位
    u32 reset_rx_status;            //由接收状态引起的复位
    u16 tx_pkt_cnt;                   //接收包计数
    u16 queue_start_addr;            //序列起始地址
    u16 dbug_cnt;
    u8 phy_addr;                     //MAC地址
    u8 device_wait_reset;            // 设备状态
    u8 nic_type;                    //网卡类型
    unsigned char srom[128];
} board_info_t;
board_info_t dmfe_info;

//*================================================================
//DM9000芯片的设置参数
//*================================================================
static int media_mode = DM9000_AUTO;
static u8 nfloor = 0;

//*================================================================
//DM9000芯片的函数声明
//*================================================================
int eth_init(bd_t * bd);                        //DM9000网卡初始化
int eth_send(volatile void *, int);                //将来自上层的数据包发送到媒介上
int eth_rx(void);                                //接收数据包并且发送到上层去
void eth_halt(void);                            //关闭网卡
static int dm9000_probe(void);                    //探测网卡芯片
static u16 phy_read(int);                        //从物理层上读取一个字(16位)
static void phy_write(int, u16);                //往物理层上写一个字(16位)
static u16 read_srom_word(int);                    //读取SROM中的一个字
static u8 DM9000_ior(int);                        //从IO口上读取一个字节
static void DM9000_iow(int reg, u8 value);        //写一个字节到IO口上

//*================================================================
//DM9000芯片的的寄存器操作宏,分为byte,word,Dword三种
//*================================================================
#define DM9000_outb(d,r) ( *(volatile u8 *)r = d )
#define DM9000_outw(d,r) ( *(volatile u16 *)r = d )
#define DM9000_outl(d,r) ( *(volatile u32 *)r = d )
#define DM9000_inb(r) (*(volatile u8 *)r)
#define DM9000_inw(r) (*(volatile u16 *)r)
#define DM9000_inl(r) (*(volatile u32 *)r)
//*================================================================
//函数名称:dm9000_probe
//函数功能:寻找DM9000芯片,分配内存空间,注册。
//               复位结束后到网卡的vendor ID寄存器和product ID寄存器读取id,
//               检测此网卡是否是dm9000。
//出口参数:无
//入口参数:无
//*================================================================
int
dm9000_probe(void)
{
    u32 id_val;  //32bit变量
    id_val = DM9000_ior(DM9000_VIDL);//首先读VIDL vendor ID low byte
    id_val |= DM9000_ior(DM9000_VIDH) << 8;//然后读VIDH vendor ID high byte
    id_val |= DM9000_ior(DM9000_PIDL) << 16;//再读PIDL Product ID low byte
    id_val |= DM9000_ior(DM9000_PIDH) << 24;//最后读PIDH Product ID high byte
    if (id_val == DM9000_ID) {
        printf("dm9000 i/o: 0x%x, id: 0x%x /n", CONFIG_DM9000_BASE,
               id_val);
        return 0;
    } else {
        printf("dm9000 not found at 0x%08x id: 0x%08x/n",
               CONFIG_DM9000_BASE, id_val);
        return -1;
    }
}

//*================================================================
//函数名称:set_PHY_mode
//函数功能:设置PHY芯片的操作模式 。若设置的是自动选择,则直接配置,若不是则可以选择
//               设置四种模式:10Mbps(半双工,全双工),100Mbps(半双工,全双工)。
//出口参数:无
//入口参数:无
//*================================================================
static void
set_PHY_mode(void)
{
    u16 phy_reg4 = 0x01e1, phy_reg0 = 0x1000;
    if (!(media_mode & DM9000_AUTO)) {
        switch (media_mode) {
        case DM9000_10MHD:                //10M半双工
            phy_reg4 = 0x21;         //设置双工、半双工
            phy_reg0 = 0x0000;  //设置速度模式
            break;
        case DM9000_10MFD:                //10M全双工
            phy_reg4 = 0x41;
            phy_reg0 = 0x1100;
            break;
        case DM9000_100MHD:               //100M半双工
            phy_reg4 = 0x81;
            phy_reg0 = 0x2000;
            break;
        case DM9000_100MFD:                //100M全双工
            phy_reg4 = 0x101;
            phy_reg0 = 0x3100;
            break;
        }
        phy_write(4, phy_reg4);            //设置为自动选择,通过写寄存器4设置该网卡支持IEEE 802.3 CSMA/CD和其他一些工作模式
        phy_write(0, phy_reg0);            //phy寄存器0是设置速度模式,采取的是自动协商
    }
    DM9000_iow(DM9000_GPCR, 0x01);        //定义GPIO的输入输出方向。1为输出,0为输入。GPIO0默认为输出做POWER_DOWN功能。
                                        //其它默认为输入。因此默认值为0001。
    DM9000_iow(DM9000_GPR, 0x00);        //使能DM9000,写DM9000的GPIO寄存器,若希望启用PHY,则驱动程序需要通过写“0”将PWER_DOWN信号清零
}

//*================================================================
//函数名称:program_dm9801
//函数功能:设置DM9801的HOMERUN模式
//出口参数:无
//入口参数:HPNA_rev
//*================================================================
static void
program_dm9801(u16 HPNA_rev)
{
    __u16 reg16, reg17, reg24, reg25;
    if (!nfloor)
        nfloor = DM9801_NOISE_FLOOR;
    reg16 = phy_read(16);
    reg17 = phy_read(17);
    reg24 = phy_read(24);
    reg25 = phy_read(25);
    switch (HPNA_rev) {
    case 0xb900:        /* DM9801 E3 */
        reg16 |= 0x1000;
        reg25 = ((reg24 + nfloor) & 0x00ff) | 0xf000;
        break;
    case 0xb901:        /* DM9801 E4 */
        reg25 = ((reg24 + nfloor) & 0x00ff) | 0xc200;
        reg17 = (reg17 & 0xfff0) + nfloor + 3;
        break;
    case 0xb902:        /* DM9801 E5 */
    case 0xb903:        /* DM9801 E6 */
    default:
        reg16 |= 0x1000;
        reg25 = ((reg24 + nfloor - 3) & 0x00ff) | 0xc200;
        reg17 = (reg17 & 0xfff0) + nfloor;
    }
    phy_write(16, reg16);
    phy_write(17, reg17);
    phy_write(25, reg25);
}

//*================================================================
//函数名称:program_dm9802
//函数功能:设置DM9802的LONGRUN模式
//出口参数:无
//入口参数:无
//*================================================================
static void
program_dm9802(void)
{
    __u16 reg25;
    if (!nfloor)
        nfloor = DM9802_NOISE_FLOOR;
    reg25 = phy_read(25);
    reg25 = (reg25 & 0xff00) + nfloor;
    phy_write(25, reg25);
}

//*================================================================
//函数名称:identify_nic
//函数功能:识别网卡芯片.接着是检测网卡类型,是FASTETHER, HOMERUN或LONGRUN类型。
//                 这里主要是通过phy_read(3)和phy_read(31)读取PHY 寄存器的值并进行比较判断。
//                 读PHY寄存器的方法将在后面介绍。
//出口参数:无
//入口参数:无
//*================================================================
static void
identify_nic(void)
{
    struct board_info *db = &dmfe_info;    /* Point a board information structure */
    u16 phy_reg3;
    DM9000_iow(DM9000_NCR, NCR_EXT_PHY);
    phy_reg3 = phy_read(3);
    switch (phy_reg3 & 0xfff0) {
    case 0xb900:
        if (phy_read(31) == 0x4404) {
            db->nic_type = HOMERUN_NIC;
            program_dm9801(phy_reg3);
            DM9000_DBG("found homerun NIC/n");
        } else {
            db->nic_type = LONGRUN_NIC;
            DM9000_DBG("found longrun NIC/n");
            program_dm9802();
        }
        break;
    default:
        db->nic_type = FASTETHER_NIC;
        break;
    }
    DM9000_iow(DM9000_NCR, 0);
}

//*================================================================
//函数名称:dm9000_reset
//函数功能:DM9000的复位。
//出口参数:无
//入口参数:无
//*================================================================
static void
dm9000_reset(void)
{
    DM9000_iow(DM9000_NCR, NCR_RST);
    OSTimeDly(1);        /* delay 50ms */
}

//*================================================================
//函数名称:eth_init
//函数功能:网卡的初始化
//出口参数:无
//入口参数:bd
//*================================================================
int
eth_init(bd_t * bd)
{
    int i, oft, lnk;
    /* RESET device */
    dm9000_reset();
    dm9000_probe();

    /* NIC Type: FASTETHER, HOMERUN, LONGRUN */
    identify_nic();

    /* GPIO0 on pre-activate PHY */
    DM9000_iow(DM9000_GPR, 0x00);    /*REG_1F bit0 activate phyxcer */

    /* Set PHY */
    set_PHY_mode();

    /* Program operating register */
    DM9000_iow(DM9000_NCR, 0x0);    /* only intern phy supported by now */
    DM9000_iow(DM9000_TCR, 0);    /* TX Polling clear */
    DM9000_iow(DM9000_BPTR, 0x3f);    /* Less 3Kb, 200us */
    DM9000_iow(DM9000_FCTR, FCTR_HWOT(3) | FCTR_LWOT(8));    /* Flow Control : High/Low Water */
    DM9000_iow(DM9000_FCR, 0x0);    /* SH FIXME: This looks strange! Flow Control */
    DM9000_iow(DM9000_SMCR, 0);    /* Special Mode */
    DM9000_iow(DM9000_NSR, NSR_WAKEST | NSR_TX2END | NSR_TX1END);    /* clear TX status */
    DM9000_iow(DM9000_ISR, 0x0f);    /* Clear interrupt status */

    /* 下面这段代码是设置dm9000的MAC地址,
    选是通过read_srom_word(i)到srom中读取MAC地址值,
    再分别写入板子信息数据结构bd和dm9000的MAC寄存器中,
    再将Multicast Address Register寄存器全部置1。*/
    for (i = 0; i < 6; i++)
        ((u16 *) bd->bi_enetaddr)[i] = read_srom_word(i);
    printf("MAC: %02x:%02x:%02x:%02x:%02x:%02x/n", bd->bi_enetaddr[0],
           bd->bi_enetaddr[1], bd->bi_enetaddr[2], bd->bi_enetaddr[3],
           bd->bi_enetaddr[4], bd->bi_enetaddr[5]);
    for (i = 0, oft = 0x10; i < 6; i++, oft++)
        DM9000_iow(oft, bd->bi_enetaddr[i]);
    for (i = 0, oft = 0x16; i < 8; i++, oft++)
        DM9000_iow(oft, 0xff);

    /* read back mac, just to be sure */
    for (i = 0, oft = 0x10; i < 6; i++, oft++)
        DM9000_DBG("%02x:", DM9000_ior(oft));
    DM9000_DBG("/n");

    /*现在开始使能网卡的接收功能,设置中断屏蔽寄存器。
    这里IMR_PAR=1000 0000b,将IMR寄存器的位7置“1”,
    使内存数据读取地址的高字节为0ch,即Memory Data Read_address Register F5。
    这样设置使得接收的数据从内部内存地址0x0c00处开始存放。 */
   
    DM9000_iow(DM9000_RCR, RCR_DIS_LONG | RCR_DIS_CRC | RCR_RXEN);    /* RX enable */
    DM9000_iow(DM9000_IMR, IMR_PAR);    /* Enable TX/RX interrupt mask */
   
    i = 0;
    while (!(phy_read(1) & 0x20)) {    /* 读取phy寄存器1,判断auto-negotiation是否完成。
                                        起动时特别慢原因就在这里。 这里判断的次数太多,
                                        延长的等待时间。如果auto-negotiation完成的快,
                                        这里是多少也就无所谓了。*/
        udelay(1000);
        i++;
        if (i == 10000) {
            printf("could not establish link/n");
            return 0;
        }
    }

/*  读PHY寄存器17,检测其工作模式。 到些网卡初始化结束。*/
    lnk = phy_read(17) >> 12;
    printf("operating at ");
    switch (lnk) {
    case 1:
        printf("10M half duplex ");
        break;
    case 2:
        printf("10M full duplex ");
        break;
    case 4:
        printf("100M half duplex ");
        break;
    case 8:
        printf("100M full duplex ");
        break;
    default:
        printf("unknown: %d ", lnk);
        break;
    }
    printf("mode/n");
    return 0;
}

//*================================================================
//函数名称:eth_send
//函数功能:发送数据包
//出口参数:无
//入口参数:数据包指针,数据包长度
//*================================================================
int
eth_send(volatile void *packet, int length)
{
    char *data_ptr;
    u32 tmplen, i;
    int tmo;
    DM9000_DBG("eth_send: length: %d/n", length);
    for (i = 0; i < length; i++) {
        if (i % 8 == 0)
            DM9000_DBG("/nSend: 02x: ", i);
        DM9000_DBG("%02x ", ((unsigned char *) packet)[i]);
    } DM9000_DBG("/n");

    /* Move data to DM9000 TX RAM */
    data_ptr = (char *) packet;
    DM9000_outb(DM9000_MWCMD, DM9000_IO);

#ifdef CONFIG_DM9000_USE_8BIT
    /* Byte mode */
    for (i = 0; i < length; i++)
        DM9000_outb((data_ptr[i] & 0xff), DM9000_DATA);

#endif                /*  */
#ifdef CONFIG_DM9000_USE_16BIT
    tmplen = (length + 1) / 2;
    for (i = 0; i < tmplen; i++)
        DM9000_outw(((u16 *) data_ptr)[i], DM9000_DATA);

#endif                /*  */
#ifdef CONFIG_DM9000_USE_32BIT
    tmplen = (length + 3) / 4;
    for (i = 0; i < tmplen; i++)
        DM9000_outl(((u32 *) data_ptr)[i], DM9000_DATA);

#endif                /*  */

    /* Set TX length to DM9000 */
    DM9000_iow(DM9000_TXPLL, length & 0xff);
    DM9000_iow(DM9000_TXPLH, (length >> 8) & 0xff);

    /* Issue TX polling command */
    DM9000_iow(DM9000_TCR, TCR_TXREQ);    /* Cleared after TX complete */

    /* wait for end of transmission */
    tmo = get_timer(0) + 5 * CFG_HZ;
    while (DM9000_ior(DM9000_TCR) & TCR_TXREQ) {
        if (get_timer(0) >= tmo) {
            printf("transmission timeout/n");
            break;
        }
    }
    DM9000_DBG("transmit done/n/n");
    return 0;
}

//*================================================================
//函数名称:eth_halt
//函数功能:关闭网卡
//出口参数:无
//入口参数:无
//*================================================================
void
eth_halt(void)
{
    DM9000_DBG("eth_halt/n");

    /* RESET devie */
    phy_write(0, 0x8000);    /* PHY RESET */
    DM9000_iow(DM9000_GPR, 0x01);    /* Power-Down PHY */
    DM9000_iow(DM9000_IMR, 0x80);    /* Disable all interrupt */
    DM9000_iow(DM9000_RCR, 0x00);    /* Disable RX */
}

/*
  Received a packet and pass to upper layer
*/
//*================================================================
//函数名称:eth_rx
//函数功能:接收一个数据包并传递给上层
//出口参数:无
//入口参数:无
//*================================================================
int
eth_rx(void)
{
    u8 rxbyte, *rdptr = (u8 *) NetRxPackets[0];
    u16 RxStatus, RxLen = 0;
    u32 tmplen, i;
#ifdef CONFIG_DM9000_USE_32BIT
    u32 tmpdata;
#endif

    /* Check packet ready or not */
    DM9000_ior(DM9000_MRCMDX);    /* Dummy read */
    rxbyte = DM9000_inb(DM9000_DATA);    /* Got most updated data */
    if (rxbyte == 0)
        return 0;

    /* Status check: this byte must be 0 or 1 */
    if (rxbyte > 1) {
        DM9000_iow(DM9000_RCR, 0x00);    /* Stop Device */
        DM9000_iow(DM9000_ISR, 0x80);    /* Stop INT request */
        DM9000_DBG("rx status check: %d/n", rxbyte);
    }
    DM9000_DBG("receiving packet/n");

    /* A packet ready now  & Get status/length */
    DM9000_outb(DM9000_MRCMD, DM9000_IO);

#ifdef CONFIG_DM9000_USE_8BIT
    RxStatus = DM9000_inb(DM9000_DATA) + (DM9000_inb(DM9000_DATA) << 8);
    RxLen = DM9000_inb(DM9000_DATA) + (DM9000_inb(DM9000_DATA) << 8);

#endif                /*  */
#ifdef CONFIG_DM9000_USE_16BIT
    RxStatus = DM9000_inw(DM9000_DATA);
    RxLen = DM9000_inw(DM9000_DATA);

#endif                /*  */
#ifdef CONFIG_DM9000_USE_32BIT
    tmpdata = DM9000_inl(DM9000_DATA);
    RxStatus = tmpdata;
    RxLen = tmpdata >> 16;

#endif                /*  */
    DM9000_DBG("rx status: 0x%04x rx len: %d/n", RxStatus, RxLen);

    /* Move data from DM9000 */
    /* Read received packet from RX SRAM */
#ifdef CONFIG_DM9000_USE_8BIT
    for (i = 0; i < RxLen; i++)
        rdptr[i] = DM9000_inb(DM9000_DATA);

#endif                /*  */
#ifdef CONFIG_DM9000_USE_16BIT
    tmplen = (RxLen + 1) / 2;
    for (i = 0; i < tmplen; i++)
        ((u16 *) rdptr)[i] = DM9000_inw(DM9000_DATA);

#endif                /*  */
#ifdef CONFIG_DM9000_USE_32BIT
    tmplen = (RxLen + 3) / 4;
    for (i = 0; i < tmplen; i++)
        ((u32 *) rdptr)[i] = DM9000_inl(DM9000_DATA);

#endif                /*  */
    if ((RxStatus & 0xbf00) || (RxLen < 0x40)
        || (RxLen > DM9000_PKT_MAX)) {
        if (RxStatus & 0x100) {
            printf("rx fifo error/n");
        }
        if (RxStatus & 0x200) {
            printf("rx crc error/n");
        }
        if (RxStatus & 0x8000) {
            printf("rx length error/n");
        }
        if (RxLen > DM9000_PKT_MAX) {
            printf("rx length too big/n");
            dm9000_reset();
        }
    } else {

        /* Pass to upper layer */
        DM9000_DBG("passing packet to upper layer/n");
        NetReceive(NetRxPackets[0], RxLen);
        return RxLen;
    }
    return 0;
}
         
/*
  Read a word data from SROM
*/
//*================================================================
//函数名称:read_srom_word
//函数功能:从srom中读取一个字长的数据。这个函数是从srom中读一个word。
//                首先把要读的那个寄存器的偏移地址offset写入EPAR寄存器,
//                然后把读命令0x4写入EPCR寄存器,等待至少150us后,
//                向EPCR寄存器写入0x0,清除读命令,
//                最后从EPDRL和EPDRH寄存器中分别读出数据的低字节和高字节。
//                EPAR是地址寄存器,存入要读/写的寄存器的偏移地址。
//                EPCR是控制寄存器,通过命令控制读/写。
//                读出的数据或要写入的数据放在PEDRL和EPDRH中。
//出口参数:无
//入口参数:偏移地址
//*================================================================
static u16
read_srom_word(int offset)
{
    DM9000_iow(DM9000_EPAR, offset);
    DM9000_iow(DM9000_EPCR, 0x4);
    udelay(200);
    DM9000_iow(DM9000_EPCR, 0x0);
    return (DM9000_ior(DM9000_EPDRL) + (DM9000_ior(DM9000_EPDRH) << 8));
}

//*================================================================
//函数名称:Dm9000_ior
//函数功能:从IO上读取一个字节
//出口参数:
//入口参数:reg
//*================================================================
static u8
DM9000_ior(int reg)
{
    DM9000_outb(reg, DM9000_IO);
    return DM9000_inb(DM9000_DATA);
}

//*================================================================
//函数名称:Dm9000_iow
//函数功能:写一个字节到IO上
//出口参数:
//入口参数:reg,value
//*================================================================
static void
DM9000_iow(int reg, u8 value)
{
    DM9000_outb(reg, DM9000_IO);
    DM9000_outb(value, DM9000_DATA);
}

//*================================================================
//函数名称:phy_read
//函数功能:从物理层上读取一个字(16位).这段代码是从PHY寄存器中读取一个字。
//                读取的方法和读srom是一样的。但在细节上有些差别。在写PHY寄存器
//                地址时要保证EPAR的第7、6位的值为01b。这样就选中PHY模式。
//                在往EPCR寄存器中写读命令时要保证其位3为1。这也是为了选中PHY模式。
//出口参数:val
//入口参数:reg
//*================================================================
static u16
phy_read(int reg)
{
    u16 val;

    /* Fill the phyxcer register into REG_0C */
    DM9000_iow(DM9000_EPAR, DM9000_PHY | reg);
    DM9000_iow(DM9000_EPCR, 0xc);    /* Issue phyxcer read command */
    udelay(100);        /* Wait read complete */
    DM9000_iow(DM9000_EPCR, 0x0);    /* Clear phyxcer read command */
    val = (DM9000_ior(DM9000_EPDRH) << 8) | DM9000_ior(DM9000_EPDRL);

    /* The read data keeps on REG_0D & REG_0E */
    DM9000_DBG("phy_read(%d): %d/n", reg, val);
    return val;
}

//*================================================================
//函数名称:phy_write
//函数功能:从物理层上写一个字(16位)
//出口参数:
//入口参数:reg,value
//*================================================================
static void
phy_write(int reg, u16 value)
{

    /* Fill the phyxcer register into REG_0C */
    DM9000_iow(DM9000_EPAR, DM9000_PHY | reg);

    /* Fill the written data into REG_0D & REG_0E */
    DM9000_iow(DM9000_EPDRL, (value & 0xff));
    DM9000_iow(DM9000_EPDRH, ((value >> 8) & 0xff));
    DM9000_iow(DM9000_EPCR, 0xa);    /* Issue phyxcer write command */
    udelay(500);        /* Wait write complete */
    DM9000_iow(DM9000_EPCR, 0x0);    /* Clear phyxcer write command */
    DM9000_DBG("phy_write(reg:%d, value:%d)/n", reg, value);
}