Bootloaders/HID/BootloaderHID.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  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.
  20
  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
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the HID class bootloader. This file contains the complete bootloader logic.
  34  */
  35
  36 #include "BootloaderHID.h"
  37
  38 /** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run
  39  *  via a soft reset. When cleared, the bootloader will abort, the USB interface will shut down and the application
  40  *  started via a forced watchdog reset.
  41  */
  42 static bool RunBootloader = true;
  43
  44 /** Magic lock for forced application start. If the HWBE fuse is programmed and BOOTRST is unprogrammed, the bootloader
  45  *  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
  46  *  low when the application attempts to start via a watchdog reset, the bootloader will re-start. If set to the value
  47  *  \ref MAGIC_BOOT_KEY the special init function \ref Application_Jump_Check() will force the application to start.
  48  */
  49 uint16_t MagicBootKey ATTR_NO_INIT;
  50
  51
  52 /** Special startup routine to check if the bootloader was started via a watchdog reset, and if the magic application
  53  *  start key has been loaded into \ref MagicBootKey. If the bootloader started via the watchdog and the key is valid,
  54  *  this will force the user application to start via a software jump.
  55  */
  56 void Application_Jump_Check(void)
  57 {
  58         /* If the reset source was the bootloader and the key is correct, clear it and jump to the application */
  59         if ((MCUSR & (1 << WDRF)) && (MagicBootKey == MAGIC_BOOT_KEY))
  60         {
  61                 MagicBootKey = 0;
  62
  63                 // cppcheck-suppress constStatement
  64                 ((void (*)(void))0x0000)();
  65         }
  66 }
  67
  68 /** Main program entry point. This routine configures the hardware required by the bootloader, then continuously
  69  *  runs the bootloader processing routine until instructed to soft-exit.
  70  */
  71 int main(void)
  72 {
  73         /* Setup hardware required for the bootloader */
  74         SetupHardware();
  75
  76         /* Enable global interrupts so that the USB stack can function */
  77         GlobalInterruptEnable();
  78
  79         while (RunBootloader)
  80           USB_USBTask();
  81
  82         /* Disconnect from the host - USB interface will be reset later along with the AVR */
  83         USB_Detach();
  84
  85         /* Unlock the forced application start mode of the bootloader if it is restarted */
  86         MagicBootKey = MAGIC_BOOT_KEY;
  87
  88         /* Enable the watchdog and force a timeout to reset the AVR */
  89         wdt_enable(WDTO_250MS);
  90
  91         for (;;);
  92 }
  93
  94 /** Configures all hardware required for the bootloader. */
  95 static void SetupHardware(void)
  96 {
  97         /* Disable watchdog if enabled by bootloader/fuses */
  98         MCUSR &= ~(1 << WDRF);
  99         wdt_disable();
 100
 101         /* Relocate the interrupt vector table to the bootloader section */
 102         MCUCR = (1 << IVCE);
 103         MCUCR = (1 << IVSEL);
 104
 105         /* Initialize USB subsystem */
 106         USB_Init();
 107 }
 108
 109 /** Event handler for the USB_ConfigurationChanged event. This configures the device's endpoints ready
 110  *  to relay data to and from the attached USB host.
 111  */
 112 void EVENT_USB_Device_ConfigurationChanged(void)
 113 {
 114         /* Setup HID Report Endpoint */
 115         Endpoint_ConfigureEndpoint(HID_IN_EPADDR, EP_TYPE_INTERRUPT, HID_IN_EPSIZE, 1);
 116 }
 117
 118 /** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
 119  *  the device from the USB host before passing along unhandled control requests to the library for processing
 120  *  internally.
 121  */
 122 void EVENT_USB_Device_ControlRequest(void)
 123 {
 124         /* Ignore any requests that aren't directed to the HID interface */
 125         if ((USB_ControlRequest.bmRequestType & (CONTROL_REQTYPE_TYPE | CONTROL_REQTYPE_RECIPIENT)) !=
 126             (REQTYPE_CLASS | REQREC_INTERFACE))
 127         {
 128                 return;
 129         }
 130
 131         /* Process HID specific control requests */
 132         switch (USB_ControlRequest.bRequest)
 133         {
 134                 case HID_REQ_SetReport:
 135                         Endpoint_ClearSETUP();
 136
 137                         /* Wait until the command has been sent by the host */
 138                         while (!(Endpoint_IsOUTReceived()));
 139
 140                         /* Read in the write destination address */
 141                         #if (FLASHEND > 0xFFFF)
 142                         uint32_t PageAddress = ((uint32_t)Endpoint_Read_16_LE() << 8);
 143                         #else
 144                         uint16_t PageAddress = Endpoint_Read_16_LE();
 145                         #endif
 146
 147                         /* Check if the command is a program page command, or a start application command */
 148                         #if (FLASHEND > 0xFFFF)
 149                         if ((uint16_t)(PageAddress >> 8) == COMMAND_STARTAPPLICATION)
 150                         #else
 151                         if (PageAddress == COMMAND_STARTAPPLICATION)
 152                         #endif
 153                         {
 154                                 RunBootloader = false;
 155                         }
 156                         else
 157                         {
 158                                 /* Erase the given FLASH page, ready to be programmed */
 159                                 boot_page_erase(PageAddress);
 160                                 boot_spm_busy_wait();
 161
 162                                 /* Write each of the FLASH page's bytes in sequence */
 163                                 for (uint8_t PageWord = 0; PageWord < (SPM_PAGESIZE / 2); PageWord++)
 164                                 {
 165                                         /* Check if endpoint is empty - if so clear it and wait until ready for next packet */
 166                                         if (!(Endpoint_BytesInEndpoint()))
 167                                         {
 168                                                 Endpoint_ClearOUT();
 169                                                 while (!(Endpoint_IsOUTReceived()));
 170                                         }
 171
 172                                         /* Write the next data word to the FLASH page */
 173                                         boot_page_fill(PageAddress + ((uint16_t)PageWord << 1), Endpoint_Read_16_LE());
 174                                 }
 175
 176                                 /* Write the filled FLASH page to memory */
 177                                 boot_page_write(PageAddress);
 178                                 boot_spm_busy_wait();
 179
 180                                 /* Re-enable RWW section */
 181                                 boot_rww_enable();
 182                         }
 183
 184                         Endpoint_ClearOUT();
 185
 186                         Endpoint_ClearStatusStage();
 187                         break;
 188         }
 189 }
 190