firmware/spminterface.h

   1 /* Name: spminterface.h
   2  * Project: USBaspLoader
   3  * Author: Stephan Baerwolf
   4  * Creation Date: 2012-08-01
   5  * Copyright: (c) 2012 by Stephan Baerwolf
   6  * License: GNU GPL v2 (see License.txt)
   7  * Version: 0.8
   8  */
   9
  10 #ifndef SPMINTERFACE_H_f70ba6adf7624275947e859bdbff0599
  11 #define SPMINTERFACE_H_f70ba6adf7624275947e859bdbff0599
  12
  13 /*
  14  * spminterface.h offers a lightweight interface by inserting
  15  * an small machine-subroutine into the bootsection. (right
  16  * after the interrupt-vector-table)
  17  * This subroutine can be called by normal code in order to
  18  * enable it to program the flash (and depending on BLB11-lockbit
  19  * also the bootsection itself). Since SPM-calls from RWW-sections
  20  * will fail to work. The routine will be called "bootloader__do_spm".
  21  * Its principle assembler-code is depicted below (real code is a
  22  * little machinedependend).
  23  * Interfaces will be the 8-bit registers r10..r13, for details
  24  * also see below. As also the pageaddress-registes (Z and rampZ)
  25  * are interfaced via different registers, it is possible to call
  26  * this routine via indirect call (icall).
  27  * Traditionally it is also possible to rcall, therefore you can
  28  * define "bootloader__do_spm" for your normal code via defsym at
  29  * linking time.
  30  * Example for an atmega8: "-Wl,--defsym=transfer_point=0x1826"
  31  * (since BOOTLOADER_ADDRESS is 0x1800 and there are
  32  * 2x19 = 38 = 0x26 byte for interrupts)
  33  *
  34
  35 bootloader__do_spm:
  36 ;disable interrupts (if enabled) before calling!
  37 ;you may also want to disable wdt, since this routine may busy-loop
  38 ;==================================================================
  39 ;-->INPUT:
  40 ;spmcr (spmcrval determines SPM action) will be register:       r18
  41 ;MCU dependend RA(MPZ should be transfered within register:     r11
  42 ;lo8(Z) should be transfered within register:                   r12
  43 ;hi8(Z) should be transfered within register:                   r13
  44 ;( as definition of SPM low8bit of dataword are stored within   r0 )
  45 ;( as definition of SPM hi8bit  of dataword are stored within   r1 )
  46
  47 ;<-->USED/CHANGED:
  48 ;temp0 will be register:                                        r11
  49 ;temp1 will be register:                                        r12
  50 ;temp2 will be register:                                        r13
  51 ;spmcrval (r18) may also be changed due to rww reenable-phase   r18
  52 ;Z (r31:r30) wil be changed during operation
  53
  54 ;<--OUT:
  55 ;==================================================================
  56 ; TODO: waitA and waitB could be merged to subroutine saving 2 opc
  57 ;==================================================================
  58
  59 ;load pageaddress (Z) from (r11:)r13:12 since it may was used for icall
  60 mov     rampZ,  r11
  61 mov     r30,    r12
  62 mov     r31,    r13
  63
  64 waitA:                  ;check for pending SPM complete
  65 in      temp0, SPMCR
  66 sbrc    temp0, SPMEN
  67 rjmp    waitA
  68
  69 out     SPMCR, spmcrval ;SPM timed sequence
  70 spm
  71
  72 waitB:                  ;check for previous SPM complete
  73 in      temp0, SPMCR
  74 sbrc    temp0, SPMEN
  75 rjmp    waitB
  76
  77 ;avoid crash of userapplication
  78 ldi     spmcrval, ((1<<RWWSRE) | (1<<SPMEN))
  79 in      temp0,    SPMCR
  80 sbrc    temp0,    RWWSB
  81 rjmp    waitA
  82
  83 ret
  84
  85 *
  86 */
  87
  88 #include <avr/io.h>
  89
  90
  91
  92 /*
  93  * This MACRO commands the linker to place correspondig
  94  * data on the top of the firmware. (Right after the
  95  * interrupt-vector-table)
  96  * This is necessary to always locate the
  97  * "bootloader__do_spm" for example at 0x1826, even if
  98  * there are existing PROGMEM within the firmware...
  99  */
 100 #define BOOTLIBLINK __attribute__ ((section (".vectors") ))
 101
 102
 103 #ifndef funcaddr___bootloader__do_spm
 104   #if (defined(BOOTLOADER_ADDRESS)) && (!(defined(NEW_BOOTLOADER_ADDRESS)))
 105     #if HAVE_SPMINTEREFACE
 106       #define  funcaddr___bootloader__do_spm (&bootloader__do_spm)
 107     #endif
 108   #else
 109     #if defined (__AVR_ATmega8__) || defined (__AVR_ATmega8A__) || defined (__AVR_ATmega8HVA__)
 110       #define  funcaddr___bootloader__do_spm 0x1826
 111     #elif defined (__AVR_ATmega32__)
 112       #define  funcaddr___bootloader__do_spm 0x7054
 113     #elif defined (__AVR_ATmega88__) || defined (__AVR_ATmega88P__) || defined (__AVR_ATmega88A__) || defined (__AVR_ATmega88PA__)
 114       #define  funcaddr___bootloader__do_spm 0x1834
 115     #elif defined (__AVR_ATmega164A__) || defined (__AVR_ATmega164P__) || defined (__AVR_ATmega164PA__)
 116       #define  funcaddr___bootloader__do_spm 0x387c
 117     #elif defined (__AVR_ATmega168__) || defined (__AVR_ATmega168P__) || defined (__AVR_ATmega168A__) || defined (__AVR_ATmega168PA__)
 118       #define  funcaddr___bootloader__do_spm 0x3868
 119     #elif defined (__AVR_ATmega324A__) || defined (__AVR_ATmega324P__) || defined (__AVR_ATmega324PA__)
 120       #define  funcaddr___bootloader__do_spm 0x707c
 121     #elif defined (__AVR_ATmega328__) || defined (__AVR_ATmega328P__)
 122       #define  funcaddr___bootloader__do_spm 0x7068
 123     #elif defined (__AVR_ATmega644__) || defined (__AVR_ATmega644A__) || defined (__AVR_ATmega644P__) || defined (__AVR_ATmega644PA__)
 124       #define  funcaddr___bootloader__do_spm 0xe07c
 125     #elif defined (__AVR_ATmega1284__) || defined (__AVR_ATmega1284P__)
 126       #define  funcaddr___bootloader__do_spm 0x1e08c
 127     #else
 128       #error "unknown MCU - where is bootloader__do_spm located?"
 129     #endif
 130   #endif
 131 #endif
 132
 133
 134 /*
 135  * Call the "bootloader__do_spm"-function, located within the BLS via comfortable C-interface
 136  * During operation code will block - disable or reset watchdog before call.
 137  *
 138  * ATTANTION:   Since the underlying "bootloader__do_spm" will automatically reenable the
 139  *              rww-section, only one way to program the flash will work.
 140  *              (First erase the page, then fill temp. buffer, finally program...)
 141  *              Since unblocking rww-section erases the temp. pagebuffer (which happens
 142  *              after a page-erase), first programming this buffer does not help !!
 143  *
 144  * REMEMBER: interrupts have to be disabled! (otherwise code may crash non-deterministic)
 145  *
 146  */
 147 #define __do_spm_Ex(flash_wordaddress, spmcrval, dataword, ___bootloader__do_spm__ptr)          \
 148 ({                                                                                              \
 149     asm volatile (                                                                              \
 150     "push r0\n\t"                                                                               \
 151     "push r1\n\t"                                                                               \
 152                                                                                                 \
 153     "mov r13, %B[flashaddress]\n\t"                                                             \
 154     "mov r12, %A[flashaddress]\n\t"                                                             \
 155     "mov r11, %C[flashaddress]\n\t"                                                             \
 156                                                                                                 \
 157     /* also load the spmcrval */                                                                \
 158     "mov r18, %[spmcrval]\n\t"                                                                  \
 159                                                                                                 \
 160                                                                                                 \
 161     "mov r1, %B[data]\n\t"                                                                      \
 162     "mov r0, %A[data]\n\t"                                                                      \
 163                                                                                                 \
 164     /* finally call the bootloader-function */                                                  \
 165     "icall\n\r"                                                                                 \
 166                                                                                                 \
 167     "pop  r1\n\t"                                                                               \
 168     "pop  r0\n\t"                                                                               \
 169                                                                                                 \
 170     :                                                                                           \
 171     : [flashaddress] "r" (flash_wordaddress),                                                   \
 172       [spmfunctionaddress] "z" (___bootloader__do_spm__ptr),                                    \
 173       [spmcrval] "r" (spmcrval),                                                                \
 174       [data] "r" (dataword)                                                                     \
 175     : "r0","r1","r11","r12","r13","r18"                                                         \
 176     );                                                                                          \
 177 })
 178
 179
 180 #if (!(defined(BOOTLOADER_ADDRESS))) || (defined(NEW_BOOTLOADER_ADDRESS))
 181 void do_spm(const uint32_t flash_byteaddress, const uint8_t spmcrval, const uint16_t dataword) {
 182     __do_spm_Ex(flash_byteaddress, spmcrval, dataword, funcaddr___bootloader__do_spm >> 1);
 183 }
 184 #endif
 185
 186
 187 #include "bootloaderconfig.h"
 188
 189 #if (HAVE_SPMINTEREFACE) && (defined(BOOTLOADER_ADDRESS)) && (!(defined(NEW_BOOTLOADER_ADDRESS)))
 190
 191 /*
 192  * insert architecture dependend "bootloader_do_spm"-code
 193  *
 194  * try to make this array as big as possible
 195  * (so bootloader always uses 2kbytes flash)
 196  */
 197 #if defined (__AVR_ATmega8__) || defined (__AVR_ATmega8A__) || defined (__AVR_ATmega8HVA__) || defined (__AVR_ATmega32__)
 198
 199 #if defined (__AVR_ATmega8__) || defined (__AVR_ATmega8A__) || defined (__AVR_ATmega8HVA__)
 200   #if (BOOTLOADER_ADDRESS != 0x1800)
 201     #error BOOTLOADER_ADDRESS!=0x1800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 202   #endif
 203 #elif defined (__AVR_ATmega32__)
 204   #if (BOOTLOADER_ADDRESS != 0x7000)
 205     #error BOOTLOADER_ADDRESS!=0x7000, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 206   #endif
 207 #else
 208   #error undefined device selection - this should not happen!
 209 #endif
 210
 211 //assume  SPMCR==0x37, SPMEN==0x0, RWWSRE=0x4, RWWSB=0x6
 212 const uint16_t bootloader__do_spm[17] BOOTLIBLINK = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 213                                                       0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 214 /*
 215 00001826 <bootloader__do_spm>:
 216     1826:       00 00           nop
 217     1828:       ec 2d           mov     r30, r12
 218     182a:       fd 2d           mov     r31, r13
 219
 220 0000182c <waitA>:
 221     182c:       b7 b6           in      r11, 0x37       ; 55
 222     182e:       b0 fc           sbrc    r11, 0
 223     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 224     1832:       27 bf           out     0x37, r18       ; 55
 225     1834:       e8 95           spm
 226
 227 00001836 <waitB>:
 228     1836:       b7 b6           in      r11, 0x37       ; 55
 229     1838:       b0 fc           sbrc    r11, 0
 230     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 231     183c:       21 e1           ldi     r18, 0x11       ; 17
 232     183e:       b7 b6           in      r11, 0x37       ; 55
 233     1840:       b6 fc           sbrc    r11, 6
 234     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 235     1844:       08 95           ret
 236 */
 237
 238
 239
 240
 241
 242 #elif defined (__AVR_ATmega48__) || defined (__AVR_ATmega48P__) || defined (__AVR_ATmega88__) || defined (__AVR_ATmega88P__) || defined (__AVR_ATmega168__) || defined (__AVR_ATmega168P__)
 243 //assume  SPMCR:=SPMCSR==0x37, SPMEN:=SELFPRGEN==0x0, RWWSRE=0x4, RWWSB=0x6
 244 const uint16_t bootloader__do_spm[17] BOOTLIBLINK = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 245                                                       0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 246
 247 #if defined (__AVR_ATmega88__) || defined (__AVR_ATmega88P__)
 248   #if (BOOTLOADER_ADDRESS != 0x1800)
 249     #error BOOTLOADER_ADDRESS!=0x1800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 250   #endif
 251 #elif defined (__AVR_ATmega168__) || defined (__AVR_ATmega168P__)
 252   #if (BOOTLOADER_ADDRESS != 0x3800)
 253     #error BOOTLOADER_ADDRESS!=0x3800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 254   #endif
 255 #else
 256   #error undefined device selection - this should not happen!
 257 #endif
 258
 259 /*
 260 00001826 <bootloader__do_spm>:
 261     1826:       00 00           nop
 262     1828:       ec 2d           mov     r30, r12
 263     182a:       fd 2d           mov     r31, r13
 264
 265 0000182c <waitA>:
 266     182c:       b7 b6           in      r11, 0x37       ; 55
 267     182e:       b0 fc           sbrc    r11, 0
 268     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 269     1832:       27 bf           out     0x37, r18       ; 55
 270     1834:       e8 95           spm
 271
 272 00001836 <waitB>:
 273     1836:       b7 b6           in      r11, 0x37       ; 55
 274     1838:       b0 fc           sbrc    r11, 0
 275     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 276     183c:       21 e1           ldi     r18, 0x11       ; 17
 277     183e:       b7 b6           in      r11, 0x37       ; 55
 278     1840:       b6 fc           sbrc    r11, 6
 279     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 280     1844:       08 95           ret
 281 */
 282
 283
 284
 285
 286
 287 #elif defined (__AVR_ATmega48A__) || defined (__AVR_ATmega48PA__) || defined (__AVR_ATmega88A__) || defined (__AVR_ATmega88PA__) || defined (__AVR_ATmega168A__) || defined (__AVR_ATmega168PA__) || defined (__AVR_ATmega328__) || defined (__AVR_ATmega328P__)
 288
 289 #if defined (__AVR_ATmega88A__) || defined (__AVR_ATmega88PA__)
 290   #if (BOOTLOADER_ADDRESS != 0x1800)
 291     #error BOOTLOADER_ADDRESS!=0x1800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 292   #endif
 293 #elif defined (__AVR_ATmega168A__) || defined (__AVR_ATmega168PA__)
 294   #if (BOOTLOADER_ADDRESS != 0x3800)
 295     #error BOOTLOADER_ADDRESS!=0x3800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 296   #endif
 297 #elif defined (__AVR_ATmega328__) || defined (__AVR_ATmega328P__)
 298   #if (BOOTLOADER_ADDRESS != 0x7000)
 299     #error BOOTLOADER_ADDRESS!=0x7000, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 300   #endif
 301 #else
 302   #error undefined device selection - this should not happen!
 303 #endif
 304
 305 //assume  SPMCR:=SPMCSR==0x37, SPMEN:=SELFPRGEN==0x0, RWWSRE=0x4, RWWSB=0x6
 306 const uint16_t bootloader__do_spm[17] BOOTLIBLINK = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 307                                                       0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 308 /*
 309 00001826 <bootloader__do_spm>:
 310     1826:       00 00           nop
 311     1828:       ec 2d           mov     r30, r12
 312     182a:       fd 2d           mov     r31, r13
 313
 314 0000182c <waitA>:
 315     182c:       b7 b6           in      r11, 0x37       ; 55
 316     182e:       b0 fc           sbrc    r11, 0
 317     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 318     1832:       27 bf           out     0x37, r18       ; 55
 319     1834:       e8 95           spm
 320
 321 00001836 <waitB>:
 322     1836:       b7 b6           in      r11, 0x37       ; 55
 323     1838:       b0 fc           sbrc    r11, 0
 324     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 325     183c:       21 e1           ldi     r18, 0x11       ; 17
 326     183e:       b7 b6           in      r11, 0x37       ; 55
 327     1840:       b6 fc           sbrc    r11, 6
 328     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 329     1844:       08 95           ret
 330 */
 331
 332
 333
 334
 335
 336 #elif defined (__AVR_ATmega164A__) || defined (__AVR_ATmega164P__) || defined (__AVR_ATmega164PA__) || defined (__AVR_ATmega324A__) || defined (__AVR_ATmega324P__) || defined (__AVR_ATmega324PA__) || defined (__AVR_ATmega644__) || defined (__AVR_ATmega644A__) || defined (__AVR_ATmega644P__) || defined (__AVR_ATmega644PA__) || defined (__AVR_ATmega1284__) || defined (__AVR_ATmega1284P__)
 337 //assume  SPMCR:=SPCSR==0x37, SPMEN==0x0, RWWSRE=0x4, RWWSB=0x6 and rampZ=0x3b
 338 const uint16_t bootloader__do_spm[17] BOOTLIBLINK = {0xbebb, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 339                                                       0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 340
 341 #if defined (__AVR_ATmega164A__) || defined (__AVR_ATmega164P__) || defined (__AVR_ATmega164PA__)
 342   #if (BOOTLOADER_ADDRESS != 0x3800)
 343     #error BOOTLOADER_ADDRESS!=0x3800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 344   #endif
 345 #elif defined (__AVR_ATmega324A__) || defined (__AVR_ATmega324P__) || defined (__AVR_ATmega324PA__)
 346   #if (BOOTLOADER_ADDRESS != 0x7000)
 347     #error BOOTLOADER_ADDRESS!=0x7000, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 348   #endif
 349 #elif defined (__AVR_ATmega644__) || defined (__AVR_ATmega644A__) || defined (__AVR_ATmega644P__) || defined (__AVR_ATmega644PA__)
 350   #if (BOOTLOADER_ADDRESS != 0xE000)
 351     #error BOOTLOADER_ADDRESS!=0xE000, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 352   #endif
 353 #elif defined (__AVR_ATmega1284__) || defined (__AVR_ATmega1284P__)
 354   #if (BOOTLOADER_ADDRESS != 0x1E000)
 355     #error BOOTLOADER_ADDRESS!=0x1E000, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 356   #endif
 357 #else
 358   #error undefined device selection - this should not happen!
 359 #endif
 360
 361 /*
 362 00001826 <bootloader__do_spm>:
 363     1826:       bb be           out     0x3b,r11        ; rampZ=r11; (rampZ is at IO 0x3b)
 364     1828:       ec 2d           mov     r30, r12
 365     182a:       fd 2d           mov     r31, r13
 366
 367 0000182c <waitA>:
 368     182c:       b7 b6           in      r11, 0x37       ; 55
 369     182e:       b0 fc           sbrc    r11, 0
 370     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 371     1832:       27 bf           out     0x37, r18       ; 55
 372     1834:       e8 95           spm
 373
 374 00001836 <waitB>:
 375     1836:       b7 b6           in      r11, 0x37       ; 55
 376     1838:       b0 fc           sbrc    r11, 0
 377     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 378     183c:       21 e1           ldi     r18, 0x11       ; 17
 379     183e:       b7 b6           in      r11, 0x37       ; 55
 380     1840:       b6 fc           sbrc    r11, 6
 381     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 382     1844:       08 95           ret
 383 */
 384
 385
 386
 387
 388
 389 #else
 390   #error "bootloader__do_spm has to be adapted, since there is no architecture code, yet"
 391 #endif
 392
 393
 394 #endif
 395
 396 #endif
 397