firmware/main.c

   1 /* Name: main.c
   2  * Project: USBaspLoader
   3  * Author: Christian Starkjohann
   4  * Creation Date: 2007-12-08
   5  * Tabsize: 4
   6  * Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH
   7  * License: GNU GPL v2 (see License.txt)
   8  * This Revision: $Id: main.c 786 2010-05-30 20:41:40Z cs $
   9  */
  10
  11 #include "spminterface.h"  /* must be included as first! */
  12
  13 #include <avr/io.h>
  14 #include <avr/interrupt.h>
  15 #include <avr/pgmspace.h>
  16 #include <avr/wdt.h>
  17 #include <avr/boot.h>
  18 #include <avr/eeprom.h>
  19 #include <util/delay.h>
  20
  21
  22 #if 0
  23 /*
  24  * 29.09.2012 /  30.09.2012
  25  *
  26  * Since cpufunc.h is not needed in this context and
  27  * since it is not available in all toolchains, this include
  28  * becomes deactivated by github issue-report.
  29  * (In case of trouble it remains in sourcecode for reactivation.)
  30  *
  31  * The autor would like to thank Lena-M for reporting this
  32  * issue (https://github.com/baerwolf/USBaspLoader/issues/1).
  33  */
  34 #include <avr/cpufunc.h>
  35 #endif
  36
  37 #include <avr/boot.h>
  38
  39 #include <string.h>
  40
  41
  42
  43 static void leaveBootloader() __attribute__((__noreturn__));
  44
  45 #include "bootloaderconfig.h"
  46 #include "usbdrv/usbdrv.c"
  47
  48 #ifndef BOOTLOADER_ADDRESS
  49   #error need to know the bootloaders flash address!
  50 #endif
  51
  52 /* ------------------------------------------------------------------------ */
  53
  54 /* Request constants used by USBasp */
  55 #define USBASP_FUNC_CONNECT         1
  56 #define USBASP_FUNC_DISCONNECT      2
  57 #define USBASP_FUNC_TRANSMIT        3
  58 #define USBASP_FUNC_READFLASH       4
  59 #define USBASP_FUNC_ENABLEPROG      5
  60 #define USBASP_FUNC_WRITEFLASH      6
  61 #define USBASP_FUNC_READEEPROM      7
  62 #define USBASP_FUNC_WRITEEEPROM     8
  63 #define USBASP_FUNC_SETLONGADDRESS  9
  64
  65 // additional USBasp Commands
  66 #define USBASP_FUNC_SETISPSCK        10
  67 #define USBASP_FUNC_TPI_CONNECT      11
  68 #define USBASP_FUNC_TPI_DISCONNECT   12
  69 #define USBASP_FUNC_TPI_RAWREAD      13
  70 #define USBASP_FUNC_TPI_RAWWRITE     14
  71 #define USBASP_FUNC_TPI_READBLOCK    15
  72 #define USBASP_FUNC_TPI_WRITEBLOCK   16
  73 #define USBASP_FUNC_GETCAPABILITIES 127
  74 /* ------------------------------------------------------------------------ */
  75
  76 #ifndef ulong
  77 #   define ulong    unsigned long
  78 #endif
  79 #ifndef uint
  80 #   define uint     unsigned int
  81 #endif
  82
  83 /* defaults if not in config file: */
  84 #ifndef HAVE_EEPROM_PAGED_ACCESS
  85 #   define HAVE_EEPROM_PAGED_ACCESS 0
  86 #endif
  87 #ifndef HAVE_EEPROM_BYTE_ACCESS
  88 #   define HAVE_EEPROM_BYTE_ACCESS  0
  89 #endif
  90 #ifndef BOOTLOADER_CAN_EXIT
  91 #   define  BOOTLOADER_CAN_EXIT     0
  92 #endif
  93
  94 /* allow compatibility with avrusbboot's bootloaderconfig.h: */
  95 #ifdef BOOTLOADER_INIT
  96 #   define bootLoaderInit()         BOOTLOADER_INIT
  97 #   define bootLoaderExit()
  98 #endif
  99 #ifdef BOOTLOADER_CONDITION
 100 #   define bootLoaderCondition()    BOOTLOADER_CONDITION
 101 #endif
 102
 103 /* device compatibility: */
 104 #ifndef GICR    /* ATMega*8 don't have GICR, use MCUCR instead */
 105 #   define GICR     MCUCR
 106 #endif
 107
 108 /* ------------------------------------------------------------------------ */
 109
 110 #if (FLASHEND) > 0xffff /* we need long addressing */
 111 #   define CURRENT_ADDRESS  currentAddress.l
 112 #   define addr_t           ulong
 113 #else
 114 #   define CURRENT_ADDRESS  currentAddress.w[0]
 115 #   define addr_t           uint
 116 #endif
 117
 118 typedef union longConverter{
 119     addr_t  l;
 120     uint    w[sizeof(addr_t)/2];
 121     uchar   b[sizeof(addr_t)];
 122 }longConverter_t;
 123
 124
 125 #if BOOTLOADER_CAN_EXIT
 126 static uchar                    requestBootLoaderExit;
 127 #endif
 128 static volatile unsigned char   stayinloader = 0xfe;
 129
 130 static longConverter_t          currentAddress; /* in bytes */
 131 static uchar                    bytesRemaining;
 132 static uchar                    isLastPage;
 133 #if HAVE_EEPROM_PAGED_ACCESS
 134 static uchar                    currentRequest;
 135 #else
 136 static const uchar              currentRequest = 0;
 137 #endif
 138
 139 static const uchar  signatureBytes[4] = {
 140 #ifdef SIGNATURE_BYTES
 141     SIGNATURE_BYTES
 142 #elif defined (__AVR_ATmega8__) || defined (__AVR_ATmega8A__) || defined (__AVR_ATmega8HVA__)
 143     0x1e, 0x93, 0x07, 0
 144 #elif defined (__AVR_ATmega48__) || defined (__AVR_ATmega48A__) || defined (__AVR_ATmega48P__)
 145     0x1e, 0x92, 0x05, 0
 146 #elif defined (__AVR_ATmega48PA__)
 147     0x1e, 0x92, 0x0A, 0
 148 #elif defined (__AVR_ATmega88__) || defined (__AVR_ATmega88A__) || defined (__AVR_ATmega88P__)
 149     0x1e, 0x93, 0x0a, 0
 150 #elif defined (__AVR_ATmega88PA__)
 151     0x1e, 0x93, 0x0F, 0
 152 #elif defined (__AVR_ATmega164A__)
 153     0x1e, 0x94, 0x0f, 0
 154 #elif defined (__AVR_ATmega164P__)
 155     0x1e, 0x94, 0x0a, 0
 156 #elif defined (__AVR_ATmega168__) || defined (__AVR_ATmega168A__) || defined (__AVR_ATmega168P__)
 157     0x1e, 0x94, 0x06, 0
 158 #elif defined (__AVR_ATmega168PA__)
 159     0x1e, 0x94, 0x0B, 0
 160 #elif defined (__AVR_ATmega32__)
 161     0x1e, 0x95, 0x02, 0
 162 #elif defined (__AVR_ATmega324A__)
 163     0x1e, 0x95, 0x15, 0
 164 #elif defined (__AVR_ATmega324P__)
 165     0x1e, 0x95, 0x08, 0
 166 #elif defined (__AVR_ATmega328__)
 167     0x1e, 0x95, 0x14, 0
 168 #elif defined (__AVR_ATmega328P__)
 169     0x1e, 0x95, 0x0f, 0
 170 #elif defined (__AVR_ATmega644__) || defined (__AVR_ATmega644A__)
 171     0x1e, 0x96, 0x09, 0
 172 #elif defined (__AVR_ATmega644P__) || defined (__AVR_ATmega644PA__)
 173     0x1e, 0x96, 0x0a, 0
 174 #elif defined (__AVR_ATmega128__)
 175     0x1e, 0x97, 0x02, 0
 176 #elif defined (__AVR_ATmega1284__)
 177     0x1e, 0x97, 0x06, 0
 178 #elif defined (__AVR_ATmega1284P__)
 179     0x1e, 0x97, 0x05, 0
 180 #else
 181 #   error "Device signature is not known, please edit main.c!"
 182 #endif
 183 };
 184
 185 /* ------------------------------------------------------------------------ */
 186
 187 static void (*nullVector)(void) __attribute__((__noreturn__));
 188
 189 static void leaveBootloader()
 190 {
 191     DBG1(0x01, 0, 0);
 192     cli();
 193     usbDeviceDisconnect();
 194     bootLoaderExit();
 195     USB_INTR_ENABLE = 0;
 196     USB_INTR_CFG = 0;       /* also reset config bits */
 197     GICR = (1 << IVCE);     /* enable change of interrupt vectors */
 198     GICR = (0 << IVSEL);    /* move interrupts to application flash section */
 199
 200 /* We must go through a global function pointer variable instead of writing
 201  *  ((void (*)(void))0)();
 202  * because the compiler optimizes a constant 0 to "rcall 0" which is not
 203  * handled correctly by the assembler.
 204  */
 205     nullVector();
 206 }
 207
 208 /* ------------------------------------------------------------------------ */
 209
 210 uchar   usbFunctionSetup(uchar data[8])
 211 {
 212 usbRequest_t    *rq = (void *)data;
 213 uchar           len = 0;
 214 static uchar    replyBuffer[4];
 215
 216     usbMsgPtr = replyBuffer;
 217     if(rq->bRequest == USBASP_FUNC_TRANSMIT){   /* emulate parts of ISP protocol */
 218         uchar rval = 0;
 219         usbWord_t address;
 220         address.bytes[1] = rq->wValue.bytes[1];
 221         address.bytes[0] = rq->wIndex.bytes[0];
 222         if(rq->wValue.bytes[0] == 0x30){        /* read signature */
 223             rval = rq->wIndex.bytes[0] & 3;
 224             rval = signatureBytes[rval];
 225 #if HAVE_READ_LOCK_FUSE
 226 #if defined (__AVR_ATmega8__) || defined (__AVR_ATmega8A__) || defined (__AVR_ATmega32__)
 227         }else if(rq->wValue.bytes[0] == 0x58 && rq->wValue.bytes[1] == 0x00){  /* read lock bits */
 228             rval = boot_lock_fuse_bits_get(GET_LOCK_BITS);
 229         }else if(rq->wValue.bytes[0] == 0x50 && rq->wValue.bytes[1] == 0x00){  /* read lfuse bits */
 230             rval = boot_lock_fuse_bits_get(GET_LOW_FUSE_BITS);
 231         }else if(rq->wValue.bytes[0] == 0x58 && rq->wValue.bytes[1] == 0x08){  /* read hfuse bits */
 232             rval = boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS);
 233
 234 #elif defined (__AVR_ATmega48__)   || defined (__AVR_ATmega48A__)   || defined (__AVR_ATmega48P__)   || defined (__AVR_ATmega48PA__)  ||  \
 235       defined (__AVR_ATmega88__)   || defined (__AVR_ATmega88A__)   || defined (__AVR_ATmega88P__)   || defined (__AVR_ATmega88PA__)  ||  \
 236       defined (__AVR_ATmega164A__) || defined (__AVR_ATmega164P__)  ||                                                                \
 237       defined (__AVR_ATmega168__)  || defined (__AVR_ATmega168A__)  || defined (__AVR_ATmega168P__)  || defined (__AVR_ATmega168PA__) ||  \
 238       defined (__AVR_ATmega324A__) || defined (__AVR_ATmega324P__)  ||                                                                \
 239       defined (__AVR_ATmega328__)  || defined (__AVR_ATmega328P__)  ||                                                                \
 240       defined (__AVR_ATmega644__)  || defined (__AVR_ATmega644A__)  || defined (__AVR_ATmega644P__) || defined (__AVR_ATmega644PA__)  ||  \
 241       defined (__AVR_ATmega128__)  ||                                                                                                         \
 242       defined (__AVR_ATmega1284__) || defined (__AVR_ATmega1284P__)
 243         }else if(rq->wValue.bytes[0] == 0x58 && rq->wValue.bytes[1] == 0x00){  /* read lock bits */
 244             rval = boot_lock_fuse_bits_get(GET_LOCK_BITS);
 245         }else if(rq->wValue.bytes[0] == 0x50 && rq->wValue.bytes[1] == 0x00){  /* read lfuse bits */
 246             rval = boot_lock_fuse_bits_get(GET_LOW_FUSE_BITS);
 247         }else if(rq->wValue.bytes[0] == 0x58 && rq->wValue.bytes[1] == 0x08){  /* read hfuse bits */
 248             rval = boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS);
 249         }else if(rq->wValue.bytes[0] == 0x50 && rq->wValue.bytes[1] == 0x08){  /* read efuse bits */
 250             rval = boot_lock_fuse_bits_get(GET_EXTENDED_FUSE_BITS );
 251 #else
 252         #warning "HAVE_READ_LOCK_FUSE is activated but MCU unknown -> will not support this feature"
 253 #endif
 254 #endif
 255 #if HAVE_EEPROM_BYTE_ACCESS
 256         }else if(rq->wValue.bytes[0] == 0xa0){  /* read EEPROM byte */
 257             rval = eeprom_read_byte((void *)address.word);
 258         }else if(rq->wValue.bytes[0] == 0xc0){  /* write EEPROM byte */
 259             eeprom_write_byte((void *)address.word, rq->wIndex.bytes[1]);
 260 #endif
 261 #if HAVE_CHIP_ERASE
 262         }else if(rq->wValue.bytes[0] == 0xac && rq->wValue.bytes[1] == 0x80){  /* chip erase */
 263             addr_t addr;
 264             for(addr = 0; addr < FLASHEND + 1 - 2048; addr += SPM_PAGESIZE) {
 265                 /* wait and erase page */
 266                 DBG1(0x33, 0, 0);
 267 #   ifndef NO_FLASH_WRITE
 268                 boot_spm_busy_wait();
 269                 cli();
 270                 boot_page_erase(addr);
 271                 sei();
 272 #   endif
 273             }
 274 #endif
 275         }else{
 276             /* ignore all others, return default value == 0 */
 277         }
 278         replyBuffer[3] = rval;
 279         len = 4;
 280     }else if((rq->bRequest == USBASP_FUNC_ENABLEPROG) || (rq->bRequest == USBASP_FUNC_SETISPSCK)){
 281         /* replyBuffer[0] = 0; is never touched and thus always 0 which means success */
 282         len = 1;
 283     }else if(rq->bRequest >= USBASP_FUNC_READFLASH && rq->bRequest <= USBASP_FUNC_SETLONGADDRESS){
 284         currentAddress.w[0] = rq->wValue.word;
 285         if(rq->bRequest == USBASP_FUNC_SETLONGADDRESS){
 286 #if (FLASHEND) > 0xffff
 287             currentAddress.w[1] = rq->wIndex.word;
 288 #endif
 289         }else{
 290             bytesRemaining = rq->wLength.bytes[0];
 291             /* if(rq->bRequest == USBASP_FUNC_WRITEFLASH) only evaluated during writeFlash anyway */
 292             isLastPage = rq->wIndex.bytes[1] & 0x02;
 293 #if HAVE_EEPROM_PAGED_ACCESS
 294             currentRequest = rq->bRequest;
 295 #endif
 296             len = 0xff; /* hand over to usbFunctionRead() / usbFunctionWrite() */
 297         }
 298
 299     }else if(rq->bRequest == USBASP_FUNC_DISCONNECT){
 300       stayinloader         &= (0xfe);
 301 #if BOOTLOADER_CAN_EXIT
 302       requestBootLoaderExit = 1;      /* allow proper shutdown/close of connection */
 303 #endif
 304     }else{
 305         /* ignore: others, but could be USBASP_FUNC_CONNECT */
 306         stayinloader       |= (0x01);
 307     }
 308     return len;
 309 }
 310
 311 uchar usbFunctionWrite(uchar *data, uchar len)
 312 {
 313 uchar   isLast;
 314
 315     DBG1(0x31, (void *)&currentAddress.l, 4);
 316     if(len > bytesRemaining)
 317         len = bytesRemaining;
 318     bytesRemaining -= len;
 319     isLast = bytesRemaining == 0;
 320     if(currentRequest >= USBASP_FUNC_READEEPROM){
 321         uchar i;
 322         for(i = 0; i < len; i++){
 323             eeprom_write_byte((void *)(currentAddress.w[0]++), *data++);
 324         }
 325     }else{
 326         uchar i;
 327         for(i = 0; i < len;){
 328 #if HAVE_BLB11_SOFTW_LOCKBIT
 329             if (CURRENT_ADDRESS >= (addr_t)(BOOTLOADER_ADDRESS)) {
 330               return 1;
 331             }
 332 #endif
 333             i += 2;
 334             DBG1(0x32, 0, 0);
 335             cli();
 336             boot_page_fill(CURRENT_ADDRESS, *(short *)data);
 337             sei();
 338             CURRENT_ADDRESS += 2;
 339             data += 2;
 340             /* write page when we cross page boundary or we have the last partial page */
 341             if((currentAddress.w[0] & (SPM_PAGESIZE - 1)) == 0 || (isLast && i >= len && isLastPage)){
 342 #if !HAVE_CHIP_ERASE
 343                 DBG1(0x33, 0, 0);
 344 #   ifndef NO_FLASH_WRITE
 345                 cli();
 346                 boot_page_erase(CURRENT_ADDRESS - 2);   /* erase page */
 347                 sei();
 348                 boot_spm_busy_wait();                   /* wait until page is erased */
 349 #   endif
 350 #endif
 351                 DBG1(0x34, 0, 0);
 352 #ifndef NO_FLASH_WRITE
 353                 cli();
 354                 boot_page_write(CURRENT_ADDRESS - 2);
 355                 sei();
 356                 boot_spm_busy_wait();
 357                 cli();
 358                 boot_rww_enable();
 359                 sei();
 360 #endif
 361             }
 362         }
 363         DBG1(0x35, (void *)&currentAddress.l, 4);
 364     }
 365     return isLast;
 366 }
 367
 368 uchar usbFunctionRead(uchar *data, uchar len)
 369 {
 370 uchar   i;
 371
 372     if(len > bytesRemaining)
 373         len = bytesRemaining;
 374     bytesRemaining -= len;
 375     for(i = 0; i < len; i++){
 376         if(currentRequest >= USBASP_FUNC_READEEPROM){
 377             *data = eeprom_read_byte((void *)currentAddress.w[0]);
 378         }else{
 379             *data = pgm_read_byte((void *)CURRENT_ADDRESS);
 380         }
 381         data++;
 382         CURRENT_ADDRESS++;
 383     }
 384     return len;
 385 }
 386
 387 /* ------------------------------------------------------------------------ */
 388
 389 static void initForUsbConnectivity(void)
 390 {
 391 uchar   i = 0;
 392
 393     usbInit();
 394     /* enforce USB re-enumerate: */
 395     usbDeviceDisconnect();  /* do this while interrupts are disabled */
 396     while(--i){         /* fake USB disconnect for > 250 ms */
 397         _delay_ms(1);
 398     }
 399     usbDeviceConnect();
 400     sei();
 401 }
 402
 403 int __attribute__((noreturn)) main(void)
 404 {
 405     /* initialize  */
 406     bootLoaderInit();
 407     odDebugInit();
 408     DBG1(0x00, 0, 0);
 409 #ifndef NO_FLASH_WRITE
 410     GICR = (1 << IVCE);  /* enable change of interrupt vectors */
 411     GICR = (1 << IVSEL); /* move interrupts to boot flash section */
 412 #endif
 413     if(bootLoaderCondition()){
 414         wdt_disable();    /* main app may have enabled watchdog */
 415 #if BOOTLOADER_CAN_EXIT
 416         uchar i = 0, j = 0;
 417 #endif
 418         initForUsbConnectivity();
 419         do{
 420             usbPoll();
 421 #if BOOTLOADER_CAN_EXIT
 422             if(requestBootLoaderExit){
 423                 if(--i == 0){
 424                     if(--j == 0)
 425                         break;
 426                 }
 427             }
 428 #endif
 429         if (stayinloader >= 0x10) {
 430           if (!bootLoaderCondition()) {
 431             stayinloader-=0x10;
 432           }
 433         } else {
 434           if (bootLoaderCondition()) {
 435             if (stayinloader > 1) stayinloader-=2;
 436           }
 437         }
 438
 439         }while (stayinloader);  /* main event loop */
 440     }
 441     leaveBootloader();
 442 }
 443
 444 /* ------------------------------------------------------------------------ */