2 #define F_CPU 1000000UL /* 1 Mhz-Takt; hier richtigen Wert eintragen */
5 #include "../firmware/spminterface.h"
6 #include "usbasploader.h"
8 // activate updaters full set of features
9 #ifndef CONFIG_UPDATER_REDUCEWRITES
10 #define CONFIG_UPDATER_REDUCEWRITES
13 #ifndef CONFIG_UPDATER_CLEANMEMCLEAR
14 #define CONFIG_UPDATER_CLEANMEMCLEAR
19 #include <avr/interrupt.h>
22 #include <avr/pgmspace.h>
26 #include <util/delay.h>
29 #define updater_pagefillcode ((1<<SPMEN))
30 #define updater_pageerasecode ((1<<PGERS) | (1<<SPMEN))
31 #define updater_pagewritecode ((1<<PGWRT) | (1<<SPMEN))
34 #include "../firmware/bootloaderconfig.h"
35 #if !HAVE_SPMINTEREFACE
36 #error "bootloader does not support updating itself! (HAVE_SPMINTEREFACE)"
39 // helpful definitions and makros ////
41 #ifndef NEW_BOOTLOADER_ADDRESS
42 #error "where should the new bootloader be positioned?"
47 #if (NEW_BOOTLOADER_ADDRESS != (funcaddr___bootloader__do_spm-(funcaddr___bootloader__do_spm % SPM_PAGESIZE)))
48 #warning the new bootloader seems to be located elsewhere, than the current one!
51 #ifndef NEW_SPM_ADDRESS
52 #warning I do not know where new "bootloader__do_spm" is located - assuming "NEW_BOOTLOADER_ADDRESS+(funcaddr___bootloader__do_spm % SPM_PAGESIZE)"
53 #define NEW_SPM_ADDRESS (NEW_BOOTLOADER_ADDRESS+(funcaddr___bootloader__do_spm % SPM_PAGESIZE))
56 // TEMP_SPM supports up to 4 pages for "bootloader__do_spm"...
57 #define TEMP_SPM_NUMPAGE 4
58 #define TEMP_SPM_BLKSIZE (TEMP_SPM_NUMPAGE*SPM_PAGESIZE)
59 #ifndef TEMP_SPM_PAGEADR
60 #warning "TEMP_SPM_PAGEADR" is not defined explicitly - will choose END OF FLASH !
61 #define TEMP_SPM_PAGEADR ((FLASHEND+1) - TEMP_SPM_BLKSIZE)
63 #define TEMP_SPM_ADDRESS ((TEMP_SPM_PAGEADR) + (funcaddr___bootloader__do_spm % SPM_PAGESIZE))
66 #if (NEW_SPM_ADDRESS == funcaddr___bootloader__do_spm)
67 #define new_do_spm do_spm
69 void new_do_spm(const uint32_t flash_byteaddress
, const uint8_t spmcrval
, const uint16_t dataword
) {
70 __do_spm_Ex(flash_byteaddress
, spmcrval
, dataword
, NEW_SPM_ADDRESS
>> 1);
74 void temp_do_spm(const uint32_t flash_byteaddress
, const uint8_t spmcrval
, const uint16_t dataword
) {
75 __do_spm_Ex(flash_byteaddress
, spmcrval
, dataword
, TEMP_SPM_ADDRESS
>> 1);
80 // some important consistency checks ////
82 //check if "NEW_BOOTLOADER_ADDRESS" is page-aligned
83 #if (NEW_BOOTLOADER_ADDRESS % SPM_PAGESIZE != 0)
84 #error "NEW_BOOTLOADER_ADDRESS" is not aligned to pages!
87 //check, if NEW_SPM_ADDRESS is an even address
88 #if ((NEW_SPM_ADDRESS % 2) != 0)
89 #error NEW_SPM_ADDRESS must be an even address, since it contains executable code!
94 //check, if TEMP_SPM somehow overlaps with old SPM
95 #if (((TEMP_SPM_ADDRESS + TEMP_SPM_BLKSIZE + SPM_PAGESIZE) >= funcaddr___bootloader__do_spm) && (TEMP_SPM_ADDRESS <= (funcaddr___bootloader__do_spm + TEMP_SPM_BLKSIZE + SPM_PAGESIZE)))
96 #error TEMP_SPM_ADDRESS overlaps "funcaddr___bootloader__do_spm"!
99 //check, if TEMP_SPM somehow overlaps with new SPM
100 #if (((TEMP_SPM_ADDRESS + TEMP_SPM_BLKSIZE + SPM_PAGESIZE) >= NEW_SPM_ADDRESS) && (TEMP_SPM_ADDRESS <= (NEW_SPM_ADDRESS + TEMP_SPM_BLKSIZE + SPM_PAGESIZE)))
101 #error TEMP_SPM_ADDRESS overlaps "NEW_SPM_ADDRESS"!
104 //check, if TEMP_SPM_ADDRESS is an even address
105 #if ((TEMP_SPM_ADDRESS % 2) != 0)
106 #error TEMP_SPM_ADDRESS must be an even address, since it contains executable code!
109 //check, if TEMP_SPM_ADDRESS fits into flash
110 #if ((TEMP_SPM_PAGEADR + TEMP_SPM_BLKSIZE) > (FLASHEND+1))
111 #error TEMP_SPM_ADDRESS exceeds flashend!
114 //check if size too low
115 #if (SIZEOF_new_firmware <= (TEMP_SPM_BLKSIZE + (NEW_SPM_ADDRESS - NEW_BOOTLOADER_ADDRESS)))
116 #error empty firmware!
119 //check if size too high
120 #if (SIZEOF_new_firmware > ((FLASHEND+1)-NEW_BOOTLOADER_ADDRESS))
121 #error firmware too big! firmware does not fit into flash memory!
127 * in this case a near address
129 typedef uint32_t mypgm_addr_t
;
130 typedef void (*mypgm_spminterface
)(const uint32_t flash_byteaddress
, const uint8_t spmcrval
, const uint16_t dataword
);
134 size_t mypgm_readpage(const mypgm_addr_t byteaddress
,const void* buffer
, const size_t bufferbytesize
) {
135 size_t result
= (bufferbytesize
< SPM_PAGESIZE
)?bufferbytesize
:SPM_PAGESIZE
;
136 size_t pagesize
= result
>> 1;
137 uint16_t *pagedata
= (void*)buffer
;
138 mypgm_addr_t pageaddr
= byteaddress
- (byteaddress
% SPM_PAGESIZE
);
141 for (i
=0;i
<pagesize
;i
+=1) {
142 pagedata
[i
]=pgm_read_word(pageaddr
);
149 // replace it somehow with "memcpy_PF" in order to save some ops...
150 size_t mypgm_readpage(const mypgm_addr_t byteaddress
,const void* buffer
, const size_t bufferbytesize
) {
151 size_t result
= (bufferbytesize
< SPM_PAGESIZE
)?bufferbytesize
:SPM_PAGESIZE
;
152 mypgm_addr_t pageaddr
= byteaddress
- (byteaddress
% SPM_PAGESIZE
);
154 memcpy_PF((void*)buffer
, (uint_farptr_t
)pageaddr
, result
);
160 #ifdef CONFIG_UPDATER_REDUCEWRITES
161 size_t mypgm_WRITEpage(const mypgm_addr_t byteaddress
,const void* buffer
, const size_t bufferbytesize
, mypgm_spminterface spmfunc
) {
162 size_t result
= (bufferbytesize
< SPM_PAGESIZE
)?bufferbytesize
:SPM_PAGESIZE
;
163 size_t pagesize
= result
>> 1;
164 uint16_t *pagedata
= (void*)buffer
;
165 mypgm_addr_t pageaddr_bakup
= byteaddress
- (byteaddress
% SPM_PAGESIZE
);
166 mypgm_addr_t pageaddr
= pageaddr_bakup
;
168 uint8_t changed
=0, needs_erase
=0;
172 // just check, if page needs a rewrite or an erase...
173 for (i
=0;i
<pagesize
;i
+=1) {
174 deeword
=pgm_read_word(pageaddr
);
176 if (deeword
!= pagedata
[i
]) changed
=1;
187 * ==> /(/x * y) ==> x + /y
189 deeword
|= ~pagedata
[i
];
190 if ((~deeword
) != 0) needs_erase
=1;
198 //do a page-erase, ATTANTION: flash only can be erased a limited number of times !
199 spmfunc(pageaddr_bakup
, updater_pageerasecode
, 0);
202 // from now on, the page is assumed empty !! (hopefully our code is located somewhere else!)
203 // now, fill the tempoary buffer
204 // ATTANTION: see comment on "do_spm" !
205 pageaddr
= pageaddr_bakup
;
206 for (i
=0;i
<pagesize
;i
+=1) {
207 spmfunc(pageaddr
, updater_pagefillcode
, pagedata
[i
]);
211 // so, now finally write the page to the FLASH
212 spmfunc(pageaddr_bakup
, updater_pagewritecode
, 0);
214 // no change - no write...
222 size_t mypgm_WRITEpage(const mypgm_addr_t byteaddress
,const void* buffer
, const size_t bufferbytesize
, mypgm_spminterface spmfunc
) {
223 size_t result
= (bufferbytesize
< SPM_PAGESIZE
)?bufferbytesize
:SPM_PAGESIZE
;
224 size_t pagesize
= result
>> 1;
225 uint16_t *pagedata
= (void*)buffer
;
226 mypgm_addr_t pageaddr_bakup
= byteaddress
- (byteaddress
% SPM_PAGESIZE
);
227 mypgm_addr_t pageaddr
= pageaddr_bakup
;
231 //do a page-erase, ATTANTION: flash only can be erased a limited number of times !
232 spmfunc(pageaddr_bakup
, updater_pageerasecode
, 0);
234 // from now on, the page is assumed empty !! (hopefully our code is located somewhere else!)
235 // now, fill the tempoary buffer
236 // ATTANTION: see comment on "do_spm" !
237 pageaddr
= pageaddr_bakup
;
238 for (i
=0;i
<pagesize
;i
+=1) {
239 spmfunc(pageaddr
, updater_pagefillcode
, pagedata
[i
]);
243 // so, now finally write the page to the FLASH
244 spmfunc(pageaddr_bakup
, updater_pagewritecode
, 0);
250 // #pragma GCC diagnostic ignored "-Wno-pointer-to-int-cast"
254 uint8_t buffer
[SPM_PAGESIZE
];
259 // check if firmware would change...
261 for (i
=0;i
<SIZEOF_new_firmware
;i
+=2) {
263 a
=pgm_read_word((void*)&new_firmware
[i
]);
264 b
=pgm_read_word(NEW_BOOTLOADER_ADDRESS
+i
);
273 // need to change the firmware...
278 // copy the current "bootloader__do_spm" to tempoary position via std. "bootloader__do_spm"
279 for (i
=0;i
<TEMP_SPM_BLKSIZE
;i
+=SPM_PAGESIZE
) {
280 mypgm_WRITEpage(TEMP_SPM_PAGEADR
+i
, buffer
, mypgm_readpage(funcaddr___bootloader__do_spm
+i
, buffer
, sizeof(buffer
)), do_spm
);
284 // start updating the firmware to "NEW_BOOTLOADER_ADDRESS" until at least "TEMP_SPM_BLKSIZE"-bytes after "NEW_SPM_ADDRESS" were written
285 // therefore use the tempoary "bootloader__do_spm" (since we most probably will overwrite the default do_spm)
286 for (i
=0;;i
+=SPM_PAGESIZE
) {
287 #ifdef CONFIG_UPDATER_CLEANMEMCLEAR
288 memset((void*)buffer
, 0xff, sizeof(buffer
));
290 memcpy_PF((void*)buffer
, (uint_farptr_t
)((void*)&new_firmware
[i
]), ((SIZEOF_new_firmware
-i
)>sizeof(buffer
))?
sizeof(buffer
):(SIZEOF_new_firmware
-i
));
292 mypgm_WRITEpage(NEW_BOOTLOADER_ADDRESS
+i
, buffer
, sizeof(buffer
), temp_do_spm
);
294 if ((NEW_BOOTLOADER_ADDRESS
+i
) > (NEW_SPM_ADDRESS
+TEMP_SPM_BLKSIZE
)) break;
298 // continue writeing the new_firmware after "NEW_SPM_ADDRESS+TEMP_SPM_BLKSIZE" this time use the "new_do_spm"
299 for (;i
<SIZEOF_new_firmware
;i
+=SPM_PAGESIZE
) {
300 #ifdef CONFIG_UPDATER_CLEANMEMCLEAR
301 memset((void*)buffer
, 0xff, sizeof(buffer
));
303 memcpy_PF((void*)buffer
, (uint_farptr_t
)((void*)&new_firmware
[i
]), ((SIZEOF_new_firmware
-i
)>sizeof(buffer
))?
sizeof(buffer
):(SIZEOF_new_firmware
-i
));
305 mypgm_WRITEpage(NEW_BOOTLOADER_ADDRESS
+i
, buffer
, sizeof(buffer
), new_do_spm
);