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