STM32与LAN9252构建EtherCAT从站(五):STM32与LAN9252适配

  1. 一、 STM32与LAN9252构建EtherCAT从站(一):项目简介
  2. 二、 STM32与LAN9252构建EtherCAT从站(二):使用SSC生成EtherCAT协议栈和XML文件
  3. 三、 STM32与LAN9252构建EtherCAT从站(三):LAN9252的XML文件
  4. 四、 STM32与LAN9252构建EtherCAT从站(四):STM32配置SPI
  5. 五、 STM32与LAN9252构建EtherCAT从站(五):STM32与LAN9252适配
  6. 六、 STM32与LAN9252构建EtherCAT从站(六):TwinCAT2的使用和从站测试

STM32与LAN9252构建EtherCAT从站(五):STM32与LAN9252适配

这一章讲解STM32与LAN9252的全面适配。

1.硬件

既然是全面适配,那不得不略微提一下硬件连接,以下是相关区域的原理图:
lan1
lan2
可以看到,LAN9252与STM32通信一共用了7根线,4根SPI,3根外部中断,这跟我们上文STM32与LAN9252构建EtherCAT从站(四):STM32配置SPI讲解的内容是一致的。

2.软件

软件的适配主要包括以下几点:

  1. 协议栈移植,至少做到.c文件没有报错。上一章我们介绍了方法,后续的步骤留给各位自行完成,千万不要拿来主义。
  2. SPI驱动移植,上一章我们已经完成。
  3. 对接接口。将协议栈暴露给我们的几个函数,在代码相应的位置进行调用。
  4. 编写业务逻辑。根据第二章在Excel中设计的IO交互数据,在指定的函数中编写业务逻辑。

2.1对接接口

整个EtherCAT协议栈期望的我们的程序主体框架的伪代码如下:

void    APPL_AckErrorInd(UINT16 stateTrans) {
}
UINT16 APPL_StartMailboxHandler(void) {
    return ALSTATUSCODE_NOERROR;
}
UINT16 APPL_StopMailboxHandler(void) {
    return ALSTATUSCODE_NOERROR;
}
UINT16 APPL_StartInputHandler(UINT16 *pIntMask) {
    return ALSTATUSCODE_NOERROR;
}
UINT16 APPL_StopInputHandler(void) {
    return ALSTATUSCODE_NOERROR;
}
UINT16 APPL_StartOutputHandler(void) {
    return ALSTATUSCODE_NOERROR;
}
UINT16 APPL_StopOutputHandler(void) {
    return ALSTATUSCODE_NOERROR;
}
UINT16 APPL_GenerateMapping(UINT16 *pInputSize, UINT16 *pOutputSize){
    return ALSTATUSCODE_NOERROR;
}
void APPL_InputMapping(UINT16 *pData) {
}
void APPL_OutputMapping(UINT16 *pData) {
}
void APPL_Application(void) {
}

void EtherCatIRQ(){
    PDI_Isr();
}

void Sync0IRQ(){
    Sync0_Isr();
}

void Sync0IRQ(){
    Sync1_Isr();
}

void Timer1msIRQ(){
    ECAT_CheckTimer();
}

int main(){
    HW_Init();
    MainInit();
    while(1){
        MainLoop();
    }
}

其中,这些函数均由协议栈提供:

  • PDI_Isr():EtherCAT主中断响应,需要配置到外部中断中,跟LAN9252的44脚对应,下降沿触发。
  • Sync0_Isr():分布式时钟同步信号0,需要配置到外部中断中,跟LAN9252的18脚对应,下降沿触发。
  • Sync1_Isr():分布式时钟同步信号1,需要配置到外部中断中,跟LAN9252的34脚对应,下降沿触发。
  • ECAT_CheckTimer():1ms定时器溢出中断,我这边配置在STM32的TIM8的break interrupt上。
  • HW_Init():硬件初始化函数,MCU通过此函数感应LAN9252设备的存在与否。
  • MainInit():协议栈初始化函数。
  • MainLoop():协议栈主循环,主while(1)中尽量只放此函数,其他业务逻辑在APPL_Application(void)函数中编写,后面介绍。

这些函数需要根据自己的业务逻辑编写:

  • APPL_InputMapping(UINT16 *pData) 输入数据映射
  • APPL_OutputMapping(UINT16 *pData) 输出数据映射
  • APPL_Application(void) 主业务逻辑

这些函数保持默认即可,也可添加自己的业务逻辑:

  • APPL_AckErrorInd(UINT16 stateTrans) EtherCAT通信故障时回调
  • APPL_StartMailboxHandler(void) 邮箱消息接收前回调
  • APPL_StopMailboxHandler(void) 邮箱消息接收后回调
  • APPL_StartInputHandler(UINT16 *pIntMask) 输入映射前回调
  • APPL_StopInputHandler(void) 输入映射后回调
  • APPL_StartOutputHandler(void)输出映射前回调
  • APPL_StopOutputHandler(void) 输出映射后回调

最后一个APPL_GenerateMapping()函数有固定的模板,我们后面介绍。

2.2 中断接口

2.2.1 PDI_Isr()

这个函数来自于ecatappl.c文件,头文件定义取自ecatappl.h,我们在主程序中直接#include applInterface.h即可。

IRQ
将此函数配置到外部中断服务函数中去,我这边使用的是EXTI0_IRQHandler,并且根据习惯,我将这个服务函数从stm32f1xx_it.c中移动到main.c中去了,仅做参考。
EXT0
需要再次提醒的是,上一章已经说过,CubeMX生成的中断初始化函数,在gpio.c中,有以下代码:
gpio
正如我所说,设备上电后我们不可以直接调用HAL_NVIC_EnableIRQ函数将各种中断使能,因为此时协议栈相关数据都没初始化好,直接使能这些中断将导致严重的逻辑问题。因此上述代码后面的使能语句,都需要注释掉。

2.2.2 Sync0_Isr() 和 Sync1_Isr()

这个函数来自于ecatappl.c文件,头文件定义取自ecatappl.h,我们在主程序中直接#include applInterface.h即可。
我们将这个函数配置到EXTI9_5_IRQHandlerEXTI4_IRQHandler中:

void EXTI9_5_IRQHandler(void) {
    /* USER CODE BEGIN EXTI9_5_IRQn 0 */
    DISABLE_ESC_INT();
    Sync0_Isr();
    ENABLE_ESC_INT();
    /* USER CODE END EXTI9_5_IRQn 0 */
    HAL_GPIO_EXTI_IRQHandler(GPIO_PIN_5);
    /* USER CODE BEGIN EXTI9_5_IRQn 1 */

    /* USER CODE END EXTI9_5_IRQn 1 */
}

void EXTI4_IRQHandler(void) {
    /* USER CODE BEGIN EXTI4_IRQn 0 */
    DISABLE_ESC_INT();
    Sync1_Isr();
    ENABLE_ESC_INT();
    /* USER CODE END EXTI4_IRQn 0 */
    HAL_GPIO_EXTI_IRQHandler(GPIO_PIN_4);
    /* USER CODE BEGIN EXTI4_IRQn 1 */

    /* USER CODE END EXTI4_IRQn 1 */
}
2.2.3 ECAT_CheckTimer()

这个函数来自于ecatappl.c文件,头文件定义取自ecatappl.h,我们在主程序中直接#include applInterface.h即可。
我们将其配置到TIM8的break interrupt服务函数中去:

void TIM8_BRK_IRQHandler(void) {
    /* USER CODE BEGIN TIM8_BRK_IRQn 0 */
    ECAT_CheckTimer();
    /* USER CODE END TIM8_BRK_IRQn 0 */
    HAL_TIM_IRQHandler(&htim8);
    /* USER CODE BEGIN TIM8_BRK_IRQn 1 */

    /* USER CODE END TIM8_BRK_IRQn 1 */
}

2.3 主程序接口

2.3.1 HW_Init()

这个函数来自9252_HW.c, 在9252HW.h中有其定义,主程序中直接#include ecatslv.h即可。

2.3.2 HW_Init()

这个函数来自ecatappl.c, 在applInterface.h中有其定义,主程序中直接#include applInterface.h即可。

2.3.2 MainLoop()

同上。

2.4 业务逻辑接口

上面提到很多回调函数,在EtherCAT协议栈中,使用了extern关键字来调用那些函数,因此我们需要有这些函数的实体。

2.4.1 APPL_GenerateMapping()

这个函数是根据我们定义的过程通信数据,与内存中的数据进行映射的函数,这个函数不需要自己写,说实话如果靠我们自己写,要对EtherCAT协议栈深入理解才行。所幸SSC生成的代码中已经帮我写好了,但是并不归属于协议栈,在项目文件中有其实现,我这边项目命名为STM32_EtherCAT_Slave,因此在STM32_EtherCAT_Slave.c中可以找到,复制粘贴到main.c中即可。

2.4.2 APPL_InputMapping(UINT16 *pData)

这个函数是输入数据映射函数。这里的【输入】是相对于主站来说,也就是我们这里从站的输出数据。我们这里定义了输入数据是64个bit,因此这里就要将内存中64个bit的数据赋值给pData指针指向的首地址。
又因为我们在SSC配置的Excel中,输入数据定义的是InputS0x6000地址,因此在我的工程文件STM32_EtherCAT_SlaveObjects.h中就会有INPUTS0x6000这个变量的定义。
那么这个函数的实现也就不难了,深入理解C语言指针的同学一定不难看懂以下代码:

void APPL_InputMapping(UINT16 *pData) {
    *pData++ = (((UINT16 *) &INPUTS0x6000)[1]);
    *pData++ = (((UINT16 *) &INPUTS0x6000)[2]);
    *pData++ = (((UINT16 *) &INPUTS0x6000)[3]);
    *pData = (((UINT16 *) &INPUTS0x6000)[4]);
}
2.4.3 APPL_OutputMapping(UINT16 *pData)

同理,该函数这么编写:

void APPL_OutputMapping(UINT16 *pData) {
    ((UINT16 *) &OUTPUTS0x7000)[1] = (*pData++);
    ((UINT16 *) &OUTPUTS0x7000)[2] = (*pData++);
    ((UINT16 *) &OUTPUTS0x7000)[3] = (*pData++);
    ((UINT16 *) &OUTPUTS0x7000)[4] = (*pData);
}

3.总结

至此STM32与LAN9252对接的所有接口都完成了,编译无误的话可以试着下载到设备中去。观察看看LAN9252的RUN灯是否可以常亮。
其实移植的最主要难点还在于是否能将一开始KEIL的所有报错,有耐心地一一排除掉。到了这一步对接接口,就好比一个萝卜一个坑,在正确的位置调用正确的API就可以了。
下一章,我们将结束这篇系列教程,在TwinCAT2上配置从站,并验证我们编写的代码。

STM32与LAN9252构建EtherCAT从站(四):STM32配置SPI

  1. 一、 STM32与LAN9252构建EtherCAT从站(一):项目简介
  2. 二、 STM32与LAN9252构建EtherCAT从站(二):使用SSC生成EtherCAT协议栈和XML文件
  3. 三、 STM32与LAN9252构建EtherCAT从站(三):LAN9252的XML文件
  4. 四、 STM32与LAN9252构建EtherCAT从站(四):STM32配置SPI
  5. 五、 STM32与LAN9252构建EtherCAT从站(五):STM32与LAN9252适配
  6. 六、 STM32与LAN9252构建EtherCAT从站(六):TwinCAT2的使用和从站测试

STM32与LAN9252构建EtherCAT从站(四):STM32配置SPI

这一章主要讲解STM32的SPI配置,以及与LAN9252的SPI接口对接。
从2018年开始,几乎所有最新的STM32项目或者教程,都不约而同地开始使用HAL库,其原因主要是意法半导体推出的STM32CubeMx这款图形化配置软件太好用了。一定程度上弥补了HAL库与标准库在使用习惯,已有项目遗产上的差距。而且,官方声明最新的STM32F7系列将只支持HAL库。
在这里我建议大家以积极的态度拥抱变化,STM32 ARM所有家族产品尽量都使用HAL库进行开发,并使用CubeMX软件辅佐开发;对于寄存器模式开发,在项目中如果有所接触,可以去翻阅手册查看原理,有价值的一些快速寄存器操作也是有必要记下来的,在一些高速场合确实很适用,比如快速开关中断,快速GPIO操作等;对于标准库模式开发,建议放弃了,标准库很久不更新了,现在已经成老古董了,再过几年就彻底跟不上时代了,就好比没人愿意用Github上5年以上不更新的项目,即使它确实很优秀。有人说【HAL臃肿,F7性能好,而且只能用HAL,所以用HAL,F0,F1,F3还是继续用标准库合适】,这种想法确实没必要,对于所有系列,还是统一学习一种库方便,而且就我目前接触过的项目,还没有什么是HAL搞不定,标准库能搞定的。

使用STM32CubeMX软件配置MCU外设

我并不打算将本系列文章写成一个关于STM32,尤其是关于STM32、Keil、CubeMX大而全的基础教程,那种每个界面都有截图,每个按钮的点击都要介绍,篇幅拉得太长了。我这里关于这些知识只能用简要地说明一下,具体到每个软件或者技术的详细使用,列为感兴趣,或者追求细节的话,还是建议去搜一些颗粒度更小,更专业的教程。
打开STM32CubeMX,新建一个STM32F103ZExx工程,我们来配置一下与LAN9252通信的外设。

与LAN9252通信,涉及到的外设包括以下几点:
  1. SPI:4线标准SPI,LAN9252支持SQI(6线高速SPI),但我们这里一切从简。标准模式下,SPI时钟频率最高支持30M。LAN9252还有高速SPI模式,时钟频率最高80M,这个自己去研究。

  2. 1ms的定时器:命名为ECAT_CheckTimer,协议栈的日常处理,包括看门狗喂狗行为,在定时器中断服务函数中进行,一般配置成1ms。

  3. 3个外部中断:包括1个EtherCAT主中断,命名为PDI_Isr;2个时钟同步IRQ,命名为Sync0_Isr,Sync1_Isr,EtherCAT主从通信中如果选择使用分布式时钟功能,这两个中断要配上。

NVIC方面,使用CubeMX配置时注意以下几点:
  1. 对于MCU来说,SPI是主站,不需要中断读写,SPI的通信时序是读的同时写,写的同时读,读写不分离,所以没必要配置中断。

  2. 3个外部中断,在CubeMX中都配置成初始enable,这样生成的代码友好一点,但到了Keil中,需要把初始化函数中最后一行Enable的语句给注释掉。什么时候Enable中断,什么时候Disable中断,都要由协议栈决定,而不是一上电就打开外部中断,那样非常容易出错,基本连不上。

  3. 定时器中断,跟外部中断一样,CubeMX中配置好enable,代码生成后注释掉最后一行Enable,由协议栈来决定打开和关闭定时器中断。

  4. 向量表的详细介绍可以参考我的另一篇博客:STM32F4+DP83848以太网通信指南系列(三):中断向量。一个可行的中断向量表为2bit抢先,2bit响应:
    a). ECAT_CheckTimer 配置为 1抢先,0响应
    b). PDI_Isr 配置为 1抢先,0响应
    c). Sync0_Isr,Sync1_Isr 均配置成 2抢先,0响应

CubeMX配置时的一些重要截图如下:
时钟:

Clock

SPI:

SPI

外部中断:

extern

NVIC:

nvic

KEIL5 工程模板:

keil5

模块化代码:

model
以上就是使用CubeMX配置的跟LAN9252通信的所有外设资源。点击右上方的【GENERATE CODE】按钮,自动生成Keil5 工程代码。下面的工作就跟CubeMX无关了,可以关掉了。

Keil5中适配SPI

CubeMX帮我们生成了Keil工程,我们的整个项目的后续开发也将以此套工程代码为蓝本继续下去。首先熟悉一下工程文件树。
tree
这是CubeMX帮我们生成的工程架构,其他都是浮云,中间的Application/User是主战场,我们自己的逻辑一般都在这个Group中,毫无疑问,main.c是主程序;gpio.c,spi.c,tim.c中有各个外设资源初始化的代码;stm32f1xx_it.c中有帮我们生成好的中断服务函数,里面有一些关键函数我们待会儿需要移动到main.c中;stm32f1xx_hal_msp.c中是外设资源与硬件资源的映射配置代码,如果有些外设,比如SPI,使用的是其他GPIO复用,将在这个文件中有所体现。此时点击Keil5中的编译按钮,应该能够顺利编译,无任何报警和错误的。

所谓的EtherCAT协议栈移植,其实就是将上面讲的各个外设资源的接口与EtherCAT协议栈的内部接口进行对接,比如SPI部分,我们需要封装一些简单的SPI操作,命名为协议栈期望的函数名,供协议栈调用;再比如3个外部中断和1个时间中断,我们需要在这4个中断服务函数中调用协议栈暴露给我们的4个不同的函数来适配协议栈。我们这个教程的本章节,将主要介绍SPI的适配,其他适配将留到后面章节介绍。

LAN9252 芯片的SSC模板

之前我们在STM32与LAN9252构建EtherCAT从站(二):使用SSC生成EtherCAT协议栈和XML文件中,使用SSC生成的EtherCAT从站代码是基于EL9800学习板的,那个学习板上的PHY芯片是ET1100这颗倍福自己的PHY芯片。我们这里使用相对廉价的LAN9252作为从站PHY芯片,LAN9252的一些寄存器设置跟ET1100是有区别的,因此我们到microchip官网下载LAN9252的SSC SDK。

下载回来以后,配合SSC5.11版本(5.12版本太新,跟LAN9252官方SDK兼容性不好),参考microchip的官方文档AN1916,生成的代码如下:
SRC
跟之前SSC生成的标准协议栈有所区别的是图片中第1,第2个文件由el9800.c,el9800.h变成了9525_HW.c,9252_HW.h;另外在LAN9252的SSC SDK中有一个SPI的工程文件,里面有SPI驱动的两个文件SPIDriver.c,SPIDriver.h,如果生成协议栈时没有add进去,这里手动复制一下;此外最后三个文件,STM32_EtherCAT_Slave开头的,是根据SSC中配置IO时的Excel文件生成的,其中STM32_EtherCAT_SlaveObjects.h是最有价值的,跟XML文件是一一对应的。
将这些文件全都copy到STM32工程的一个目录中,比如新建一个EtherCAT目录。
在KEIL的工程结构中新建2个Group,比如命名为EtherCAT,和Porting,按照图示,引入以下文件:
EtherCAT
至此,当前所看到的全部文件,均原封不动地来自于CubeMX,SSC和LAN9252 SDK,我们暂未对此进行任何修改。此时编译将引发大量错误,不过不要担心,根据Keil提示一定可以慢慢磨合掉的。
这里简单解释一下为什么此时编译,Keil会报大量错误。首先,EtherCAT协议虽然公开、免费,但倍福公司也要赚钱,于是他们自己设计生产了ET1100,ET1200等EtherCAT PHY芯片,同时还有EL9800开发板,并发布了与之配套的SSC软件与之适配。这套玩意儿价格确实很高,淘宝搜ET1100价格基本都在170左右,而且BGA封装的芯片对中小微企业也不太友好。于是MICROCHIP顺应时势,也想分一杯羹,设计制造了同样功能的LAN9252,淘宝售价在50元左右,而且有TQFP封装,中小微企业的福音,电烙铁直接能搞定。同时,为了推广自家的LAN9252,MICROCHIP还很体贴的提供了SSC SDK为大家辅助生成协议栈,但是有点不厚道的是,MICROCHIP为LAN9252提供的SDK,仅支持自家的PIC32单片机,这家伙跟STM32是竞争对手,所以不可能为他人做嫁衣,于是我们目前得到的所有代码,是基于PIC32单片机的,而不是STM32的。所以KEIL编译出来当然一大堆的错误,连MCU芯片型号都不一致。

移植,移植,移植

OK,这下思路明确了,下一步的任务就是要把基于PIC32的代码移植成STM32F1的代码,不要慌,稳住,相信自己一定可以的。
整体思路就是要充分利用KEIL的报错信息,以及Ctrl+F全局搜索,一步一步地去改源代码,我这里没法事无巨细地讲解,因为报错实在太多了,只能选几个典型的示例来做个示范。比如:

function “INTDisableInterrupts” declared implicitly

碰到的第一个错误应该是这个,定位到的代码应该是9252_HW.c的190行:

static void GetInterruptRegister(void)
{
      DISABLE_AL_EVENT_INT;
      HW_EscReadIsr((MEM_ADDR *)&EscALEvent.Word, 0x220, 2);
      ENABLE_AL_EVENT_INT;

}

DISABLE_AL_EVENT_INT这是一个宏定义,看名字应该是关闭所有中断,追踪到同文件第106行:

#define DISABLE_GLOBAL_INT          INTDisableInterrupts()
#define ENABLE_GLOBAL_INT           INTEnableInterrupts()
#define DISABLE_AL_EVENT_INT        DISABLE_GLOBAL_INT
#define ENABLE_AL_EVENT_INT         ENABLE_GLOBAL_INT

于是看到INTDisableInterrupts()INTEnableInterrupts()这两个玩意儿,果然是PIC32中启用和禁用全局中断的函数,对应STM32,应该是下面这段:

#include "stm32f1xx.h"
#define   DISABLE_GLOBAL_INT        __disable_irq()
#define   ENABLE_GLOBAL_INT            __enable_irq()
argument of type “__packed unsigned short “ is incompatible with parameter of type “const void restrict”

这个错误比较隐蔽,是__packed关键字引发的,STM32中,使用__packed关键字可以强制结构体内的数据以1字节对齐(非常不推荐,M3内核通常情况下会保证最高效率进行4字节对齐),在进行一些函数传参时,会报错,意思是无法将一个1字节对齐的结构体指针,强制转成void*,因为void*这种泛型指针,默认是4字节对齐的。
KEIL跟踪这种错误比较难跟,考虑使用Ctrl+F进行全局搜索关键词packed,找到ecat_def.h第742,754行:
packed
可以发现定义了4个宏,分别是两个结构体的前缀和后缀,然后在两个结构体后缀宏上,打上了__attribute__((aligned(1), packed))的标记,看来原作者的意图是将这两个宏对应的结构体变成1字节对齐的数据结构,然而PIC32(或者KEIL内的编译器,没有详细去了解)的字节对齐语法跟STM32的还是有一些差异的,导致字节对齐的语法在这里并不适用,感兴趣的朋友可以去详细了解一下。我们这里就简单的将这个宏后面的映射语句删掉,将其变成空的宏定义。
但是要注意,这两个宏是对应邮箱和过程数据数据结构的,后面设计InputMap和OutputMap时,也要注意,不再是1字节对齐了,而是默认的4字节对齐。

..\EtherCAT\ecatappl.c(143): warning: #1215-D: #warning directive: “Define the timer ticks per ms”

这个报警按照字面上的理解就是有个宏没有定义,我们搜一下这个名为ECAT_TIMER_INC_P_MS的宏。
9252HW.h第146行确实定义了这个宏,但是KEIL帮我自动感应置灰了,因为这个宏定义在一个#ifdef PIC32_HW预编译语法内部,显然我们这里的库函数框架并没有谁会去定义一个PIC32_HW来,因此我们需要将这里面由#ifdef PIC32_HW包围的一大段宏定义,全部复制一份副本,然后用类似#ifdef STM32F1的预编译语法包围起来:
F1
需要说明的是,考虑到本项目定时器配置的具体情况,这里将ECAT_TIMER_INC_P_MS的定义改为与之前配置的1ms定时器完全匹配的数值,即1000,配图中的2000需要修订

其他错误和警告

其他还有若干错误和警告,不胜枚举,这里就不一一赘述了,像什么UINT8,UINT16类型没找到,协议栈需要的数据类型都在ecat_def.h里;参数为空的函数需要加void等小问题,相信聪明的你一定能自己修复。

SPI适配

这里着重讲一下SPI方面的报错处理,把这些报错处理掉,其实就相当于SPI的移植了。主要是SPIDriver.hSPIDriver.c两个文件的去警告和移植。

SPIDriver.h

SPIDriver.h中是相关函数的定义,我们看到:
SPI.H
其中,SPIOpen(),SPIPut()两个函数对于STM32来说无意义,直接删掉,SPIRead(),SPIReadBurstMode()函数参数为空,需要加上void,否则有一个warning。其他就没什么变动了。

SPIDriver.c
  • 打开SPIDriver.c,第一个函数居然是Delay(),这个函数是用PIC32编译器语法写的,显然没用,而且这个函数整个代码都没用到过,有点搞笑,果断删掉。
  • 继而删掉SPIPutSPIOpen两个函数。
  • SPIWriteSPIRead用STM32的常规语法代替:
void SPIWrite(UINT8 data) {
    HAL_SPI_Transmit(&hspi1, &data, 1, 2000);
}

UINT8 SPIRead() {
    UINT8 data;   
    HAL_SPI_Receive(&hspi1, &data, 1, 2000);
    return (data);
}

以上代码用过STM32 SPI通信和HAL库的朋友应该毫无压力。

  • CSLOW()CSHIGH()两个宏的修复:这两个宏是SPI的NSS使能引脚控制,一般我们做SPI通信都会设置成软件使能,这里也不例外,软件使能能够更灵活地控制读写位数。将这两个宏修复如下:
#define DESELECT_SPI    HAL_GPIO_WritePin(SPI1_NSS_GPIO_Port,SPI1_NSS_Pin,GPIO_PIN_SET)
#define SELECT_SPI        HAL_GPIO_WritePin(SPI1_NSS_GPIO_Port,SPI1_NSS_Pin,GPIO_PIN_RESET) 

#define CSHIGH()        DESELECT_SPI
#define CSLOW()            SELECT_SPI

其中SPI1_NSS_GPIO_PortSPI1_NSS_Pin的定义在CubeMX中已经设计好了,存于main.h文件中。

总结

本文讲解了通过CubeMX软件生成STM32工程,同时重新使用LAN9252的SDK,配合SSC软件生成了新的协议栈。将协议栈的相关代码混入工程文件,并尝试一步一步修复代码中的错误和警告。最后单独讲解了SPI部分的代码修复,这部分代码不算复杂,用好Keil的Go to Definition和Ctrl+F全局搜索,一步一步跟踪调试总归能搞定的,调试过程中做到胆大心细,及时保存和备份副本,感觉可以删掉的就大胆删,大不了回档重来。
下一章,我们将全面适配LAN9252,观察EtherCAT协议栈暴露给上层应用的接口,并在我们配置的各个中断中调用它们。

STM32与LAN9252构建EtherCAT从站(三):LAN9252的XML文件

  1. 一、 STM32与LAN9252构建EtherCAT从站(一):项目简介
  2. 二、 STM32与LAN9252构建EtherCAT从站(二):使用SSC生成EtherCAT协议栈和XML文件
  3. 三、 STM32与LAN9252构建EtherCAT从站(三):LAN9252的XML文件
  4. 四、 STM32与LAN9252构建EtherCAT从站(四):STM32配置SPI
  5. 五、 STM32与LAN9252构建EtherCAT从站(五):STM32与LAN9252适配
  6. 六、 STM32与LAN9252构建EtherCAT从站(六):TwinCAT2的使用和从站测试

STM32与LAN9252构建EtherCAT从站(三):LAN9252的XML文件

EtherCAT从站XML文件简介

每一个EtherCAT从站设备都需要有一个硬件描述的XML文件,用来给TwinCAT组态,XML文件中描述定义了通信时需要用到的各种数据。包括设备所属公司名,设备名,设备版本,LOGO等基础信息,亦包括通信时的点位,点位名称,大小,数量等信息,还包括一个非常特别的14ByteConfigData,这14个字节用来给PHY识别,像ET1100,LAN9252等芯片通过其来识别自身的工作方式,比如第一章STM32与LAN9252构建EtherCAT从站(一):项目简介中我们提到的LAN9252工作的四种方式就是通过这组数据进行确定的。

TwinCAT对设备进行组态时,首先通过其硬件网卡搜索网络上所有的EtherCAT设备,发现设备后可以将XML文件烧录至LAN9252连接的EEPROM中,此后设备上电时,PHY就能根据EEPROM中的数据对自身进行相应的配置。关于TwinCAT的使用,我们在第六章STM32与LAN9252构建EtherCAT从站(六):TwinCAT2的使用和从站测试详细介绍。

XML文件比较大,用普通的文本编辑器打开会显得有些凌乱,上下文结构也不能很好的体现。因此需要一些专门处理XML的工具来辅助编辑,推荐的有XMLSPY和XML Notepad,前者是收费的,破解版也很难找,后者是微软2007年出的,免费试用,但是年代有些久远,功能也不及前者多。

XML中的设备基础信息


如图使用XMLNotepad打开上一章STM32与LAN9252构建EtherCAT从站(二):使用SSC生成EtherCAT协议栈和XML文件生成的XML文件,可以粗略地观察到整个文档由两个节点组成,VendorDescriptions

Vendor下面的idname来自于EtherCAT会员企业信息,我这里不方便用我们公司的真实信息,暂且用#x1EtherCAT来替代。

Vendor下面的ImageData16x14节点,存储的是.bmp格式的16色深度的logo文件,可以使用微软画图或者Photoshop等软件制作,制作完成后使用任何16进制查看器(Notepad++和Sublime都有相关插件直接查看任何文件的16进制数据)将数据填入该节点。

Descriptions->Groups->Group节点下方的TypeName两个节点描述的设备类型的种类和名称,这里根据自己的想法自定义即可。ImageData16x14是设备类型图标,可以直接用上面的数据。

Descriptions->Devices->Device->Physics是以太网口类型,YY表示两个RJ45,一进一出,跟Y相对应的是K,表示EBUS网口,德国倍福的专用端口,不需要修改。

Descriptions->Devices->Device->Type节点下的ProductCodeRevisonNo表示的是硬件编号和版本号,这里取一些有意义的名称,产品迭代升级时不要忘记这里的版本号也应该做相应的升级。TwinCAT通过这两个字段确定XML的唯一性,也就是说你如果两份XML这两个字段一样,放到TwinCAT/IO/EtherCAT文件夹下,只能识别其中一个。

Descriptions->Devices->Device->Name设备名,任意取。

Descriptions->Devices->Device->Info节点存储了一些超时限制的数据,没有特殊情况不需要修改,这里设置好了以后在TwinCAT界面可以看到设备在各种状态切换时的超时限制。

Descriptions->Devices->Device->GroupType与上面Descriptions->Groups->Group->Type相对应。

至此,有关设备基础信息的部分就结束了。

XML中的字典和IO数据

这部分数据超级复杂,包括字典定义和IO点位描述,但这部分数据已经由SSC创建完成了,SSC通过我们填写的Excel自动生成的,如果没有SSC,这里的数据全都由我们自己填写,将是一件非常恐怖的事情,不仅编写起来工作量非常巨大,而且极易出错。我们这里仅做简单地浏览认识一下。

首先理解一下字典,所谓字典就是对数据结构的描述,XML里面每种数据集合都需要有它的类型定义,有些类型是简单的String,UINT等基本类型,有些类型是由多种基本类型组合而成的复合结构,在字典定义部分都需要对其进行定义。打开Descriptions->Devices->Device->Profile节点,里面有两个子节点DataTypeObjects,有点类似C语言中的typedef定义类型和int x定义变量,事实上在SSC生成的协议栈中的SSC-DeviceObjects.h文件也确实与这里的定义一一对应的,感兴趣的朋友可以提前去浏览一下,我们将会在STM32与LAN9252构建EtherCAT从站(五):STM32与LAN9252适配做详细介绍。

举个例子,如图所示,在Objects节点下有一个Object名叫Device name, 其index为#x1008,type为STRING(10),这个STRING(10)就要从上面的DataTypes节点里面找对应的子项了,果然我们会发现一个DataType子节点名叫STRING(10),它的BitSize定义的是80个bit,应该是个uchar[10]的数组,那么这个字符串内容是什么呢,还记得我们之前在硬件基础信息部分定义的Device Name吗,我们去看看,上面定义的是SSC-Device,数一数正好10个字节。

所以在XML中每一个元素都会有自己的数据结构,每一种数据结构都会在数据字典中定义,如果这之间的关系理得不顺,EtherCAT将无法建立连接,想要手工把这里面的关系搞定真的非常困难,SSC在之前帮我们全都搞定了。

IO点位数据就更加复杂了,在Descriptions->Devices->Device节点下有四个Sm节点,这个表示通道,我们通信时一共有四个通道,除了过程传输数据输出和输入以外,还有两个通道用来控制EtherCAT自身状态的,也是EtherCAT协议中非常重要的MailBox概念,分别叫做MBoxOutMBoxIn,这里不需要管它,只需要了解过程传输数据InputsOutputs两个通道,这两个通道内部的数据又分别指向RxPdoTxPdo两个节点,这两个节点每个Entry节点都是我们之前在Excel中定义的一个IO点。SSC通过Excel帮我们完成了一项庞大的工作,在XML中生成了64+64个Entry,如果手工录入,这工作量将会非常恐怖。

综上,XML中数据字典和IO点位我们就粗略的理解到这里了。这其中的还有很多深奥的地方,比如SM通道的size需要16位对齐,Entry节点的bitlen和subindex属性等等,如果您有兴趣理解透彻,可以去看一下CanOpen协议中关于字典和对象的描述,EtherCAT协议这部分内容完全脱胎于CanOPEN协议。

XML中的EEPROM内容


现在我们来到XML最后一部分内容,EEPROM节点,这个节点数据量非常少,只有两个子节点,ByteSize一般为2048,代表板载的EEPROM芯片容量是2KByte,其实我们一般使用512K的物理容量芯片,防止IO数据定义时数据量增加不够存储。这里插一句题外话,与LAN9252相连的EEPROM芯片尽量使用ATMEL家的24FC512,否则EtherCAT可能会有连接困难的现象。

XML中大部分内容都由SSC帮我们生成,现在到了比较重要的最后14byte数据,也就是ConfigData节点,SSC帮我们构建的XML是按照ET1100芯片生成的,默认为050E03440A0000000000,这里使用的是LAN9252,打开LAN9252芯片手册AN1907-Microchip LAN9252 Migration from Beckhoff ET1100,看到2.3节,手册上让我们改成800E00CC8813F0000000800000,我们先跟着做,手册下面一行提示我们如果想进一步了解含义,需要阅读LAN9252 EEPROM章节。

打开LAN9252 datasheet,在12.8 EEPROM Configurable Registers章节,有如下介绍:

可以看到这14个byte其实是由这张表组成的,上面的截图只是表格的前半部分,下面一页有后半部分,不过最重要的就是这前面第一个字节。看到第一个字节定义了芯片的0140h寄存器,这个寄存器叫做Process Data Interface,点击进入改寄存器的详细描述,如下图所示:

在12.14.24章节,有0140h寄存器的详细描述,可以看到这个寄存器配置为80h即为SPI通信方式,这与我们项目架构相匹配。回忆一下之前手册上让我们将ConfigData节点修改为800E00CC8813F0000000800000这第1个80其实就是指的SPI方式,至于后面这些数据代表什么含义,都可以在LAN9252 datasheet中查找到,如果暂时不理解就不要修改,保持默认就可以了。

至此整个XML文档我们就浏览剖析结束了,这份XML后面会放到TwinCAT安装路径下的/Io/EtherCAT文件夹,然后在TwinCAT中给寻找到的EtherCAT设备烧录,LAN9252将其中关键数据存储到与自己相连的EEPROM中,供自己以后上电时给自己配置各项参数。

花开两朵,各表一枝,XML文件我们暂且放在一边,下面一章,我们将给STM32F103配置一下SPI功能,并与之前SSC生成的协议栈做一下SPI部分的融合。

丁丁生于 1987.07.01 ,30岁,英文ID:newflydd
  • 现居住地 江苏 ● 泰州 ● 姜堰
  • 创建了 Jblog 开源博客系统
  • 坚持十余年的 独立博客 作者
  • 大学本科毕业后就职于 中国电信江苏泰州分公司,前两年从事Oracle数据库DBA工作,两年后公司精简技术人员,被安排到农村担任支局长(其本质是搞销售),于2016年因志向不合从国企辞职,在小城镇找了一份程序员的工作。
  • 在 Git OSChina 上积极参与开源社区
  •