SOEM源码解析——eeprom_read(读EEPROM)
0 工具准备
1.SOEM-master-1.4.0源码
1 eeprom_read函数总览
eeprom_read函数在SOEM源码的路径如下：test->linux->eepromtool->eepromtool.c，功能是读取指定字地址和长度的EEPROM数据：
/**
* @brief 读取EEPROM数据
*
* @param slave 从站序号
* @param start 起始字地址
* @param length 长度（以字为单位）
* @return int
*/
int eeprom_read(int slave, int start, int length)
{
int j = 0;
int i, ainc = 2;
uint16 estat, aiadr;
uint32 b4;
uint64 b8;
uint8 eepctl;
if ((ec_slavecount >= slave) && (slave > 0) && ((start + length) <= MAXBUF))
{
aiadr = 1 - slave;
eepctl = 2;
/* force Eeprom from PDI */
/* 强制PDI操作释放，复位0x0501.0为0，将EEPROM访问控制权分配给主站 */
ec_APWR(aiadr, ECT_REG_EEPCFG, sizeof(eepctl), &eepctl, EC_TIMEOUTRET);
eepctl = 0;
/* set Eeprom to master */
/* 设置EEPRO访问权限分配给主站 */
ec_APWR(aiadr, ECT_REG_EEPCFG, sizeof(eepctl), &eepctl, EC_TIMEOUTRET);
estat = 0x0000;
aiadr = 1 - slave;
/* read eeprom status */
/* 读取EEPROM状态 */
ec_APRD(aiadr, ECT_REG_EEPSTAT, sizeof(estat), &estat, EC_TIMEOUTRET);
estat = etohs(estat);
if (estat & EC_ESTAT_R64)
{
ainc = 4;
for (i = start; i < (start + length); i += ainc)
{
b8 = ec_readeepromAP(aiadr, i, EC_TIMEOUTEEP);
ebuf[j] = b8 & 0xFF;
ebuf[j + 1] = (b8 >> 8) & 0xFF;
ebuf[j + 2] = (b8 >> 16) & 0xFF;
ebuf[j + 3] = (b8 >> 24) & 0xFF;
ebuf[j + 4] = (b8 >> 32) & 0xFF;
ebuf[j + 5] = (b8 >> 40) & 0xFF;
ebuf[j + 6] = (b8 >> 48) & 0xFF;
ebuf[j + 7] = (b8 >> 56) & 0xFF;
j += 2 * ainc;
}
}
else
{
for (i = start; i < (start + length); i += ainc)
{
b4 = ec_readeepromAP(aiadr, i, EC_TIMEOUTEEP) & 0xFFFFFFFF;
ebuf[j] = b4 & 0xFF;
ebuf[j + 1] = (b4 >> 8) & 0xFF;
ebuf[j + 2] = (b4 >> 16) & 0xFF;
ebuf[j + 3] = (b4 >> 24) & 0xFF;
j += 2 * ainc;
}
}
return 1;
}
return 0;
}
从以上代码可以看到，SOEM主站读从站EEPROM的操作可以分为3块：
（1）发送APWR报文夺取EEPROM访问控制权
（2）发送APRD报文获取EEPROM支持读字节数
（3）通过ec_readeepromAP函数读取从站EEPROM数据
1.1 夺取EEPROM访问控制权
夺取EEPROM访问控制权涉及的寄存器如下：
主站通过APWR报文设置0x0501.0=0，强制PDI操作释放，随后通过APWR报文设置0x0501=0x0将EEPROM访问控制权分配给主站。相关语句如下：
aiadr = 1 - slave;
eepctl = 2;
/* force Eeprom from PDI */
/* 强制PDI操作释放，复位0x0501.0为0，将EEPROM访问控制权分配给主站 */
ec_APWR(aiadr, ECT_REG_EEPCFG, sizeof(eepctl), &eepctl, EC_TIMEOUTRET);
eepctl = 0;
/* set Eeprom to master */
/* 设置EEPRO访问权限分配给主站 */
ec_APWR(aiadr, ECT_REG_EEPCFG, sizeof(eepctl), &eepctl, EC_TIMEOUTRET);
1.2 获取EEPROM支持读字节数
获取EEPROM支持读字节数涉及的寄存器如下：
主站发送APRD报文去读取0x0502寄存器bit6，确定主站读取EEPROM一次返回的数据长度。相关语句如下：
/* read eeprom status */
/* 读取EEPROM状态 */
ec_APRD(aiadr, ECT_REG_EEPSTAT, sizeof(estat), &estat, EC_TIMEOUTRET);
estat = etohs(estat);
1.3 通过ec_readeepromAP函数读取从站EEPROM数据
ec_readeepromAP函数实际上调用的是ecx_readeepromAP函数：
/** Read EEPROM from slave bypassing cache. APRD method.：绕过本地EEPROM缓存，用APRD（主站使用顺序寻址从从站读取一定长度数据）方法
* @param[in] context = context struct 句柄
* @param[in] aiadr = auto increment address of slave 自动增量地址
* @param[in] eeproma = (WORD) Address in the EEPROM EEPROM地址（以字为单位）
* @param[in] timeout = Timeout in us.
* @return EEPROM data 64bit or 32bit EEPROM数据 32bit或64bit
*/
uint64 ecx_readeepromAP(ecx_contextt *context, uint16 aiadr, uint16 eeproma, int timeout)
{
uint16 estat;
uint32 edat32;
uint64 edat64;
ec_eepromt ed;
int wkc, cnt, nackcnt = 0;
edat64 = 0;
edat32 = 0;
if (ecx_eeprom_waitnotbusyAP(context, aiadr, &estat, timeout))
{
/* error bits are set */
/* 如果EEPROM有错误标志 */
if (estat & EC_ESTAT_EMASK)
{
/* clear error bits */
/* 清空错误位 */
estat = htoes(EC_ECMD_NOP);
wkc = ecx_APWR(context->port, aiadr, ECT_REG_EEPCTL, sizeof(estat), &estat, EC_TIMEOUTRET3);
}
do
{
/* 设置命令为读取命令、设置读取地址 */
ed.comm = htoes(EC_ECMD_READ);
ed.addr = htoes(eeproma);
ed.d2 = 0x0000;
cnt = 0;
do
{
/* 发送EEPROM读命令 */
wkc = ecx_APWR(context->port, aiadr, ECT_REG_EEPCTL, sizeof(ed), &ed, EC_TIMEOUTRET);
}
while ((wkc <= 0) && (cnt++ < EC_DEFAULTRETRIES));
if (wkc)
{
osal_usleep(EC_LOCALDELAY);
estat = 0x0000;
if (ecx_eeprom_waitnotbusyAP(context, aiadr, &estat, timeout))
{
if (estat & EC_ESTAT_NACK)
{
nackcnt++;
osal_usleep(EC_LOCALDELAY * 5);
}
else
{
nackcnt = 0;
/* 根据支持的读字节数不同读取不同大小数据 8byte 或 4byte*/
if (estat & EC_ESTAT_R64)
{
cnt = 0;
do
{
wkc = ecx_APRD(context->port, aiadr, ECT_REG_EEPDAT, sizeof(edat64), &edat64, EC_TIMEOUTRET);
}
while ((wkc <= 0) && (cnt++ < EC_DEFAULTRETRIES));
}
else
{
cnt = 0;
do
{
wkc = ecx_APRD(context->port, aiadr, ECT_REG_EEPDAT, sizeof(edat32), &edat32, EC_TIMEOUTRET);
}
while ((wkc <= 0) && (cnt++ < EC_DEFAULTRETRIES));
edat64=(uint64)edat32;
}
}
}
}
}
while ((nackcnt > 0) && (nackcnt < 3));
}
return edat64;
}
该函数涉及的寄存器如下：
（1）等待EEPROM接口空闲
主站发送APRD报文检查0x0502寄存器的bit15，等待EEPROM接口空闲。相关语句如下：
if (ecx_eeprom_waitnotbusyAP(context, aiadr, &estat, timeout))
{
/* error bits are set */
/* 如果EEPROM有错误标志 */
if (estat & EC_ESTAT_EMASK)
{
/* clear error bits */
/* 清空错误位 */
estat = htoes(EC_ECMD_NOP);
wkc = ecx_APWR(context->port, aiadr, ECT_REG_EEPCTL, sizeof(estat), &estat, EC_TIMEOUTRET3);
}
当EERPOM接口空闲时会检查错误标志位，如果错误标志置位则设置0x0502寄存器为0，清空错误标志位。
（2）设置读命令及读取地址
主站通过APWR报文设置0x0502寄存器的bit8位为1表示读命令，设置0x0504-0x0507EEPROM地址寄存器为需要读取的EEPROM字地址。相关语句如下：
/* 设置命令为读取命令、设置读取地址 */
ed.comm = htoes(EC_ECMD_READ);
ed.addr = htoes(eeproma);
ed.d2 = 0x0000;
cnt = 0;
do
{
/* 发送EEPROM读命令 */
wkc = ecx_APWR(context->port, aiadr, ECT_REG_EEPCTL, sizeof(ed), &ed, EC_TIMEOUTRET);
}
（3）等待EEPROM接口空闲
主站发送APRD报文检查0x0502寄存器的bit15，等待EEPROM接口空闲。相关语句如下：
if (ecx_eeprom_waitnotbusyAP(context, aiadr, &estat, timeout))
（4）读取EEPROM数据
主站发送APRD报文，读取0x0508寄存器开头，长度为EEPROM支持读取字节数的寄存器数据。支持读取字节数有32bit和64bit这2种。相关语句如下：
/* 根据支持的读字节数不同读取不同大小数据 8byte 或 4byte*/
if (estat & EC_ESTAT_R64)
{
cnt = 0;
do
{
wkc = ecx_APRD(context->port, aiadr, ECT_REG_EEPDAT, sizeof(edat64), &edat64, EC_TIMEOUTRET);
}
while ((wkc <= 0) && (cnt++ < EC_DEFAULTRETRIES));
}
else
{
cnt = 0;
do
{
wkc = ecx_APRD(context->port, aiadr, ECT_REG_EEPDAT, sizeof(edat32), &edat32, EC_TIMEOUTRET);
}
while ((wkc <= 0) && (cnt++ < EC_DEFAULTRETRIES));
edat64=(uint64)edat32;
}
至此，主站读取从站EEPROM的工作结束。
2 总结
eeprom_read函数读取从站EEPROM数据可以分为以下3个步骤：
（1）夺取EEPROM访问控制权
（2）获取EEPROM支持读字节数
（3）通过ec_readeepromAP函数读取从站EEPROM数据