Bootloaders/CDC/BootloaderCDC.c

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