英创信息技术SJA1000的CAN通讯接口函数介绍

英创信息技术 2020-01-14 2603

描述

英创ARM9系列嵌入式主板一大特色就是提供了CAN接口，并实现了相应的驱动程序，用户只需直接调用CAN_API函数即可实现CAN数据报文的通讯操作。目前EM9000以及EM9X60系列板卡所提供的CAN接口均是采用的是SJA1000 CAN总线控制器，SJA1000是一款独立的控制器，主要用于汽车和一般工业环境中的控制器局域网络（CAN）芯片。CAN通讯接口可提供高达1Mbps的数据传输速率，当采用5Kbps的的数据传输速率时其通讯距离最高可达到10KM。硬件的错误检定特性也增强了CAN的抗电磁干扰能力，这给数据的远程可靠传输提供了有利保证。

硬件上来说，英创提供的CAN通讯接口根据用户的需要分为两种：一种带光电隔离，一种不带光电隔离。带光电隔离CAN总线通讯模块的CAN收发器端的所有信号和电源与其它部分完全隔离，可承受至少1Kv(有效值)的电压冲击。

软件上英创出厂的带有CAN通讯接口的ARM9板卡均带有相应的驱动，基于WinCE系统配置了标准的WinCE流式驱动程序，基于Linux系统是将CAN接口配置为字符设备驱动程序。CAN通讯的数据收发均采用的中断方式，驱动程序中已自动完成了数据的收发，以及内部定义的CAN接收缓冲区和发送缓冲区的管理。

	接收缓冲区	发送缓冲区
WinCE	64k	4k
Linux	64k	4k

为了方便用户的使用，在CAN驱动程序的基础上为客户封装了一套简单实用的API函数。各个函数的定义在can_api.h文件下，在该头文件中对于各个API函数均有相应的中文说明。本文将详细介绍各个接口函数的使用。

1、CAN接口API函数定义
英创公司提供的CAN通讯接口的驱动程序采用标准的驱动程序，用户可以用标准的打开文件、关闭文件的方式，来打开该CAN设备。相关的一些函数定义如下：

/*
* 功能描述：设置CAN控制芯片为操作模式。
* 输入参数：
* fd: CAN设备文件描述符
* 返回值：
* 0: 成功
* <0: 失败
*/
int CAN_StartChip( int fd );

/*
* 功能描述：设置CAN控制芯片为复位模式。
* 输入参数：
* fd: CAN设备文件描述符
* 返回值：
* 0: 成功
* <0: 失败
*/
int CAN_StopChip( int fd );

/*
* 功能描述：设置CAN通讯的波特率
* 输入参数：
* fd: CAN设备文件描述符
* Baud：枚举变量，分别对应不同的波特率
* CAN_BAUDRATE_10K = 0: 10Kbps
* CAN_BAUDRATE_20K = 1: 20Kbps
* CAN_BAUDRATE_50K = 2: 50Kbps
* CAN_BAUDRATE_100K = 3: 100Kbps
* CAN_BAUDRATE_125K = 4: 125Kbps
* CAN_BAUDRATE_250K = 5: 250Kbps
* CAN_BAUDRATE_500K = 6: 500Kbps
* CAN_BAUDRATE_1000K = 7: 1Mbps
* CAN_BAUDRATE_60K = 8: 60Kbps
* 返回值：
* 0: 成功
* <0: 失败
*/
int CAN_SetBaudRate( int fd , CAN_BAUDRATE Baud );

/*
* 功能描述：设置CAN通讯验收滤波器配置
* 输入参数：
* fd: CAN设备文件描述符
* *AcceptanceFilter: 验收滤波器结构指针
* struct accept_filter
* {
* unsigned int accept_code;
* unsigned int accept_mask;
* unsigned char filter_mode;
* };
* accept_code: 滤波器接收码
* accept_mask: 滤波器屏蔽码
* filter_mode: 0-双滤波器 1-单滤波器
*
* 返回值：
* 0: 成功
* <0: 失败
*/
int CAN_SetGlobalAcceptanceFilter( int fd , accept_filter *AcceptanceFilter );

/*
* 功能描述：用于启动或关闭CAN自检测模式
* 输入参数：
* fd: CAN设备文件描述符
* Mode： 1-启动自检测模式
* 0-关闭自检测模式，返回正常模式
* 返回值：
* 0: 成功
* <0: 失败
*/
int CAN_SelfTest( int fd , int Mode );

/*
* 功能描述：获取CAN通讯时的错误编码
* 输入参数：
* fd: CAN设备文件描述符
* 输出参数：
* *ErrorPtr：错误编码
* 返回值：
* 0: 成功
* <0: 失败
*/
int CAN_GetError( int fd , DWORD *ErrorPtr);

/*
* 功能描述：获取CAN通讯中相关统计数据以及CAN控制芯片的状态寄存器值
* 输入参数：
* fd: CAN设备文件描述符
* 输出参数：
* *DriverStatistics：得到相应统计结构数据
* 返回值：
* 0: 成功
* <0: 失败
*/
int CAN_GetCANDriverStatistics( int fd , drv_statistics *DriverStatistics );

在can_api.h中还定义了一个CAN驱动的统计数据结构struct DRIVERSTATISTICS，这个结构中记录了CAN通讯的一些统计参数，包括CAN中断次数，CAN数据帧发送成功统计次数等等。这些参数可通过API函数中CAN_GetCANDriverStatistics来获取，这些参数可以作为分析CAN通讯的状态的一个重要参考。以下为这些参数的定义。

typedef struct
{
        DWORD NumISTEvents; // CAN中断事件统计次数
        DWORD NumRxDataFrameInt; // CAN数据帧接收中断统计次数
        DWORD NumRxDataFramePutRing; // CAN接收数据帧放入接收环形数据
        // BUF的统计次数
        DWORD NumTxDataFramePutRing; // CAN发送数据帧放入发送环形数据
        // BUF的统计次数
        DWORD NumTxDataFrameInt; // CAN数据帧发送中断统计次数
        DWORD NumTxSuccessful; // CAN数据帧发送成功统计次数
        DWORD NumTxFailed; // CAN数据帧发送失败统计次数
        DWORD NumErrorWarningInt; // CAN通讯错误报警中断的统计次数
        DWORD NumErrorWarningLevel; // CAN通讯出错的统计次数，错误指至
        // 少一个错误计数器满或由错误报警限
        // 制寄存器（EWLR）定义的CPU报警
        // 限制
        DWORD NumErrorPassive; // CAN通讯中错误消极中断的统计次数
        DWORD NumErrorBusOff; // CAN通讯错误中总线关闭错误的统计次数
        DWORD NumSwitchedToNormalOperation; // CAN通讯中错误状态切换到正常
        // 状态（总线开启）的统计次数
        DWORD NumOverrunInt; // CAN通讯中数据溢出中断的统计次数
        DWORD NumBusErrorInt; // CAN通讯中数据BUSOFF错误中断的统计次数
        DWORD NumArbitrationLostInt; // CAN通讯中仲裁丢失中断的统计次数
        DWORD MaxNumMsgsInRing; // CAN通讯中接收数据帧的数目
        DWORD RXErrorCounter; // 读取CAN通讯芯片中RX错误计数器的值
        DWORD TXErrorCounter; // 读取CAN通讯芯片中TX错误计数器的值
        DWORD Status; // 读取CAN通讯芯片中状态寄存器的值
}DRIVERSTATISTICS;

2、CAN数据的接收和发送
在WinCE下，作为流式接口函数通常和文件系统的API函数（如CreateFile）紧密匹配的，因此在使用英创提供的CAN接口的API函数时，首先需要调用CreateFile(…)来获取CAN接口设备的句柄handle，如使用CAN1通讯口，可以调用以下函数：
m_hCAN=CreateFile(_T(“CAN1:”), GENERIC_READ|GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, NULL);

在Linux下，调用的方式如下：

m_fd=open('/dev/em9x60_can1',O_RDWR | O_NOBLOCK );

在创建CAN设备得到有效的handle之后，就可以调用can_api.h中定义的相应函数来启动CAN设备接口。

BOOL CAN_StartChip (HANDLE hDevice);

在进行CAN数据通讯之前，需要设置和CAN通讯相关的一些参数，包括CAN通讯的波特率设置以及对接收过滤器的设置。

BOOL CAN_SetBaudRate(HANDLE hDevice, BYTE *index);

用于设置CAN通讯的波特率，波特率的设置范围包括：10kbps~1Mbps。具体的定义请参见can_api.h文件中的注释说明。

通过配置接收过滤器，CAN通讯接口可以实现只接收标识符也接收过滤器预设值相一致的报文。接收过滤器由接收码寄存器ACRn和接收屏蔽码寄存器AMRn来定义的，还可以选择两种不同的过滤器模式，单过滤器模式或者双过滤器模式。关于ACR、AMR中各位的定义，请参见SJA1000的数据手册，这里就不再赘述。在英创提供的API函数中，用户可以调用以下函数来实现接收过滤器的设置：
BOOL CAN_SetGlobalAcceptanceFilter( HANDLE hDevice, BYTE *AcceptanceFilter, BYTE size)

对于CAN通讯数据接收线程可以采用两种方式：一种可以采用定时查询，即定时调用函数CAN_GetNextReceivedFrame( …)检测是否有接收到CAN报文数据；一种可以利用操作系统的消息机制，采用事件响应的方式，一旦硬件接收的数据报文，底层的驱动接收程序会自动读取报文，同时发送一个接收事件。作为应用程序的接收线程在等待到该事件后，调用CAN_GetNextReceivedFrame（…）即可进行CAN数据报文的读取。需要注意的是函数CAN_GetNextReceivedFrame每执行一次，只是读取了一帧CAN数据报文，如果在应用程序中需要将最新的数据全部读出，只需反复调用该函数，直到该函数的返回值为FALSE。

接收线程部分代码：

DWORD CEM9000_CAN::ReadThreadFunc( LPVOID lparam )
{
        CEM9000_CAN *ceCAN = (CEM9000_CAN*)lparam;
        BOOL bResult;
        while( 1 )
        {
                if(WaitForSingleObject(ceCAN->m_hReadCloseEvent,0 )==WAIT_OBJECT_0 )
                {
                        break;
                }
                // 等待接收事件触发，使用以下代码
                WaitForSingleObject( ceCAN->m_hRxEvent, INFINITE );
                // 若采用定时查询，则调用Sleep(..)即可，Sleep的时间由应用程序确定
                // Sleep( 50 );

                ceCAN->m_nRxCounter = 0；
                for( ; ; )
                {
                        // 读取已接收的所有数据帧
                        bResult=CAN_GetNextReceivedFrame(ceCAN->m_hCAN, &ceCAN->RxMFrame[ceCAN->m_nRxCounter] );
                        if( !bResult )
                        {
                                break;
                        }
                        ceCAN->m_nRxCounter++;
                }
                if(ceCAN->m_nRxCounter>0 )
                {
                        // 调用回调函数，进行必要的数据处理
                        ceCAN->OnRead( ceCAN->m_pCANOwner );
                }
        }
        return 0;
}

CAN数据报文的发送比较简单，应用程序直接调用函数CAN_SendFrame（…）即可，该函数的功能只是将需要发送的数据填入驱动的发送数据缓冲区，真正的数据发送是由驱动程序中的发送线程自动完成的。若用户需要查看数据是否发送成功，可以通过检查驱动的相关统计数据DriversStatistics来判断，其中NumTxSuccessful为CAN数据帧成功发送统计数，每成功发送一次CAN数据帧，该计数值自动加1。

3、CAN通讯的出错处理
在can_api.h文件对于CAN通讯所返回的错误代码分别定义如下：

错误代码	定义
CANCONTROLLER_NORMAL	表明CAN通讯工作正常
CANCONTROLLER_WARNING_LIMIT_REACHED	表明出错，至少接收或发送错误计数器中的一个已达到或超过了由错误报警寄存器（EWLR）定义的报警限，缺省为96
CANCONTROLLER_ERROR_PASSIVE	表明SJA1000达到错误消极状态，也就是说至少一个错误计数器超过规定值127
CANCONTROLLER_BUS_OFF	表明该接口脱离总线
CANCONTROLLER_OVERRUN	数据溢出错误
RING_BUFFER_FULL	表明接收或发送缓冲区满

错误代码可通过API函数CAN_GetError(HANDLE hDevice, DWORD *ErrorPtr)来获取。一般来说出现前面两个错误：CANCONTROLLER_WARNING_LIMIT_REACHED和CANCONTROLLER_ERROR_PASSIVE，CAN通讯口还可恢复，一旦CAN接口成功接收或发送一帧数据，CAN接口又可回到正常工作状态。而对于出现其余的三项错误，我们建议在应用程序最好是做复位CAN接口的操作，即通过函数调用先关闭CAN口然后再重新初始化该接口。

在英创公司提供的应用光盘中有具体CAN接口的测试代码，可供客户参考测试。

打开APP阅读更多精彩内容