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  *
 109  * REMEMBER: interrupts have to be disabled! (otherwise code may crash non-deterministic)
 110  *
 111  */
 112 void do_spm(const uint32_t flash_byteaddress, const uint8_t spmcrval, const uint8_t r1_highdatabyte, const uint8_t r0_lowdatabyte) {
 113     uint8_t loaddr = (flash_byteaddress >>  0) & 0xff;
 114     uint8_t hiaddr = (flash_byteaddress >>  8) & 0xff;
 115     uint8_t adaddr = (flash_byteaddress >> 16) & 0xff;
 116
 117     asm volatile (
 118     "push r0\n\t"
 119     "push r1\n\t"
 120
 121     "mov r13, %[hiaddr]\n\t"
 122     "mov r12, %[loaddr]\n\t"
 123     "mov r11, %[adaddr]\n\t"
 124
 125
 126     /* high8 of address of bootloader__do_spm */
 127     "ldi r18, %[hi8spmfunc]\n\t"
 128     "mov r31, r18\n\t"
 129
 130     /* low8 of address of bootloader__do_spm */
 131     "ldi r18, %[lo8spmfunc]\n\t"
 132     "mov r30, r18\n\t"
 133
 134     /* also load the spmcrval */
 135     "mov r18, %[spmcrval]\n\t"
 136
 137     /* correkt address of bootloader__do_spm from bytes into words */
 138     "lsr r31\n\t"
 139     "ror r30\n\t"
 140
 141     "mov r1, %[hidata]\n\t"
 142     "mov r0, %[lodata]\n\t"
 143
 144     /* finally call the bootloader-function */
 145     "icall\n\r"
 146
 147     "pop  r1\n\t"
 148     "pop  r0\n\t"
 149
 150     :
 151     : [loaddr] "r" (loaddr), [hiaddr] "r" (hiaddr), [adaddr] "r" (adaddr), [spmcrval] "r" (spmcrval),
 152       [lodata] "r" (r0_lowdatabyte), [hidata] "r" (r1_highdatabyte),
 153       [hi8spmfunc] "M" (funcaddr___bootloader__do_spm >> 8), [lo8spmfunc] "M" (funcaddr___bootloader__do_spm & 0xff)
 154
 155     : "r0","r1","r11","r12","r13","r18"
 156     );
 157 }
 158
 159
 160
 161 #else /*ifndef BOOTLOADER_ADDRESS*/
 162 // this header is used directly within bootloader_do_spm
 163 #include "bootloaderconfig.h"
 164
 165 #if HAVE_SPMINTEREFACE
 166
 167
 168 /*
 169  * insert architecture dependend "bootloader_do_spm"-code
 170  *
 171  * try to make this array as big as possible
 172  * (so bootloader always uses 2kbytes flash)
 173  */
 174 #if defined (__AVR_ATmega8__) || defined (__AVR_ATmega8HVA__)
 175 //assume  SPMCR==0x37, SPMEN==0x0, RWWSRE=0x4, RWWSB=0x6
 176 const uint16_t bootloader__do_spm[17] PROGMEM = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 177                                                  0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 178 /*
 179 00001826 <bootloader__do_spm>:
 180     1826:       00 00           nop
 181     1828:       ec 2d           mov     r30, r12
 182     182a:       fd 2d           mov     r31, r13
 183
 184 0000182c <waitA>:
 185     182c:       b7 b6           in      r11, 0x37       ; 55
 186     182e:       b0 fc           sbrc    r11, 0
 187     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 188     1832:       27 bf           out     0x37, r18       ; 55
 189     1834:       e8 95           spm
 190
 191 00001836 <waitB>:
 192     1836:       b7 b6           in      r11, 0x37       ; 55
 193     1838:       b0 fc           sbrc    r11, 0
 194     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 195     183c:       21 e1           ldi     r18, 0x11       ; 17
 196     183e:       b7 b6           in      r11, 0x37       ; 55
 197     1840:       b6 fc           sbrc    r11, 6
 198     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 199     1844:       08 95           ret
 200 */
 201
 202
 203
 204
 205
 206 #elif defined (__AVR_ATmega48__) || defined (__AVR_ATmega48P__) || defined (__AVR_ATmega88__) || defined (__AVR_ATmega88P__) || defined (__AVR_ATmega168__) || defined (__AVR_ATmega168P__)
 207 //assume  SPMCR:=SPMCSR==0x37, SPMEN:=SELFPRGEN==0x0, RWWSRE=0x4, RWWSB=0x6
 208 const uint16_t bootloader__do_spm[17] PROGMEM = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 209                                                  0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 210 /*
 211 00001826 <bootloader__do_spm>:
 212     1826:       00 00           nop
 213     1828:       ec 2d           mov     r30, r12
 214     182a:       fd 2d           mov     r31, r13
 215
 216 0000182c <waitA>:
 217     182c:       b7 b6           in      r11, 0x37       ; 55
 218     182e:       b0 fc           sbrc    r11, 0
 219     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 220     1832:       27 bf           out     0x37, r18       ; 55
 221     1834:       e8 95           spm
 222
 223 00001836 <waitB>:
 224     1836:       b7 b6           in      r11, 0x37       ; 55
 225     1838:       b0 fc           sbrc    r11, 0
 226     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 227     183c:       21 e1           ldi     r18, 0x11       ; 17
 228     183e:       b7 b6           in      r11, 0x37       ; 55
 229     1840:       b6 fc           sbrc    r11, 6
 230     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 231     1844:       08 95           ret
 232 */
 233
 234
 235
 236
 237
 238 #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__)
 239 //assume  SPMCR:=SPMCSR==0x37, SPMEN:=SELFPRGEN==0x0, RWWSRE=0x4, RWWSB=0x6
 240 const uint16_t bootloader__do_spm[17] PROGMEM = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 241                                                  0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 242 /*
 243 00001826 <bootloader__do_spm>:
 244     1826:       00 00           nop
 245     1828:       ec 2d           mov     r30, r12
 246     182a:       fd 2d           mov     r31, r13
 247
 248 0000182c <waitA>:
 249     182c:       b7 b6           in      r11, 0x37       ; 55
 250     182e:       b0 fc           sbrc    r11, 0
 251     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 252     1832:       27 bf           out     0x37, r18       ; 55
 253     1834:       e8 95           spm
 254
 255 00001836 <waitB>:
 256     1836:       b7 b6           in      r11, 0x37       ; 55
 257     1838:       b0 fc           sbrc    r11, 0
 258     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 259     183c:       21 e1           ldi     r18, 0x11       ; 17
 260     183e:       b7 b6           in      r11, 0x37       ; 55
 261     1840:       b6 fc           sbrc    r11, 6
 262     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 263     1844:       08 95           ret
 264 */
 265
 266
 267
 268
 269
 270 #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__)
 271 //assume  SPMCR:=SPCSR==0x37, SPMEN==0x0, RWWSRE=0x4, RWWSB=0x6
 272 const uint16_t bootloader__do_spm[17] PROGMEM = {0x0000, 0x2dec, 0x2dfd, 0xb6b7, 0xfcb0, 0xcffd, 0xbf27, 0x95e8, 0xb6b7,
 273                                                  0xfcb0, 0xcffd, 0xe121, 0xb6b7, 0xfcb6, 0xcff4, 0x9508, 0xFFFF};
 274 /*
 275 00001826 <bootloader__do_spm>:
 276     1826:       00 00           nop
 277     1828:       ec 2d           mov     r30, r12
 278     182a:       fd 2d           mov     r31, r13
 279
 280 0000182c <waitA>:
 281     182c:       b7 b6           in      r11, 0x37       ; 55
 282     182e:       b0 fc           sbrc    r11, 0
 283     1830:       fd cf           rjmp    .-6             ; 0x182c <waitA>
 284     1832:       27 bf           out     0x37, r18       ; 55
 285     1834:       e8 95           spm
 286
 287 00001836 <waitB>:
 288     1836:       b7 b6           in      r11, 0x37       ; 55
 289     1838:       b0 fc           sbrc    r11, 0
 290     183a:       fd cf           rjmp    .-6             ; 0x1836 <waitB>
 291     183c:       21 e1           ldi     r18, 0x11       ; 17
 292     183e:       b7 b6           in      r11, 0x37       ; 55
 293     1840:       b6 fc           sbrc    r11, 6
 294     1842:       f4 cf           rjmp    .-24            ; 0x182c <waitA>
 295     1844:       08 95           ret
 296 */
 297
 298
 299
 300
 301
 302 #else
 303   #error "bootloader__do_spm has to be adapted, since there is no architecture code, yet"
 304 #endif
 305
 306
 307 #endif
 308 #endif /*ifdef BOOTLOADER_ADDRESS*/
 309
 310 #endif
 311