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