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 #include <avr/cpufunc.h>
  22
  23 #include <string.h>
  24
  25
  26
  27 static void leaveBootloader() __attribute__((__noreturn__));
  28
  29 #include "bootloaderconfig.h"
  30 #include "usbdrv/usbdrv.c"
  31
  32 #ifndef BOOTLOADER_ADDRESS
  33   #error need to know the bootloaders flash address!
  34 #endif
  35
  36 /* ------------------------------------------------------------------------ */
  37
  38 /* Request constants used by USBasp */
  39 #define USBASP_FUNC_CONNECT         1
  40 #define USBASP_FUNC_DISCONNECT      2
  41 #define USBASP_FUNC_TRANSMIT        3
  42 #define USBASP_FUNC_READFLASH       4
  43 #define USBASP_FUNC_ENABLEPROG      5
  44 #define USBASP_FUNC_WRITEFLASH      6
  45 #define USBASP_FUNC_READEEPROM      7
  46 #define USBASP_FUNC_WRITEEEPROM     8
  47 #define USBASP_FUNC_SETLONGADDRESS  9
  48
  49 /* ------------------------------------------------------------------------ */
  50
  51 #ifndef ulong
  52 #   define ulong    unsigned long
  53 #endif
  54 #ifndef uint
  55 #   define uint     unsigned int
  56 #endif
  57
  58 /* defaults if not in config file: */
  59 #ifndef HAVE_EEPROM_PAGED_ACCESS
  60 #   define HAVE_EEPROM_PAGED_ACCESS 0
  61 #endif
  62 #ifndef HAVE_EEPROM_BYTE_ACCESS
  63 #   define HAVE_EEPROM_BYTE_ACCESS  0
  64 #endif
  65 #ifndef BOOTLOADER_CAN_EXIT
  66 #   define  BOOTLOADER_CAN_EXIT     0
  67 #endif
  68
  69 /* allow compatibility with avrusbboot's bootloaderconfig.h: */
  70 #ifdef BOOTLOADER_INIT
  71 #   define bootLoaderInit()         BOOTLOADER_INIT
  72 #   define bootLoaderExit()
  73 #endif
  74 #ifdef BOOTLOADER_CONDITION
  75 #   define bootLoaderCondition()    BOOTLOADER_CONDITION
  76 #endif
  77
  78 /* device compatibility: */
  79 #ifndef GICR    /* ATMega*8 don't have GICR, use MCUCR instead */
  80 #   define GICR     MCUCR
  81 #endif
  82
  83 /* ------------------------------------------------------------------------ */
  84
  85 #if (FLASHEND) > 0xffff /* we need long addressing */
  86 #   define CURRENT_ADDRESS  currentAddress.l
  87 #   define addr_t           ulong
  88 #else
  89 #   define CURRENT_ADDRESS  currentAddress.w[0]
  90 #   define addr_t           uint
  91 #endif
  92
  93 typedef union longConverter{
  94     addr_t  l;
  95     uint    w[sizeof(addr_t)/2];
  96     uchar   b[sizeof(addr_t)];
  97 }longConverter_t;
  98
  99
 100 #if BOOTLOADER_CAN_EXIT
 101 static uchar                    requestBootLoaderExit;
 102 #endif
 103 static volatile unsigned char   stayinloader = 0xfe;
 104
 105 static longConverter_t          currentAddress; /* in bytes */
 106 static uchar                    bytesRemaining;
 107 static uchar                    isLastPage;
 108 #if HAVE_EEPROM_PAGED_ACCESS
 109 static uchar                    currentRequest;
 110 #else
 111 static const uchar              currentRequest = 0;
 112 #endif
 113
 114 static const uchar  signatureBytes[4] = {
 115 #ifdef SIGNATURE_BYTES
 116     SIGNATURE_BYTES
 117 #elif defined (__AVR_ATmega8__) || defined (__AVR_ATmega8HVA__)
 118     0x1e, 0x93, 0x07, 0
 119 #elif defined (__AVR_ATmega48__) || defined (__AVR_ATmega48P__)
 120     0x1e, 0x92, 0x05, 0
 121 #elif defined (__AVR_ATmega88__) || defined (__AVR_ATmega88P__)
 122     0x1e, 0x93, 0x0a, 0
 123 #elif defined (__AVR_ATmega168__) || defined (__AVR_ATmega168P__)
 124     0x1e, 0x94, 0x06, 0
 125 #elif defined (__AVR_ATmega328P__)
 126     0x1e, 0x95, 0x0f, 0
 127 #elif defined (__AVR_ATmega1284P__)
 128     0x1e, 0x97, 0x05, 0
 129 #else
 130 #   error "Device signature is not known, please edit main.c!"
 131 #endif
 132 };
 133
 134 /* ------------------------------------------------------------------------ */
 135
 136 static void (*nullVector)(void) __attribute__((__noreturn__));
 137
 138 static void leaveBootloader()
 139 {
 140     DBG1(0x01, 0, 0);
 141     cli();
 142     usbDeviceDisconnect();
 143     bootLoaderExit();
 144     USB_INTR_ENABLE = 0;
 145     USB_INTR_CFG = 0;       /* also reset config bits */
 146     GICR = (1 << IVCE);     /* enable change of interrupt vectors */
 147     GICR = (0 << IVSEL);    /* move interrupts to application flash section */
 148
 149 /* We must go through a global function pointer variable instead of writing
 150  *  ((void (*)(void))0)();
 151  * because the compiler optimizes a constant 0 to "rcall 0" which is not
 152  * handled correctly by the assembler.
 153  */
 154     nullVector();
 155 }
 156
 157 /* ------------------------------------------------------------------------ */
 158
 159 uchar   usbFunctionSetup(uchar data[8])
 160 {
 161 usbRequest_t    *rq = (void *)data;
 162 uchar           len = 0;
 163 static uchar    replyBuffer[4];
 164
 165     usbMsgPtr = replyBuffer;
 166     if(rq->bRequest == USBASP_FUNC_TRANSMIT){   /* emulate parts of ISP protocol */
 167         uchar rval = 0;
 168         usbWord_t address;
 169         address.bytes[1] = rq->wValue.bytes[1];
 170         address.bytes[0] = rq->wIndex.bytes[0];
 171         if(rq->wValue.bytes[0] == 0x30){        /* read signature */
 172             rval = rq->wIndex.bytes[0] & 3;
 173             rval = signatureBytes[rval];
 174 #if HAVE_READ_LOCK_FUSE
 175 #if defined (__AVR_ATmega8__)
 176         }else if(rq->wValue.bytes[0] == 0x58 && rq->wValue.bytes[1] == 0x00){  /* read lock bits */
 177             rval = boot_lock_fuse_bits_get(GET_LOCK_BITS);
 178         }else if(rq->wValue.bytes[0] == 0x50 && rq->wValue.bytes[1] == 0x00){  /* read lfuse bits */
 179             rval = boot_lock_fuse_bits_get(GET_LOW_FUSE_BITS);
 180         }else if(rq->wValue.bytes[0] == 0x58 && rq->wValue.bytes[1] == 0x08){  /* read hfuse bits */
 181             rval = boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS);
 182 #endif
 183 #endif
 184 #if HAVE_EEPROM_BYTE_ACCESS
 185         }else if(rq->wValue.bytes[0] == 0xa0){  /* read EEPROM byte */
 186             rval = eeprom_read_byte((void *)address.word);
 187         }else if(rq->wValue.bytes[0] == 0xc0){  /* write EEPROM byte */
 188             eeprom_write_byte((void *)address.word, rq->wIndex.bytes[1]);
 189 #endif
 190 #if HAVE_CHIP_ERASE
 191         }else if(rq->wValue.bytes[0] == 0xac && rq->wValue.bytes[1] == 0x80){  /* chip erase */
 192             addr_t addr;
 193             for(addr = 0; addr < FLASHEND + 1 - 2048; addr += SPM_PAGESIZE) {
 194                 /* wait and erase page */
 195                 DBG1(0x33, 0, 0);
 196 #   ifndef NO_FLASH_WRITE
 197                 boot_spm_busy_wait();
 198                 cli();
 199                 boot_page_erase(addr);
 200                 sei();
 201 #   endif
 202             }
 203 #endif
 204         }else{
 205             /* ignore all others, return default value == 0 */
 206         }
 207         replyBuffer[3] = rval;
 208         len = 4;
 209     }else if(rq->bRequest == USBASP_FUNC_ENABLEPROG){
 210         /* replyBuffer[0] = 0; is never touched and thus always 0 which means success */
 211         len = 1;
 212     }else if(rq->bRequest >= USBASP_FUNC_READFLASH && rq->bRequest <= USBASP_FUNC_SETLONGADDRESS){
 213         currentAddress.w[0] = rq->wValue.word;
 214         if(rq->bRequest == USBASP_FUNC_SETLONGADDRESS){
 215 #if (FLASHEND) > 0xffff
 216             currentAddress.w[1] = rq->wIndex.word;
 217 #endif
 218         }else{
 219             bytesRemaining = rq->wLength.bytes[0];
 220             /* if(rq->bRequest == USBASP_FUNC_WRITEFLASH) only evaluated during writeFlash anyway */
 221             isLastPage = rq->wIndex.bytes[1] & 0x02;
 222 #if HAVE_EEPROM_PAGED_ACCESS
 223             currentRequest = rq->bRequest;
 224 #endif
 225             len = 0xff; /* hand over to usbFunctionRead() / usbFunctionWrite() */
 226         }
 227
 228     }else if(rq->bRequest == USBASP_FUNC_DISCONNECT){
 229       stayinloader         &= (0xfe);
 230 #if BOOTLOADER_CAN_EXIT
 231       requestBootLoaderExit = 1;      /* allow proper shutdown/close of connection */
 232 #endif
 233     }else{
 234         /* ignore: others, but could be USBASP_FUNC_CONNECT */
 235         stayinloader       |= (0x01);
 236     }
 237     return len;
 238 }
 239
 240 uchar usbFunctionWrite(uchar *data, uchar len)
 241 {
 242 uchar   isLast;
 243
 244     DBG1(0x31, (void *)&currentAddress.l, 4);
 245     if(len > bytesRemaining)
 246         len = bytesRemaining;
 247     bytesRemaining -= len;
 248     isLast = bytesRemaining == 0;
 249     if(currentRequest >= USBASP_FUNC_READEEPROM){
 250         uchar i;
 251         for(i = 0; i < len; i++){
 252             eeprom_write_byte((void *)(currentAddress.w[0]++), *data++);
 253         }
 254     }else{
 255         uchar i;
 256         for(i = 0; i < len;){
 257 #if HAVE_BLB11_SOFTW_LOCKBIT
 258             if (CURRENT_ADDRESS >= (addr_t)(BOOTLOADER_ADDRESS)) {
 259               return 1;
 260             }
 261 #endif
 262             i += 2;
 263             DBG1(0x32, 0, 0);
 264             cli();
 265             boot_page_fill(CURRENT_ADDRESS, *(short *)data);
 266             sei();
 267             CURRENT_ADDRESS += 2;
 268             data += 2;
 269             /* write page when we cross page boundary or we have the last partial page */
 270             if((currentAddress.w[0] & (SPM_PAGESIZE - 1)) == 0 || (isLast && i >= len && isLastPage)){
 271 #if !HAVE_CHIP_ERASE
 272                 DBG1(0x33, 0, 0);
 273 #   ifndef NO_FLASH_WRITE
 274                 cli();
 275                 boot_page_erase(CURRENT_ADDRESS - 2);   /* erase page */
 276                 sei();
 277                 boot_spm_busy_wait();                   /* wait until page is erased */
 278 #   endif
 279 #endif
 280                 DBG1(0x34, 0, 0);
 281 #ifndef NO_FLASH_WRITE
 282                 cli();
 283                 boot_page_write(CURRENT_ADDRESS - 2);
 284                 sei();
 285                 boot_spm_busy_wait();
 286                 cli();
 287                 boot_rww_enable();
 288                 sei();
 289 #endif
 290             }
 291         }
 292         DBG1(0x35, (void *)&currentAddress.l, 4);
 293     }
 294     return isLast;
 295 }
 296
 297 uchar usbFunctionRead(uchar *data, uchar len)
 298 {
 299 uchar   i;
 300
 301     if(len > bytesRemaining)
 302         len = bytesRemaining;
 303     bytesRemaining -= len;
 304     for(i = 0; i < len; i++){
 305         if(currentRequest >= USBASP_FUNC_READEEPROM){
 306             *data = eeprom_read_byte((void *)currentAddress.w[0]);
 307         }else{
 308             *data = pgm_read_byte((void *)CURRENT_ADDRESS);
 309         }
 310         data++;
 311         CURRENT_ADDRESS++;
 312     }
 313     return len;
 314 }
 315
 316 /* ------------------------------------------------------------------------ */
 317
 318 static void initForUsbConnectivity(void)
 319 {
 320 uchar   i = 0;
 321
 322     usbInit();
 323     /* enforce USB re-enumerate: */
 324     usbDeviceDisconnect();  /* do this while interrupts are disabled */
 325     while(--i){         /* fake USB disconnect for > 250 ms */
 326         _delay_ms(1);
 327     }
 328     usbDeviceConnect();
 329     sei();
 330 }
 331
 332 int __attribute__((noreturn)) main(void)
 333 {
 334     /* initialize  */
 335     bootLoaderInit();
 336     odDebugInit();
 337     DBG1(0x00, 0, 0);
 338 #ifndef NO_FLASH_WRITE
 339     GICR = (1 << IVCE);  /* enable change of interrupt vectors */
 340     GICR = (1 << IVSEL); /* move interrupts to boot flash section */
 341 #endif
 342     if(bootLoaderCondition()){
 343         wdt_disable();    /* main app may have enabled watchdog */
 344 #if BOOTLOADER_CAN_EXIT
 345         uchar i = 0, j = 0;
 346 #endif
 347         initForUsbConnectivity();
 348         do{
 349             usbPoll();
 350 #if BOOTLOADER_CAN_EXIT
 351             if(requestBootLoaderExit){
 352                 if(--i == 0){
 353                     if(--j == 0)
 354                         break;
 355                 }
 356             }
 357 #endif
 358         if (stayinloader >= 0x10) {
 359           if (!bootLoaderCondition()) {
 360             stayinloader-=0x10;
 361           }
 362         } else {
 363           if (bootLoaderCondition()) {
 364             if (stayinloader > 1) stayinloader-=2;
 365           }
 366         }
 367
 368         }while (stayinloader);  /* main event loop */
 369     }
 370     leaveBootloader();
 371 }
 372
 373 /* ------------------------------------------------------------------------ */