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.4
   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 #include <avr/pgmspace.h>
  90
  91 #ifndef BOOTLOADER_ADDRESS
  92 // this header is the interface for user-code
  93
  94 #ifndef funcaddr___bootloader__do_spm
  95   #if defined (__AVR_ATmega8__) || defined (__AVR_ATmega8HVA__)
  96     #define  funcaddr___bootloader__do_spm 0x1826
  97
  98   #else
  99     #error "unknown MCU - where is bootloader__do_spm located?"
 100   #endif
 101 #endif
 102
 103
 104 /*
 105  * Call the "bootloader__do_spm"-function, located within the BLS via comfortable C-interface
 106  * During operation code will block - disable or reset watchdog before call.
 107  *
 108  * ATTANTION:   Since the underlying "bootloader__do_spm" will automatically reenable the
 109  *              rww-section, only one way to program the flash will work.
 110  *              (First erase the page, then fill temp. buffer, finally program...)
 111  *              Since unblocking rww-section erases the temp. pagebuffer (which happens
 112  *              after a page-erase), first programming this buffer does not help !!
 113  *
 114  * REMEMBER: interrupts have to be disabled! (otherwise code may crash non-deterministic)
 115  *
 116  */
 117 #define __do_spm_Ex(flash_wordaddress, spmcrval, dataword, ___bootloader__do_spm__ptr)          \
 118 ({                                                                                              \
 119     asm volatile (                                                                              \
 120     "push r0\n\t"                                                                               \
 121     "push r1\n\t"                                                                               \
 122                                                                                                 \
 123     "mov r13, %B[flashaddress]\n\t"                                                             \
 124     "mov r12, %A[flashaddress]\n\t"                                                             \
 125     "mov r11, %C[flashaddress]\n\t"                                                             \
 126                                                                                                 \
 127     /* also load the spmcrval */                                                                \
 128     "mov r18, %[spmcrval]\n\t"                                                                  \
 129                                                                                                 \
 130                                                                                                 \
 131     "mov r1, %B[data]\n\t"                                                                      \
 132     "mov r0, %A[data]\n\t"                                                                      \
 133                                                                                                 \
 134     /* finally call the bootloader-function */                                                  \
 135     "icall\n\r"                                                                                 \
 136                                                                                                 \
 137     "pop  r1\n\t"                                                                               \
 138     "pop  r0\n\t"                                                                               \
 139                                                                                                 \
 140     :                                                                                           \
 141     : [flashaddress] "r" (flash_wordaddress),                                                   \
 142       [spmfunctionaddress] "z" (___bootloader__do_spm__ptr),                                    \
 143       [spmcrval] "r" (spmcrval),                                                                \
 144       [data] "r" (dataword)                                                                     \
 145     : "r0","r1","r11","r12","r13","r18"                                                         \
 146     );                                                                                          \
 147 })
 148
 149 void do_spm(const uint32_t flash_byteaddress, const uint8_t spmcrval, const uint16_t dataword) {
 150     __do_spm_Ex(flash_byteaddress, spmcrval, dataword, funcaddr___bootloader__do_spm >> 1);
 151 }
 152
 153
 154
 155 #else /*ifndef BOOTLOADER_ADDRESS*/
 156 // this header is used directly within bootloader_do_spm
 157 #include "bootloaderconfig.h"
 158
 159 #if HAVE_SPMINTEREFACE
 160
 161
 162 /*
 163  * insert architecture dependend "bootloader_do_spm"-code
 164  *
 165  * try to make this array as big as possible
 166  * (so bootloader always uses 2kbytes flash)
 167  */
 168 #if defined (__AVR_ATmega8__) || defined (__AVR_ATmega8HVA__)
 169 //assume  SPMCR==0x37, SPMEN==0x0, RWWSRE=0x4, RWWSB=0x6
 170 const uint16_t bootloader__do_spm[17] PROGMEM = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 171                                                  0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 172 /*
 173 00001826 <bootloader__do_spm>:
 174     1826:       00 00           nop
 175     1828:       ec 2d           mov     r30, r12
 176     182a:       fd 2d           mov     r31, r13
 177
 178 0000182c <waitA>:
 179     182c:       b7 b6           in      r11, 0x37       ; 55
 180     182e:       b0 fc           sbrc    r11, 0
 181     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 182     1832:       27 bf           out     0x37, r18       ; 55
 183     1834:       e8 95           spm
 184
 185 00001836 <waitB>:
 186     1836:       b7 b6           in      r11, 0x37       ; 55
 187     1838:       b0 fc           sbrc    r11, 0
 188     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 189     183c:       21 e1           ldi     r18, 0x11       ; 17
 190     183e:       b7 b6           in      r11, 0x37       ; 55
 191     1840:       b6 fc           sbrc    r11, 6
 192     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 193     1844:       08 95           ret
 194 */
 195
 196
 197
 198
 199
 200 #elif defined (__AVR_ATmega48__) || defined (__AVR_ATmega48P__) || defined (__AVR_ATmega88__) || defined (__AVR_ATmega88P__) || defined (__AVR_ATmega168__) || defined (__AVR_ATmega168P__)
 201 //assume  SPMCR:=SPMCSR==0x37, SPMEN:=SELFPRGEN==0x0, RWWSRE=0x4, RWWSB=0x6
 202 const uint16_t bootloader__do_spm[17] PROGMEM = {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_ATmega48A__) || defined (__AVR_ATmega48PA__) || defined (__AVR_ATmega88A__) || defined (__AVR_ATmega88PA__) || defined (__AVR_ATmega168A__) || defined (__AVR_ATmega168PA__) || defined (__AVR_ATmega328__) || defined (__AVR_ATmega328P__)
 233 //assume  SPMCR:=SPMCSR==0x37, SPMEN:=SELFPRGEN==0x0, RWWSRE=0x4, RWWSB=0x6
 234 const uint16_t bootloader__do_spm[17] PROGMEM = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 235                                                  0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 236 /*
 237 00001826 <bootloader__do_spm>:
 238     1826:       00 00           nop
 239     1828:       ec 2d           mov     r30, r12
 240     182a:       fd 2d           mov     r31, r13
 241
 242 0000182c <waitA>:
 243     182c:       b7 b6           in      r11, 0x37       ; 55
 244     182e:       b0 fc           sbrc    r11, 0
 245     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 246     1832:       27 bf           out     0x37, r18       ; 55
 247     1834:       e8 95           spm
 248
 249 00001836 <waitB>:
 250     1836:       b7 b6           in      r11, 0x37       ; 55
 251     1838:       b0 fc           sbrc    r11, 0
 252     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 253     183c:       21 e1           ldi     r18, 0x11       ; 17
 254     183e:       b7 b6           in      r11, 0x37       ; 55
 255     1840:       b6 fc           sbrc    r11, 6
 256     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 257     1844:       08 95           ret
 258 */
 259
 260
 261
 262
 263
 264 #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__)
 265 //assume  SPMCR:=SPCSR==0x37, SPMEN==0x0, RWWSRE=0x4, RWWSB=0x6
 266 const uint16_t bootloader__do_spm[17] PROGMEM = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 267                                                  0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 268 /*
 269 00001826 <bootloader__do_spm>:
 270     1826:       00 00           nop
 271     1828:       ec 2d           mov     r30, r12
 272     182a:       fd 2d           mov     r31, r13
 273
 274 0000182c <waitA>:
 275     182c:       b7 b6           in      r11, 0x37       ; 55
 276     182e:       b0 fc           sbrc    r11, 0
 277     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 278     1832:       27 bf           out     0x37, r18       ; 55
 279     1834:       e8 95           spm
 280
 281 00001836 <waitB>:
 282     1836:       b7 b6           in      r11, 0x37       ; 55
 283     1838:       b0 fc           sbrc    r11, 0
 284     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 285     183c:       21 e1           ldi     r18, 0x11       ; 17
 286     183e:       b7 b6           in      r11, 0x37       ; 55
 287     1840:       b6 fc           sbrc    r11, 6
 288     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 289     1844:       08 95           ret
 290 */
 291
 292
 293
 294
 295
 296 #else
 297   #error "bootloader__do_spm has to be adapted, since there is no architecture code, yet"
 298 #endif
 299
 300
 301 #endif
 302 #endif /*ifdef BOOTLOADER_ADDRESS*/
 303
 304 #endif
 305