Rev 2817 Rev 2848
1 /**** BootLoader for PIC16F887 1 /**** BootLoader for PIC16F887
2   2  
3 Ussage: 3 Ussage:
4 ascii-xfr -s -v -l 110 ./bltest.hex > /dev/ttyUSB0 4 ascii-xfr -s -v -l 110 ./bltest.hex > /dev/ttyUSB0
5 5
6 ascii-xfr is part of 'minicom' package 6 ascii-xfr is part of 'minicom' package
7   7  
8 Add "uf\n\r" to the first line of .HEX. or use this script: 8 Add "uf\n\r" to the first line of .HEX. or use this script:
9 echo uf > /dev/ttyUSB$1 9 echo uf > /dev/ttyUSB$1
10 ascii-xfr -s -v -l 100 ./bltest.hex > /dev/ttyUSB$1 10 ascii-xfr -s -v -l 100 ./bltest.hex > /dev/ttyUSB$1
11 11
12 Or add "uf\n\r" and add some dummy characters at end or begin of each line (for 100 ms delay) and use: 12 Or add "uf\n\r" and add some dummy characters at end or begin of each line (for 100 ms delay) and use:
13 cp ./bltest.hex > /dev/ttyUSB0 13 cp ./bltest.hex > /dev/ttyUSB0
14 14
15 For adding characters you can use this: 15 For adding characters you can use this:
16 sed -i 's/^/pppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppp/' ./bltest.hex 16 sed -i 's/^/pppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppp/' ./bltest.hex
17 sed -i 1i"uf" ./bltest.hex 17 sed -i 1i"uf" ./bltest.hex
18 18
19 */ 19 */
20   20  
21 #define ID "$Id: bloader.c 2817 2013-03-10 10:56:44Z kakl $" 21 #define ID "$Id: bloader.c 2848 2013-03-21 08:16:49Z kakl $"
22   22  
23 #CASE // Case sensitive compiler 23 #CASE // Case sensitive compiler
24   24  
25 #define ERR_BUFFER_OVERRUN 1 // Error 1 - Buffer Overrun 25 #define ERR_BUFFER_OVERRUN 1 // Error 1 - Buffer Overrun
26 #define ERR_CHECKSUM 2 // Error 2 - Bad CheckSum 26 #define ERR_CHECKSUM 2 // Error 2 - Bad CheckSum
27 #define ERR_TOO_MANY_BYTES 3 // Error 3 - Too many bytes in one line 27 #define ERR_TOO_MANY_BYTES 3 // Error 3 - Too many bytes in one line
28 #define ERR_UNSUPORTED_LINETYPE 4 // Error 4 - Unsuported Line type 28 #define ERR_UNSUPORTED_LINETYPE 4 // Error 4 - Unsuported Line type
29   29  
30 #define BUFFER_LEN_LOD 46 // Length of Working buffer for HEX 30 #define BUFFER_LEN_LOD 46 // Length of Working buffer for HEX
31   31  
32 #include "..\common\bloader_defs.h" 32 #include "..\common\bloader_defs.h"
33 #include "bloader.h" 33 #include "bloader.h"
34 #include <string.h> 34 #include <string.h>
35   35  
36 #INT_RDA 36 #INT_RDA
37 void rs232_handler() // Test of interrupt 37 void rs232_handler() // Test of interrupt
38 { 38 {
39 putchar(getc()); // Just echo for test 39 putchar(getc()); // Just echo for test
40 } 40 }
41   41  
42 void welcome(void) // Welcome message 42 void welcome(void) // Welcome message
43 { 43 {
44 char REV[50]=ID; // Buffer for concatenate of a version string 44 char REV[50]=ID; // Buffer for concatenate of a version string
45   45  
46 if (REV[strlen(REV)-1]=='$') REV[strlen(REV)-1]=0; 46 if (REV[strlen(REV)-1]=='$') REV[strlen(REV)-1]=0;
47 printf("\r\n\r\n# BLoader 887 (C) 2013 KAKL\r\n"); // Welcome message 47 printf("\r\n\r\n# BLoader 887 (C) 2013 KAKL\r\n"); // Welcome message
48 printf("#%s\r\n",&REV[4]); 48 printf("#%s\r\n",&REV[4]);
49 } 49 }
50   50  
51   51  
52 /*-------------------------------- MAIN --------------------------------------*/ 52 /*-------------------------------- MAIN --------------------------------------*/
53 #SEPARATE 53 #SEPARATE
54 void real_main() // Main of loaded program 54 void real_main() // Main of loaded program
55 { 55 {
56 int8 i=0; 56 int8 i=0;
57   57  
58 i=rs232_errors; // Just for compiler pleasure (supress Warning) 58 i=rs232_errors; // Just for compiler pleasure (supress Warning)
59 59
60 welcome(); 60 welcome();
61   61  
62 printf("# Reserved: %Lu\r\n", RESERVED_BLOCKS*FLASH_BLOCK_SIZE); 62 printf("# Reserved: %Lu\r\n", RESERVED_BLOCKS*FLASH_BLOCK_SIZE);
63 printf("# FLASH_ERASE_SIZE: %Lu\r\n",getenv("FLASH_ERASE_SIZE")); 63 printf("# FLASH_ERASE_SIZE: %Lu\r\n",getenv("FLASH_ERASE_SIZE"));
64 printf("# FLASH_WRITE_SIZE: %Lu\r\n",getenv("FLASH_WRITE_SIZE")); 64 printf("# FLASH_WRITE_SIZE: %Lu\r\n",getenv("FLASH_WRITE_SIZE"));
65 65
66 printf("# Boot Loader Test >>>\r\n# "); 66 printf("# Boot Loader Test >>>\r\n# ");
67 enable_interrupts(INT_RDA); 67 enable_interrupts(INT_RDA);
68 enable_interrupts(GLOBAL); 68 enable_interrupts(GLOBAL);
69 while(TRUE) 69 while(TRUE)
70 { 70 {
71 printf("%u|",i++); // Do something 71 printf("%u|",i++); // Do something
72 delay_ms(100); 72 delay_ms(100);
73 } 73 }
74 } 74 }
75   75  
76   76  
77 /*------------------- BOOT LOADER --------------------------------------------*/ 77 /*------------------- BOOT LOADER --------------------------------------------*/
78   78  
79 #BUILD(INTERRUPT=FLASH_BLOCK_SIZE) // Redirect Interrupt routine above first flash block 79 #BUILD(INTERRUPT=FLASH_BLOCK_SIZE) // Redirect Interrupt routine above first flash block
80 #ORG 4,5 -  
81 void JumpToTheInterrupt() // Jump to the Interrupt Handler 80 #ROM 0x0004={0,0,0,0,0,0,0,0,0,0,0,0} // 12x NOP from interrupt vector to interrupt routine
82 { #asm GOTO FLASH_BLOCK_SIZE #endasm } -  
83 #ORG 6,FLASH_BLOCK_SIZE-1 {} // First Flash block is reserved -  
84   81  
85   82  
86 #ORG LOADER_RESERVED,LOADER_RESERVED+FLASH_BLOCK_SIZE-1 auto=0 83 #ORG LOADER_RESERVED,LOADER_RESERVED+FLASH_BLOCK_SIZE-1 auto=0
87 #SEPARATE 84 #SEPARATE
88 void dummy_main() // Main on the fix position. It will be overwriten by downloaded program reset vector. 85 void dummy_main() // Main on the fix position. It will be overwriten by downloaded program reset vector.
89 { 86 {
90 real_main(); 87 real_main();
91 } 88 }
92   89  
93 #ORG LOADER_RESERVED+FLASH_BLOCK_SIZE,getenv("PROGRAM_MEMORY")-1 auto=0 default //Start of BootLoader 90 #ORG LOADER_RESERVED+FLASH_BLOCK_SIZE,getenv("PROGRAM_MEMORY")-1 auto=0 default //Start of BootLoader
94   91  
95 #use rs232(baud=9600,parity=N,xmit=PIN_C6,rcv=PIN_C7,bits=8,ERRORS) //RS232 control routine for BootLoader 92 #use rs232(baud=9600,parity=N,xmit=PIN_C6,rcv=PIN_C7,bits=8,ERRORS) //RS232 control routine for BootLoader
96   93  
97 #SEPARATE 94 #SEPARATE
98 unsigned int8 atoi_b16(char *s) // Convert two hex characters to an int8 95 unsigned int8 atoi_b16(char *s) // Convert two hex characters to an int8
99 { 96 {
100 unsigned int8 result = 0; 97 unsigned int8 result = 0;
101 int i; 98 int i;
102   99  
103 for (i=0; i<2; i++,s++) { 100 for (i=0; i<2; i++,s++) {
104 if (*s >= 'A') 101 if (*s >= 'A')
105 result = 16*result + (*s) - 'A' + 10; 102 result = 16*result + (*s) - 'A' + 10;
106 else 103 else
107 result = 16*result + (*s) - '0'; 104 result = 16*result + (*s) - '0';
108 } 105 }
109   106  
110 return(result); 107 return(result);
111 } 108 }
112   109  
113 void assert(int1 Condition, int8 ErrorCode) // Send error number to the serial line 110 void assert(int1 Condition, int8 ErrorCode) // Send error number to the serial line
114 { 111 {
115 if(Condition) 112 if(Condition)
116 { 113 {
117 putchar('E'); 114 putchar('E');
118 putchar(ErrorCode+'0'); 115 putchar(ErrorCode+'0');
119 reset_cpu(); 116 reset_cpu();
120 } 117 }
121 } 118 }
122   119  
123 void pause() 120 void pause()
124 { 121 {
125 int16 timeout; 122 int16 timeout;
126   123  
127 for(timeout=0; timeout<65535; timeout++); // Delay cca 300ms 124 for(timeout=0; timeout<65535; timeout++); // Delay cca 300ms
128 } 125 }
129   126  
130 #SEPARATE 127 #SEPARATE
131 void boot_loader() // Loads a new program 128 void boot_loader() // Loads a new program
132 { 129 {
133 /* 130 /*
134 :100240001F2999000A300C1E232999006430A4004C 131 :100240001F2999000A300C1E232999006430A4004C
135 10 = 16 bytes 132 10 = 16 bytes
136 0249 = address 0x0120 (0x240/2 because of words) 133 0249 = address 0x0120 (0x240/2 because of words)
137 00 = data 134 00 = data
138 ...data... 135 ...data...
139 4C = checksum 136 4C = checksum
140   137  
141 :00000001FF 138 :00000001FF
142 00 = 0 bytes 139 00 = 0 bytes
143 0000 = address 0 140 0000 = address 0
144 01 = END 141 01 = END
145 FF = checksum 142 FF = checksum
146   143  
147 http://cs.wikipedia.org/wiki/Intel_HEX 144 http://cs.wikipedia.org/wiki/Intel_HEX
148 */ 145 */
149 int buffidx; 146 int buffidx;
150 char buffer[BUFFER_LEN_LOD]; // Buffer for HEX line 147 char buffer[BUFFER_LEN_LOD]; // Buffer for HEX line
151   148  
152 int8 checksum, num_of_bytes, line_type; // Extracted values from HEX line 149 int8 checksum, num_of_bytes, line_type; // Extracted values from HEX line
153 int16 l_addr,h_addr=0; 150 int16 l_addr,h_addr=0;
154 int16 addr; // Address of word in PIC 151 int16 addr; // Address of word in PIC
155 int32 next_addr; // Helper variable for for 152 int32 next_addr; // Helper variable for for
156   153  
157 int8 dataidx, i; // Buffer for program bytes and pointers 154 int8 dataidx, i; // Buffer for program bytes and pointers
158 union program_data { 155 union program_data {
159 int8 i8[16]; 156 int8 i8[16];
160 int16 i16[8]; 157 int16 i16[8];
161 } data; 158 } data;
162   159  
163 disable_interrupts(GLOBAL); 160 disable_interrupts(GLOBAL);
164 /* 161 /*
165 putchar('@'); //Start Erase 162 putchar('@'); //Start Erase
166   163  
167 //Erase program memory is not necessary. 164 //Erase program memory is not necessary.
168 { 165 {
169 int8 i; 166 int8 i;
170 for(i=0;i<32;i++)buffer[i]=0xFF; 167 for(i=0;i<32;i++)buffer[i]=0xFF;
171 } 168 }
172 for(addr=FLASH_BLOCK_SIZE;addr<LOADER_RESERVED+FLASH_BLOCK_SIZE;addr+=FLASH_BLOCK_SIZE) 169 for(addr=FLASH_BLOCK_SIZE;addr<LOADER_RESERVED+FLASH_BLOCK_SIZE;addr+=FLASH_BLOCK_SIZE)
173 { 170 {
174 write_program_memory(addr, &buffer[0], 32); 171 write_program_memory(addr, &buffer[0], 32);
175 putchar('.'); 172 putchar('.');
176 restart_wdt(); 173 restart_wdt();
177 } 174 }
178 */ 175 */
179 putchar('!'); //Erase completed 176 putchar('!'); //Erase completed
180   177  
181 //---WDT 178 //---WDT
182 while(!kbhit()) restart_wdt(); //Wait for HEX 179 while(!kbhit()) restart_wdt(); //Wait for HEX
183 putc('\r'); putc('\n'); 180 putc('\r'); putc('\n');
184 181
185 while(TRUE) 182 while(TRUE)
186 { 183 {
187 //---WDT 184 //---WDT
188 while (getc()!=':') restart_wdt(); // Only process data blocks that starts with ':' 185 while (getc()!=':') restart_wdt(); // Only process data blocks that starts with ':'
189 putchar(':'); 186 putchar(':');
190   187  
191 buffidx = 0; // Read into the buffer until CR is received or buffer is full 188 buffidx = 0; // Read into the buffer until CR is received or buffer is full
192 do 189 do
193 { 190 {
194 buffer[buffidx] = getc(); 191 buffer[buffidx] = getc();
195 putc(buffer[buffidx]); 192 putc(buffer[buffidx]);
196 } while ( (buffer[buffidx++] != '\r') && (buffidx < BUFFER_LEN_LOD) ); 193 } while ( (buffer[buffidx++] != '\r') && (buffidx < BUFFER_LEN_LOD) );
197 assert(buffidx == BUFFER_LEN_LOD, ERR_BUFFER_OVERRUN); // Error 1 - Buffer Overrun 194 assert(buffidx == BUFFER_LEN_LOD, ERR_BUFFER_OVERRUN); // Error 1 - Buffer Overrun
198 buffidx--; 195 buffidx--;
199 196
200 //---WDT 197 //---WDT
201 restart_wdt(); 198 restart_wdt();
202   199  
203 checksum = 0; // Sum the bytes to find the check sum value 200 checksum = 0; // Sum the bytes to find the check sum value
204 for (i=0; i<(buffidx); i+=2) 201 for (i=0; i<(buffidx); i+=2)
205 { 202 {
206 checksum += atoi_b16 (&buffer[i]); 203 checksum += atoi_b16 (&buffer[i]);
207 } 204 }
208 assert(checksum != 0, ERR_CHECKSUM); // Error 2 - Bad CheckSum 205 assert(checksum != 0, ERR_CHECKSUM); // Error 2 - Bad CheckSum
209   206  
210 // Get the lower 16 bits of address 207 // Get the lower 16 bits of address
211 l_addr = make16(atoi_b16(&buffer[2]),atoi_b16(&buffer[4])); 208 l_addr = make16(atoi_b16(&buffer[2]),atoi_b16(&buffer[4]));
212   209  
213 line_type = atoi_b16 (&buffer[6]); 210 line_type = atoi_b16 (&buffer[6]);
214 211
215 num_of_bytes = atoi_b16 (&buffer[0]); 212 num_of_bytes = atoi_b16 (&buffer[0]);
216 assert (num_of_bytes > 16, ERR_TOO_MANY_BYTES); // Error 3 - Too many bytes in one line 213 assert (num_of_bytes > 16, ERR_TOO_MANY_BYTES); // Error 3 - Too many bytes in one line
217   214  
218 addr = make32(h_addr,l_addr); 215 addr = make32(h_addr,l_addr);
219   216  
220 addr /= 2; // PIC16 uses word addresses 217 addr /= 2; // PIC16 uses word addresses
221   218  
222 // If the line type is 1 then END 219 // If the line type is 1 then END
223 if (line_type == 1) 220 if (line_type == 1)
224 { 221 {
225 putchar('#'); 222 putchar('#');
226 reset_cpu(); 223 reset_cpu();
227 } 224 }
228   225  
229 assert (line_type != 0, ERR_UNSUPORTED_LINETYPE); // Error 4 - Unsuported Line type 226 assert (line_type != 0, ERR_UNSUPORTED_LINETYPE); // Error 4 - Unsuported Line type
230   227  
231 { 228 {
232 // Read old program memory content 229 // Read old program memory content
233 for (i=0,next_addr=addr;i<8;i++) 230 for (i=0,next_addr=addr;i<8;i++)
234 data.i16[i]=read_program_eeprom(next_addr++); 231 data.i16[i]=read_program_eeprom(next_addr++);
235 // Loops through all of the data and stores it in data 232 // Loops through all of the data and stores it in data
236 // The last 2 bytes are the check sum, hence buffidx-2 233 // The last 2 bytes are the check sum, hence buffidx-2
237 for (i=8,dataidx=0; i < (buffidx-2); i += 2) 234 for (i=8,dataidx=0; i < (buffidx-2); i += 2)
238 data.i8[dataidx++]=atoi_b16(&buffer[i]); 235 data.i8[dataidx++]=atoi_b16(&buffer[i]);
239   236  
240 if (addr == 0) 237 if (addr == 0)
241 { 238 {
242 // Write 8 words to the Loader location (jump to the main()) 239 // Write 8 words to the Loader location (jump to the main())
243 addr=LOADER_RESERVED; 240 addr=LOADER_RESERVED;
244 write_program_memory(addr, &data.i8[0], 16); // It works only with 16 !!! 241 write_program_memory(addr, &data.i8[0], 16); // It works only with 16 !!!
245 putchar('%'); 242 putchar('%');
246 } 243 }
247 else 244 else
248 if ( (addr > 7) && (addr <= (LOADER_RESERVED-16)) ) // Do not overwrite BootLoader 245 if ( (addr > 7) && (addr <= (LOADER_RESERVED-16)) ) // Do not overwrite BootLoader
249 { 246 {
250 // Write program 247 // Write program
251 write_program_memory(addr, &data.i8[0], 16); // It works only with 16 !!! 248 write_program_memory(addr, &data.i8[0], 16); // It works only with 16 !!!
252 putchar('$'); 249 putchar('$');
253 } 250 }
254 else putchar('.'); // Possibly there was prevented write to the location of BootLoader 251 else putchar('.'); // Possibly there was prevented write to the location of BootLoader
255 putc('\r'); putc('\n'); 252 putc('\r'); putc('\n');
256   253  
257 //---WDT 254 //---WDT
258 restart_wdt(); 255 restart_wdt();
259 } 256 }
260 } 257 }
261 } 258 }
262   259  
263   260  
264 void main() 261 void main()
265 { 262 {
266 int8 timeout; 263 int8 timeout;
267   264  
268 disable_interrupts(GLOBAL); 265 disable_interrupts(GLOBAL);
269 setup_wdt(WDT_2304MS); // Setup Watch Dog 266 setup_wdt(WDT_2304MS); // Setup Watch Dog
270 setup_adc_ports(NO_ANALOGS); 267 setup_adc_ports(NO_ANALOGS);
271 setup_adc(ADC_OFF); 268 setup_adc(ADC_OFF);
272 setup_timer_0(RTCC_INTERNAL|RTCC_DIV_1); 269 setup_timer_0(RTCC_INTERNAL|RTCC_DIV_1);
273 setup_timer_1(T1_DISABLED); 270 setup_timer_1(T1_DISABLED);
274 setup_timer_2(T2_DISABLED,0,1); 271 setup_timer_2(T2_DISABLED,0,1);
275 setup_comparator(NC_NC_NC_NC); 272 setup_comparator(NC_NC_NC_NC);
276 setup_vref(FALSE); 273 setup_vref(FALSE);
277 setup_oscillator(OSC_8MHZ|OSC_INTRC); 274 setup_oscillator(OSC_8MHZ|OSC_INTRC);
278   275  
279 for(timeout=0; timeout<255; timeout++) //cca 50s 276 for(timeout=0; timeout<255; timeout++) //cca 50s
280 { 277 {
281 if (kbhit()) 278 if (kbhit())
282 if (getc()=='u') // Send "uf" for Update Firmware 279 if (getc()=='u') // Send "uf" for Update Firmware
283 { 280 {
284 putchar('*'); 281 putchar('*');
285 if (getc()=='f') 282 if (getc()=='f')
286 { 283 {
287 restart_wdt(); 284 restart_wdt();
288 boot_loader(); // Update Firmware starter 285 boot_loader(); // Update Firmware starter
289 } 286 }
290 } 287 }
291 else break; 288 else break;
292 putchar('u'); putchar('f'); putchar('?'); 289 putchar('u'); putchar('f'); putchar('?');
293 pause(); 290 pause();
294 restart_wdt(); 291 restart_wdt();
295 }; 292 };
296   293  
297 restart_wdt(); 294 restart_wdt();
298 goto_address(LOADER_RESERVED); // Jump to the location where is the jump to the main 295 goto_address(LOADER_RESERVED); // Jump to the location where is the jump to the main
299 } 296 }
300 #ORG default // End of BootLoader 297 #ORG default // End of BootLoader