Xmodem源代碼

原創 fandelxin 2020-02-23 07:21


1、研究Xmodem協議必看的11個問題

Xmodem協議作爲串口數據傳輸主要的方式之一，恐怕只有做過bootloader的纔有機會 接觸一下，網上有關該協議的內容要麼是英語要麼講解不詳細。筆者以前寫bootloader時研究過1k-Xmodem，參考了不少相關資料。這裏和大家交流一下我對Xmodem的理解，多多指教！


1．Xmodem協議是什麼？
　　XMODEM協議是一種串口通信中廣泛用到的異步文件傳輸協議。分爲標準Xmodem和1k-Xmodem兩種，前者以128字節塊的形式傳輸數據，後者字節塊爲1k即1024字節，並且每個塊都使用一個校驗和過程來進行錯誤檢測。在校驗過程中如果接收方關於一個塊的校驗和與它在發送方的校驗和相同時，接收方就向發送方發送一個確認字節(ACK)。由於Xmodem需要對每個塊都進行認可，這將導致性能有所下降，特別是延時比較長的場合，這種協議顯得效率更低。
    除了Xmodem，還有Ymodem，Zmodem協議。他們的協議內容和Xmodem類似，不同的是Ymodem允許批處理文件傳輸，效率更高；Zmodem則是改進的了Xmodem，它只需要對損壞的塊進行重發，其它正確的塊不需要發送確認字節。減少了通信量。
2．Xmodem協議相關控制字符
    SOH             0x01
    STX           0x02
    EOT             0x04
    ACK             0x06
    NAK             0x15
    CAN             0x18
    CTRLZ         0x1A
3．標準Xmodem協議（每個數據包含有128字節數據）幀格式
  _______________________________________________________________
|     |            |                   |          |            |
| SOH | 信息包序號   |  信息包序號的補碼    | 數據區段  |  校驗和      |
|_____|____________|___________________|__________|____________|
4．1k-Xmodem（每個數據包含有1024字節數據）幀格式
  _______________________________________________________________
|     |            |                   |          |            |
| STX | 信息包序號   |  信息包序號的補碼    | 數據區段  |  校驗和      |
|_____|____________|___________________|__________|____________|
5．數據包說明
    對於標準Xmodem協議來說，如果傳送的文件不是128的整數倍，那麼最後一個數據包的有效內容肯定小於幀長，不足的部分需要用CTRL-Z(0x1A)來填充。這裏可能有人會問，如果我傳送的是bootloader工程生成的.bin文件，mcu收到後遇到0x1A字符會怎麼處理？其實如果傳送的是文本文件，那麼接收方對於接收的內容是很容易識別的，因爲CTRL-Z不是前128個ascii碼，不是通用可見字符，如果是二進制文件，mcu其實也不會把它當作代碼來執行。哪怕是excel文件等，由於其內部會有些結構表示各個字段長度等，所以不會讀取多餘的填充字符。否則Xmodem太弱了。對於1k-Xmodem，同上理。
6．如何啓動傳輸？
    傳輸由接收方啓動，方法是向發送方發送"C"或者NAK(注意哦，這裏提到的NAK是用來啓動傳輸的。以下我們會看到NAK還可以用來對數據產生重傳的機制)。接收方發送NAK信號表示接收方打算用累加和校驗；發送字符"C"則表示接收方想打算使用CRC校驗（具體校驗規則下文Xmodem源碼，源碼勝於雄辯)。
7．傳輸過程
    當接收方發送的第一個"C"或者NAK到達發送方，發送方認爲可以發送第一個數據包，傳輸已經啓動。發送方接着應該將數據以每次128字節的數據加上包頭，包號，包號補碼，末尾加上校驗和，打包成幀格式傳送。
發送方發了第一包後就等待接收方的確認字節ACK，收到接收方傳來的ACK確認，就認爲數據包被接收方正確接收，並且接收方要求發送方繼續發送下一個包；如果發送方收到接收方傳來的NAK(這裏，NAK用來告訴發送方重傳，不是用來啓動傳輸)字節，則表示接收方請求重發剛纔的數據包；如果發送方收到接收方傳來的CAN字節，則表示接收方請求無條件停止傳輸。
8．如何結束傳輸？
    如果發送方正常傳輸完全部數據，需要結束傳輸，正常結束需要發送方發送EOT 字節通知接收方。接收方回以ACK進行確認。當然接收方也可強制停止傳輸，當接收方發送CAN 字節給發送方，表示接收方想無條件停止傳輸，發送方收到CAN後，不需要再發送 EOT確認（因爲接收方已經不想理它了，呵呵）。
9．特殊處理
    雖然數據包是以 SOH 來標誌一個信息包的起始的，但在 SOH 位置上如果出現EOT則表示數據傳輸結束，再也沒有數據傳過來。
接收方首先應確認數據包序號的完整性，通過對數據包序號取補，然後和數據包序號的補碼異或，結果爲0表示正確，結果不爲0則發送NAK請求重傳。
    接收方確認數據包序號正確後，然後檢查是否期望的序號。如果不是期望得到的數據包序號，說明發生嚴重錯誤，應該發送一個 CAN 來中止傳輸。
    如果接收到的數據包的包序號和前一包相同，那麼接收方會忽略這個重複包，向發送方發出 ACK ，準備接收下一個包。
    接收方確認了信息包序號的完整性和是正確期望的後，只對 128 字節的數據區段進行算術和校驗，結果與幀中最後一個字節（算術校驗和）比較，相同發送 ACK，不同發送 NAK。
10．校驗和的說明
    Xmodem協議支持2種校驗和，它們是累加和與CRC校驗。
    當接收方一開始啓動傳輸時發送的是NAK，表示它希望以累加和方式校驗。
    當接收方一開始啓動傳輸時發送的是字符“C”，表示它希望以CRC方式校驗。
    可能有人會問，接收方想怎麼校驗發送方都得配合嗎，難道發送方必須都支持累加和校驗和CRC校驗？事實上Xmodem要求支持CRC的就必須同時支持累加和，如果發送方只支持累加和，而接收方用字符“C”來啓動，那麼發送方只要不管它，當接收方繼續發送“C”，三次後都沒收到應答，就自動會改爲發送NAK，因爲它已經明白髮送方可能不支持CRC校驗，現在接收方改爲累加和校驗和發送方通訊。發送方收到NAK就趕緊發送數據包響應。
11．Xmodem協議代碼
        看了以上說明，再參考代碼，應該很容易會理解代碼編寫者的思路。


2.1、Xmodem源代碼

<span style="font-family: Arial, Helvetica, sans-serif;">#include "crc16.h"</span>

#define SOH  0x01
#define STX  0x02
#define EOT  0x04
#define ACK  0x06
#define NAK  0x15
#define CAN  0x18
#define CTRLZ 0x1A

#define DLY_1S 1000
#define MAXRETRANS 25
static int last_error = 0;

#include "string.h"

void port_outbyte(unsigned char trychar)
{
    unsigned char buf[2];
    buf[0] = trychar;
    lowLevel_write(buf,1);
}

unsigned char port_inbyte(unsigned int time_out)
{
    unsigned char ch;
    int i;
    last_error = 0;

    if(lowLevel_read(&ch,1) == 1)
        return ch;

    last_error = 1;
    return ch;
}

static int check(int crc, const unsigned char *buf, int sz)
{
    if (crc)
    {
        unsigned short crc = crc16_ccitt(buf, sz);
        unsigned short tcrc = (buf[sz]<<8)+buf[sz+1];
        if (crc == tcrc)
            return 1;
    }
    else
    {
        int i;
        unsigned char cks = 0;
        for (i = 0; i < sz; ++i)
        {
            cks += buf[i];
        }
        if (cks == buf[sz])
            return 1;
    }
    return 0;
}

static void flushinput(void)
{
 //while (port_inbyte(((DLY_1S)*3)>>1) >= 0)
    ;
}

int xmodemReceive(unsigned char *dest, int destsz)
{
    unsigned char xbuff[1030];
    unsigned char *p;
    int bufsz, crc = 0;
    unsigned char trychar = 'C';
    unsigned char packetno = 1;
    int i, c, len = 0;
    int retry, retrans = MAXRETRANS;

    for(;;)
    {
        for( retry = 0; retry < 16; ++retry)
        {
            if (trychar)
                port_outbyte(trychar);
            c = port_inbyte((DLY_1S)<<1);
            if (last_error == 0)
            {
                switch (c)
                {
                case SOH:
                    bufsz = 128;
                    goto start_recv;
                case STX:
                    bufsz = 1024;
                    goto start_recv;
                case EOT:
                    flushinput();
                    port_outbyte(ACK);
                    return len;
                case CAN:
                    c = port_inbyte(DLY_1S);

                    if (c == CAN)
                    {
                        flushinput();
                        port_outbyte(ACK);
                        return -1;
                    }
                    break;
                default:
                    break;
                }
            }
        }
        if (trychar == 'C')
        {
            trychar = NAK;
            continue;
        }
        flushinput();
        port_outbyte(CAN);
        port_outbyte(CAN);
        port_outbyte(CAN);
        return -2;
start_recv:
        if (trychar == 'C') crc = 1;
            trychar = 0;
        p = xbuff;
        *p++ = c;
        for (i = 0;  i < (bufsz+(crc?1:0)+3); ++i)
        {
            c = port_inbyte(DLY_1S);

            if (last_error != 0)
                goto reject;
            *p++ = c;
        }

        if (xbuff[1] == (unsigned char)(~xbuff[2]) &&
            (xbuff[1] == packetno || xbuff[1] == (unsigned char)packetno-1) &&
            check(crc, &xbuff[3], bufsz))
        {
            if (xbuff[1] == packetno) 
            {
                int count = destsz - len;
                if (count > bufsz)
                    count = bufsz;
                if (count > 0)
                {
                    memcpy (&dest[len], &xbuff[3], count);
                    len += count;
                }
                ++packetno;
                retrans = MAXRETRANS+1;
            }
            if (--retrans <= 0)
            {
                flushinput();
                port_outbyte(CAN);
                port_outbyte(CAN);
                port_outbyte(CAN);
                return -3;
            }
            port_outbyte(ACK);
            continue;
        }
reject:
        flushinput();
        port_outbyte(NAK);
    }
}

int xmodemTransmit(unsigned char *src, int srcsz)
{
    unsigned char xbuff[1030];
    int bufsz, crc = -1;
    unsigned char packetno = 1;
    int i, c, len = 0;
    int retry;

    for(;;) 
    {
        for( retry = 0; retry < 16; ++retry)
        {
            c = port_inbyte((DLY_1S)<<1);
            if (last_error == 0)
            {
                switch (c)
                {
                case 'C':
                    crc = 1;
                    goto start_trans;
                case NAK:
                    crc = 0;
                    goto start_trans;
                case CAN:
                    c = port_inbyte(DLY_1S);
                    if (c == CAN)
                    {
                        port_outbyte(ACK);
                        flushinput();
                        return -1;
                    }
                    break;
                default:
                    break;
                }
            }
        }
        port_outbyte(CAN);
        port_outbyte(CAN);
        port_outbyte(CAN);
        flushinput();
        return -2;

        for(;;)
        {
start_trans:
            xbuff[0] = SOH; bufsz = 128;
            xbuff[1] = packetno;
            xbuff[2] = ~packetno;
            c = srcsz - len;
            if (c > bufsz) 
                c = bufsz;
            if (c >= 0)
            {
                memset (&xbuff[3], 0, bufsz);
                if (c == 0)
                {
                    xbuff[3] = CTRLZ;
                }
                else
                {
                    memcpy (&xbuff[3], &src[len], c);
                    if (c < bufsz) 
                        xbuff[3+c] = CTRLZ;
                }
                if (crc)
                {
                    unsigned short ccrc = crc16_ccitt(&xbuff[3], bufsz);
                    xbuff[bufsz+3] = (ccrc>>8) & 0xFF;
                    xbuff[bufsz+4] = ccrc & 0xFF;
                }
                else
                {
                    unsigned char ccks = 0;
                    for (i = 3; i < bufsz+3; ++i)
                    {
                        ccks += xbuff[i];
                    }
                    xbuff[bufsz+3] = ccks;
                }
                for (retry = 0; retry < MAXRETRANS; ++retry)
                {
                    for (i = 0; i < bufsz+4+(crc?1:0); ++i)
                    {
                        port_outbyte(xbuff[i]);
                    }
                    c = port_inbyte(DLY_1S);
                    if (last_error == 0 )
                    {
                        switch (c)
                        {
                        case ACK:
                            ++packetno;
                            len += bufsz;
                            goto start_trans;
                        case CAN:
                            c = port_inbyte(DLY_1S);
                            if ( c == CAN)
                            {
                                port_outbyte(ACK);
                                flushinput();
                                return -1;
                            }
                            break;
                        case NAK:
                        default:
                            break;
                        }
                    }
                }
                port_outbyte(CAN);
                port_outbyte(CAN);
                port_outbyte(CAN);
                flushinput();
                return -4;
            }
            else
            {
                for (retry = 0; retry < 10; ++retry)
                {
                    port_outbyte(EOT);
                    c = port_inbyte((DLY_1S)<<1);
                    if (c == ACK) 
                        break;
                }
                flushinput();
                return (c == ACK)?len:-5;
            }
        }
    }
}
2.2、CRC16-CCITT 

crc16.c

＃include "crc16.h"

static const unsigned short crc16tab[256]= {
 0x0000,0x1021,0x2042,0x3063,0x4084,0x50a5,0x60c6,0x70e7,
 0x8108,0x9129,0xa14a,0xb16b,0xc18c,0xd1ad,0xe1ce,0xf1ef,
 0x1231,0x0210,0x3273,0x2252,0x52b5,0x4294,0x72f7,0x62d6,
 0x9339,0x8318,0xb37b,0xa35a,0xd3bd,0xc39c,0xf3ff,0xe3de,
 0x2462,0x3443,0x0420,0x1401,0x64e6,0x74c7,0x44a4,0x5485,
 0xa56a,0xb54b,0x8528,0x9509,0xe5ee,0xf5cf,0xc5ac,0xd58d,
 0x3653,0x2672,0x1611,0x0630,0x76d7,0x66f6,0x5695,0x46b4,
 0xb75b,0xa77a,0x9719,0x8738,0xf7df,0xe7fe,0xd79d,0xc7bc,
 0x48c4,0x58e5,0x6886,0x78a7,0x0840,0x1861,0x2802,0x3823,
 0xc9cc,0xd9ed,0xe98e,0xf9af,0x8948,0x9969,0xa90a,0xb92b,
 0x5af5,0x4ad4,0x7ab7,0x6a96,0x1a71,0x0a50,0x3a33,0x2a12,
 0xdbfd,0xcbdc,0xfbbf,0xeb9e,0x9b79,0x8b58,0xbb3b,0xab1a,
 0x6ca6,0x7c87,0x4ce4,0x5cc5,0x2c22,0x3c03,0x0c60,0x1c41,
 0xedae,0xfd8f,0xcdec,0xddcd,0xad2a,0xbd0b,0x8d68,0x9d49,
 0x7e97,0x6eb6,0x5ed5,0x4ef4,0x3e13,0x2e32,0x1e51,0x0e70,
 0xff9f,0xefbe,0xdfdd,0xcffc,0xbf1b,0xaf3a,0x9f59,0x8f78,
 0x9188,0x81a9,0xb1ca,0xa1eb,0xd10c,0xc12d,0xf14e,0xe16f,
 0x1080,0x00a1,0x30c2,0x20e3,0x5004,0x4025,0x7046,0x6067,
 0x83b9,0x9398,0xa3fb,0xb3da,0xc33d,0xd31c,0xe37f,0xf35e,
 0x02b1,0x1290,0x22f3,0x32d2,0x4235,0x5214,0x6277,0x7256,
 0xb5ea,0xa5cb,0x95a8,0x8589,0xf56e,0xe54f,0xd52c,0xc50d,
 0x34e2,0x24c3,0x14a0,0x0481,0x7466,0x6447,0x5424,0x4405,
 0xa7db,0xb7fa,0x8799,0x97b8,0xe75f,0xf77e,0xc71d,0xd73c,
 0x26d3,0x36f2,0x0691,0x16b0,0x6657,0x7676,0x4615,0x5634,
 0xd94c,0xc96d,0xf90e,0xe92f,0x99c8,0x89e9,0xb98a,0xa9ab,
 0x5844,0x4865,0x7806,0x6827,0x18c0,0x08e1,0x3882,0x28a3,
 0xcb7d,0xdb5c,0xeb3f,0xfb1e,0x8bf9,0x9bd8,0xabbb,0xbb9a,
 0x4a75,0x5a54,0x6a37,0x7a16,0x0af1,0x1ad0,0x2ab3,0x3a92,
 0xfd2e,0xed0f,0xdd6c,0xcd4d,0xbdaa,0xad8b,0x9de8,0x8dc9,
 0x7c26,0x6c07,0x5c64,0x4c45,0x3ca2,0x2c83,0x1ce0,0x0cc1,
 0xef1f,0xff3e,0xcf5d,0xdf7c,0xaf9b,0xbfba,0x8fd9,0x9ff8,
 0x6e17,0x7e36,0x4e55,0x5e74,0x2e93,0x3eb2,0x0ed1,0x1ef0
};
 
unsigned short crc16_ccitt(const char *buf, int len)
{
    register int counter;
    register unsigned short crc = 0;
    for( counter = 0; counter < len; counter++)
        crc = (crc<<8) ^ crc16tab[((crc>>8) ^ *(char *)buf++)&0x00FF];
    return crc;
}



發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章

書店管理系統---不完善

這是一個C語言寫的書店管理系統 主要缺點：0，不能保存數據，每次重新運行，數據會刷新；     1，收銀時會發生問題 #include "stdio.h" #include "stdlib.h" #include "string.h"

KuseBear 2020-07-08 11:07:33

一個簡易的bc計算器

 #include<stdio.h> #include<stdlib.h> #include<string.h> #include<ctype.h> void help( void ); void chushi( void ); vo

KuseBear 2020-07-08 11:07:30

C異常處理機制：setjmp和longjmp

http://en.wikipedia.org/wiki/Setjmp.h  setjmp.h is a header defined in the C standard library to provide "non-local j

walterxia 2020-07-08 10:38:40

C語言 個位數統計

給定一個 k 位整數 N=d​k−1​​10​k−1​​+⋯+d​1​​10​1​​+d​0​​ (0≤d​i​​≤9, i=0,⋯,k−1, d​k−1​​>0)，請編寫程序統計每種不同的個位數字出現的次數。例如：給定 N=100311

badgirl-bb 2020-07-08 09:38:07

PAT-L1-012 計算指數

真的沒騙你，這道纔是簡單題 —— 對任意給定的不超過 10 的正整數 n，要求你輸出 2​n​​。不難吧？ 輸入格式： 輸入在一行中給出一個不超過 10 的正整數 n。 輸出格式： 在一行中按照格式 2^n = 計算結果 輸出 2​n​​

badgirl-bb 2020-07-08 09:38:07

C語言求解由1,2,3,4，四位數字構成的互不相同且無重複數字的四位數

採用多重循環的方式即可，首先明確一共有四個數字供選擇，組成的是四位數，那麼在個、十、百、千的取值上，就只能有一位是1，一位是2，一位是3，一位是4 代碼如下： #include<stdio.h> int main(){     //四位數

badgirl-bb 2020-07-08 09:38:07

被遺忘的volatile關鍵字

1，是類型修飾符，用來修飾被不同線程訪問和修改的變量，如果沒有volatile，基本上會導致這樣的結果：要麼無法編寫多線程程序，要麼編譯器失去大量優化的機會。 2，作用：作爲指令關鍵字，確保本條指令不會因編譯器的優化而省略，且要求每次直

武汉WiFi开发与设计工程师 2020-07-08 06:57:59

向量相加其二（C串行、OpenMP、OpenMP AVX2實現）

向量相加其二摘要測試機配置源代碼說明1.C串行版和OpenMP版可以用idle環境編譯，AVX2普通idle可能識別不出2.sys/time.h這個頭文件idle環境也可能識別不了運行結果及分析 摘要 在向量相加一中比較了純pyt

鸣王星U+2647 2020-07-08 06:38:06

C語言之變量內存體現(VS編譯器)

計算機中所有的數據都是以二進制形式表示的，一個字節（byte）=8位（bit）。 爲了便於書寫與理解，內存地址空間是用16進制的數據表示, 如0x8049324,因爲十六進制更簡短，換算的時候一位16進制數可以頂4位2進制數。（所

吃数据的猴子 2020-07-08 06:06:01

C問題－－－矩陣輸出問題

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 典型例題 33：C問題－－－矩陣輸出問題 －－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－      1    #include <iostream>

haiping_3 2020-07-08 05:34:30

計算機字節序問題－－－字節序編程測試

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 典型例題 25：計算機字節序問題－－－字節序編程測試 －－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－  1    /*  2     

haiping_3 2020-07-08 05:34:29

C問題－－－itostr（） 實現

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 典型例題 22：C問題－－－itostr（） 實現。 －－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－  1    #include <

haiping_3 2020-07-08 05:34:29

計算機字節序問題－－－指針和聯合體編程測試

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 典型例題 26：計算機字節序問題－－－指針和聯合體編程測試 －－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ －－－－－－－－－－－－－

haiping_3 2020-07-08 05:34:18

C問題－－－求pi經典算法

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 典型例題 20：C問題－－－求pi經典算法。 －－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－  1    //************

haiping_3 2020-07-08 05:34:17

C問題－－－典型遞歸問題

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ 典型例題 31：C問題－－－典型遞歸問題 －－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ （1）輸入兩個字符串， 比如abdbcc和abc， 輸出第二

haiping_3 2020-07-08 05:34:17