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