/* LUFA Library Copyright (C) Dean Camera, 2012. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) 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 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 software without specific, written prior permission. The author disclaims all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */ /** \file * * Main source file for the CDC class bootloader. This file contains the complete bootloader logic. */ #define INCLUDE_FROM_BOOTLOADERCDC_C #include "BootloaderCDC.h" /** 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. */ static CDC_LineEncoding_t LineEncoding = { .BaudRateBPS = 0, .CharFormat = CDC_LINEENCODING_OneStopBit, .ParityType = CDC_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 * command.) */ static uint32_t CurrAddress; /** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run * via a watchdog reset. When cleared the bootloader will exit, starting the watchdog and entering an infinite * loop until the AVR restarts and the application runs. */ static bool RunBootloader = true; /** Magic lock for forced application start. If the HWBE fuse is programmed and BOOTRST is unprogrammed, the bootloader * 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 * low when the application attempts to start via a watchdog reset, the bootloader will re-start. If set to the value * \ref MAGIC_BOOT_KEY the special init function \ref Application_Jump_Check() will force the application to start. */ uint16_t MagicBootKey ATTR_NO_INIT; /** Special startup routine to check if the bootloader was started via a watchdog reset, and if the magic application * start key has been loaded into \ref MagicBootKey. If the bootloader started via the watchdog and the key is valid, * this will force the user application to start via a software jump. */ void Application_Jump_Check(void) { bool JumpToApplication = false; #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1)) /* Disable JTAG debugging */ JTAG_DISABLE(); /* Enable pull-up on the JTAG TCK pin so we can use it to select the mode */ PORTF |= (1 << 4); Delay_MS(10); /* If the TCK pin is not jumpered to ground, start the user application instead */ JumpToApplication |= ((PINF & (1 << 4)) != 0); /* Re-enable JTAG debugging */ JTAG_ENABLE(); #endif /* If the reset source was the bootloader and the key is correct, clear it and jump to the application */ if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY)) JumpToApplication |= true; /* If a request has been made to jump to the user application, honor it */ if (JumpToApplication) { /* Turn off the watchdog */ MCUSR &= ~(1< 0xFFFF) WriteNextResponseByte(pgm_read_byte_far(CurrAddress | HighByte)); #else 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 { /* Read the next EEPROM byte into the endpoint */ WriteNextResponseByte(eeprom_read_byte((uint8_t*)(intptr_t)(CurrAddress >> 1))); /* Increment the address counter after use */ CurrAddress += 2; } } } else { uint32_t PageStartAddress = CurrAddress; if (MemoryType == MEMORY_TYPE_FLASH) { boot_page_erase(PageStartAddress); boot_spm_busy_wait(); } while (BlockSize--) { if (MemoryType == MEMORY_TYPE_FLASH) { /* If both bytes in current word have been written, increment the address counter */ if (HighByte) { /* Write the next FLASH word to the current FLASH page */ boot_page_fill(CurrAddress, ((FetchNextCommandByte() << 8) | LowByte)); /* Increment the address counter after use */ CurrAddress += 2; } else { LowByte = FetchNextCommandByte(); } HighByte = !HighByte; } else { /* Write the next EEPROM byte from the endpoint */ eeprom_write_byte((uint8_t*)((intptr_t)(CurrAddress >> 1)), FetchNextCommandByte()); /* Increment the address counter after use */ CurrAddress += 2; } } /* If in FLASH programming mode, commit the page after writing */ if (MemoryType == MEMORY_TYPE_FLASH) { /* 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'); } } #endif /** Retrieves the next byte from the host in the CDC data OUT endpoint, and clears the endpoint bank if needed * to allow reception of the next data packet from the host. * * \return Next received byte from the host in the CDC data OUT endpoint */ static uint8_t FetchNextCommandByte(void) { /* Select the OUT endpoint so that the next data byte can be read */ Endpoint_SelectEndpoint(CDC_RX_EPADDR); /* If OUT endpoint empty, clear it and wait for the next packet from the host */ while (!(Endpoint_IsReadWriteAllowed())) { Endpoint_ClearOUT(); while (!(Endpoint_IsOUTReceived())) { if (USB_DeviceState == DEVICE_STATE_Unattached) return 0; } } /* Fetch the next byte from the OUT endpoint */ return Endpoint_Read_8(); } /** Writes the next response byte to the CDC data IN endpoint, and sends the endpoint back if needed to free up the * bank when full ready for the next byte in the packet to the host. * * \param[in] Response Next response byte to send to the host */ static void WriteNextResponseByte(const uint8_t Response) { /* Select the IN endpoint so that the next data byte can be written */ Endpoint_SelectEndpoint(CDC_TX_EPADDR); /* 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 IN endpoint */ Endpoint_Write_8(Response); } /** Task to read in AVR910 commands from the CDC data OUT endpoint, process them, perform the required actions * and send the appropriate response back to the host. */ static void CDC_Task(void) { /* Select the OUT endpoint */ Endpoint_SelectEndpoint(CDC_RX_EPADDR); /* Check if endpoint has a command in it sent from the host */ if (!(Endpoint_IsOUTReceived())) return; /* Read in the bootloader command (first byte sent from host) */ uint8_t Command = FetchNextCommandByte(); if (Command == AVR109_COMMAND_ExitBootloader) { RunBootloader = false; /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } else if ((Command == AVR109_COMMAND_SetLED) || (Command == AVR109_COMMAND_ClearLED) || (Command == AVR109_COMMAND_SelectDeviceType)) { FetchNextCommandByte(); /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } else if ((Command == AVR109_COMMAND_EnterProgrammingMode) || (Command == AVR109_COMMAND_LeaveProgrammingMode)) { /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } else if (Command == AVR109_COMMAND_ReadPartCode) { /* Return ATMEGA128 part code - this is only to allow AVRProg to use the bootloader */ WriteNextResponseByte(0x44); WriteNextResponseByte(0x00); } else if (Command == AVR109_COMMAND_ReadAutoAddressIncrement) { /* Indicate auto-address increment is supported */ WriteNextResponseByte('Y'); } else if (Command == AVR109_COMMAND_SetCurrentAddress) { /* Set the current address to that given by the host (translate 16-bit word address to byte address) */ CurrAddress = (FetchNextCommandByte() << 9); CurrAddress |= (FetchNextCommandByte() << 1); /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } else if (Command == AVR109_COMMAND_ReadBootloaderInterface) { /* Indicate serial programmer back to the host */ WriteNextResponseByte('S'); } else if (Command == AVR109_COMMAND_ReadBootloaderIdentifier) { /* Write the 7-byte software identifier to the endpoint */ for (uint8_t CurrByte = 0; CurrByte < 7; CurrByte++) WriteNextResponseByte(SOFTWARE_IDENTIFIER[CurrByte]); } else if (Command == AVR109_COMMAND_ReadBootloaderSWVersion) { WriteNextResponseByte('0' + BOOTLOADER_VERSION_MAJOR); WriteNextResponseByte('0' + BOOTLOADER_VERSION_MINOR); } else if (Command == AVR109_COMMAND_ReadSignature) { WriteNextResponseByte(AVR_SIGNATURE_3); WriteNextResponseByte(AVR_SIGNATURE_2); WriteNextResponseByte(AVR_SIGNATURE_1); } else if (Command == AVR109_COMMAND_EraseFLASH) { /* Clear the application section of flash */ for (uint32_t CurrFlashAddress = 0; CurrFlashAddress < (uint32_t)BOOT_START_ADDR; CurrFlashAddress += SPM_PAGESIZE) { boot_page_erase(CurrFlashAddress); boot_spm_busy_wait(); boot_page_write(CurrFlashAddress); boot_spm_busy_wait(); } /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } #if !defined(NO_LOCK_BYTE_WRITE_SUPPORT) else if (Command == AVR109_COMMAND_WriteLockbits) { /* Set the lock bits to those given by the host */ boot_lock_bits_set(FetchNextCommandByte()); /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } #endif else if (Command == AVR109_COMMAND_ReadLockbits) { WriteNextResponseByte(boot_lock_fuse_bits_get(GET_LOCK_BITS)); } else if (Command == AVR109_COMMAND_ReadLowFuses) { WriteNextResponseByte(boot_lock_fuse_bits_get(GET_LOW_FUSE_BITS)); } else if (Command == AVR109_COMMAND_ReadHighFuses) { WriteNextResponseByte(boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS)); } else if (Command == AVR109_COMMAND_ReadExtendedFuses) { WriteNextResponseByte(boot_lock_fuse_bits_get(GET_EXTENDED_FUSE_BITS)); } #if !defined(NO_BLOCK_SUPPORT) else if (Command == AVR109_COMMAND_GetBlockWriteSupport) { WriteNextResponseByte('Y'); /* Send block size to the host */ WriteNextResponseByte(SPM_PAGESIZE >> 8); WriteNextResponseByte(SPM_PAGESIZE & 0xFF); } else if ((Command == AVR109_COMMAND_BlockWrite) || (Command == AVR109_COMMAND_BlockRead)) { /* Delegate the block write/read to a separate function for clarity */ ReadWriteMemoryBlock(Command); } #endif #if !defined(NO_FLASH_BYTE_SUPPORT) else if (Command == AVR109_COMMAND_FillFlashPageWordHigh) { /* Write the high byte to the current flash page */ boot_page_fill(CurrAddress, FetchNextCommandByte()); /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } else if (Command == AVR109_COMMAND_FillFlashPageWordLow) { /* Write the low byte to the current flash page */ boot_page_fill(CurrAddress | 0x01, FetchNextCommandByte()); /* Increment the address */ CurrAddress += 2; /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } else if (Command == AVR109_COMMAND_WriteFlashPage) { /* 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'); } else if (Command == AVR109_COMMAND_ReadFLASHWord) { #if (FLASHEND > 0xFFFF) uint16_t ProgramWord = pgm_read_word_far(CurrAddress); #else uint16_t ProgramWord = pgm_read_word(CurrAddress); #endif WriteNextResponseByte(ProgramWord >> 8); WriteNextResponseByte(ProgramWord & 0xFF); } #endif #if !defined(NO_EEPROM_BYTE_SUPPORT) else if (Command == AVR109_COMMAND_WriteEEPROM) { /* 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 */ CurrAddress += 2; /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } else if (Command == AVR109_COMMAND_ReadEEPROM) { /* Read the EEPROM byte and write it to the endpoint */ WriteNextResponseByte(eeprom_read_byte((uint8_t*)((intptr_t)(CurrAddress >> 1)))); /* Increment the address after use */ CurrAddress += 2; } #endif else if (Command != AVR109_COMMAND_Sync) { /* Unknown (non-sync) command, return fail code */ WriteNextResponseByte('?'); } /* Select the IN endpoint */ Endpoint_SelectEndpoint(CDC_TX_EPADDR); /* Remember if the endpoint is completely full before clearing it */ bool IsEndpointFull = !(Endpoint_IsReadWriteAllowed()); /* 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; } Endpoint_ClearIN(); } /* 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_EPADDR); /* Acknowledge the command from the host */ Endpoint_ClearOUT(); }