Bootloaders/TeensyHID/TeensyHID.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 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
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the TeensyHID bootloader. This file contains the complete bootloader logic.
  34  */
  35
  36 #include "TeensyHID.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 bool RunBootloader = true;
  43
  44 /** Main program entry point. This routine configures the hardware required by the bootloader, then continuously
  45  *  runs the bootloader processing routine until instructed to soft-exit.
  46  */
  47 int main(void)
  48 {
  49         /* Setup hardware required for the bootloader */
  50         SetupHardware();
  51
  52         /* Enable global interrupts so that the USB stack can function */
  53         sei();
  54
  55         while (RunBootloader)
  56           USB_USBTask();
  57
  58         /* Disconnect from the host - USB interface will be reset later along with the AVR */
  59         USB_Detach();
  60
  61         /* Enable the watchdog and force a timeout to reset the AVR */
  62         wdt_enable(WDTO_250MS);
  63
  64         for (;;);
  65 }
  66
  67 /** Configures all hardware required for the bootloader. */
  68 void SetupHardware(void)
  69 {
  70         /* Disable watchdog if enabled by bootloader/fuses */
  71         MCUSR &= ~(1 << WDRF);
  72         wdt_disable();
  73
  74         /* Relocate the interrupt vector table to the bootloader section */
  75         MCUCR = (1 << IVCE);
  76         MCUCR = (1 << IVSEL);
  77
  78         /* Initialize USB subsystem */
  79         USB_Init();
  80 }
  81
  82 /** Event handler for the USB_ConfigurationChanged event. This configures the device's endpoints ready
  83  *  to relay data to and from the attached USB host.
  84  */
  85 void EVENT_USB_Device_ConfigurationChanged(void)
  86 {
  87         /* Setup HID Report Endpoint */
  88         Endpoint_ConfigureEndpoint(HID_EPNUM, EP_TYPE_INTERRUPT,
  89                                        ENDPOINT_DIR_IN, HID_EPSIZE,
  90                                    ENDPOINT_BANK_SINGLE);
  91 }
  92
  93 /** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific
  94  *  control requests that are not handled internally by the USB library (including the HID commands, which are
  95  *  all issued via the control endpoint), so that they can be handled appropriately for the application.
  96  */
  97 void EVENT_USB_Device_UnhandledControlRequest(void)
  98 {
  99         /* Handle HID Class specific requests */
 100         switch (USB_ControlRequest.bRequest)
 101         {
 102                 case REQ_SetReport:
 103                         Endpoint_ClearSETUP();
 104
 105                         /* Wait until the command has been sent by the host */
 106                         while (!(Endpoint_IsOUTReceived()));
 107
 108                         /* Read in the write destination index */
 109                         uint16_t PageIndex = Endpoint_Read_Word_LE();
 110
 111                         /* Check if the command is a program page command, or a start application command */
 112                         if (PageIndex == TEENSY_STARTAPPLICATION)
 113                         {
 114                                 RunBootloader = false;
 115                         }
 116                         else
 117                         {
 118                                 #if (FLASHEND > 0xFFFF)
 119                                 uint32_t PageByteAddress = ((uint32_t)PageIndex << 8);
 120                                 #else
 121                                 uint16_t PageByteAddress = PageIndex;
 122                                 #endif
 123
 124                                 /* Erase the given FLASH page, ready to be programmed */
 125                                 boot_page_erase(PageByteAddress);
 126                                 boot_spm_busy_wait();
 127
 128                                 /* Write each of the FLASH page's bytes in sequence */
 129                                 #if (SPM_PAGESIZE == 128)
 130                                 for (uint8_t PageByte = 0; PageByte < SPM_PAGESIZE; PageByte += 2)
 131                                 #else
 132                                 for (uint16_t PageByte = 0; PageByte < SPM_PAGESIZE; PageByte += 2)
 133                                 #endif
 134                                 {
 135                                         /* Check if endpoint is empty - if so clear it and wait until ready for next packet */
 136                                         if (!(Endpoint_BytesInEndpoint()))
 137                                         {
 138                                                 Endpoint_ClearOUT();
 139                                                 while (!(Endpoint_IsOUTReceived()));
 140                                         }
 141
 142                                         /* Write the next data word to the FLASH page */
 143                                         boot_page_fill(PageByteAddress + PageByte, Endpoint_Read_Word_LE());
 144                                 }
 145
 146                                 /* Write the filled FLASH page to memory */
 147                                 boot_page_write(PageByteAddress);
 148                                 boot_spm_busy_wait();
 149                         }
 150
 151                         Endpoint_ClearOUT();
 152
 153                         Endpoint_ClearStatusStage();
 154
 155                         break;
 156         }
 157 }