Demos/Device/LowLevel/MassStorage/MassStorage.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 Mass Storage demo. This file contains the main tasks of the demo and
  34  *  is responsible for the initial application hardware configuration.
  35  */
  36
  37 #define  INCLUDE_FROM_MASSSTORAGE_C
  38 #include "MassStorage.h"
  39
  40 /** Structure to hold the latest Command Block Wrapper issued by the host, containing a SCSI command to execute. */
  41 CommandBlockWrapper_t  CommandBlock;
  42
  43 /** Structure to hold the latest Command Status Wrapper to return to the host, containing the status of the last issued command. */
  44 CommandStatusWrapper_t CommandStatus = { .Signature = CSW_SIGNATURE };
  45
  46 /** Flag to asynchronously abort any in-progress data transfers upon the reception of a mass storage reset command. */
  47 volatile bool          IsMassStoreReset = false;
  48
  49
  50 /** Main program entry point. This routine configures the hardware required by the application, then
  51  *  enters a loop to run the application tasks in sequence.
  52  */
  53 int main(void)
  54 {
  55         SetupHardware();
  56
  57         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  58         sei();
  59
  60         for (;;)
  61         {
  62                 MassStorage_Task();
  63                 USB_USBTask();
  64         }
  65 }
  66
  67 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  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         /* Hardware Initialization */
  78         LEDs_Init();
  79         SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_SCK_LEAD_FALLING | SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
  80         Dataflash_Init();
  81         USB_Init();
  82
  83         /* Clear Dataflash sector protections, if enabled */
  84         DataflashManager_ResetDataflashProtections();
  85 }
  86
  87 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */
  88 void EVENT_USB_Device_Connect(void)
  89 {
  90         /* Indicate USB enumerating */
  91         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  92
  93         /* Reset the MSReset flag upon connection */
  94         IsMassStoreReset = false;
  95 }
  96
  97 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
  98  *  the status LEDs and stops the Mass Storage management task.
  99  */
 100 void EVENT_USB_Device_Disconnect(void)
 101 {
 102         /* Indicate USB not ready */
 103         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 104 }
 105
 106 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration
 107  *  of the USB device after enumeration - the device endpoints are configured and the Mass Storage management task started.
 108  */
 109 void EVENT_USB_Device_ConfigurationChanged(void)
 110 {
 111         /* Indicate USB connected and ready */
 112         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 113
 114         /* Setup Mass Storage In and Out Endpoints */
 115         if (!(Endpoint_ConfigureEndpoint(MASS_STORAGE_IN_EPNUM, EP_TYPE_BULK,
 116                                              ENDPOINT_DIR_IN, MASS_STORAGE_IO_EPSIZE,
 117                                          ENDPOINT_BANK_SINGLE)))
 118         {
 119                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 120         }
 121
 122         if (!(Endpoint_ConfigureEndpoint(MASS_STORAGE_OUT_EPNUM, EP_TYPE_BULK,
 123                                              ENDPOINT_DIR_OUT, MASS_STORAGE_IO_EPSIZE,
 124                                          ENDPOINT_BANK_SINGLE)))
 125         {
 126                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 127         }
 128 }
 129
 130 /** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific
 131  *  control requests that are not handled internally by the USB library (including the Mass Storage class-specific
 132  *  requests) so that they can be handled appropriately for the application.
 133  */
 134 void EVENT_USB_Device_UnhandledControlRequest(void)
 135 {
 136         /* Process UFI specific control requests */
 137         switch (USB_ControlRequest.bRequest)
 138         {
 139                 case REQ_MassStorageReset:
 140                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 141                         {
 142                                 Endpoint_ClearSETUP();
 143
 144                                 /* Indicate that the current transfer should be aborted */
 145                                 IsMassStoreReset = true;
 146
 147                                 Endpoint_ClearStatusStage();
 148                         }
 149
 150                         break;
 151                 case REQ_GetMaxLUN:
 152                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 153                         {
 154                                 Endpoint_ClearSETUP();
 155
 156                                 /* Indicate to the host the number of supported LUNs (virtual disks) on the device */
 157                                 Endpoint_Write_Byte(TOTAL_LUNS - 1);
 158
 159                                 Endpoint_ClearIN();
 160
 161                                 Endpoint_ClearStatusStage();
 162                         }
 163
 164                         break;
 165         }
 166 }
 167
 168 /** Task to manage the Mass Storage interface, reading in Command Block Wrappers from the host, processing the SCSI commands they
 169  *  contain, and returning Command Status Wrappers back to the host to indicate the success or failure of the last issued command.
 170  */
 171 void MassStorage_Task(void)
 172 {
 173         /* Device must be connected and configured for the task to run */
 174         if (USB_DeviceState != DEVICE_STATE_Configured)
 175           return;
 176
 177         /* Select the Data Out Endpoint */
 178         Endpoint_SelectEndpoint(MASS_STORAGE_OUT_EPNUM);
 179
 180         /* Check to see if a command from the host has been issued */
 181         if (Endpoint_IsReadWriteAllowed())
 182         {
 183                 /* Indicate busy */
 184                 LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 185
 186                 /* Process sent command block from the host */
 187                 if (ReadInCommandBlock())
 188                 {
 189                         /* Check direction of command, select Data IN endpoint if data is from the device */
 190                         if (CommandBlock.Flags & COMMAND_DIRECTION_DATA_IN)
 191                           Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);
 192
 193                         /* Decode the received SCSI command, set returned status code */
 194                         CommandStatus.Status = SCSI_DecodeSCSICommand() ? Command_Pass : Command_Fail;
 195
 196                         /* Load in the CBW tag into the CSW to link them together */
 197                         CommandStatus.Tag = CommandBlock.Tag;
 198
 199                         /* Load in the data residue counter into the CSW */
 200                         CommandStatus.DataTransferResidue = CommandBlock.DataTransferLength;
 201
 202                         /* Stall the selected data pipe if command failed (if data is still to be transferred) */
 203                         if ((CommandStatus.Status == Command_Fail) && (CommandStatus.DataTransferResidue))
 204                           Endpoint_StallTransaction();
 205
 206                         /* Return command status block to the host */
 207                         ReturnCommandStatus();
 208
 209                         /* Indicate ready */
 210                         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 211                 }
 212                 else
 213                 {
 214                         /* Indicate error reading in the command block from the host */
 215                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 216                 }
 217         }
 218
 219         /* Check if a Mass Storage Reset occurred */
 220         if (IsMassStoreReset)
 221         {
 222                 /* Reset the data endpoint banks */
 223                 Endpoint_ResetFIFO(MASS_STORAGE_OUT_EPNUM);
 224                 Endpoint_ResetFIFO(MASS_STORAGE_IN_EPNUM);
 225
 226                 Endpoint_SelectEndpoint(MASS_STORAGE_OUT_EPNUM);
 227                 Endpoint_ClearStall();
 228                 Endpoint_ResetDataToggle();
 229                 Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);
 230                 Endpoint_ClearStall();
 231                 Endpoint_ResetDataToggle();
 232
 233                 /* Clear the abort transfer flag */
 234                 IsMassStoreReset = false;
 235         }
 236 }
 237
 238 /** Function to read in a command block from the host, via the bulk data OUT endpoint. This function reads in the next command block
 239  *  if one has been issued, and performs validation to ensure that the block command is valid.
 240  *
 241  *  \return Boolean true if a valid command block has been read in from the endpoint, false otherwise
 242  */
 243 static bool ReadInCommandBlock(void)
 244 {
 245         /* Select the Data Out endpoint */
 246         Endpoint_SelectEndpoint(MASS_STORAGE_OUT_EPNUM);
 247
 248         /* Read in command block header */
 249         Endpoint_Read_Stream_LE(&CommandBlock, (sizeof(CommandBlock) - sizeof(CommandBlock.SCSICommandData)),
 250                                 StreamCallback_AbortOnMassStoreReset);
 251
 252         /* Check if the current command is being aborted by the host */
 253         if (IsMassStoreReset)
 254           return false;
 255
 256         /* Verify the command block - abort if invalid */
 257         if ((CommandBlock.Signature         != CBW_SIGNATURE) ||
 258             (CommandBlock.LUN               >= TOTAL_LUNS)    ||
 259                 (CommandBlock.Flags              & 0x1F)          ||
 260                 (CommandBlock.SCSICommandLength == 0)             ||
 261                 (CommandBlock.SCSICommandLength >  MAX_SCSI_COMMAND_LENGTH))
 262         {
 263                 /* Stall both data pipes until reset by host */
 264                 Endpoint_StallTransaction();
 265                 Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);
 266                 Endpoint_StallTransaction();
 267
 268                 return false;
 269         }
 270
 271         /* Read in command block command data */
 272         Endpoint_Read_Stream_LE(&CommandBlock.SCSICommandData,
 273                                 CommandBlock.SCSICommandLength,
 274                                 StreamCallback_AbortOnMassStoreReset);
 275
 276         /* Check if the current command is being aborted by the host */
 277         if (IsMassStoreReset)
 278           return false;
 279
 280         /* Finalize the stream transfer to send the last packet */
 281         Endpoint_ClearOUT();
 282
 283         return true;
 284 }
 285
 286 /** Returns the filled Command Status Wrapper back to the host via the bulk data IN endpoint, waiting for the host to clear any
 287  *  stalled data endpoints as needed.
 288  */
 289 static void ReturnCommandStatus(void)
 290 {
 291         /* Select the Data Out endpoint */
 292         Endpoint_SelectEndpoint(MASS_STORAGE_OUT_EPNUM);
 293
 294         /* While data pipe is stalled, wait until the host issues a control request to clear the stall */
 295         while (Endpoint_IsStalled())
 296         {
 297                 /* Check if the current command is being aborted by the host */
 298                 if (IsMassStoreReset)
 299                   return;
 300         }
 301
 302         /* Select the Data In endpoint */
 303         Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);
 304
 305         /* While data pipe is stalled, wait until the host issues a control request to clear the stall */
 306         while (Endpoint_IsStalled())
 307         {
 308                 /* Check if the current command is being aborted by the host */
 309                 if (IsMassStoreReset)
 310                   return;
 311         }
 312
 313         /* Write the CSW to the endpoint */
 314         Endpoint_Write_Stream_LE(&CommandStatus, sizeof(CommandStatus),
 315                                   StreamCallback_AbortOnMassStoreReset);
 316
 317         /* Check if the current command is being aborted by the host */
 318         if (IsMassStoreReset)
 319           return;
 320
 321         /* Finalize the stream transfer to send the last packet */
 322         Endpoint_ClearIN();
 323 }
 324
 325 /** Stream callback function for the Endpoint stream read and write functions. This callback will abort the current stream transfer
 326  *  if a Mass Storage Reset request has been issued to the control endpoint.
 327  */
 328 uint8_t StreamCallback_AbortOnMassStoreReset(void)
 329 {
 330         /* Abort if a Mass Storage reset command was received */
 331         if (IsMassStoreReset)
 332           return STREAMCALLBACK_Abort;
 333
 334         /* Continue with the current stream operation */
 335         return STREAMCALLBACK_Continue;
 336 }