3 Copyright (C) Dean Camera, 2009.
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
10 Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
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.
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
33 * Main source file for the DFU class bootloader. This file contains the complete bootloader logic.
36 #define INCLUDE_FROM_BOOTLOADER_C
37 #include "BootloaderDFU.h"
39 /** Flag to indicate if the bootloader is currently running in secure mode, disallowing memory operations
40 * other than erase. This is initially set to the value set by SECURE_MODE, and cleared by the bootloader
41 * once a memory erase has completed.
43 bool IsSecure
= SECURE_MODE
;
45 /** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run
46 * via a soft reset. When cleared, the bootloader will abort, the USB interface will shut down and the application
47 * jumped to via an indirect jump to location 0x0000 (or other location specified by the host).
49 bool RunBootloader
= true;
51 /** Flag to indicate if the bootloader is waiting to exit. When the host requests the bootloader to exit and
52 * jump to the application address it specifies, it sends two sequential commands which must be properly
53 * acknowledged. Upon reception of the first the RunBootloader flag is cleared and the WaitForExit flag is set,
54 * causing the bootloader to wait for the final exit command before shutting down.
56 bool WaitForExit
= false;
58 /** Current DFU state machine state, one of the values in the DFU_State_t enum. */
59 uint8_t DFU_State
= dfuIDLE
;
61 /** Status code of the last executed DFU command. This is set to one of the values in the DFU_Status_t enum after
62 * each operation, and returned to the host when a Get Status DFU request is issued.
64 uint8_t DFU_Status
= OK
;
66 /** Data containing the DFU command sent from the host. */
67 DFU_Command_t SentCommand
;
69 /** Response to the last issued Read Data DFU command. Unlike other DFU commands, the read command
70 * requires a single byte response from the bootloader containing the read data when the next DFU_UPLOAD command
71 * is issued by the host.
75 /** Pointer to the start of the user application. By default this is 0x0000 (the reset vector), however the host
76 * may specify an alternate address when issuing the application soft-start command.
78 AppPtr_t AppStartPtr
= (AppPtr_t
)0x0000;
80 /** 64-bit flash page number. This is concatenated with the current 16-bit address on USB AVRs containing more than
81 * 64KB of flash memory.
83 uint8_t Flash64KBPage
= 0;
85 /** Memory start address, indicating the current address in the memory being addressed (either FLASH or EEPROM
86 * depending on the issued command from the host).
88 uint16_t StartAddr
= 0x0000;
90 /** Memory end address, indicating the end address to read to/write from in the memory being addressed (either FLASH
91 * of EEPROM depending on the issued command from the host).
93 uint16_t EndAddr
= 0x0000;
95 /** Main program entry point. This routine configures the hardware required by the bootloader, then continuously
96 * runs the bootloader processing routine until instructed to soft-exit, or hard-reset via the watchdog to start
97 * the loaded application code.
101 /* Disable watchdog if enabled by bootloader/fuses */
102 MCUSR
&= ~(1 << WDRF
);
105 /* Disable clock division */
106 clock_prescale_set(clock_div_1
);
108 /* Relocate the interrupt vector table to the bootloader section */
110 MCUCR
= (1 << IVSEL
);
112 /* Initialize the USB subsystem */
115 /* Run the USB management task while the bootloader is supposed to be running */
116 while (RunBootloader
|| WaitForExit
)
119 /* Shut down the USB subsystem */
122 /* Relocate the interrupt vector table back to the application section */
126 /* Reset any used hardware ports back to their defaults */
135 /* Start the user application */
139 /** Event handler for the USB_Disconnect event. This indicates that the bootloader should exit and the user
140 * application started.
142 EVENT_HANDLER(USB_Disconnect
)
144 /* Upon disconnection, run user application */
145 RunBootloader
= false;
148 /** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific
149 * control requests that are not handled internally by the USB library (including the DFU commands, which are
150 * all issued via the control endpoint), so that they can be handled appropriately for the application.
152 EVENT_HANDLER(USB_UnhandledControlPacket
)
154 /* Get the size of the command and data from the wLength value */
155 SentCommand
.DataSize
= USB_ControlRequest
.wLength
;
157 switch (USB_ControlRequest
.bRequest
)
160 Endpoint_ClearSETUP();
162 /* Check if bootloader is waiting to terminate */
165 /* Bootloader is terminating - process last received command */
166 ProcessBootloaderCommand();
168 /* Indicate that the last command has now been processed - free to exit bootloader */
172 /* If the request has a data stage, load it into the command struct */
173 if (SentCommand
.DataSize
)
175 while (!(Endpoint_IsOUTReceived()));
177 /* First byte of the data stage is the DNLOAD request's command */
178 SentCommand
.Command
= Endpoint_Read_Byte();
180 /* One byte of the data stage is the command, so subtract it from the total data bytes */
181 SentCommand
.DataSize
--;
183 /* Load in the rest of the data stage as command parameters */
184 for (uint8_t DataByte
= 0; (DataByte
< sizeof(SentCommand
.Data
)) &&
185 Endpoint_BytesInEndpoint(); DataByte
++)
187 SentCommand
.Data
[DataByte
] = Endpoint_Read_Byte();
188 SentCommand
.DataSize
--;
191 /* Process the command */
192 ProcessBootloaderCommand();
195 /* Check if currently downloading firmware */
196 if (DFU_State
== dfuDNLOAD_IDLE
)
198 if (!(SentCommand
.DataSize
))
204 /* Throw away the filler bytes before the start of the firmware */
205 DiscardFillerBytes(DFU_FILLER_BYTES_SIZE
);
207 /* Throw away the page alignment filler bytes before the start of the firmware */
208 DiscardFillerBytes(StartAddr
% SPM_PAGESIZE
);
210 /* Calculate the number of bytes remaining to be written */
211 uint16_t BytesRemaining
= ((EndAddr
- StartAddr
) + 1);
213 if (IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x00)) // Write flash
215 /* Calculate the number of words to be written from the number of bytes to be written */
216 uint16_t WordsRemaining
= (BytesRemaining
>> 1);
222 } CurrFlashAddress
= {.Words
= {StartAddr
, Flash64KBPage
}};
224 uint32_t CurrFlashPageStartAddress
= CurrFlashAddress
.Long
;
225 uint8_t WordsInFlashPage
= 0;
227 while (WordsRemaining
--)
229 /* Check if endpoint is empty - if so clear it and wait until ready for next packet */
230 if (!(Endpoint_BytesInEndpoint()))
233 while (!(Endpoint_IsOUTReceived()));
236 /* Write the next word into the current flash page */
237 boot_page_fill(CurrFlashAddress
.Long
, Endpoint_Read_Word_LE());
239 /* Adjust counters */
240 WordsInFlashPage
+= 1;
241 CurrFlashAddress
.Long
+= 2;
243 /* See if an entire page has been written to the flash page buffer */
244 if ((WordsInFlashPage
== (SPM_PAGESIZE
>> 1)) || !(WordsRemaining
))
246 /* Commit the flash page to memory */
247 boot_page_write(CurrFlashPageStartAddress
);
248 boot_spm_busy_wait();
250 /* Check if programming incomplete */
253 CurrFlashPageStartAddress
= CurrFlashAddress
.Long
;
254 WordsInFlashPage
= 0;
256 /* Erase next page's temp buffer */
257 boot_page_erase(CurrFlashAddress
.Long
);
258 boot_spm_busy_wait();
263 /* Once programming complete, start address equals the end address */
266 /* Re-enable the RWW section of flash */
271 while (BytesRemaining
--)
273 /* Check if endpoint is empty - if so clear it and wait until ready for next packet */
274 if (!(Endpoint_BytesInEndpoint()))
277 while (!(Endpoint_IsOUTReceived()));
280 /* Read the byte from the USB interface and write to to the EEPROM */
281 eeprom_write_byte((uint8_t*)StartAddr
, Endpoint_Read_Byte());
283 /* Adjust counters */
288 /* Throw away the currently unused DFU file suffix */
289 DiscardFillerBytes(DFU_FILE_SUFFIX_SIZE
);
295 /* Acknowledge status stage */
296 while (!(Endpoint_IsINReady()));
301 Endpoint_ClearSETUP();
303 while (!(Endpoint_IsINReady()));
305 if (DFU_State
!= dfuUPLOAD_IDLE
)
307 if ((DFU_State
== dfuERROR
) && IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x01)) // Blank Check
309 /* Blank checking is performed in the DFU_DNLOAD request - if we get here we've told the host
310 that the memory isn't blank, and the host is requesting the first non-blank address */
311 Endpoint_Write_Word_LE(StartAddr
);
315 /* Idle state upload - send response to last issued command */
316 Endpoint_Write_Byte(ResponseByte
);
321 /* Determine the number of bytes remaining in the current block */
322 uint16_t BytesRemaining
= ((EndAddr
- StartAddr
) + 1);
324 if (IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x00)) // Read FLASH
326 /* Calculate the number of words to be written from the number of bytes to be written */
327 uint16_t WordsRemaining
= (BytesRemaining
>> 1);
333 } CurrFlashAddress
= {.Words
= {StartAddr
, Flash64KBPage
}};
335 while (WordsRemaining
--)
337 /* Check if endpoint is full - if so clear it and wait until ready for next packet */
338 if (Endpoint_BytesInEndpoint() == FIXED_CONTROL_ENDPOINT_SIZE
)
341 while (!(Endpoint_IsINReady()));
344 /* Read the flash word and send it via USB to the host */
346 Endpoint_Write_Word_LE(pgm_read_word_far(CurrFlashAddress
.Long
));
348 Endpoint_Write_Word_LE(pgm_read_word(CurrFlashAddress
.Long
));
351 /* Adjust counters */
352 CurrFlashAddress
.Long
+= 2;
355 /* Once reading is complete, start address equals the end address */
358 else if (IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x02)) // Read EEPROM
360 while (BytesRemaining
--)
362 /* Check if endpoint is full - if so clear it and wait until ready for next packet */
363 if (Endpoint_BytesInEndpoint() == FIXED_CONTROL_ENDPOINT_SIZE
)
366 while (!(Endpoint_IsINReady()));
369 /* Read the EEPROM byte and send it via USB to the host */
370 Endpoint_Write_Byte(eeprom_read_byte((uint8_t*)StartAddr
));
372 /* Adjust counters */
377 /* Return to idle state */
383 /* Acknowledge status stage */
384 while (!(Endpoint_IsOUTReceived()));
389 Endpoint_ClearSETUP();
391 /* Write 8-bit status value */
392 Endpoint_Write_Byte(DFU_Status
);
394 /* Write 24-bit poll timeout value */
395 Endpoint_Write_Byte(0);
396 Endpoint_Write_Word_LE(0);
398 /* Write 8-bit state value */
399 Endpoint_Write_Byte(DFU_State
);
401 /* Write 8-bit state string ID number */
402 Endpoint_Write_Byte(0);
406 /* Acknowledge status stage */
407 while (!(Endpoint_IsOUTReceived()));
412 Endpoint_ClearSETUP();
414 /* Reset the status value variable to the default OK status */
417 /* Acknowledge status stage */
418 while (!(Endpoint_IsINReady()));
423 Endpoint_ClearSETUP();
425 /* Write the current device state to the endpoint */
426 Endpoint_Write_Byte(DFU_State
);
430 /* Acknowledge status stage */
431 while (!(Endpoint_IsOUTReceived()));
436 Endpoint_ClearSETUP();
438 /* Reset the current state variable to the default idle state */
441 /* Acknowledge status stage */
442 while (!(Endpoint_IsINReady()));
449 /** Routine to discard the specified number of bytes from the control endpoint stream. This is used to
450 * discard unused bytes in the stream from the host, including the memory program block suffix.
452 * \param NumberOfBytes Number of bytes to discard from the host from the control endpoint
454 static void DiscardFillerBytes(uint8_t NumberOfBytes
)
456 while (NumberOfBytes
--)
458 if (!(Endpoint_BytesInEndpoint()))
462 /* Wait until next data packet received */
463 while (!(Endpoint_IsOUTReceived()));
466 Endpoint_Discard_Byte();
470 /** Routine to process an issued command from the host, via a DFU_DNLOAD request wrapper. This routine ensures
471 * that the command is allowed based on the current secure mode flag value, and passes the command off to the
472 * appropriate handler function.
474 static void ProcessBootloaderCommand(void)
476 /* Check if device is in secure mode */
479 /* Don't process command unless it is a READ or chip erase command */
480 if (!(((SentCommand
.Command
== COMMAND_WRITE
) &&
481 IS_TWOBYTE_COMMAND(SentCommand
.Data
, 0x00, 0xFF)) ||
482 (SentCommand
.Command
== COMMAND_READ
)))
484 /* Set the state and status variables to indicate the error */
485 DFU_State
= dfuERROR
;
486 DFU_Status
= errWRITE
;
489 Endpoint_StallTransaction();
491 /* Don't process the command */
496 /* Dispatch the required command processing routine based on the command type */
497 switch (SentCommand
.Command
)
499 case COMMAND_PROG_START
:
500 ProcessMemProgCommand();
502 case COMMAND_DISP_DATA
:
503 ProcessMemReadCommand();
506 ProcessWriteCommand();
509 ProcessReadCommand();
511 case COMMAND_CHANGE_BASE_ADDR
:
512 if (IS_TWOBYTE_COMMAND(SentCommand
.Data
, 0x03, 0x00)) // Set 64KB flash page command
513 Flash64KBPage
= SentCommand
.Data
[2];
519 /** Routine to concatenate the given pair of 16-bit memory start and end addresses from the host, and store them
520 * in the StartAddr and EndAddr global variables.
522 static void LoadStartEndAddresses(void)
528 } Address
[2] = {{.Bytes
= {SentCommand
.Data
[2], SentCommand
.Data
[1]}},
529 {.Bytes
= {SentCommand
.Data
[4], SentCommand
.Data
[3]}}};
531 /* Load in the start and ending read addresses from the sent data packet */
532 StartAddr
= Address
[0].Word
;
533 EndAddr
= Address
[1].Word
;
536 /** Handler for a Memory Program command issued by the host. This routine handles the preparations needed
537 * to write subsequent data from the host into the specified memory.
539 static void ProcessMemProgCommand(void)
541 if (IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x00) || // Write FLASH command
542 IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x01)) // Write EEPROM command
544 /* Load in the start and ending read addresses */
545 LoadStartEndAddresses();
547 /* If FLASH is being written to, we need to pre-erase the first page to write to */
548 if (IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x00))
554 } CurrFlashAddress
= {.Words
= {StartAddr
, Flash64KBPage
}};
556 /* Erase the current page's temp buffer */
557 boot_page_erase(CurrFlashAddress
.Long
);
558 boot_spm_busy_wait();
561 /* Set the state so that the next DNLOAD requests reads in the firmware */
562 DFU_State
= dfuDNLOAD_IDLE
;
566 /** Handler for a Memory Read command issued by the host. This routine handles the preparations needed
567 * to read subsequent data from the specified memory out to the host, as well as implementing the memory
568 * blank check command.
570 static void ProcessMemReadCommand(void)
572 if (IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x00) || // Read FLASH command
573 IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x02)) // Read EEPROM command
575 /* Load in the start and ending read addresses */
576 LoadStartEndAddresses();
578 /* Set the state so that the next UPLOAD requests read out the firmware */
579 DFU_State
= dfuUPLOAD_IDLE
;
581 else if (IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x01)) // Blank check FLASH command
583 uint32_t CurrFlashAddress
= 0;
585 while (CurrFlashAddress
< BOOT_START_ADDR
)
587 /* Check if the current byte is not blank */
589 if (pgm_read_byte_far(CurrFlashAddress
) != 0xFF)
591 if (pgm_read_byte(CurrFlashAddress
) != 0xFF)
594 /* Save the location of the first non-blank byte for response back to the host */
595 Flash64KBPage
= (CurrFlashAddress
>> 16);
596 StartAddr
= CurrFlashAddress
;
598 /* Set state and status variables to the appropriate error values */
599 DFU_State
= dfuERROR
;
600 DFU_Status
= errCHECK_ERASED
;
610 /** Handler for a Data Write command issued by the host. This routine handles non-programming commands such as
611 * bootloader exit (both via software jumps and hardware watchdog resets) and flash memory erasure.
613 static void ProcessWriteCommand(void)
615 if (IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x03)) // Start application
617 /* Indicate that the bootloader is terminating */
620 /* Check if empty request data array - an empty request after a filled request retains the
621 previous valid request data, but initializes the reset */
622 if (!(SentCommand
.DataSize
))
624 if (SentCommand
.Data
[1] == 0x00) // Start via watchdog
626 /* Start the watchdog to reset the AVR once the communications are finalized */
627 wdt_enable(WDTO_250MS
);
629 else // Start via jump
631 /* Load in the jump address into the application start address pointer */
636 } Address
= {.Bytes
= {SentCommand
.Data
[4], SentCommand
.Data
[3]}};
638 AppStartPtr
= Address
.FuncPtr
;
640 /* Set the flag to terminate the bootloader at next opportunity */
641 RunBootloader
= false;
645 else if (IS_TWOBYTE_COMMAND(SentCommand
.Data
, 0x00, 0xFF)) // Erase flash
647 uint32_t CurrFlashAddress
= 0;
649 /* Clear the application section of flash */
650 while (CurrFlashAddress
< BOOT_START_ADDR
)
652 boot_page_erase(CurrFlashAddress
);
653 boot_spm_busy_wait();
654 boot_page_write(CurrFlashAddress
);
655 boot_spm_busy_wait();
657 CurrFlashAddress
+= SPM_PAGESIZE
;
660 /* Re-enable the RWW section of flash as writing to the flash locks it out */
663 /* Memory has been erased, reset the security bit so that programming/reading is allowed */
668 /** Handler for a Data Read command issued by the host. This routine handles bootloader information retrieval
669 * commands such as device signature and bootloader version retrieval.
671 static void ProcessReadCommand(void)
673 const uint8_t BootloaderInfo
[3] = {BOOTLOADER_VERSION
, BOOTLOADER_ID_BYTE1
, BOOTLOADER_ID_BYTE2
};
674 const uint8_t SignatureInfo
[3] = {SIGNATURE_0
, SIGNATURE_1
, SIGNATURE_2
};
676 uint8_t DataIndexToRead
= SentCommand
.Data
[1];
678 if (IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x00)) // Read bootloader info
680 ResponseByte
= BootloaderInfo
[DataIndexToRead
];
682 else if (IS_ONEBYTE_COMMAND(SentCommand
.Data
, 0x01)) // Read signature byte
684 ResponseByte
= SignatureInfo
[DataIndexToRead
- 0x30];