Bootloaders/CDC/BootloaderCDC.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the CDC class bootloader. This file contains the complete bootloader logic.
  34  */
  35
  36 #define  INCLUDE_FROM_BOOTLOADERCDC_C
  37 #include "BootloaderCDC.h"
  38
  39 /** Contains the current baud rate and other settings of the first virtual serial port. This must be retained as some
  40  *  operating systems will not open the port unless the settings can be set successfully.
  41  */
  42 CDC_Line_Coding_t LineEncoding = { .BaudRateBPS = 0,
  43                                    .CharFormat  = OneStopBit,
  44                                    .ParityType  = Parity_None,
  45                                    .DataBits    = 8            };
  46
  47 /** Current address counter. This stores the current address of the FLASH or EEPROM as set by the host,
  48  *  and is used when reading or writing to the AVRs memory (either FLASH or EEPROM depending on the issued
  49  *  command.)
  50  */
  51 uint32_t CurrAddress;
  52
  53 /** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run
  54  *  via a watchdog reset. When cleared the bootloader will exit, starting the watchdog and entering an infinite
  55  *  loop until the AVR restarts and the application runs.
  56  */
  57 bool RunBootloader = true;
  58
  59
  60 /** Main program entry point. This routine configures the hardware required by the bootloader, then continuously
  61  *  runs the bootloader processing routine until instructed to soft-exit, or hard-reset via the watchdog to start
  62  *  the loaded application code.
  63  */
  64 int main(void)
  65 {
  66         /* Setup hardware required for the bootloader */
  67         SetupHardware();
  68
  69         /* Enable global interrupts so that the USB stack can function */
  70         sei();
  71
  72         while (RunBootloader)
  73         {
  74                 CDC_Task();
  75                 USB_USBTask();
  76         }
  77
  78         /* Disconnect from the host - USB interface will be reset later along with the AVR */
  79         USB_Detach();
  80
  81         /* Enable the watchdog and force a timeout to reset the AVR */
  82         wdt_enable(WDTO_250MS);
  83
  84         for (;;);
  85 }
  86
  87 /** Configures all hardware required for the bootloader. */
  88 void SetupHardware(void)
  89 {
  90         /* Disable watchdog if enabled by bootloader/fuses */
  91         MCUSR &= ~(1 << WDRF);
  92         wdt_disable();
  93
  94         /* Disable clock division */
  95         clock_prescale_set(clock_div_1);
  96
  97         /* Relocate the interrupt vector table to the bootloader section */
  98         MCUCR = (1 << IVCE);
  99         MCUCR = (1 << IVSEL);
 100
 101         /* Initialize USB Subsystem */
 102         USB_Init();
 103 }
 104
 105 /** Event handler for the USB_ConfigurationChanged event. This configures the device's endpoints ready
 106  *  to relay data to and from the attached USB host.
 107  */
 108 void EVENT_USB_Device_ConfigurationChanged(void)
 109 {
 110         /* Setup CDC Notification, Rx and Tx Endpoints */
 111         Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,
 112                                    ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,
 113                                    ENDPOINT_BANK_SINGLE);
 114
 115         Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK,
 116                                    ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,
 117                                    ENDPOINT_BANK_SINGLE);
 118
 119         Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK,
 120                                    ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,
 121                                    ENDPOINT_BANK_SINGLE);
 122 }
 123
 124 /** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
 125  *  the device from the USB host before passing along unhandled control requests to the library for processing
 126  *  internally.
 127  */
 128 void EVENT_USB_Device_ControlRequest(void)
 129 {
 130         /* Process CDC specific control requests */
 131         switch (USB_ControlRequest.bRequest)
 132         {
 133                 case REQ_GetLineEncoding:
 134                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 135                         {
 136                                 Endpoint_ClearSETUP();
 137
 138                                 /* Write the line coding data to the control endpoint */
 139                                 Endpoint_Write_Control_Stream_LE(&LineEncoding, sizeof(CDC_Line_Coding_t));
 140                                 Endpoint_ClearOUT();
 141                         }
 142
 143                         break;
 144                 case REQ_SetLineEncoding:
 145                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 146                         {
 147                                 Endpoint_ClearSETUP();
 148
 149                                 /* Read the line coding data in from the host into the global struct */
 150                                 Endpoint_Read_Control_Stream_LE(&LineEncoding, sizeof(CDC_Line_Coding_t));
 151                                 Endpoint_ClearIN();
 152                         }
 153
 154                         break;
 155         }
 156 }
 157
 158 #if !defined(NO_BLOCK_SUPPORT)
 159 /** Reads or writes a block of EEPROM or FLASH memory to or from the appropriate CDC data endpoint, depending
 160  *  on the AVR910 protocol command issued.
 161  *
 162  *  \param[in] Command  Single character AVR910 protocol command indicating what memory operation to perform
 163  */
 164 static void ReadWriteMemoryBlock(const uint8_t Command)
 165 {
 166         uint16_t BlockSize;
 167         char     MemoryType;
 168
 169         bool     HighByte = false;
 170         uint8_t  LowByte  = 0;
 171
 172         BlockSize  = (FetchNextCommandByte() << 8);
 173         BlockSize |=  FetchNextCommandByte();
 174
 175         MemoryType =  FetchNextCommandByte();
 176
 177         if ((MemoryType != 'E') && (MemoryType != 'F'))
 178         {
 179                 /* Send error byte back to the host */
 180                 WriteNextResponseByte('?');
 181
 182                 return;
 183         }
 184
 185         /* Check if command is to read memory */
 186         if (Command == 'g')
 187         {
 188                 /* Re-enable RWW section */
 189                 boot_rww_enable();
 190
 191                 while (BlockSize--)
 192                 {
 193                         if (MemoryType == 'F')
 194                         {
 195                                 /* Read the next FLASH byte from the current FLASH page */
 196                                 #if (FLASHEND > 0xFFFF)
 197                                 WriteNextResponseByte(pgm_read_byte_far(CurrAddress | HighByte));
 198                                 #else
 199                                 WriteNextResponseByte(pgm_read_byte(CurrAddress | HighByte));
 200                                 #endif
 201
 202                                 /* If both bytes in current word have been read, increment the address counter */
 203                                 if (HighByte)
 204                                   CurrAddress += 2;
 205
 206                                 HighByte = !HighByte;
 207                         }
 208                         else
 209                         {
 210                                 /* Read the next EEPROM byte into the endpoint */
 211                                 WriteNextResponseByte(eeprom_read_byte((uint8_t*)(intptr_t)(CurrAddress >> 1)));
 212
 213                                 /* Increment the address counter after use */
 214                                 CurrAddress += 2;
 215                         }
 216                 }
 217         }
 218         else
 219         {
 220                 uint32_t PageStartAddress = CurrAddress;
 221
 222                 if (MemoryType == 'F')
 223                 {
 224                         boot_page_erase(PageStartAddress);
 225                         boot_spm_busy_wait();
 226                 }
 227
 228                 while (BlockSize--)
 229                 {
 230                         if (MemoryType == 'F')
 231                         {
 232                                 /* If both bytes in current word have been written, increment the address counter */
 233                                 if (HighByte)
 234                                 {
 235                                         /* Write the next FLASH word to the current FLASH page */
 236                                         boot_page_fill(CurrAddress, ((FetchNextCommandByte() << 8) | LowByte));
 237
 238                                         /* Increment the address counter after use */
 239                                         CurrAddress += 2;
 240                                 }
 241                                 else
 242                                 {
 243                                         LowByte = FetchNextCommandByte();
 244                                 }
 245
 246                                 HighByte = !HighByte;
 247                         }
 248                         else
 249                         {
 250                                 /* Write the next EEPROM byte from the endpoint */
 251                                 eeprom_write_byte((uint8_t*)((intptr_t)(CurrAddress >> 1)), FetchNextCommandByte());
 252
 253                                 /* Increment the address counter after use */
 254                                 CurrAddress += 2;
 255                         }
 256                 }
 257
 258                 /* If in FLASH programming mode, commit the page after writing */
 259                 if (MemoryType == 'F')
 260                 {
 261                         /* Commit the flash page to memory */
 262                         boot_page_write(PageStartAddress);
 263
 264                         /* Wait until write operation has completed */
 265                         boot_spm_busy_wait();
 266                 }
 267
 268                 /* Send response byte back to the host */
 269                 WriteNextResponseByte('\r');
 270         }
 271 }
 272 #endif
 273
 274 /** Retrieves the next byte from the host in the CDC data OUT endpoint, and clears the endpoint bank if needed
 275  *  to allow reception of the next data packet from the host.
 276  *
 277  *  \return Next received byte from the host in the CDC data OUT endpoint
 278  */
 279 static uint8_t FetchNextCommandByte(void)
 280 {
 281         /* Select the OUT endpoint so that the next data byte can be read */
 282         Endpoint_SelectEndpoint(CDC_RX_EPNUM);
 283
 284         /* If OUT endpoint empty, clear it and wait for the next packet from the host */
 285         while (!(Endpoint_IsReadWriteAllowed()))
 286         {
 287                 Endpoint_ClearOUT();
 288
 289                 while (!(Endpoint_IsOUTReceived()))
 290                 {
 291                         if (USB_DeviceState == DEVICE_STATE_Unattached)
 292                           return 0;
 293                 }
 294         }
 295
 296         /* Fetch the next byte from the OUT endpoint */
 297         return Endpoint_Read_Byte();
 298 }
 299
 300 /** Writes the next response byte to the CDC data IN endpoint, and sends the endpoint back if needed to free up the
 301  *  bank when full ready for the next byte in the packet to the host.
 302  *
 303  *  \param[in] Response  Next response byte to send to the host
 304  */
 305 static void WriteNextResponseByte(const uint8_t Response)
 306 {
 307         /* Select the IN endpoint so that the next data byte can be written */
 308         Endpoint_SelectEndpoint(CDC_TX_EPNUM);
 309
 310         /* If IN endpoint full, clear it and wait until ready for the next packet to the host */
 311         if (!(Endpoint_IsReadWriteAllowed()))
 312         {
 313                 Endpoint_ClearIN();
 314
 315                 while (!(Endpoint_IsINReady()))
 316                 {
 317                         if (USB_DeviceState == DEVICE_STATE_Unattached)
 318                           return;
 319                 }
 320         }
 321
 322         /* Write the next byte to the OUT endpoint */
 323         Endpoint_Write_Byte(Response);
 324 }
 325
 326 /** Task to read in AVR910 commands from the CDC data OUT endpoint, process them, perform the required actions
 327  *  and send the appropriate response back to the host.
 328  */
 329 void CDC_Task(void)
 330 {
 331         /* Select the OUT endpoint */
 332         Endpoint_SelectEndpoint(CDC_RX_EPNUM);
 333
 334         /* Check if endpoint has a command in it sent from the host */
 335         if (!(Endpoint_IsOUTReceived()))
 336           return;
 337
 338         /* Read in the bootloader command (first byte sent from host) */
 339         uint8_t Command = FetchNextCommandByte();
 340
 341         if (Command == 'E')
 342         {
 343                 RunBootloader = false;
 344
 345                 /* Send confirmation byte back to the host */
 346                 WriteNextResponseByte('\r');
 347         }
 348         else if (Command == 'T')
 349         {
 350                 FetchNextCommandByte();
 351
 352                 /* Send confirmation byte back to the host */
 353                 WriteNextResponseByte('\r');
 354         }
 355         else if ((Command == 'L') || (Command == 'P'))
 356         {
 357                 /* Send confirmation byte back to the host */
 358                 WriteNextResponseByte('\r');
 359         }
 360         else if (Command == 't')
 361         {
 362                 /* Return ATMEGA128 part code - this is only to allow AVRProg to use the bootloader */
 363                 WriteNextResponseByte(0x44);
 364                 WriteNextResponseByte(0x00);
 365         }
 366         else if (Command == 'a')
 367         {
 368                 /* Indicate auto-address increment is supported */
 369                 WriteNextResponseByte('Y');
 370         }
 371         else if (Command == 'A')
 372         {
 373                 /* Set the current address to that given by the host */
 374                 CurrAddress   = (FetchNextCommandByte() << 9);
 375                 CurrAddress  |= (FetchNextCommandByte() << 1);
 376
 377                 /* Send confirmation byte back to the host */
 378                 WriteNextResponseByte('\r');
 379         }
 380         else if (Command == 'p')
 381         {
 382                 /* Indicate serial programmer back to the host */
 383                 WriteNextResponseByte('S');
 384         }
 385         else if (Command == 'S')
 386         {
 387                 /* Write the 7-byte software identifier to the endpoint */
 388                 for (uint8_t CurrByte = 0; CurrByte < 7; CurrByte++)
 389                   WriteNextResponseByte(SOFTWARE_IDENTIFIER[CurrByte]);
 390         }
 391         else if (Command == 'V')
 392         {
 393                 WriteNextResponseByte('0' + BOOTLOADER_VERSION_MAJOR);
 394                 WriteNextResponseByte('0' + BOOTLOADER_VERSION_MINOR);
 395         }
 396         else if (Command == 's')
 397         {
 398                 WriteNextResponseByte(AVR_SIGNATURE_3);
 399                 WriteNextResponseByte(AVR_SIGNATURE_2);
 400                 WriteNextResponseByte(AVR_SIGNATURE_1);
 401         }
 402         else if (Command == 'e')
 403         {
 404                 /* Clear the application section of flash */
 405                 for (uint32_t CurrFlashAddress = 0; CurrFlashAddress < BOOT_START_ADDR; CurrFlashAddress += SPM_PAGESIZE)
 406                 {
 407                         boot_page_erase(CurrFlashAddress);
 408                         boot_spm_busy_wait();
 409                         boot_page_write(CurrFlashAddress);
 410                         boot_spm_busy_wait();
 411                 }
 412
 413                 /* Send confirmation byte back to the host */
 414                 WriteNextResponseByte('\r');
 415         }
 416         #if !defined(NO_LOCK_BYTE_WRITE_SUPPORT)
 417         else if (Command == 'l')
 418         {
 419                 /* Set the lock bits to those given by the host */
 420                 boot_lock_bits_set(FetchNextCommandByte());
 421
 422                 /* Send confirmation byte back to the host */
 423                 WriteNextResponseByte('\r');
 424         }
 425         #endif
 426         else if (Command == 'r')
 427         {
 428                 WriteNextResponseByte(boot_lock_fuse_bits_get(GET_LOCK_BITS));
 429         }
 430         else if (Command == 'F')
 431         {
 432                 WriteNextResponseByte(boot_lock_fuse_bits_get(GET_LOW_FUSE_BITS));
 433         }
 434         else if (Command == 'N')
 435         {
 436                 WriteNextResponseByte(boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS));
 437         }
 438         else if (Command == 'Q')
 439         {
 440                 WriteNextResponseByte(boot_lock_fuse_bits_get(GET_EXTENDED_FUSE_BITS));
 441         }
 442         #if !defined(NO_BLOCK_SUPPORT)
 443         else if (Command == 'b')
 444         {
 445                 WriteNextResponseByte('Y');
 446
 447                 /* Send block size to the host */
 448                 WriteNextResponseByte(SPM_PAGESIZE >> 8);
 449                 WriteNextResponseByte(SPM_PAGESIZE & 0xFF);
 450         }
 451         else if ((Command == 'B') || (Command == 'g'))
 452         {
 453                 /* Delegate the block write/read to a separate function for clarity */
 454                 ReadWriteMemoryBlock(Command);
 455         }
 456         #endif
 457         #if !defined(NO_FLASH_BYTE_SUPPORT)
 458         else if (Command == 'C')
 459         {
 460                 /* Write the high byte to the current flash page */
 461                 boot_page_fill(CurrAddress, FetchNextCommandByte());
 462
 463                 /* Send confirmation byte back to the host */
 464                 WriteNextResponseByte('\r');
 465         }
 466         else if (Command == 'c')
 467         {
 468                 /* Write the low byte to the current flash page */
 469                 boot_page_fill(CurrAddress | 0x01, FetchNextCommandByte());
 470
 471                 /* Increment the address */
 472                 CurrAddress += 2;
 473
 474                 /* Send confirmation byte back to the host */
 475                 WriteNextResponseByte('\r');
 476         }
 477         else if (Command == 'm')
 478         {
 479                 /* Commit the flash page to memory */
 480                 boot_page_write(CurrAddress);
 481
 482                 /* Wait until write operation has completed */
 483                 boot_spm_busy_wait();
 484
 485                 /* Send confirmation byte back to the host */
 486                 WriteNextResponseByte('\r');
 487         }
 488         else if (Command == 'R')
 489         {
 490                 #if (FLASHEND > 0xFFFF)
 491                 uint16_t ProgramWord = pgm_read_word_far(CurrAddress);
 492                 #else
 493                 uint16_t ProgramWord = pgm_read_word(CurrAddress);
 494                 #endif
 495
 496                 WriteNextResponseByte(ProgramWord >> 8);
 497                 WriteNextResponseByte(ProgramWord & 0xFF);
 498         }
 499         #endif
 500         #if !defined(NO_EEPROM_BYTE_SUPPORT)
 501         else if (Command == 'D')
 502         {
 503                 /* Read the byte from the endpoint and write it to the EEPROM */
 504                 eeprom_write_byte((uint8_t*)((intptr_t)(CurrAddress >> 1)), FetchNextCommandByte());
 505
 506                 /* Increment the address after use */
 507                 CurrAddress += 2;
 508
 509                 /* Send confirmation byte back to the host */
 510                 WriteNextResponseByte('\r');
 511         }
 512         else if (Command == 'd')
 513         {
 514                 /* Read the EEPROM byte and write it to the endpoint */
 515                 WriteNextResponseByte(eeprom_read_byte((uint8_t*)((intptr_t)(CurrAddress >> 1))));
 516
 517                 /* Increment the address after use */
 518                 CurrAddress += 2;
 519         }
 520         #endif
 521         else if (Command != 27)
 522         {
 523                 /* Unknown (non-sync) command, return fail code */
 524                 WriteNextResponseByte('?');
 525         }
 526
 527         /* Select the IN endpoint */
 528         Endpoint_SelectEndpoint(CDC_TX_EPNUM);
 529
 530         /* Remember if the endpoint is completely full before clearing it */
 531         bool IsEndpointFull = !(Endpoint_IsReadWriteAllowed());
 532
 533         /* Send the endpoint data to the host */
 534         Endpoint_ClearIN();
 535
 536         /* If a full endpoint's worth of data was sent, we need to send an empty packet afterwards to signal end of transfer */
 537         if (IsEndpointFull)
 538         {
 539                 while (!(Endpoint_IsINReady()))
 540                 {
 541                         if (USB_DeviceState == DEVICE_STATE_Unattached)
 542                           return;
 543                 }
 544
 545                 Endpoint_ClearIN();
 546         }
 547
 548         /* Wait until the data has been sent to the host */
 549         while (!(Endpoint_IsINReady()))
 550         {
 551                 if (USB_DeviceState == DEVICE_STATE_Unattached)
 552                   return;
 553         }
 554
 555         /* Select the OUT endpoint */
 556         Endpoint_SelectEndpoint(CDC_RX_EPNUM);
 557
 558         /* Acknowledge the command from the host */
 559         Endpoint_ClearOUT();
 560 }
 561