/*
LUFA Library
Copyright (C) Dean Camera, 2010.
-
+
dean [at] fourwalledcubicle [dot] com
www.fourwalledcubicle.com
*/
/*
Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
- Permission to use, copy, modify, distribute, and sell this
+ Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
- without fee, provided that the above copyright notice appear in
+ without fee, provided that the above copyright notice appear in
all copies and that both that the copyright notice and this
- permission notice and warranty disclaimer appear in supporting
- documentation, and that the name of the author not be used in
- advertising or publicity pertaining to distribution of the
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
software without specific, written prior permission.
The author disclaim all warranties with regard to this
*
* Main source file for the CDC class bootloader. This file contains the complete bootloader logic.
*/
-
+
#define INCLUDE_FROM_BOOTLOADERCDC_C
#include "BootloaderCDC.h"
-/** Line coding options for the virtual serial port. Although the virtual serial port data is never
- * sent through a physical serial port, the line encoding data must still be read and preserved from
- * the host, or the host will detect a problem and fail to open the port. This structure contains the
- * current encoding options, including baud rate, character format, parity mode and total number of
- * bits in each data chunk.
+/** Contains the current baud rate and other settings of the first virtual serial port. This must be retained as some
+ * operating systems will not open the port unless the settings can be set successfully.
*/
-CDC_Line_Coding_t LineCoding = { .BaudRateBPS = 9600,
- .CharFormat = OneStopBit,
- .ParityType = Parity_None,
- .DataBits = 8 };
+CDC_Line_Coding_t LineEncoding = { .BaudRateBPS = 0,
+ .CharFormat = OneStopBit,
+ .ParityType = Parity_None,
+ .DataBits = 8 };
/** Current address counter. This stores the current address of the FLASH or EEPROM as set by the host,
* and is used when reading or writing to the AVRs memory (either FLASH or EEPROM depending on the issued
bool RunBootloader = true;
-/** Main program entry point. This routine configures the hardware required by the bootloader, then continuously
+/** Main program entry point. This routine configures the hardware required by the bootloader, then continuously
* runs the bootloader processing routine until instructed to soft-exit, or hard-reset via the watchdog to start
* the loaded application code.
*/
CDC_Task();
USB_USBTask();
}
-
+
/* Disconnect from the host - USB interface will be reset later along with the AVR */
USB_Detach();
/* Disable clock division */
clock_prescale_set(clock_div_1);
-
+
/* Relocate the interrupt vector table to the bootloader section */
MCUCR = (1 << IVCE);
MCUCR = (1 << IVSEL);
-
+
/* Initialize USB Subsystem */
USB_Init();
}
{
/* Setup CDC Notification, Rx and Tx Endpoints */
Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,
- ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,
+ ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,
ENDPOINT_BANK_SINGLE);
Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK,
- ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,
+ ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,
ENDPOINT_BANK_SINGLE);
Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK,
- ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,
+ ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,
ENDPOINT_BANK_SINGLE);
}
/** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific
- * control requests that are not handled internally by the USB library, so that they can be handled appropriately
- * for the application.
+ * control requests that are not handled internally by the USB library (including the CDC control commands,
+ * which are all issued via the control endpoint), so that they can be handled appropriately for the application.
*/
void EVENT_USB_Device_UnhandledControlRequest(void)
{
- uint8_t* LineCodingData = (uint8_t*)&LineCoding;
-
/* Process CDC specific control requests */
switch (USB_ControlRequest.bRequest)
{
{
Endpoint_ClearSETUP();
- for (uint8_t i = 0; i < sizeof(LineCoding); i++)
- Endpoint_Write_Byte(*(LineCodingData++));
-
- Endpoint_ClearIN();
-
- Endpoint_ClearStatusStage();
+ /* Write the line coding data to the control endpoint */
+ Endpoint_Write_Control_Stream_LE(&LineEncoding, sizeof(CDC_Line_Coding_t));
+ Endpoint_ClearOUT();
}
-
+
break;
case REQ_SetLineEncoding:
if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
{
Endpoint_ClearSETUP();
- while (!(Endpoint_IsOUTReceived()))
- {
- if (USB_DeviceState == DEVICE_STATE_Unattached)
- return;
- }
-
- for (uint8_t i = 0; i < sizeof(LineCoding); i++)
- *(LineCodingData++) = Endpoint_Read_Byte();
-
- Endpoint_ClearOUT();
-
- Endpoint_ClearStatusStage();
- }
-
- break;
- case REQ_SetControlLineState:
- if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
- {
- Endpoint_ClearSETUP();
-
- Endpoint_ClearStatusStage();
+ /* Read the line coding data in from the host into the global struct */
+ Endpoint_Read_Control_Stream_LE(&LineEncoding, sizeof(CDC_Line_Coding_t));
+ Endpoint_ClearIN();
}
-
+
break;
}
}
{
uint16_t BlockSize;
char MemoryType;
-
+
bool HighByte = false;
uint8_t LowByte = 0;
-
+
BlockSize = (FetchNextCommandByte() << 8);
BlockSize |= FetchNextCommandByte();
-
+
MemoryType = FetchNextCommandByte();
if ((MemoryType != 'E') && (MemoryType != 'F'))
{
/* Send error byte back to the host */
WriteNextResponseByte('?');
-
+
return;
}
#if (FLASHEND > 0xFFFF)
WriteNextResponseByte(pgm_read_byte_far(CurrAddress | HighByte));
#else
- WriteNextResponseByte(pgm_read_byte(CurrAddress | HighByte));
+ WriteNextResponseByte(pgm_read_byte(CurrAddress | HighByte));
#endif
-
+
/* If both bytes in current word have been read, increment the address counter */
if (HighByte)
CurrAddress += 2;
-
+
HighByte = !HighByte;
}
else
/* Increment the address counter after use */
CurrAddress += 2;
- }
+ }
}
}
else
boot_page_erase(PageStartAddress);
boot_spm_busy_wait();
}
-
+
while (BlockSize--)
{
if (MemoryType == 'F')
- {
+ {
/* If both bytes in current word have been written, increment the address counter */
if (HighByte)
{
else
{
LowByte = FetchNextCommandByte();
-
+
HighByte = true;
}
}
else
{
/* Write the next EEPROM byte from the endpoint */
- eeprom_write_byte((uint8_t*)((intptr_t)(CurrAddress >> 1)), FetchNextCommandByte());
+ eeprom_write_byte((uint8_t*)((intptr_t)(CurrAddress >> 1)), FetchNextCommandByte());
/* Increment the address counter after use */
CurrAddress += 2;
{
/* Commit the flash page to memory */
boot_page_write(PageStartAddress);
-
+
/* Wait until write operation has completed */
boot_spm_busy_wait();
}
-
+
/* Send response byte back to the host */
- WriteNextResponseByte('\r');
+ WriteNextResponseByte('\r');
}
}
{
/* Select the OUT endpoint so that the next data byte can be read */
Endpoint_SelectEndpoint(CDC_RX_EPNUM);
-
+
/* If OUT endpoint empty, clear it and wait for the next packet from the host */
while (!(Endpoint_IsReadWriteAllowed()))
{
return 0;
}
}
-
+
/* Fetch the next byte from the OUT endpoint */
return Endpoint_Read_Byte();
}
{
/* Select the IN endpoint so that the next data byte can be written */
Endpoint_SelectEndpoint(CDC_TX_EPNUM);
-
+
/* If IN endpoint full, clear it and wait until ready for the next packet to the host */
if (!(Endpoint_IsReadWriteAllowed()))
{
Endpoint_ClearIN();
-
+
while (!(Endpoint_IsINReady()))
- {
+ {
if (USB_DeviceState == DEVICE_STATE_Unattached)
return;
}
}
-
+
/* Write the next byte to the OUT endpoint */
Endpoint_Write_Byte(Response);
}
{
/* Select the OUT endpoint */
Endpoint_SelectEndpoint(CDC_RX_EPNUM);
-
+
/* Check if endpoint has a command in it sent from the host */
if (Endpoint_IsOUTReceived())
{
{
if (Command == 'E')
RunBootloader = false;
- if (Command == 'T')
+ else if (Command == 'T')
FetchNextCommandByte();
/* Send confirmation byte back to the host */
- WriteNextResponseByte('\r');
+ WriteNextResponseByte('\r');
}
else if (Command == 't')
{
/* Return ATMEGA128 part code - this is only to allow AVRProg to use the bootloader */
WriteNextResponseByte(0x44);
-
WriteNextResponseByte(0x00);
}
else if (Command == 'a')
else if (Command == 'p')
{
/* Indicate serial programmer back to the host */
- WriteNextResponseByte('S');
+ WriteNextResponseByte('S');
}
else if (Command == 'S')
{
/* Write the 7-byte software identifier to the endpoint */
for (uint8_t CurrByte = 0; CurrByte < 7; CurrByte++)
- WriteNextResponseByte(SOFTWARE_IDENTIFIER[CurrByte]);
+ WriteNextResponseByte(SOFTWARE_IDENTIFIER[CurrByte]);
}
else if (Command == 'V')
{
}
else if (Command == 's')
{
- WriteNextResponseByte(AVR_SIGNATURE_3);
+ WriteNextResponseByte(AVR_SIGNATURE_3);
WriteNextResponseByte(AVR_SIGNATURE_2);
WriteNextResponseByte(AVR_SIGNATURE_1);
}
else if (Command == 'b')
{
WriteNextResponseByte('Y');
-
+
/* Send block size to the host */
WriteNextResponseByte(SPM_PAGESIZE >> 8);
- WriteNextResponseByte(SPM_PAGESIZE & 0xFF);
+ WriteNextResponseByte(SPM_PAGESIZE & 0xFF);
}
else if (Command == 'e')
{
CurrFlashAddress += SPM_PAGESIZE;
}
-
+
/* Send confirmation byte back to the host */
- WriteNextResponseByte('\r');
+ WriteNextResponseByte('\r');
}
else if (Command == 'l')
{
}
else if (Command == 'r')
{
- WriteNextResponseByte(boot_lock_fuse_bits_get(GET_LOCK_BITS));
+ WriteNextResponseByte(boot_lock_fuse_bits_get(GET_LOCK_BITS));
}
else if (Command == 'F')
{
}
else if (Command == 'N')
{
- WriteNextResponseByte(boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS));
+ WriteNextResponseByte(boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS));
}
else if (Command == 'Q')
{
- WriteNextResponseByte(boot_lock_fuse_bits_get(GET_EXTENDED_FUSE_BITS));
+ WriteNextResponseByte(boot_lock_fuse_bits_get(GET_EXTENDED_FUSE_BITS));
}
else if (Command == 'C')
- {
+ {
/* Write the high byte to the current flash page */
boot_page_fill(CurrAddress, FetchNextCommandByte());
/* Send confirmation byte back to the host */
- WriteNextResponseByte('\r');
+ WriteNextResponseByte('\r');
}
else if (Command == 'c')
- {
+ {
/* Write the low byte to the current flash page */
boot_page_fill(CurrAddress | 1, FetchNextCommandByte());
-
+
/* Increment the address */
CurrAddress += 2;
/* Send confirmation byte back to the host */
- WriteNextResponseByte('\r');
+ WriteNextResponseByte('\r');
}
else if (Command == 'm')
{
/* Commit the flash page to memory */
boot_page_write(CurrAddress);
-
+
/* Wait until write operation has completed */
boot_spm_busy_wait();
/* Send confirmation byte back to the host */
- WriteNextResponseByte('\r');
+ WriteNextResponseByte('\r');
}
else if ((Command == 'B') || (Command == 'g'))
{
#if (FLASHEND > 0xFFFF)
uint16_t ProgramWord = pgm_read_word_far(CurrAddress);
#else
- uint16_t ProgramWord = pgm_read_word(CurrAddress);
+ uint16_t ProgramWord = pgm_read_word(CurrAddress);
#endif
-
+
WriteNextResponseByte(ProgramWord >> 8);
WriteNextResponseByte(ProgramWord & 0xFF);
}
{
/* Read the byte from the endpoint and write it to the EEPROM */
eeprom_write_byte((uint8_t*)((intptr_t)(CurrAddress >> 1)), FetchNextCommandByte());
-
- /* Increment the address after use */
+
+ /* Increment the address after use */
CurrAddress += 2;
-
+
/* Send confirmation byte back to the host */
- WriteNextResponseByte('\r');
+ WriteNextResponseByte('\r');
}
else if (Command == 'd')
{
/* Send the endpoint data to the host */
Endpoint_ClearIN();
-
+
/* If a full endpoint's worth of data was sent, we need to send an empty packet afterwards to signal end of transfer */
if (IsEndpointFull)
{
while (!(Endpoint_IsINReady()))
- {
+ {
if (USB_DeviceState == DEVICE_STATE_Unattached)
return;
}
/* Wait until the data has been sent to the host */
while (!(Endpoint_IsINReady()))
- {
+ {
if (USB_DeviceState == DEVICE_STATE_Unattached)
return;
}
-
+
/* Select the OUT endpoint */
Endpoint_SelectEndpoint(CDC_RX_EPNUM);
Endpoint_ClearOUT();
}
}
+