Bootloaders/MassStorage/BootloaderMassStorage.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 Mass Storage class bootloader. This file contains the complete bootloader logic.
  34  */
  35
  36 #include "BootloaderMassStorage.h"
  37
  38 /** LUFA Mass Storage Class driver interface configuration and state information. This structure is
  39  *  passed to all Mass Storage Class driver functions, so that multiple instances of the same class
  40  *  within a device can be differentiated from one another.
  41  */
  42 USB_ClassInfo_MS_Device_t Disk_MS_Interface =
  43         {
  44                 .Config =
  45                         {
  46                                 .InterfaceNumber           = 0,
  47                                 .DataINEndpoint            =
  48                                         {
  49                                                 .Address           = MASS_STORAGE_IN_EPADDR,
  50                                                 .Size              = MASS_STORAGE_IO_EPSIZE,
  51                                                 .Banks             = 1,
  52                                         },
  53                                 .DataOUTEndpoint           =
  54                                         {
  55                                                 .Address           = MASS_STORAGE_OUT_EPADDR,
  56                                                 .Size              = MASS_STORAGE_IO_EPSIZE,
  57                                                 .Banks             = 1,
  58                                         },
  59                                 .TotalLUNs                 = 1,
  60                         },
  61         };
  62
  63
  64 void Application_Jump_Check(void)
  65 {
  66         bool JumpToApplication = false;
  67
  68         #if (BOARD == BOARD_LEONARDO)
  69                 /* Enable pull-up on the IO13 pin so we can use it to select the mode */
  70                 PORTC |=  (1 << 7);
  71                 Delay_MS(10);
  72
  73                 /* If IO13 is not jumpered to ground, start the user application instead */
  74                 JumpToApplication |= ((PINC & (1 << 7)) != 0);
  75
  76                 /* Disable pull-up after the check has completed */
  77                 PORTC &= ~(1 << 7);
  78         #elif ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
  79                 /* Disable JTAG debugging */
  80                 JTAG_DISABLE();
  81
  82                 /* Enable pull-up on the JTAG TCK pin so we can use it to select the mode */
  83                 PORTF |= (1 << 4);
  84                 Delay_MS(10);
  85
  86                 /* If the TCK pin is not jumpered to ground, start the user application instead */
  87                 JumpToApplication |= ((PINF & (1 << 4)) != 0);
  88
  89                 /* Re-enable JTAG debugging */
  90                 JTAG_ENABLE();
  91         #endif
  92
  93         if (JumpToApplication)
  94         {
  95                 // cppcheck-suppress constStatement
  96                 ((void (*)(void))0x0000)();
  97         }
  98 }
  99
 100 /** Main program entry point. This routine configures the hardware required by the application, then
 101  *  enters a loop to run the application tasks in sequence.
 102  */
 103 int main(void)
 104 {
 105         SetupHardware();
 106
 107         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 108         GlobalInterruptEnable();
 109
 110         for (;;)
 111         {
 112                 MS_Device_USBTask(&Disk_MS_Interface);
 113                 USB_USBTask();
 114         }
 115 }
 116
 117 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 118 static void SetupHardware(void)
 119 {
 120         /* Disable watchdog if enabled by bootloader/fuses */
 121         MCUSR &= ~(1 << WDRF);
 122         wdt_disable();
 123
 124         /* Disable clock division */
 125         clock_prescale_set(clock_div_1);
 126
 127         /* Relocate the interrupt vector table to the bootloader section */
 128         MCUCR = (1 << IVCE);
 129         MCUCR = (1 << IVSEL);
 130
 131         /* Hardware Initialization */
 132         LEDs_Init();
 133         USB_Init();
 134
 135         /* Bootloader active LED toggle timer initialization */
 136         TIMSK1 = (1 << TOIE1);
 137         TCCR1B = ((1 << CS11) | (1 << CS10));
 138 }
 139
 140 /** ISR to periodically toggle the LEDs on the board to indicate that the bootloader is active. */
 141 ISR(TIMER1_OVF_vect, ISR_BLOCK)
 142 {
 143         LEDs_ToggleLEDs(LEDS_LED1 | LEDS_LED2);
 144 }
 145
 146 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */
 147 void EVENT_USB_Device_Connect(void)
 148 {
 149         /* Indicate USB enumerating */
 150         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 151 }
 152
 153 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
 154  *  the status LEDs and stops the Mass Storage management task.
 155  */
 156 void EVENT_USB_Device_Disconnect(void)
 157 {
 158         /* Indicate USB not ready */
 159         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 160 }
 161
 162 /** Event handler for the library USB Configuration Changed event. */
 163 void EVENT_USB_Device_ConfigurationChanged(void)
 164 {
 165         bool ConfigSuccess = true;
 166
 167         /* Setup Mass Storage Data Endpoints */
 168         ConfigSuccess &= MS_Device_ConfigureEndpoints(&Disk_MS_Interface);
 169
 170         /* Indicate endpoint configuration success or failure */
 171         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 172 }
 173
 174 /** Event handler for the library USB Control Request reception event. */
 175 void EVENT_USB_Device_ControlRequest(void)
 176 {
 177         MS_Device_ProcessControlRequest(&Disk_MS_Interface);
 178 }
 179
 180 /** Mass Storage class driver callback function the reception of SCSI commands from the host, which must be processed.
 181  *
 182  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface configuration structure being referenced
 183  */
 184 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 185 {
 186         bool CommandSuccess;
 187
 188         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 189         CommandSuccess = SCSI_DecodeSCSICommand(MSInterfaceInfo);
 190         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 191
 192         return CommandSuccess;
 193 }