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_ATmega8HVA__)
 143     0x1e, 0x93, 0x07, 0
 144 #elif defined (__AVR_ATmega48__) || defined (__AVR_ATmega48P__)
 145     0x1e, 0x92, 0x05, 0
 146 #elif defined (__AVR_ATmega88__) || defined (__AVR_ATmega88P__)
 147     0x1e, 0x93, 0x0a, 0
 148 #elif defined (__AVR_ATmega168__) || defined (__AVR_ATmega168P__)
 149     0x1e, 0x94, 0x06, 0
 150 #elif defined (__AVR_ATmega328P__)
 151     0x1e, 0x95, 0x0f, 0
 152 #elif defined (__AVR_ATmega1284P__)
 153     0x1e, 0x97, 0x05, 0
 154 #else
 155 #   error "Device signature is not known, please edit main.c!"
 156 #endif
 157 };
 158
 159 /* ------------------------------------------------------------------------ */
 160
 161 static void (*nullVector)(void) __attribute__((__noreturn__));
 162
 163 static void leaveBootloader()
 164 {
 165     DBG1(0x01, 0, 0);
 166     cli();
 167     usbDeviceDisconnect();
 168     bootLoaderExit();
 169     USB_INTR_ENABLE = 0;
 170     USB_INTR_CFG = 0;       /* also reset config bits */
 171     GICR = (1 << IVCE);     /* enable change of interrupt vectors */
 172     GICR = (0 << IVSEL);    /* move interrupts to application flash section */
 173
 174 /* We must go through a global function pointer variable instead of writing
 175  *  ((void (*)(void))0)();
 176  * because the compiler optimizes a constant 0 to "rcall 0" which is not
 177  * handled correctly by the assembler.
 178  */
 179     nullVector();
 180 }
 181
 182 /* ------------------------------------------------------------------------ */
 183
 184 uchar   usbFunctionSetup(uchar data[8])
 185 {
 186 usbRequest_t    *rq = (void *)data;
 187 uchar           len = 0;
 188 static uchar    replyBuffer[4];
 189
 190     usbMsgPtr = replyBuffer;
 191     if(rq->bRequest == USBASP_FUNC_TRANSMIT){   /* emulate parts of ISP protocol */
 192         uchar rval = 0;
 193         usbWord_t address;
 194         address.bytes[1] = rq->wValue.bytes[1];
 195         address.bytes[0] = rq->wIndex.bytes[0];
 196         if(rq->wValue.bytes[0] == 0x30){        /* read signature */
 197             rval = rq->wIndex.bytes[0] & 3;
 198             rval = signatureBytes[rval];
 199 #if HAVE_READ_LOCK_FUSE
 200 #if defined (__AVR_ATmega8__)
 201         }else if(rq->wValue.bytes[0] == 0x58 && rq->wValue.bytes[1] == 0x00){  /* read lock bits */
 202             rval = boot_lock_fuse_bits_get(GET_LOCK_BITS);
 203         }else if(rq->wValue.bytes[0] == 0x50 && rq->wValue.bytes[1] == 0x00){  /* read lfuse bits */
 204             rval = boot_lock_fuse_bits_get(GET_LOW_FUSE_BITS);
 205         }else if(rq->wValue.bytes[0] == 0x58 && rq->wValue.bytes[1] == 0x08){  /* read hfuse bits */
 206             rval = boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS);
 207 #endif
 208 #endif
 209 #if HAVE_EEPROM_BYTE_ACCESS
 210         }else if(rq->wValue.bytes[0] == 0xa0){  /* read EEPROM byte */
 211             rval = eeprom_read_byte((void *)address.word);
 212         }else if(rq->wValue.bytes[0] == 0xc0){  /* write EEPROM byte */
 213             eeprom_write_byte((void *)address.word, rq->wIndex.bytes[1]);
 214 #endif
 215 #if HAVE_CHIP_ERASE
 216         }else if(rq->wValue.bytes[0] == 0xac && rq->wValue.bytes[1] == 0x80){  /* chip erase */
 217             addr_t addr;
 218             for(addr = 0; addr < FLASHEND + 1 - 2048; addr += SPM_PAGESIZE) {
 219                 /* wait and erase page */
 220                 DBG1(0x33, 0, 0);
 221 #   ifndef NO_FLASH_WRITE
 222                 boot_spm_busy_wait();
 223                 cli();
 224                 boot_page_erase(addr);
 225                 sei();
 226 #   endif
 227             }
 228 #endif
 229         }else{
 230             /* ignore all others, return default value == 0 */
 231         }
 232         replyBuffer[3] = rval;
 233         len = 4;
 234     }else if((rq->bRequest == USBASP_FUNC_ENABLEPROG) || (rq->bRequest == USBASP_FUNC_SETISPSCK)){
 235         /* replyBuffer[0] = 0; is never touched and thus always 0 which means success */
 236         len = 1;
 237     }else if(rq->bRequest >= USBASP_FUNC_READFLASH && rq->bRequest <= USBASP_FUNC_SETLONGADDRESS){
 238         currentAddress.w[0] = rq->wValue.word;
 239         if(rq->bRequest == USBASP_FUNC_SETLONGADDRESS){
 240 #if (FLASHEND) > 0xffff
 241             currentAddress.w[1] = rq->wIndex.word;
 242 #endif
 243         }else{
 244             bytesRemaining = rq->wLength.bytes[0];
 245             /* if(rq->bRequest == USBASP_FUNC_WRITEFLASH) only evaluated during writeFlash anyway */
 246             isLastPage = rq->wIndex.bytes[1] & 0x02;
 247 #if HAVE_EEPROM_PAGED_ACCESS
 248             currentRequest = rq->bRequest;
 249 #endif
 250             len = 0xff; /* hand over to usbFunctionRead() / usbFunctionWrite() */
 251         }
 252
 253     }else if(rq->bRequest == USBASP_FUNC_DISCONNECT){
 254       stayinloader         &= (0xfe);
 255 #if BOOTLOADER_CAN_EXIT
 256       requestBootLoaderExit = 1;      /* allow proper shutdown/close of connection */
 257 #endif
 258     }else{
 259         /* ignore: others, but could be USBASP_FUNC_CONNECT */
 260         stayinloader       |= (0x01);
 261     }
 262     return len;
 263 }
 264
 265 uchar usbFunctionWrite(uchar *data, uchar len)
 266 {
 267 uchar   isLast;
 268
 269     DBG1(0x31, (void *)&currentAddress.l, 4);
 270     if(len > bytesRemaining)
 271         len = bytesRemaining;
 272     bytesRemaining -= len;
 273     isLast = bytesRemaining == 0;
 274     if(currentRequest >= USBASP_FUNC_READEEPROM){
 275         uchar i;
 276         for(i = 0; i < len; i++){
 277             eeprom_write_byte((void *)(currentAddress.w[0]++), *data++);
 278         }
 279     }else{
 280         uchar i;
 281         for(i = 0; i < len;){
 282 #if HAVE_BLB11_SOFTW_LOCKBIT
 283             if (CURRENT_ADDRESS >= (addr_t)(BOOTLOADER_ADDRESS)) {
 284               return 1;
 285             }
 286 #endif
 287             i += 2;
 288             DBG1(0x32, 0, 0);
 289             cli();
 290             boot_page_fill(CURRENT_ADDRESS, *(short *)data);
 291             sei();
 292             CURRENT_ADDRESS += 2;
 293             data += 2;
 294             /* write page when we cross page boundary or we have the last partial page */
 295             if((currentAddress.w[0] & (SPM_PAGESIZE - 1)) == 0 || (isLast && i >= len && isLastPage)){
 296 #if !HAVE_CHIP_ERASE
 297                 DBG1(0x33, 0, 0);
 298 #   ifndef NO_FLASH_WRITE
 299                 cli();
 300                 boot_page_erase(CURRENT_ADDRESS - 2);   /* erase page */
 301                 sei();
 302                 boot_spm_busy_wait();                   /* wait until page is erased */
 303 #   endif
 304 #endif
 305                 DBG1(0x34, 0, 0);
 306 #ifndef NO_FLASH_WRITE
 307                 cli();
 308                 boot_page_write(CURRENT_ADDRESS - 2);
 309                 sei();
 310                 boot_spm_busy_wait();
 311                 cli();
 312                 boot_rww_enable();
 313                 sei();
 314 #endif
 315             }
 316         }
 317         DBG1(0x35, (void *)&currentAddress.l, 4);
 318     }
 319     return isLast;
 320 }
 321
 322 uchar usbFunctionRead(uchar *data, uchar len)
 323 {
 324 uchar   i;
 325
 326     if(len > bytesRemaining)
 327         len = bytesRemaining;
 328     bytesRemaining -= len;
 329     for(i = 0; i < len; i++){
 330         if(currentRequest >= USBASP_FUNC_READEEPROM){
 331             *data = eeprom_read_byte((void *)currentAddress.w[0]);
 332         }else{
 333             *data = pgm_read_byte((void *)CURRENT_ADDRESS);
 334         }
 335         data++;
 336         CURRENT_ADDRESS++;
 337     }
 338     return len;
 339 }
 340
 341 /* ------------------------------------------------------------------------ */
 342
 343 static void initForUsbConnectivity(void)
 344 {
 345 uchar   i = 0;
 346
 347     usbInit();
 348     /* enforce USB re-enumerate: */
 349     usbDeviceDisconnect();  /* do this while interrupts are disabled */
 350     while(--i){         /* fake USB disconnect for > 250 ms */
 351         _delay_ms(1);
 352     }
 353     usbDeviceConnect();
 354     sei();
 355 }
 356
 357 int __attribute__((noreturn)) main(void)
 358 {
 359     /* initialize  */
 360     bootLoaderInit();
 361     odDebugInit();
 362     DBG1(0x00, 0, 0);
 363 #ifndef NO_FLASH_WRITE
 364     GICR = (1 << IVCE);  /* enable change of interrupt vectors */
 365     GICR = (1 << IVSEL); /* move interrupts to boot flash section */
 366 #endif
 367     if(bootLoaderCondition()){
 368         wdt_disable();    /* main app may have enabled watchdog */
 369 #if BOOTLOADER_CAN_EXIT
 370         uchar i = 0, j = 0;
 371 #endif
 372         initForUsbConnectivity();
 373         do{
 374             usbPoll();
 375 #if BOOTLOADER_CAN_EXIT
 376             if(requestBootLoaderExit){
 377                 if(--i == 0){
 378                     if(--j == 0)
 379                         break;
 380                 }
 381             }
 382 #endif
 383         if (stayinloader >= 0x10) {
 384           if (!bootLoaderCondition()) {
 385             stayinloader-=0x10;
 386           }
 387         } else {
 388           if (bootLoaderCondition()) {
 389             if (stayinloader > 1) stayinloader-=2;
 390           }
 391         }
 392
 393         }while (stayinloader);  /* main event loop */
 394     }
 395     leaveBootloader();
 396 }
 397
 398 /* ------------------------------------------------------------------------ */