firmware/main.c

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