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