X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/40db485c7967c584eb9fe855e744ed0dc6fe8bae..5cae54154506176d64a581c5b3d9550c901b570c:/Bootloaders/CDC/BootloaderCDC.c diff --git a/Bootloaders/CDC/BootloaderCDC.c b/Bootloaders/CDC/BootloaderCDC.c index 74dd5d293..5f1047eee 100644 --- a/Bootloaders/CDC/BootloaderCDC.c +++ b/Bootloaders/CDC/BootloaderCDC.c @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. + Copyright (C) Dean Camera, 2013. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2013 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 @@ -18,7 +18,7 @@ advertising or publicity pertaining to distribution of the software without specific, written prior permission. - The author disclaim all warranties with regard to this + 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 @@ -39,23 +39,72 @@ /** 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 LineEncoding = { .BaudRateBPS = 0, - .CharFormat = OneStopBit, - .ParityType = Parity_None, - .DataBits = 8 }; +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.) */ -uint32_t CurrAddress; +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. */ -bool RunBootloader = true; +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) @@ -219,7 +298,7 @@ static void ReadWriteMemoryBlock(const uint8_t Command) { uint32_t PageStartAddress = CurrAddress; - if (MemoryType == 'F') + if (MemoryType == MEMORY_TYPE_FLASH) { boot_page_erase(PageStartAddress); boot_spm_busy_wait(); @@ -227,7 +306,7 @@ static void ReadWriteMemoryBlock(const uint8_t Command) while (BlockSize--) { - if (MemoryType == 'F') + if (MemoryType == MEMORY_TYPE_FLASH) { /* If both bytes in current word have been written, increment the address counter */ if (HighByte) @@ -242,7 +321,7 @@ static void ReadWriteMemoryBlock(const uint8_t Command) { LowByte = FetchNextCommandByte(); } - + HighByte = !HighByte; } else @@ -256,7 +335,7 @@ static void ReadWriteMemoryBlock(const uint8_t Command) } /* If in FLASH programming mode, commit the page after writing */ - if (MemoryType == 'F') + if (MemoryType == MEMORY_TYPE_FLASH) { /* Commit the flash page to memory */ boot_page_write(PageStartAddress); @@ -279,7 +358,7 @@ static void ReadWriteMemoryBlock(const uint8_t Command) static uint8_t FetchNextCommandByte(void) { /* Select the OUT endpoint so that the next data byte can be read */ - Endpoint_SelectEndpoint(CDC_RX_EPNUM); + Endpoint_SelectEndpoint(CDC_RX_EPADDR); /* If OUT endpoint empty, clear it and wait for the next packet from the host */ while (!(Endpoint_IsReadWriteAllowed())) @@ -294,7 +373,7 @@ static uint8_t FetchNextCommandByte(void) } /* Fetch the next byte from the OUT endpoint */ - return Endpoint_Read_Byte(); + 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 @@ -305,7 +384,7 @@ static uint8_t FetchNextCommandByte(void) static void WriteNextResponseByte(const uint8_t Response) { /* Select the IN endpoint so that the next data byte can be written */ - Endpoint_SelectEndpoint(CDC_TX_EPNUM); + 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())) @@ -319,17 +398,17 @@ static void WriteNextResponseByte(const uint8_t Response) } } - /* Write the next byte to the OUT endpoint */ - Endpoint_Write_Byte(Response); + /* 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 +/** Task to read in AVR109 commands from the CDC data OUT endpoint, process them, perform the required actions * and send the appropriate response back to the host. */ -void CDC_Task(void) +static void CDC_Task(void) { /* Select the OUT endpoint */ - Endpoint_SelectEndpoint(CDC_RX_EPNUM); + Endpoint_SelectEndpoint(CDC_RX_EPADDR); /* Check if endpoint has a command in it sent from the host */ if (!(Endpoint_IsOUTReceived())) @@ -338,71 +417,72 @@ void CDC_Task(void) /* Read in the bootloader command (first byte sent from host) */ uint8_t Command = FetchNextCommandByte(); - if (Command == 'E') + if (Command == AVR109_COMMAND_ExitBootloader) { RunBootloader = false; - + /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } - else if (Command == 'T') + 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 == 'L') || (Command == 'P')) + else if ((Command == AVR109_COMMAND_EnterProgrammingMode) || (Command == AVR109_COMMAND_LeaveProgrammingMode)) { /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } - else if (Command == 't') + 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 == 'a') + else if (Command == AVR109_COMMAND_ReadAutoAddressIncrement) { /* Indicate auto-address increment is supported */ WriteNextResponseByte('Y'); } - else if (Command == 'A') + else if (Command == AVR109_COMMAND_SetCurrentAddress) { - /* Set the current address to that given by the host */ + /* 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 == 'p') + else if (Command == AVR109_COMMAND_ReadBootloaderInterface) { /* Indicate serial programmer back to the host */ WriteNextResponseByte('S'); } - else if (Command == '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 == 'V') + else if (Command == AVR109_COMMAND_ReadBootloaderSWVersion) { WriteNextResponseByte('0' + BOOTLOADER_VERSION_MAJOR); WriteNextResponseByte('0' + BOOTLOADER_VERSION_MINOR); } - else if (Command == 's') + else if (Command == AVR109_COMMAND_ReadSignature) { WriteNextResponseByte(AVR_SIGNATURE_3); WriteNextResponseByte(AVR_SIGNATURE_2); WriteNextResponseByte(AVR_SIGNATURE_1); } - else if (Command == 'e') + else if (Command == AVR109_COMMAND_EraseFLASH) { /* Clear the application section of flash */ - for (uint32_t CurrFlashAddress = 0; CurrFlashAddress < BOOT_START_ADDR; CurrFlashAddress += SPM_PAGESIZE) + for (uint32_t CurrFlashAddress = 0; CurrFlashAddress < (uint32_t)BOOT_START_ADDR; CurrFlashAddress += SPM_PAGESIZE) { boot_page_erase(CurrFlashAddress); boot_spm_busy_wait(); @@ -414,7 +494,7 @@ void CDC_Task(void) WriteNextResponseByte('\r'); } #if !defined(NO_LOCK_BYTE_WRITE_SUPPORT) - else if (Command == 'l') + else if (Command == AVR109_COMMAND_WriteLockbits) { /* Set the lock bits to those given by the host */ boot_lock_bits_set(FetchNextCommandByte()); @@ -423,24 +503,24 @@ void CDC_Task(void) WriteNextResponseByte('\r'); } #endif - else if (Command == 'r') + else if (Command == AVR109_COMMAND_ReadLockbits) { WriteNextResponseByte(boot_lock_fuse_bits_get(GET_LOCK_BITS)); } - else if (Command == 'F') + else if (Command == AVR109_COMMAND_ReadLowFuses) { WriteNextResponseByte(boot_lock_fuse_bits_get(GET_LOW_FUSE_BITS)); } - else if (Command == 'N') + else if (Command == AVR109_COMMAND_ReadHighFuses) { WriteNextResponseByte(boot_lock_fuse_bits_get(GET_HIGH_FUSE_BITS)); } - else if (Command == 'Q') + else if (Command == AVR109_COMMAND_ReadExtendedFuses) { WriteNextResponseByte(boot_lock_fuse_bits_get(GET_EXTENDED_FUSE_BITS)); } #if !defined(NO_BLOCK_SUPPORT) - else if (Command == 'b') + else if (Command == AVR109_COMMAND_GetBlockWriteSupport) { WriteNextResponseByte('Y'); @@ -448,14 +528,14 @@ void CDC_Task(void) WriteNextResponseByte(SPM_PAGESIZE >> 8); WriteNextResponseByte(SPM_PAGESIZE & 0xFF); } - else if ((Command == 'B') || (Command == 'g')) + 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 == 'C') + else if (Command == AVR109_COMMAND_FillFlashPageWordHigh) { /* Write the high byte to the current flash page */ boot_page_fill(CurrAddress, FetchNextCommandByte()); @@ -463,7 +543,7 @@ void CDC_Task(void) /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } - else if (Command == 'c') + else if (Command == AVR109_COMMAND_FillFlashPageWordLow) { /* Write the low byte to the current flash page */ boot_page_fill(CurrAddress | 0x01, FetchNextCommandByte()); @@ -474,7 +554,7 @@ void CDC_Task(void) /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } - else if (Command == 'm') + else if (Command == AVR109_COMMAND_WriteFlashPage) { /* Commit the flash page to memory */ boot_page_write(CurrAddress); @@ -485,7 +565,7 @@ void CDC_Task(void) /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } - else if (Command == 'R') + else if (Command == AVR109_COMMAND_ReadFLASHWord) { #if (FLASHEND > 0xFFFF) uint16_t ProgramWord = pgm_read_word_far(CurrAddress); @@ -498,7 +578,7 @@ void CDC_Task(void) } #endif #if !defined(NO_EEPROM_BYTE_SUPPORT) - else if (Command == 'D') + 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()); @@ -509,7 +589,7 @@ void CDC_Task(void) /* Send confirmation byte back to the host */ WriteNextResponseByte('\r'); } - else if (Command == 'd') + 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)))); @@ -518,14 +598,14 @@ void CDC_Task(void) CurrAddress += 2; } #endif - else if (Command != 27) + else if (Command != AVR109_COMMAND_Sync) { /* Unknown (non-sync) command, return fail code */ WriteNextResponseByte('?'); } /* Select the IN endpoint */ - Endpoint_SelectEndpoint(CDC_TX_EPNUM); + Endpoint_SelectEndpoint(CDC_TX_EPADDR); /* Remember if the endpoint is completely full before clearing it */ bool IsEndpointFull = !(Endpoint_IsReadWriteAllowed()); @@ -553,7 +633,7 @@ void CDC_Task(void) } /* Select the OUT endpoint */ - Endpoint_SelectEndpoint(CDC_RX_EPNUM); + Endpoint_SelectEndpoint(CDC_RX_EPADDR); /* Acknowledge the command from the host */ Endpoint_ClearOUT();