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