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_ATmega168__) || defined (__AVR_ATmega168P__) || defined (__AVR_ATmega168A__) || defined (__AVR_ATmega168PA__)
 116       #define  funcaddr___bootloader__do_spm 0x3868
 117     #else
 118       #error "unknown MCU - where is bootloader__do_spm located?"
 119     #endif
 120   #endif
 121 #endif
 122
 123
 124 /*
 125  * Call the "bootloader__do_spm"-function, located within the BLS via comfortable C-interface
 126  * During operation code will block - disable or reset watchdog before call.
 127  *
 128  * ATTANTION:   Since the underlying "bootloader__do_spm" will automatically reenable the
 129  *              rww-section, only one way to program the flash will work.
 130  *              (First erase the page, then fill temp. buffer, finally program...)
 131  *              Since unblocking rww-section erases the temp. pagebuffer (which happens
 132  *              after a page-erase), first programming this buffer does not help !!
 133  *
 134  * REMEMBER: interrupts have to be disabled! (otherwise code may crash non-deterministic)
 135  *
 136  */
 137 #define __do_spm_Ex(flash_wordaddress, spmcrval, dataword, ___bootloader__do_spm__ptr)          \
 138 ({                                                                                              \
 139     asm volatile (                                                                              \
 140     "push r0\n\t"                                                                               \
 141     "push r1\n\t"                                                                               \
 142                                                                                                 \
 143     "mov r13, %B[flashaddress]\n\t"                                                             \
 144     "mov r12, %A[flashaddress]\n\t"                                                             \
 145     "mov r11, %C[flashaddress]\n\t"                                                             \
 146                                                                                                 \
 147     /* also load the spmcrval */                                                                \
 148     "mov r18, %[spmcrval]\n\t"                                                                  \
 149                                                                                                 \
 150                                                                                                 \
 151     "mov r1, %B[data]\n\t"                                                                      \
 152     "mov r0, %A[data]\n\t"                                                                      \
 153                                                                                                 \
 154     /* finally call the bootloader-function */                                                  \
 155     "icall\n\r"                                                                                 \
 156                                                                                                 \
 157     "pop  r1\n\t"                                                                               \
 158     "pop  r0\n\t"                                                                               \
 159                                                                                                 \
 160     :                                                                                           \
 161     : [flashaddress] "r" (flash_wordaddress),                                                   \
 162       [spmfunctionaddress] "z" (___bootloader__do_spm__ptr),                                    \
 163       [spmcrval] "r" (spmcrval),                                                                \
 164       [data] "r" (dataword)                                                                     \
 165     : "r0","r1","r11","r12","r13","r18"                                                         \
 166     );                                                                                          \
 167 })
 168
 169
 170 #if (!(defined(BOOTLOADER_ADDRESS))) || (defined(NEW_BOOTLOADER_ADDRESS))
 171 void do_spm(const uint32_t flash_byteaddress, const uint8_t spmcrval, const uint16_t dataword) {
 172     __do_spm_Ex(flash_byteaddress, spmcrval, dataword, funcaddr___bootloader__do_spm >> 1);
 173 }
 174 #endif
 175
 176
 177 #include "bootloaderconfig.h"
 178
 179 #if (HAVE_SPMINTEREFACE) && (defined(BOOTLOADER_ADDRESS)) && (!(defined(NEW_BOOTLOADER_ADDRESS)))
 180
 181 /*
 182  * insert architecture dependend "bootloader_do_spm"-code
 183  *
 184  * try to make this array as big as possible
 185  * (so bootloader always uses 2kbytes flash)
 186  */
 187 #if defined (__AVR_ATmega8__) || defined (__AVR_ATmega8A__) || defined (__AVR_ATmega8HVA__) || defined (__AVR_ATmega32__)
 188
 189 #if defined (__AVR_ATmega8__) || defined (__AVR_ATmega8A__) || defined (__AVR_ATmega8HVA__)
 190   #if (BOOTLOADER_ADDRESS != 0x1800)
 191     #error BOOTLOADER_ADDRESS!=0x1800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 192   #endif
 193 #elif defined (__AVR_ATmega32__)
 194   #if (BOOTLOADER_ADDRESS != 0x7000)
 195     #error BOOTLOADER_ADDRESS!=0x7000, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 196   #endif
 197 #else
 198   #error undefined device selection - this should not happen!
 199 #endif
 200
 201 //assume  SPMCR==0x37, SPMEN==0x0, RWWSRE=0x4, RWWSB=0x6
 202 const uint16_t bootloader__do_spm[17] BOOTLIBLINK = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 203                                                       0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 204 /*
 205 00001826 <bootloader__do_spm>:
 206     1826:       00 00           nop
 207     1828:       ec 2d           mov     r30, r12
 208     182a:       fd 2d           mov     r31, r13
 209
 210 0000182c <waitA>:
 211     182c:       b7 b6           in      r11, 0x37       ; 55
 212     182e:       b0 fc           sbrc    r11, 0
 213     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 214     1832:       27 bf           out     0x37, r18       ; 55
 215     1834:       e8 95           spm
 216
 217 00001836 <waitB>:
 218     1836:       b7 b6           in      r11, 0x37       ; 55
 219     1838:       b0 fc           sbrc    r11, 0
 220     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 221     183c:       21 e1           ldi     r18, 0x11       ; 17
 222     183e:       b7 b6           in      r11, 0x37       ; 55
 223     1840:       b6 fc           sbrc    r11, 6
 224     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 225     1844:       08 95           ret
 226 */
 227
 228
 229
 230
 231
 232 #elif defined (__AVR_ATmega48__) || defined (__AVR_ATmega48P__) || defined (__AVR_ATmega88__) || defined (__AVR_ATmega88P__) || defined (__AVR_ATmega168__) || defined (__AVR_ATmega168P__)
 233 //assume  SPMCR:=SPMCSR==0x37, SPMEN:=SELFPRGEN==0x0, RWWSRE=0x4, RWWSB=0x6
 234 const uint16_t bootloader__do_spm[17] BOOTLIBLINK = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 235                                                       0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 236
 237 #if defined (__AVR_ATmega88__) || defined (__AVR_ATmega88P__)
 238   #if (BOOTLOADER_ADDRESS != 0x1800)
 239     #error BOOTLOADER_ADDRESS!=0x1800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 240   #endif
 241 #elif defined (__AVR_ATmega168__) || defined (__AVR_ATmega168P__)
 242   #if (BOOTLOADER_ADDRESS != 0x3800)
 243     #error BOOTLOADER_ADDRESS!=0x3800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 244   #endif
 245 #else
 246   #error undefined device selection - this should not happen!
 247 #endif
 248
 249 /*
 250 00001826 <bootloader__do_spm>:
 251     1826:       00 00           nop
 252     1828:       ec 2d           mov     r30, r12
 253     182a:       fd 2d           mov     r31, r13
 254
 255 0000182c <waitA>:
 256     182c:       b7 b6           in      r11, 0x37       ; 55
 257     182e:       b0 fc           sbrc    r11, 0
 258     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 259     1832:       27 bf           out     0x37, r18       ; 55
 260     1834:       e8 95           spm
 261
 262 00001836 <waitB>:
 263     1836:       b7 b6           in      r11, 0x37       ; 55
 264     1838:       b0 fc           sbrc    r11, 0
 265     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 266     183c:       21 e1           ldi     r18, 0x11       ; 17
 267     183e:       b7 b6           in      r11, 0x37       ; 55
 268     1840:       b6 fc           sbrc    r11, 6
 269     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 270     1844:       08 95           ret
 271 */
 272
 273
 274
 275
 276
 277 #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__)
 278
 279 #if defined (__AVR_ATmega88A__) || defined (__AVR_ATmega88PA__)
 280   #if (BOOTLOADER_ADDRESS != 0x1800)
 281     #error BOOTLOADER_ADDRESS!=0x1800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 282   #endif
 283 #elif defined (__AVR_ATmega168A__) || defined (__AVR_ATmega168PA__)
 284   #if (BOOTLOADER_ADDRESS != 0x3800)
 285     #error BOOTLOADER_ADDRESS!=0x3800, on current MCU "funcaddr___bootloader__do_spm" might be currupted - please edit spminterface.h for nonstandard use
 286   #endif
 287 #else
 288   #error undefined device selection - this should not happen!
 289 #endif
 290
 291 //assume  SPMCR:=SPMCSR==0x37, SPMEN:=SELFPRGEN==0x0, RWWSRE=0x4, RWWSB=0x6
 292 const uint16_t bootloader__do_spm[17] BOOTLIBLINK = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 293                                                      0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 294 /*
 295 00001826 <bootloader__do_spm>:
 296     1826:       00 00           nop
 297     1828:       ec 2d           mov     r30, r12
 298     182a:       fd 2d           mov     r31, r13
 299
 300 0000182c <waitA>:
 301     182c:       b7 b6           in      r11, 0x37       ; 55
 302     182e:       b0 fc           sbrc    r11, 0
 303     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 304     1832:       27 bf           out     0x37, r18       ; 55
 305     1834:       e8 95           spm
 306
 307 00001836 <waitB>:
 308     1836:       b7 b6           in      r11, 0x37       ; 55
 309     1838:       b0 fc           sbrc    r11, 0
 310     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 311     183c:       21 e1           ldi     r18, 0x11       ; 17
 312     183e:       b7 b6           in      r11, 0x37       ; 55
 313     1840:       b6 fc           sbrc    r11, 6
 314     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 315     1844:       08 95           ret
 316 */
 317
 318
 319
 320
 321
 322 #elif defined (__AVR_ATmega164A__) || defined (__AVR_ATmega164PA__) || defined (__AVR_ATmega324A__) || defined (__AVR_ATmega324PA__) || defined (__AVR_ATmega644A__) || defined (__AVR_ATmega644PA__) || defined (__AVR_ATmega1284__) || defined (__AVR_ATmega1284P__)
 323 //assume  SPMCR:=SPCSR==0x37, SPMEN==0x0, RWWSRE=0x4, RWWSB=0x6 and rampZ=0x3b
 324 const uint16_t bootloader__do_spm[17] BOOTLIBLINK = {0xbebb, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 325                                                      0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 326 /*
 327 00001826 <bootloader__do_spm>:
 328     1826:       bb be           out     0x3b,r11        ; rampZ=r11; (rampZ is at IO 0x3b)
 329     1828:       ec 2d           mov     r30, r12
 330     182a:       fd 2d           mov     r31, r13
 331
 332 0000182c <waitA>:
 333     182c:       b7 b6           in      r11, 0x37       ; 55
 334     182e:       b0 fc           sbrc    r11, 0
 335     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 336     1832:       27 bf           out     0x37, r18       ; 55
 337     1834:       e8 95           spm
 338
 339 00001836 <waitB>:
 340     1836:       b7 b6           in      r11, 0x37       ; 55
 341     1838:       b0 fc           sbrc    r11, 0
 342     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 343     183c:       21 e1           ldi     r18, 0x11       ; 17
 344     183e:       b7 b6           in      r11, 0x37       ; 55
 345     1840:       b6 fc           sbrc    r11, 6
 346     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 347     1844:       08 95           ret
 348 */
 349
 350
 351
 352
 353
 354 #else
 355   #error "bootloader__do_spm has to be adapted, since there is no architecture code, yet"
 356 #endif
 357
 358
 359 #endif
 360
 361 #endif
 362