采用TCP协议实现ethernet bootloader


TCP/IP Stack

Microchip TCP/IP Stack是免费的，广泛应用于PIC单片机中。由于有远程更新程序的需求，我决定开发基于TCP协议的ethernet bootloader, 主要使用了Microchip TCP/IP Stack的TCP模块。最终我开发出来的ethernet bootloader 在PIC18F97J60上验证通过。整个实现上分两部分，一部分是单片机端的基于TCP协议的bootloader程序，我将其命名为PhnBoot_v2.0, 另外一部分是PC端同样基于TCP协议于单片机互动的通信程序，我将其命名为PhnLoader_v2.0。我还定义了PhnBoot_v2.0和PhnLoader_v2.0之间传输数据的通信协定。下面将细说我是如何实现的。

通信协定

单片机端PhnBoot_v2.0和PC端PhnLoader_v2.0之间的通信数据包采用以下协定

<STX><CMD><ADDRL><ADDRH><ADDRU><LEN><DATA>...<DATA><ETX>

定义如下:

STX - Start of packet indicator

ETX - End of packet indicator

LEN - The length of true data

DATA - General data 16 bytes, only first LEN of datas are true

CMD - Base command

ADDR - Address up to 24 bits ( ADDRL , ADDRH , ADDRH)

具体有以下Base command:

RD-VER: 0x00 -- Read Version Information (最终版本删除了此命令)

RD_MEM： 0x01 -- Read Program Memory (最终版本删除了此命令)

ER_MEM: 0x03 -- Erase Program Memory

WR_MEM： 0x02 -- Write Program Memory

WR_CFG： 0x04 -- Write Configuration Registers

PhnLoader_v2.0 功能

定义好了通讯协定, 接着就按照协定去实现PhnLoader_v2.0。 PhnLoader_v2.0的具体功能包括选择IP地址，端口和协议类型, 目前只支持TCP协议, 建立TCP服务器，加载应用程序Hex文件，Parse 应用程序的Hex文件，一行一行解读Hex文件，一旦收到连接请求，建立TCP连接，一旦收到应用程序跟新请求，立刻按照通讯协定采用TCP协议发送Hex记录到单片机，接收单片机发送回来的Response，发送完毕后断开TCP连接，发送期间出现问题就立马结束发送。

PhnLoader_v2.0 主要代码段

PhnLoader_v2.0是用C#实现的，是我在利用空余时间自学C#后写的，上面提到的功能都实现了。

View Code

PhnLoader_v2.0 用户界面

 

PhnBoot_v2.0 功能

在PhnLoader_v2.0完成后，接着就是完成PhnBoot_v2.0。 PhnBoot_v2.0主要功能就是使用Microchip的TCP/IP Stack建立TCP Client，发送连接请求，建立连接后发送更新应用程序请求，接收PhnLoader_v2.0传送过来的Hex记录。解读Hex记录中的启始位，命名，地址，数据和结束位，将数据烧录到指定的程序存储器的位置上，然后通过ethernet返回Response消息给PC端PhnLoader_v2.0。

PhnBoot_v2.0 位置

PhnBoot_v2.0放置在程序存储器的头部，大小为0x4C00程序字。

 

Interrupt Vector Remap

由于PhnBoot_v2.0位于程序存储器的头部，需要对Interrupt Vector进行remap. 代码如下。

  1. #define APP_START 0x4C00 
  2.  
  3. #define REMAPPED_APP_HIGH_INTERRUPT_VECTOR 0x4C08 
  4.  
  5. #define REMAPPED_APP_LOW_INTERRUPT_VECTOR 0x4C18 
  6.  
  7. #pragma code low_vector_section=0x018 
  8.  
  9. void low_vector (void) 
  10.  
  11. { 
  12.  
  13. _asm 
  14.  
  15. goto REMAPPED_APP_LOW_INTERRUPT_VECTOR 
  16.  
  17. _endasm 
  18.  
  19. } 
  20.  
  21. #pragma code high_vector_section=0x08 
  22.  
  23. void high_vector (void) 
  24.  
  25. { 
  26.  
  27. _asm 
  28.  
  29. goto REMAPPED_APP_HIGH_INTERRUPT_VECTOR 
  30.  
  31. _endasm 
  32.  
  33. } 

PhnBoot_v2.0 主要代码段

PhnBoot_v2.0 是用C语言写的，Microchip 8-bit C Compiler--MCC18编译的。

  1. switch (GenState) 
  2.  
  3. { 
  4.  
  5. case SM_HOME: 
  6.  
  7. ARPResolve(&Server.IPAddr); 
  8.  
  9. if (ARPIsResolved(&Server.IPAddr,&Server.MACAddr)) 
  10.  
  11. { 
  12.  
  13. #ifdef STACK_USE_UDP 
  14.  
  15. MySock = UDPOpen(ClientPort,&Server,ServerPort); 
  16.  
  17. #endif 
  18.  
  19. #ifdef STACK_USE_TCP 
  20.  
  21. MySock = TCPOpen((DWORD)&Server, TCP_OPEN_NODE_INFO, ServerPort, 0); 
  22.  
  23. #endif 
  24.  
  25. if (MySock != INVALID_SOCKET) 
  26.  
  27. { 
  28.  
  29. tick = 0x4000; 
  30.  
  31. delay = BOOT_TIMEOUT; 
  32.  
  33. GenState++; 
  34.  
  35. } 
  36.  
  37. } 
  38.  
  39. else 
  40.  
  41. { 
  42.  
  43. tick--; 
  44.  
  45. if (tick==0) 
  46.  
  47. { 
  48.  
  49. tick = 0x4000; 
  50.  
  51. if (delay == 0) 
  52.  
  53. { 
  54.  
  55. delay = BOOT_TIMEOUT; 
  56.  
  57. GenState = SM_CLOSE; 
  58.  
  59. } 
  60.  
  61. delay--; 
  62.  
  63. } 
  64.  
  65. } 
  66.  
  67. break; 
  68.  
  69. case SM_READY: 
  70.  
  71. #ifdef STACK_USE_UDP 
  72.  
  73. if (UDPIsPutReady(MySock) > BUFFER_MAX) 
  74.  
  75. { 
  76.  
  77. UDPPutString(ok); 
  78.  
  79. UDPFlush(); 
  80.  
  81. GenState++; 
  82.  
  83. } 
  84.  
  85. #endif 
  86.  
  87. #ifdef STACK_USE_TCP 
  88.  
  89. if (TCPIsConnected(MySock)) 
  90.  
  91. { 
  92.  
  93. TCPPutString(MySock,ok); 
  94.  
  95. TCPFlush(MySock); 
  96.  
  97. GenState++; 
  98.  
  99. } 
  100.  
  101. #endif 
  102.  
  103. else 
  104.  
  105. { 
  106.  
  107. tick--; 
  108.  
  109. if (tick==0) 
  110.  
  111. { 
  112.  
  113. tick = 0x4000; 
  114.  
  115. if (delay == 0) 
  116.  
  117. { 
  118.  
  119. delay = BOOT_TIMEOUT; 
  120.  
  121. GenState = SM_CLOSE; 
  122.  
  123. } 
  124.  
  125. delay--; 
  126.  
  127. } 
  128.  
  129. } 
  130.  
  131. break; 
  132.  
  133. case SM_RESPONSE: 
  134.  
  135. #ifdef STACK_USE_UDP 
  136.  
  137. networkBytes = UDPIsGetReady(MySock); 
  138.  
  139. #endif 
  140.  
  141. #ifdef STACK_USE_TCP 
  142.  
  143. networkBytes = TCPIsGetReady(MySock); 
  144.  
  145. #endif 
  146.  
  147. if (networkBytes >= BUFFER_MAX) 
  148.  
  149. { 
  150.  
  151. #ifdef STACK_USE_UDP 
  152.  
  153. UDPGetArray(line_buffer, BUFFER_MAX); 
  154.  
  155. UDPDiscard(); 
  156.  
  157. #endif 
  158.  
  159. #ifdef STACK_USE_TCP 
  160.  
  161. TCPGetArray(MySock,line_buffer,BUFFER_MAX); 
  162.  
  163. TCPDiscard(MySock); 
  164.  
  165. #endif 
  166.  
  167. if (line_buffer[0] == STX && line_buffer[BUFFER_MAX - 1] == ETX) 
  168.  
  169. { 
  170.  
  171. switch (line_buffer[CMD_INDEX]) 
  172.  
  173. { 
  174.  
  175. case WR_MEM: 
  176.  
  177. EECON1 = PGM_WRITE; 
  178.  
  179. WriteMem(); 
  180.  
  181. break; 
  182.  
  183. case WR_CFG: 
  184.  
  185. if (!last_block_written&&!CFG_NUM) 
  186.  
  187. { 
  188.  
  189. WriteStart(); 
  190.  
  191. last_block_written = 1; 
  192.  
  193. ResetBlockBuffer(); 
  194.  
  195. } 
  196.  
  197. CFG_NUM++; 
  198.  
  199. EECON1 = CFG_WRITE; 
  200.  
  201. WriteCfg(); 
  202.  
  203. break; 
  204.  
  205. case ER_MEM: 
  206.  
  207. EECON1 = PGM_ERASE; 
  208.  
  209. EraseMem(); 
  210.  
  211. break; 
  212.  
  213. case RUN_APP: 
  214.  
  215. if (!last_block_written) 
  216.  
  217. { 
  218.  
  219. WriteStart(); 
  220.  
  221. last_block_written = 1; 
  222.  
  223. ResetBlockBuffer(); 
  224.  
  225. } 
  226.  
  227. GenState++; 
  228.  
  229. default: 
  230.  
  231. break; 
  232.  
  233. } 
  234.  
  235. #ifdef STACK_USE_UDP 
  236.  
  237. if (UDPIsPutReady(MySock) >= BUFFER_MAX) 
  238.  
  239. { 
  240.  
  241. UDPPutArray(line_buffer, BUFFER_MAX); 
  242.  
  243. UDPFlush(); 
  244.  
  245. } 
  246.  
  247. #endif 
  248.  
  249. #ifdef STACK_USE_TCP 
  250.  
  251. if (TCPIsPutReady(MySock) >= BUFFER_MAX) 
  252.  
  253. { 
  254.  
  255. TCPPutArray(MySock,line_buffer, BUFFER_MAX); 
  256.  
  257. TCPFlush(MySock); 
  258.  
  259. } 
  260.  
  261. #endif 
  262.  
  263. } 
  264.  
  265. } 
  266.  
  267. else 
  268.  
  269. { 
  270.  
  271. tick--; 
  272.  
  273. if (tick==0) 
  274.  
  275. { 
  276.  
  277. tick = 0x4000; 
  278.  
  279. if (delay == 0) 
  280.  
  281. { 
  282.  
  283. delay = BOOT_TIMEOUT; 
  284.  
  285. GenState = SM_CLOSE; 
  286.  
  287. } 
  288.  
  289. delay--; 
  290.  
  291. } 
  292.  
  293. } 
  294.  
  295. break; 
  296.  
  297. case SM_CLOSE: 
  298.  
  299. while (!TXSTAbits.TRMT); 
  300.  
  301. TXREG='>'; 
  302.  
  303. #ifdef STACK_USE_UDP 
  304.  
  305. UDPClose(MySock); 
  306.  
  307. #endif 
  308.  
  309. #ifdef STACK_USE_TCP 
  310.  
  311. TCPDisconnect(MySock); 
  312.  
  313. #endif 
  314.  
  315. MySock = INVALID_SOCKET; 
  316.  
  317. _asm 
  318.  
  319. goto APP_START 
  320.  
  321. _endasm 
  322.  
  323. break; 
  324.  
  325. } 

如何使用

1. 使用MCC18编译PhnBoot_v2.0，

2. 使用pickit3烧录PhnBoot_v2.0的Hex文件到目标板中。

3. 拔除pickit3烧录器

4. 将目标板与PC的接入同一局域网，并设置PC的IP地址和目标板的IP地址为同一网域，打开PhnLoader_v2.0用户界面，选择IP, 端口，和通信协议。

5. 点击PhnLoader_v2.0用户界面上的“.."按钮加载需要烧录的应用程序Hex文件 (注意：由于PhnBoot_v2.0占用了程序存储器头部0x4C00程序字，所以应用程序编译需要设置Code offset为0x4C00)。

6. 重启目标板，接着立刻在PhnLoader_v2.0界面上点击Download按钮。如果超时未点击Download按钮，目标板会自动跳转到上次烧录的应用程序中去。

7. 烧录完毕，再次重启目标板, 2秒后目标板开始正常运行应用程序。

之后每次更新应用程序，只需重复步骤 4 ~ 7 就可以了。

主要特性

本PIC ethernet bootloader有以下主要特性

1. 使用了Microchip免费的TCP/IP Stack，采用TCP协议。

2. C语言写的，MCC18 编译。

3. 非常容易移植。

4. 支持FLASH烧写, 快速，占用空间小。

5. 不支持EEPROM烧写。

6. 支持CONFIG BITS/IDLOC 烧写。

相关内容