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