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