3 Copyright (C) Dean Camera, 2013.
5 dean [at] fourwalledcubicle [dot] com
10 Copyright 2013 Dean Camera (dean [at] fourwalledcubicle [dot] com)
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.
21 The author disclaims 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
33 * Main source file for the CDC class bootloader. This file contains the complete bootloader logic.
36 #define INCLUDE_FROM_BOOTLOADERCDC_C
37 #include "BootloaderCDC.h"
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.
42 static CDC_LineEncoding_t LineEncoding
= { .BaudRateBPS
= 0,
43 .CharFormat
= CDC_LINEENCODING_OneStopBit
,
44 .ParityType
= CDC_PARITY_None
,
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
51 static uint32_t CurrAddress
;
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.
57 static bool RunBootloader
= true;
59 /** Magic lock for forced application start. If the HWBE fuse is programmed and BOOTRST is unprogrammed, the bootloader
60 * will start if the /HWB line of the AVR is held low and the system is reset. However, if the /HWB line is still held
61 * low when the application attempts to start via a watchdog reset, the bootloader will re-start. If set to the value
62 * \ref MAGIC_BOOT_KEY the special init function \ref Application_Jump_Check() will force the application to start.
64 uint16_t MagicBootKey ATTR_NO_INIT
;
67 /** Special startup routine to check if the bootloader was started via a watchdog reset, and if the magic application
68 * start key has been loaded into \ref MagicBootKey. If the bootloader started via the watchdog and the key is valid,
69 * this will force the user application to start via a software jump.
71 void Application_Jump_Check(void)
73 bool JumpToApplication
= false;
75 #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
76 /* Disable JTAG debugging */
79 /* Enable pull-up on the JTAG TCK pin so we can use it to select the mode */
83 /* If the TCK pin is not jumpered to ground, start the user application instead */
84 JumpToApplication
|= ((PINF
& (1 << 4)) != 0);
86 /* Re-enable JTAG debugging */
90 /* If the reset source was the bootloader and the key is correct, clear it and jump to the application */
91 if ((MCUSR
& (1 << WDRF
)) && (MagicBootKey
== MAGIC_BOOT_KEY
))
92 JumpToApplication
|= true;
94 /* If a request has been made to jump to the user application, honor it */
95 if (JumpToApplication
)
97 /* Turn off the watchdog */
101 /* Clear the boot key and jump to the user application */
104 // cppcheck-suppress constStatement
105 ((void (*)(void))0x0000)();
109 /** Main program entry point. This routine configures the hardware required by the bootloader, then continuously
110 * runs the bootloader processing routine until instructed to soft-exit, or hard-reset via the watchdog to start
111 * the loaded application code.
115 /* Setup hardware required for the bootloader */
118 /* Turn on first LED on the board to indicate that the bootloader has started */
119 LEDs_SetAllLEDs(LEDS_LED1
);
121 /* Enable global interrupts so that the USB stack can function */
122 GlobalInterruptEnable();
124 while (RunBootloader
)
130 /* Disconnect from the host - USB interface will be reset later along with the AVR */
133 /* Unlock the forced application start mode of the bootloader if it is restarted */
134 MagicBootKey
= MAGIC_BOOT_KEY
;
136 /* Enable the watchdog and force a timeout to reset the AVR */
137 wdt_enable(WDTO_250MS
);
142 /** Configures all hardware required for the bootloader. */
143 static void SetupHardware(void)
145 /* Disable watchdog if enabled by bootloader/fuses */
146 MCUSR
&= ~(1 << WDRF
);
149 /* Disable clock division */
150 clock_prescale_set(clock_div_1
);
152 /* Relocate the interrupt vector table to the bootloader section */
154 MCUCR
= (1 << IVSEL
);
156 /* Initialize the USB and other board hardware drivers */
160 /* Bootloader active LED toggle timer initialization */
161 TIMSK1
= (1 << TOIE1
);
162 TCCR1B
= ((1 << CS11
) | (1 << CS10
));
165 /** ISR to periodically toggle the LEDs on the board to indicate that the bootloader is active. */
166 ISR(TIMER1_OVF_vect
, ISR_BLOCK
)
168 LEDs_ToggleLEDs(LEDS_LED1
| LEDS_LED2
);
171 /** Event handler for the USB_ConfigurationChanged event. This configures the device's endpoints ready
172 * to relay data to and from the attached USB host.
174 void EVENT_USB_Device_ConfigurationChanged(void)
176 /* Setup CDC Notification, Rx and Tx Endpoints */
177 Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPADDR
, EP_TYPE_INTERRUPT
,
178 CDC_NOTIFICATION_EPSIZE
, 1);
180 Endpoint_ConfigureEndpoint(CDC_TX_EPADDR
, EP_TYPE_BULK
, CDC_TXRX_EPSIZE
, 1);
182 Endpoint_ConfigureEndpoint(CDC_RX_EPADDR
, EP_TYPE_BULK
, CDC_TXRX_EPSIZE
, 1);
185 /** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
186 * the device from the USB host before passing along unhandled control requests to the library for processing
189 void EVENT_USB_Device_ControlRequest(void)
191 /* Ignore any requests that aren't directed to the CDC interface */
192 if ((USB_ControlRequest
.bmRequestType
& (CONTROL_REQTYPE_TYPE
| CONTROL_REQTYPE_RECIPIENT
)) !=
193 (REQTYPE_CLASS
| REQREC_INTERFACE
))
198 /* Activity - toggle indicator LEDs */
199 LEDs_ToggleLEDs(LEDS_LED1
| LEDS_LED2
);
201 /* Process CDC specific control requests */
202 switch (USB_ControlRequest
.bRequest
)
204 case CDC_REQ_GetLineEncoding
:
205 if (USB_ControlRequest
.bmRequestType
== (REQDIR_DEVICETOHOST
| REQTYPE_CLASS
| REQREC_INTERFACE
))
207 Endpoint_ClearSETUP();
209 /* Write the line coding data to the control endpoint */
210 Endpoint_Write_Control_Stream_LE(&LineEncoding
, sizeof(CDC_LineEncoding_t
));
215 case CDC_REQ_SetLineEncoding
:
216 if (USB_ControlRequest
.bmRequestType
== (REQDIR_HOSTTODEVICE
| REQTYPE_CLASS
| REQREC_INTERFACE
))
218 Endpoint_ClearSETUP();
220 /* Read the line coding data in from the host into the global struct */
221 Endpoint_Read_Control_Stream_LE(&LineEncoding
, sizeof(CDC_LineEncoding_t
));
226 case CDC_REQ_SetControlLineState
:
227 if (USB_ControlRequest
.bmRequestType
== (REQDIR_HOSTTODEVICE
| REQTYPE_CLASS
| REQREC_INTERFACE
))
229 Endpoint_ClearSETUP();
230 Endpoint_ClearStatusStage();
237 #if !defined(NO_BLOCK_SUPPORT)
238 /** Reads or writes a block of EEPROM or FLASH memory to or from the appropriate CDC data endpoint, depending
239 * on the AVR109 protocol command issued.
241 * \param[in] Command Single character AVR109 protocol command indicating what memory operation to perform
243 static void ReadWriteMemoryBlock(const uint8_t Command
)
248 uint8_t HighByte
= 0;
251 BlockSize
= (FetchNextCommandByte() << 8);
252 BlockSize
|= FetchNextCommandByte();
254 MemoryType
= FetchNextCommandByte();
256 if ((MemoryType
!= MEMORY_TYPE_FLASH
) && (MemoryType
!= MEMORY_TYPE_EEPROM
))
258 /* Send error byte back to the host */
259 WriteNextResponseByte('?');
264 /* Check if command is to read a memory block */
265 if (Command
== AVR109_COMMAND_BlockRead
)
267 /* Re-enable RWW section */
272 if (MemoryType
== MEMORY_TYPE_FLASH
)
274 /* Read the next FLASH byte from the current FLASH page */
275 #if (FLASHEND > 0xFFFF)
276 WriteNextResponseByte(pgm_read_byte_far(CurrAddress
| HighByte
));
278 WriteNextResponseByte(pgm_read_byte(CurrAddress
| HighByte
));
281 /* If both bytes in current word have been read, increment the address counter */
285 HighByte
= !HighByte
;
289 /* Read the next EEPROM byte into the endpoint */
290 WriteNextResponseByte(eeprom_read_byte((uint8_t*)(intptr_t)(CurrAddress
>> 1)));
292 /* Increment the address counter after use */
299 uint32_t PageStartAddress
= CurrAddress
;
301 if (MemoryType
== MEMORY_TYPE_FLASH
)
303 boot_page_erase(PageStartAddress
);
304 boot_spm_busy_wait();
309 if (MemoryType
== MEMORY_TYPE_FLASH
)
311 /* If both bytes in current word have been written, increment the address counter */
314 /* Write the next FLASH word to the current FLASH page */
315 boot_page_fill(CurrAddress
, ((FetchNextCommandByte() << 8) | LowByte
));
317 /* Increment the address counter after use */
322 LowByte
= FetchNextCommandByte();
325 HighByte
= !HighByte
;
329 /* Write the next EEPROM byte from the endpoint */
330 eeprom_write_byte((uint8_t*)((intptr_t)(CurrAddress
>> 1)), FetchNextCommandByte());
332 /* Increment the address counter after use */
337 /* If in FLASH programming mode, commit the page after writing */
338 if (MemoryType
== MEMORY_TYPE_FLASH
)
340 /* Commit the flash page to memory */
341 boot_page_write(PageStartAddress
);
343 /* Wait until write operation has completed */
344 boot_spm_busy_wait();
347 /* Send response byte back to the host */
348 WriteNextResponseByte('\r');
353 /** Retrieves the next byte from the host in the CDC data OUT endpoint, and clears the endpoint bank if needed
354 * to allow reception of the next data packet from the host.
356 * \return Next received byte from the host in the CDC data OUT endpoint
358 static uint8_t FetchNextCommandByte(void)
360 /* Select the OUT endpoint so that the next data byte can be read */
361 Endpoint_SelectEndpoint(CDC_RX_EPADDR
);
363 /* If OUT endpoint empty, clear it and wait for the next packet from the host */
364 while (!(Endpoint_IsReadWriteAllowed()))
368 while (!(Endpoint_IsOUTReceived()))
370 if (USB_DeviceState
== DEVICE_STATE_Unattached
)
375 /* Fetch the next byte from the OUT endpoint */
376 return Endpoint_Read_8();
379 /** Writes the next response byte to the CDC data IN endpoint, and sends the endpoint back if needed to free up the
380 * bank when full ready for the next byte in the packet to the host.
382 * \param[in] Response Next response byte to send to the host
384 static void WriteNextResponseByte(const uint8_t Response
)
386 /* Select the IN endpoint so that the next data byte can be written */
387 Endpoint_SelectEndpoint(CDC_TX_EPADDR
);
389 /* If IN endpoint full, clear it and wait until ready for the next packet to the host */
390 if (!(Endpoint_IsReadWriteAllowed()))
394 while (!(Endpoint_IsINReady()))
396 if (USB_DeviceState
== DEVICE_STATE_Unattached
)
401 /* Write the next byte to the IN endpoint */
402 Endpoint_Write_8(Response
);
405 /** Task to read in AVR109 commands from the CDC data OUT endpoint, process them, perform the required actions
406 * and send the appropriate response back to the host.
408 static void CDC_Task(void)
410 /* Select the OUT endpoint */
411 Endpoint_SelectEndpoint(CDC_RX_EPADDR
);
413 /* Check if endpoint has a command in it sent from the host */
414 if (!(Endpoint_IsOUTReceived()))
417 /* Read in the bootloader command (first byte sent from host) */
418 uint8_t Command
= FetchNextCommandByte();
420 if (Command
== AVR109_COMMAND_ExitBootloader
)
422 RunBootloader
= false;
424 /* Send confirmation byte back to the host */
425 WriteNextResponseByte('\r');
427 else if ((Command
== AVR109_COMMAND_SetLED
) || (Command
== AVR109_COMMAND_ClearLED
) ||
428 (Command
== AVR109_COMMAND_SelectDeviceType
))
430 FetchNextCommandByte();
432 /* Send confirmation byte back to the host */
433 WriteNextResponseByte('\r');
435 else if ((Command
== AVR109_COMMAND_EnterProgrammingMode
) || (Command
== AVR109_COMMAND_LeaveProgrammingMode
))
437 /* Send confirmation byte back to the host */
438 WriteNextResponseByte('\r');
440 else if (Command
== AVR109_COMMAND_ReadPartCode
)
442 /* Return ATMEGA128 part code - this is only to allow AVRProg to use the bootloader */
443 WriteNextResponseByte(0x44);
444 WriteNextResponseByte(0x00);
446 else if (Command
== AVR109_COMMAND_ReadAutoAddressIncrement
)
448 /* Indicate auto-address increment is supported */
449 WriteNextResponseByte('Y');
451 else if (Command
== AVR109_COMMAND_SetCurrentAddress
)
453 /* Set the current address to that given by the host (translate 16-bit word address to byte address) */
454 CurrAddress
= (FetchNextCommandByte() << 9);
455 CurrAddress
|= (FetchNextCommandByte() << 1);
457 /* Send confirmation byte back to the host */
458 WriteNextResponseByte('\r');
460 else if (Command
== AVR109_COMMAND_ReadBootloaderInterface
)
462 /* Indicate serial programmer back to the host */
463 WriteNextResponseByte('S');
465 else if (Command
== AVR109_COMMAND_ReadBootloaderIdentifier
)
467 /* Write the 7-byte software identifier to the endpoint */
468 for (uint8_t CurrByte
= 0; CurrByte
< 7; CurrByte
++)
469 WriteNextResponseByte(SOFTWARE_IDENTIFIER
[CurrByte
]);
471 else if (Command
== AVR109_COMMAND_ReadBootloaderSWVersion
)
473 WriteNextResponseByte('0' + BOOTLOADER_VERSION_MAJOR
);
474 WriteNextResponseByte('0' + BOOTLOADER_VERSION_MINOR
);
476 else if (Command
== AVR109_COMMAND_ReadSignature
)
478 WriteNextResponseByte(AVR_SIGNATURE_3
);
479 WriteNextResponseByte(AVR_SIGNATURE_2
);
480 WriteNextResponseByte(AVR_SIGNATURE_1
);
482 else if (Command
== AVR109_COMMAND_EraseFLASH
)
484 /* Clear the application section of flash */
485 for (uint32_t CurrFlashAddress
= 0; CurrFlashAddress
< (uint32_t)BOOT_START_ADDR
; CurrFlashAddress
+= SPM_PAGESIZE
)
487 boot_page_erase(CurrFlashAddress
);
488 boot_spm_busy_wait();
489 boot_page_write(CurrFlashAddress
);
490 boot_spm_busy_wait();
493 /* Send confirmation byte back to the host */
494 WriteNextResponseByte('\r');
496 #if !defined(NO_LOCK_BYTE_WRITE_SUPPORT)
497 else if (Command
== AVR109_COMMAND_WriteLockbits
)
499 /* Set the lock bits to those given by the host */
500 boot_lock_bits_set(FetchNextCommandByte());
502 /* Send confirmation byte back to the host */
503 WriteNextResponseByte('\r');
506 else if (Command
== AVR109_COMMAND_ReadLockbits
)
508 WriteNextResponseByte(boot_lock_fuse_bits_get(GET_LOCK_BITS
));
510 else if (Command
== AVR109_COMMAND_ReadLowFuses
)
512 WriteNextResponseByte(boot_lock_fuse_bits_get(GET_LOW_FUSE_BITS
));
514 else if (Command
== AVR109_COMMAND_ReadHighFuses
)
516 WriteNextResponseByte(boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS
));
518 else if (Command
== AVR109_COMMAND_ReadExtendedFuses
)
520 WriteNextResponseByte(boot_lock_fuse_bits_get(GET_EXTENDED_FUSE_BITS
));
522 #if !defined(NO_BLOCK_SUPPORT)
523 else if (Command
== AVR109_COMMAND_GetBlockWriteSupport
)
525 WriteNextResponseByte('Y');
527 /* Send block size to the host */
528 WriteNextResponseByte(SPM_PAGESIZE
>> 8);
529 WriteNextResponseByte(SPM_PAGESIZE
& 0xFF);
531 else if ((Command
== AVR109_COMMAND_BlockWrite
) || (Command
== AVR109_COMMAND_BlockRead
))
533 /* Delegate the block write/read to a separate function for clarity */
534 ReadWriteMemoryBlock(Command
);
537 #if !defined(NO_FLASH_BYTE_SUPPORT)
538 else if (Command
== AVR109_COMMAND_FillFlashPageWordHigh
)
540 /* Write the high byte to the current flash page */
541 boot_page_fill(CurrAddress
, FetchNextCommandByte());
543 /* Send confirmation byte back to the host */
544 WriteNextResponseByte('\r');
546 else if (Command
== AVR109_COMMAND_FillFlashPageWordLow
)
548 /* Write the low byte to the current flash page */
549 boot_page_fill(CurrAddress
| 0x01, FetchNextCommandByte());
551 /* Increment the address */
554 /* Send confirmation byte back to the host */
555 WriteNextResponseByte('\r');
557 else if (Command
== AVR109_COMMAND_WriteFlashPage
)
559 /* Commit the flash page to memory */
560 boot_page_write(CurrAddress
);
562 /* Wait until write operation has completed */
563 boot_spm_busy_wait();
565 /* Send confirmation byte back to the host */
566 WriteNextResponseByte('\r');
568 else if (Command
== AVR109_COMMAND_ReadFLASHWord
)
570 #if (FLASHEND > 0xFFFF)
571 uint16_t ProgramWord
= pgm_read_word_far(CurrAddress
);
573 uint16_t ProgramWord
= pgm_read_word(CurrAddress
);
576 WriteNextResponseByte(ProgramWord
>> 8);
577 WriteNextResponseByte(ProgramWord
& 0xFF);
580 #if !defined(NO_EEPROM_BYTE_SUPPORT)
581 else if (Command
== AVR109_COMMAND_WriteEEPROM
)
583 /* Read the byte from the endpoint and write it to the EEPROM */
584 eeprom_write_byte((uint8_t*)((intptr_t)(CurrAddress
>> 1)), FetchNextCommandByte());
586 /* Increment the address after use */
589 /* Send confirmation byte back to the host */
590 WriteNextResponseByte('\r');
592 else if (Command
== AVR109_COMMAND_ReadEEPROM
)
594 /* Read the EEPROM byte and write it to the endpoint */
595 WriteNextResponseByte(eeprom_read_byte((uint8_t*)((intptr_t)(CurrAddress
>> 1))));
597 /* Increment the address after use */
601 else if (Command
!= AVR109_COMMAND_Sync
)
603 /* Unknown (non-sync) command, return fail code */
604 WriteNextResponseByte('?');
607 /* Select the IN endpoint */
608 Endpoint_SelectEndpoint(CDC_TX_EPADDR
);
610 /* Remember if the endpoint is completely full before clearing it */
611 bool IsEndpointFull
= !(Endpoint_IsReadWriteAllowed());
613 /* Send the endpoint data to the host */
616 /* If a full endpoint's worth of data was sent, we need to send an empty packet afterwards to signal end of transfer */
619 while (!(Endpoint_IsINReady()))
621 if (USB_DeviceState
== DEVICE_STATE_Unattached
)
628 /* Wait until the data has been sent to the host */
629 while (!(Endpoint_IsINReady()))
631 if (USB_DeviceState
== DEVICE_STATE_Unattached
)
635 /* Select the OUT endpoint */
636 Endpoint_SelectEndpoint(CDC_RX_EPADDR
);
638 /* Acknowledge the command from the host */