Bootloaders/TeensyHID/TeensyHID.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 #define  INCLUDE_FROM_TEENSYHID_C
  37 #include "TeensyHID.h"
  38
  39 /* Global Variables: */
  40 /** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run
  41  *  via a soft reset. When cleared, the bootloader will abort, the USB interface will shut down and the application
  42  *  started via a forced watchdog reset.
  43  */
  44 bool RunBootloader = true;
  45
  46
  47 /** Main program entry point. This routine configures the hardware required by the bootloader, then continuously
  48  *  runs the bootloader processing routine until instructed to soft-exit.
  49  */
  50 int main(void)
  51 {
  52         /* Setup hardware required for the bootloader */
  53         SetupHardware();
  54
  55         while (RunBootloader)
  56           USB_USBTask();
  57
  58         /* Wait 100ms to give the host time to register the disconnection */
  59         _delay_ms(100);
  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         /* Disable clock division */
  75         clock_prescale_set(clock_div_1);
  76
  77         /* Relocate the interrupt vector table to the bootloader section */
  78         MCUCR = (1 << IVCE);
  79         MCUCR = (1 << IVSEL);
  80
  81         /* Initialize USB subsystem */
  82         USB_Init();
  83 }
  84
  85 /** Event handler for the USB_ConfigurationChanged event. This configures the device's endpoints ready
  86  *  to relay data to and from the attached USB host.
  87  */
  88 void EVENT_USB_ConfigurationChanged(void)
  89 {
  90         /* Setup HID Report Endpoint */
  91         Endpoint_ConfigureEndpoint(HID_EPNUM, EP_TYPE_INTERRUPT,
  92                                        ENDPOINT_DIR_IN, HID_EPSIZE,
  93                                    ENDPOINT_BANK_SINGLE);
  94 }
  95
  96 /** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific
  97  *  control requests that are not handled internally by the USB library (including the HID commands, which are
  98  *  all issued via the control endpoint), so that they can be handled appropriately for the application.
  99  */
 100 void EVENT_USB_UnhandledControlPacket(void)
 101 {
 102         /* Handle HID Class specific requests */
 103         switch (USB_ControlRequest.bRequest)
 104         {
 105                 case REQ_SetReport:
 106                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 107                         {
 108                                 Endpoint_ClearSETUP();
 109
 110                                 /* Wait until the command (report) has been sent by the host */
 111                                 while (!(Endpoint_IsOUTReceived()));
 112
 113                                 /* Read in the write destination address */
 114                                 uint16_t PageAddress = Endpoint_Read_Word_LE();
 115
 116                                 /* Check if the command is a program page command, or a start application command */
 117                                 if (PageAddress == TEENSY_STARTAPPLICATION)
 118                                 {
 119                                         RunBootloader = false;
 120                                 }
 121                                 else
 122                                 {
 123                                         /* Erase the given FLASH page, ready to be programmed */
 124                                         boot_page_erase(PageAddress);
 125                                         boot_spm_busy_wait();
 126
 127                                         /* Write each of the FLASH page's bytes in sequence */
 128                                         for (uint8_t PageByte = 0; PageByte < 128; PageByte += 2)
 129                                         {
 130                                                 /* Check if endpoint is empty - if so clear it and wait until ready for next packet */
 131                                                 if (!(Endpoint_BytesInEndpoint()))
 132                                                 {
 133                                                         Endpoint_ClearOUT();
 134                                                         while (!(Endpoint_IsOUTReceived()));
 135                                                 }
 136
 137                                                 /* Write the next data word to the FLASH page */
 138                                                 boot_page_fill(PageAddress + PageByte, Endpoint_Read_Word_LE());
 139                                         }
 140
 141                                         /* Write the filled FLASH page to memory */
 142                                         boot_page_write(PageAddress);
 143                                         boot_spm_busy_wait();
 144
 145                                         /* Re-enable RWW section */
 146                                         boot_rww_enable();
 147                                 }
 148
 149                                 Endpoint_ClearOUT();
 150
 151                                 Endpoint_ClearStatusStage();
 152                         }
 153
 154                         break;
 155         }
 156 }