XModem协议介绍

大家好，欢迎来到IT知识分享网。

XModem协议介绍： XModem是一种在串口通信中广泛使用的异步文件传输协议，分为XModem和1k-XModem协议两种，前者使用128字节的数据块，后者使用1024字节即1k字节的数据块。

一、XModem校验和协议

1. XModem信息包格式

XModem协议最早由Ward Christensen在20世纪70年代提出并实现的，传输数据单位为信息包，信息包格式如下：

--------------------------------------------------------------------------- | Byte1 | Byte2 | Byte3 |Byte4~Byte131| Byte132 | |-------------------------------------------------------------------------| |Start Of Header|Packet Number|~(Packet Number)| Packet Data | Check Sum | --------------------------------------------------------------------------- 

2. 校验和的计算

所有的数据字节都将参与和运算，由于校验和只占一个字节，如果累加的和超过255将从零开始继续累加。

------------------------------------------------------------------------------ | SENDER | | RECIEVER | | | <--- | NAK | | | | Time out after 3 second | | | <--- | NAK | | SOH|0x01|0xFE|Data[0~127]|CheckSum| | ---> | | | | <--- | ACK | | SOH|0x02|0xFD|Data[0~127]|CheckSum| | ---> | | | | <--- | NAK | | SOH|0x02|0xFD|Data[0~127]|CheckSum| | ---> | | | | <--- | ACK | | SOH|0x03|0xFC|Data[0~127]|CheckSum| | ---> | | | | <--- | ACK | | . | | . | | . | | . | | . | | . | | | <--- | ACK | | EOT | ---> | | | | <--- | ACK | ------------------------------------------------------------------------------

------------------------------------------------------------------------------ | Byte1 | Byte2 | Byte3 |Byte4~Byte131|Byte132~Byte133| |----------------------------------------------------------------------------| |Start Of Header|Packet Number|~(Packet Number)| Packet Data | 16Bit CRC | ------------------------------------------------------------------------------ 

2. CRC16的计算

int calcrc(char *ptr, int count) { int crc; char i; crc = 0; while (--count >= 0) { crc = crc ^ (int) *ptr++ << 8; i = 8; do { if (crc & 0x8000) crc = crc << 1 ^ 0x1021; else crc = crc << 1; } while (--i); } return (crc); }

需要注意的是，在发送方，CRC是高字节在前，低字节在后。

3. CRC16校验的XModem传输流程

传输流程如图所示：

--------------------------------------------------------------------------- | SENDER | | RECIEVER | | | <--- | 'C' | | | | Time out after 3 second | | | <--- | 'C' | | SOH|0x01|0xFE|Data[0~127]|CRC16| | ---> | | | | <--- | ACK | | SOH|0x02|0xFD|Data[0~127]|CRC16| | ---> | | | | <--- | NAK | | SOH|0x02|0xFD|Data[0~127]|CRC16| | ---> | | | | <--- | ACK | | SOH|0x03|0xFC|Data[0~127]|CRC16| | ---> | | | | <--- | ACK | | . | | . | | . | | . | | . | | . | | | <--- | ACK | | EOT | ---> | | | | <--- | ACK | --------------------------------------------------------------------------- 

和校验和方式不同的是，当接收方要求发送方以CRC16校验方式发送数据时以’C’来请求，发送方对此做出应答，流程就如上图所示。当发送方仅仅支持校验和方式时，则接收方要发送NAK来请求，要求以校验和方式来发送数据，如果仅仅支持CRC16校验方式，则只能发送’C’来请求。如果两者都支持的话，优先发送’C’来请求，流程如图所示：

------------------------------------------------------------------------------ | SENDER | | RECIEVER | | | <--- | 'C' | | | | Time out after 3 second | | | <--- | NAK | | | | Time out after 3 second | | | <--- | 'C' | | | | Time out after 3 second | | | <--- | NAK | | SOH|0x01|0xFE|Data[0~127]|CheckSum| | ---> | | | | <--- | ACK | | SOH|0x02|0xFD|Data[0~127]|CheckSum| | ---> | | | | <--- | NAK | | SOH|0x02|0xFD|Data[0~127]|CheckSum| | ---> | | | | <--- | ACK | | SOH|0x03|0xFC|Data[0~127]|CheckSum| | ---> | | | | <--- | ACK | | . | | . | | . | | . | | . | | . | | | <--- | ACK | | EOT | ---> | | | | <--- | ACK | ------------------------------------------------------------------------------ 

YMODEM协议是一个文件传输协议，由Chuck Forsberg于上世纪90年代开发完成，通常用于资源受限的设备。

ST官方在STM32CubeHAL库中提供了一个IAP例程，其使用的便是YMODEM协议。这个协议有比较多的变种（YMODEM作者在其协议手册中提及），以至于大家的实现不太一样，本文以STM32CubeHAL库中IAP例程的实现为标准。

下面先对YMODEM协议进行介绍，然后进行代码实现和例程试验。

1. YMODEM协议简介

YMODEM协议的传输过程如下图所示（摘自YMODEM协议手册）：

• 其中“sb foo.*<CR>”指的是Linux中的sb命令，可在Linux终端执行 sb –help查看使用方法
• 上图中YMODEM协议传输的数据块是128字节，其实YMODEM协议还支持1024字节的数据块，或者128字节和1024字节混合模式。详情请查阅YMODEM协议手册。
• SOH 表示本数据块大小为128字节
• STX 表示本数据块大小为1024字节
• 本文中EOT指令仅有一次会话，即上图中的最后一次

2. 起始帧的数据格式

YMODEM的起始帧的数据块大小为128字节，传输的是文件名、文件大小、文件修改日期等信息，其中文件名和文件大小信息是必须的。128字节的剩余部分用空字符填充（也就是0）。

SOH 00 FF foo.c 3232 NUL[118] CRCH CRCL

• SOH：表示本帧数据块大小为128字节
• 00： 表示数据帧序号，初始是0，依次向下递增，FF是帧序号的取反
• foo.c：是要传输的文件名，是ASCII字符串（以空字符结尾）
• 3232：表示文件的大小，是ASCII字符串（以空字符结尾）
• NUL[118]：剩余部分用空字符填充
• CRCH/L： 表示16位CRC校验码的高8位与低8位

3. 数据帧的数据格式

YModem的数据帧的数据块大小可以是128字节或者1024字节。

// 128字节的数据块 SOH 01 FE data[128] CRCH CRCL // 1024字节的数据块 STX 01 FE data[1024] CRCH CRCL

一般会使用1024字节的数据块进行传输，这样可以加快传输速度，如果最后文件数据不足1024字节，则将其拆分为128字节的数据块进行传输，如果拆分后有不足128字节的数据依然按照128字节的数据块进行传输，但是剩余空间全部用0x1A填充，以表示文件结束。

4. 结束帧数据结构

当文件传输结束时，除了发送EOT传输结束指令外，还需要发送一个结束帧。YModem的结束帧与起始帧的数据格式相同，数据块大小为128字节，但是结束帧的数据块要全用空字符填充。

SOH 3A C5 NUL[128] CRCH CRCL