ENC28J60驱动程序说明.doc

Enc28j60以太网芯片驱动程序简介
本介绍可分为三块内容：
1.以太网数据帧结构
符合IEEE802.3标准的以太网帧的长度是介于64-1516字节之间。主要由目标MAC地址、源MAC地址、类型/长度字段、数据有效负载、可选填充字段和循环冗余校验组成，另外在通过以太网介质发送数据包时，一个7字节的前导字段和一字节的帧起始定界符被附加到以太网数据包的开头。以太网数据包的结构如图1所示。

图1以太网数据帧结构图
ENC28J60在发送或接收数据包时由以下几点值得关注：
首先，ENC28J60具有一个接收过滤器可以丢弃或接收具有组播、广播或单播目标地址的数据包。
其次，在数据字段处：
以太网数据字段的长度可以在0-1500字节之间变换，超过这一范围的数据包是违反以太网标准的，这些包将会被大多数以太网节点丢弃。若设置ENC28J60的巨大帧使能位为1，可以发送和接收超大规格数据包。
在数据域中的填充字段是在数据字段小于46字节时起填充作用。ENC28J60在发送数据包时，会自动填充0。ENC28J60在接收时自动拒绝小于18字节的数据包。数据填充亦可由主控芯片来配置。
最后，在CRC处：
ENC28J60在接收数据包时将检查每个传入数据包的CRC，通过检测ERXFCON.CRCEN位来判断输入数据包的CRC是否正确。ENC28J60在发送数据包时，将自动生成一个有效的CRC并发送它。发送数据包的CRC亦可由主控芯片来提供。
2．驱动程序介绍
(1)ENC28J60的寄存器读写规则
由于ENC28J60芯片采用的是SPI串行接口模式，其对内部寄存器读写的规则是先发操作码<前3bit>+寄存器地址<后5bit>，再发送欲操作数据。通过不同操作码来判别操作时读寄存器(缓存区)还是写寄存器(缓冲区)或是其它。
(2)ENC28J60芯片初始化程序
ENC28J60发送和接收数据包前必须对内进行初始化设置，通常在复位后完成，不需再更改。
void enc28j60_init(void)
{
//*****Bank1区相关寄存器配置 SPI操作块 数据块
//初始化程序一开始先进行软件复位，111<操作码>+11111<参数>， N/A
// ENC28J60_SOFT_RESET=0xFF
enc28j60WriteOp(ENC28J60_SOFT_RESET, 0, ENC28J60_SOFT_RESET);
delay_ms(5);

//初始化接收缓冲区，设置接收起始地址
NextPacketPtr = RXSTART_INIT; //读下一数据包指针
enc28j60Write(ERXSTL, RXSTART_INIT&0xFF);
enc28j60Write(ERXSTH, RXSTART_INIT>>8);

//设置接收读指针指向地址
enc28j60Write(ERXRDPTL, RXSTART_INIT&0xFF);
enc28j60Write(ERXRDPTH, RXSTART_INIT>>8);

//设置接收缓冲区的末尾地址
// ERXND寄存器默认指向整个缓冲区的最后一个单元
enc28j60Write(ERXNDL, RXSTOP_INIT&0xFF);
enc28j60Write(ERXNDH, RXSTOP_INIT>>8)

//设置发送缓冲区的起始地址
//ETXST寄存器默认地址是整个缓冲区的第一个单元
enc28j60Write(ETXSTL, TXSTART_INIT&0xFF);
enc28j60Write(ETXSTH, TXSTART_INIT>>8);

//*****Bank2区相关寄存器配置
//MAC初始化配置
//MAC接收使能，下行程序段表示使能MAC接收，使能IEEE流量控制
enc28j60Write(MACON1, MACON1_MARXEN|MACON1_TXPAUS|MACON1_RXPAUS);
//MACON2清零，让MAC退出复位状态
enc28j60Write(MACON2, 0x00);
//下行程序段表示使能自动填充和自动CRC添加
enc28j60WriteOp(ENC28J60_BIT_FIELD_SET,MACON3,
MACON3_PADCFG0|MACON3_TXCRCEN|MACON3_FRMLNEN);
//enc28j60Write(MACON3, MACON3_PADCFG0|MACON3_TXCRCEN|MACON3_FRMLNEN);
//配置非背对背包之间的间隔
enc28j60Write(MAIPGL, 0x12);
enc28j60Write(MAIPGH, 0x0C);
//配置背对背包之间的间隔
enc28j60Write(MABBIPG, 0x12);
//设置允许接收或发送的最大帧长度编程
enc28j60Write(MAMXFLL, MAX_FRAMELEN&0xFF);
enc28j60Write(MAMXFLH, MAX_FRAMELEN>>8);

//*****Bank3区相关寄存器配置
// 将MAC地址写入MAADR0-MAADR5寄存器中
// NOTE: MAC address in ENC28J60 is byte-backward
enc28j60Write(MAADR5, UIP_ETHADDR0);
enc28j60Write(MAADR4, UIP_ETHADDR1);
enc28j60Write(MAADR3, UIP_ETHADDR2);
enc28j60Write(MAADR2, UIP_ETHADDR3);
enc28j60Write(MAADR1, UIP_ETHADDR4);
enc28j60Write(MAADR0, UIP_ETHADDR5);
//阻止发送回路的自动环回
enc28j60PhyWrite(PHCON2, PHCON2_HDLDIS);

//*****Bank0区相关寄存器配置
enc28j60SetBank(ECON1);//设置寄存器区
//中断使能
enc28j60WriteOp(ENC28J60_BIT_FIELD_SET, EIE, EIE_INTIE|EIE_PKTIE);
//包接收使能
enc28j60WriteOp(ENC28J60_BIT_FIELD_SET, ECON1, ECON1_RXEN);
}
说明：enc28j60Write函数内部包含了SetBank<设置寄存器区>子程序，而enc28j60WriteOp直接根据spi操作码<前3bit>+寄存器地址<后5bit>进行操作的。
(3)ENC28J60发送数据包程序
ENC28J60内的MAC在发送数据包时会自动生成前导符合帧起始定界符。此外，也会根据用户配置以及数据具体情况自动生成数据填充和CRC字段。主控器必须把所有其它要发送的帧数据写入ENC28J60缓冲存储器中。另外在待发送数据包前要添加一个包控制字节。包控制字节包括内容有:包超大帧使能位(PHUGEEN)、包填充使能位(PPADEN)、包CRC使能位(PCRCEN)和包改写位(POVERRIDE)四个内容。如图2所示。
void enc28j60PacketSend(u16_t len, u8_t* packet)
{
//配置发送缓冲区写指针起始地址
enc28j60Write(EWRPTL, TXSTART_INIT);
enc28j60Write(EWRPTH, TXSTART_INIT>>8);

// 根据给定数据域的大小配置发送缓冲区的末尾地址
enc28j60Write(ETXNDL, (TXSTART_INIT+len));
enc28j60Write(ETXNDH, (TXSTART_INIT+len)>>8);

//给每个数据包的包控制字节预留一个单元
enc28j60WriteOp(ENC28J60_WRITE_BUF_MEM, 0, 0x00);

// TO DO, fix this up

if( uip_len <= TOTAL_HEADER_LENGTH )
{
//将数据包复制到缓冲区中
enc28j60WriteBuffer(len, packet);
}
else
{
len -= TOTAL_HEADER_LENGTH;
enc28j60WriteBuffer(TOTAL_HEADER_LENGTH, packet);
enc28j60WriteBuffer(len, (unsigned char *)uip_appdata);
}

//将以太网控制寄存器ECON1所有位 置1，以发送缓冲区数据
enc28j60WriteOp(ENC28J60_BIT_FIELD_SET, ECON1, ECON1_TXRTS);
}

图2 发送数据包结构

（4）ENC28J60接收数据包程序
u16_t enc28j60PacketReceive(u16_t maxlen, u8_t* packet)
{
u16_t rxstat;
u16_t len;

//检测缓冲区是否收到一个数据包
if( !(enc28j60Read(EIR) & EIR_PKTIF) ) //检测EIR.PKTIF是否为1
{
// 通过查看EPKTCNT寄存器再次检查是否收到包
if (enc28j60Read(EPKTCNT) == 0)//EPKTCNT为0表示没有包接收/或包已被处理
return 0;
}

// 配置接收缓冲器读指针指向地址
enc28j60Write(ERDPTL, (NextPacketPtr));
enc28j60Write(ERDPTH, (NextPacketPtr)>>8);

//下一个数据包的读指针<详情可查看接收数据包结构图图3>
NextPacketPtr = enc28j60ReadOp(ENC28J60_READ_BUF_MEM, 0);
NextPacketPtr |= enc28j60ReadOp(ENC28J60_READ_BUF_MEM, 0)<<8;

//读数据包字节长度<详情可查看接收数据包结构图图3,status[15..0]>
len = enc28j60ReadOp(ENC28J60_READ_BUF_MEM, 0);
len |= enc28j60ReadOp(ENC28J60_READ_BUF_MEM, 0)<<8;

//读接收数据包的状态
rxstat = enc28j60ReadOp(ENC28J60_READ_BUF_MEM, 0);
rxstat |= enc28j60ReadOp(ENC28J60_READ_BUF_MEM, 0)<<8;

//计算实际数据长度
//移除CRC字段的长度来减少MAC所报告长度
len = MIN(len, maxlen);

//从缓冲区中将数据包复制到packet中
enc28j60ReadBuffer(len, packet);
//ERXRDPT读缓冲器指针
//ENC28J60将一直写到该指针之前的一单元为止
u16_t rs,re;
rs = enc28j60Read(ERXSTH);//ERXST接收缓冲区的起始地址
rs <<= 8;
rs |= enc28j60Read(ERXSTL);
re = enc28j60Read(ERXNDH);//ERXND接收缓冲区的末尾地址
re <<= 8;
re |= enc28j60Read(ERXNDL)
if (NextPacketPtr - 1 < rs || NextPacketPtr - 1 > re)
{
enc28j60Write(ERXRDPTL, (re));//ERXRDPT接收读地址
enc28j60Write(ERXRDPTH, (re)>>8);
}
else
{
enc28j60Write(ERXRDPTL, (NextPacketPtr-1));
enc28j60Write(ERXRDPTH, (NextPacketPtr-1)>>8);
}

// 数据包个数递减位EPKTCNT减1
enc28j60WriteOp(ENC28J60_BIT_FIELD_SET, ECON2, ECON2_PKTDEC);

return len;
}

图3 接收数据包结构