X-Modem 协议接收端的实现 For RVDS

1. 前段时间搞ARM实验平台的开发，需要经常实时调试程序。但是烧写一次Flash又太麻烦，后来想到一个最经典的解决方法，就是通过串口下载到内存实时运行调试。本来不想写太多，所以选择了最最古老但又最最有效的一个传输协议：X-Modem。X-Modem协议是 1977 年 Ward Christensen 所发明的。这个协议使用最简单的“等待/重传”算法，对于ARM这一类嵌入式系统来说，由于通常外围IP都有UART模块，所以不仅易于实现，而且还节省硬件资源。相关X-Modem协议详细资料可以在网上找到。
3. 这里给出我前段时间写的X-Modem接收端程序核心。本程序是针对Samsung的s3c2410系列编写的，使用了2410的内部UART模块，以及UART的FIFO机制。值得注意的是，由于Xmodem接收包的时候并不能保证CPU处于100%在本进程，或者不能保证CPU能马上响应UART事件，所以并不能使用POLL方法进行UART的操作，必须要打开UART模块的FIFO机制，才能保证数据的准确而且不掉包。
5. 本模块接口为：
7. int xmodem_receive(unsigned char* buf, int timeoutcount, int* receivedsize)
9. 返回值：具体值在 xmodem.h 里定义，是接收的最后状态。
11. 输入参数：buf为接收缓冲区地址。timeoutcount为超时计数。
13. 输出参数：receivedsize为总接收数据量，以byte为单位。
17. xmodem.h:
19.  /*=============================================================================
20. --------------------------------- Copy Left -----------------------------------
21.                         Illidan Fly's Project
22.                         Power by BigFly Network
23.                         http://bigfly.happybobby.com
24.                         
25.                         Released under GPL2 License
27. ----------------------------- File Description --------------------------------
28.  Filename:  xmodem.h
29.  Date:      2007.01.12
30.  Version:   0.0.1
31.  Description:
32.             Xmodem protocol using polling and Uart FIFO.
33. ----------------------------- Version History ---------------------------------
34.  0.0.2: Size parameter added to xmodem_receive().
35.  0.0.1: First release
37. =============================================================================*/
39. #ifndef __XMODEM_H__
40. #define __XMODEM_H__
42. #define XMODEM_DATA_SIZE    128
44. #define XMODEM_SOH  0x01
45. #define XMODEM_EOT  0x04
46. #define XMODEM_ACK  0x06
47. #define XMODEM_NAK  0x15
48. #define XMODEM_CAN  0x18
50. #define XMODEM_ERR_OK       0x00
51. #define XMODEM_ERR_TIMEOUT  0x01
52. #define XMODEM_ERR_CANCEL   0x02
53. #define XMODEM_ERR_TRANSMIT 0x03
54. #define XMODEM_ERR_RECEIVE  0x04
56. int xmodem_receive(unsigned char* buf, int timeoutcount, int* receivedsize);
58. #endif  //__XMODEM_H__
65. xmodem.c：
67. /*=============================================================================
68. --------------------------------- Copy Left -----------------------------------
69.                         Illidan Fly's Project
70.                         Power by BigFly Network
71.                         http://bigfly.happybobby.com
72.                         
73.                         Released under GPL2 License
75. ----------------------------- File Description --------------------------------
76.  Filename:  xmodem.c
77.  Date:      2007.01.14
78.  Version:   0.0.2
79.  Description:
80.             Xmodem protocol using polling and Uart FIFO.
81. ----------------------------- Version History ---------------------------------
82.  0.0.2: First package issue fixed. Size parameter added to xmodem_receive().
83.  0.0.1: First release
85. =============================================================================*/
87. #include "xmodem.h"
89. #include "2410addr.h"
90. #include "2410lib.h"
91. #include "def.h"
93. #define UART_NOT_EMPTY (rUFSTAT0 & 0x000F)
95. // Save for UART state
96. int save_rufcon;
98. typedef struct _xmodem_package
99. {
100.     unsigned char blknum;
101.     unsigned char checkblknum;
102.     unsigned char data[XMODEM_DATA_SIZE];
103.     unsigned char checksum;
104. }xmodem_package;
106. unsigned char uart_getdata(void)
107. {
108.     // Wait for Rx FIFO not empty
109.     while(!UART_NOT_EMPTY){;}
110.     return RdURXH0();
111. }
113. void uart_senddata(unsigned char data)
114. {
115.     // Wait for Tx FIFO not full
116.     while(rUFSTAT0 & 0x0200){;}
117.     WrUTXH0(data);
118. }
120. void uart_initstate(void)
121. {
122.     Uart_TxEmpty(0);
123.     save_rufcon = rUFCON0;
124.     
125.     // Note: Xmodem must work in FIFO mode or will encounter data loss.
126.     // Set UART0 to FIFO mode
127.     rUFCON0 = 0x7;
128.     Delay(100);
129. }
131. void uart_restorestate(void)
132. {
133.     rUFCON0 = save_rufcon;
134. }
136. int xmodem_receive(unsigned char* buf, int timeoutcount, int* receivedsize)
137. {
138.     xmodem_package receivedpak;
139.     unsigned char tmpchar;
140.     unsigned char tmpsum;
141.     unsigned char packnum;
142.     int retrytime;
143.     int fc1;
144.     
145.     // Init UART state
146.     uart_initstate();
147.     
148.     // Xmodem first frame number = 0x01
149.     packnum=0x01;
150.     retrytime=0;
151.     *receivedsize=0;
152.     
153.     // Send NAK and wait for sender signal, resend NAK in 10 seconds
154.     do
155.     {
156.         if(retrytime++>timeoutcount)
157.         {
158.             uart_restorestate();
159.             return XMODEM_ERR_TIMEOUT;
160.         }
161.         uart_senddata(XMODEM_NAK);
162.         for(fc1=0;fc1<10000000;fc1++)
163.         {
164.             if(UART_NOT_EMPTY){break;}
165.         }
166.     }while(!UART_NOT_EMPTY);
167.     
168.     // Start receive
169.     while(1)
170.     {
171.         tmpsum=0;
172.         
173.         // Get control signal
174.         tmpchar=uart_getdata();
175.         switch(tmpchar)
176.         {
177.             case XMODEM_SOH:
178.             // New package
179.             break;
180.             
181.             case XMODEM_EOT:
182.             // End of transmit
183.             uart_senddata(XMODEM_ACK);
184.             uart_restorestate();
185.             return XMODEM_ERR_OK;
186.             
187.             case XMODEM_CAN:
188.             // Cancel transmit
189.             tmpchar=uart_getdata();
190.             if(tmpchar==XMODEM_CAN)
191.             {
192.                 uart_restorestate();
193.                 return XMODEM_ERR_CANCEL;
194.             }
195.             
196.             default:
197.             // Invaild signal
198.             uart_restorestate();
199.             return XMODEM_ERR_RECEIVE;
200.         }
201.         
202.         // Receive package
203.         receivedpak.blknum=uart_getdata();
204.         receivedpak.checkblknum=uart_getdata();
205.         for(fc1=0;fc1<XMODEM_DATA_SIZE;fc1++)
206.         {
207.             tmpchar=uart_getdata();
208.             receivedpak.data[fc1]=tmpchar;
209.             tmpsum+=tmpchar;
210.         }
211.         receivedpak.checksum=uart_getdata();
212.         
213.         // Check blknum
214.         if(receivedpak.blknum==(~receivedpak.checkblknum))
215.         {
216.             if(receivedpak.blknum==(packnum & 0xFF))
217.             {
218.                 // Check checksum
219.                 if(tmpsum==receivedpak.checksum)  
220.                 {
221.                         // Package vaild
222.                         packnum++;
223.                         for(fc1=0;fc1<XMODEM_DATA_SIZE;fc1++)
224.                         {
225.                             *(buf++)=receivedpak.data[fc1];
226.                         }
227.                         *receivedsize+=XMODEM_DATA_SIZE;
228.                         uart_senddata(XMODEM_ACK);
229.                 }
230.                 else
231.                 {
232.                     // Package checksum invaild, request for resend
233.                     uart_senddata(XMODEM_NAK);
234.                 }
235.             }
236.             else if(receivedpak.blknum==packnum-1)
237.             {
238.                 // Sender didn't received ACK, resend ACK
239.                 uart_senddata(XMODEM_ACK);
240.             }
241.             else
242.             {
243.                 // Package blknum invaild, error occur. Try to resend
244.                 uart_senddata(XMODEM_NAK);
245.             }
246.         }
247.         else
248.         {
249.             // Package blknum check invaild, request for resend
250.             uart_senddata(XMODEM_NAK);
251.         }
252.     }
253. }