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_ORDER_MSB_FIRST | 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         bool ConfigSuccess = true;
 112
 113         /* Setup Mass Storage Data Endpoints */
 114         ConfigSuccess &= Endpoint_ConfigureEndpoint(MASS_STORAGE_IN_EPNUM,  EP_TYPE_BULK, ENDPOINT_DIR_IN,
 115                                                     MASS_STORAGE_IO_EPSIZE, ENDPOINT_BANK_SINGLE);
 116         ConfigSuccess &= Endpoint_ConfigureEndpoint(MASS_STORAGE_OUT_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_OUT,
 117                                                     MASS_STORAGE_IO_EPSIZE, ENDPOINT_BANK_SINGLE);
 118
 119         /* Indicate endpoint configuration success or failure */
 120         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 121 }
 122
 123 /** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific
 124  *  control requests that are not handled internally by the USB library (including the Mass Storage class-specific
 125  *  requests) so that they can be handled appropriately for the application.
 126  */
 127 void EVENT_USB_Device_UnhandledControlRequest(void)
 128 {
 129         /* Process UFI specific control requests */
 130         switch (USB_ControlRequest.bRequest)
 131         {
 132                 case REQ_MassStorageReset:
 133                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 134                         {
 135                                 Endpoint_ClearSETUP();
 136
 137                                 /* Indicate that the current transfer should be aborted */
 138                                 IsMassStoreReset = true;
 139
 140                                 Endpoint_ClearStatusStage();
 141                         }
 142
 143                         break;
 144                 case REQ_GetMaxLUN:
 145                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 146                         {
 147                                 Endpoint_ClearSETUP();
 148
 149                                 /* Indicate to the host the number of supported LUNs (virtual disks) on the device */
 150                                 Endpoint_Write_Byte(TOTAL_LUNS - 1);
 151
 152                                 Endpoint_ClearIN();
 153
 154                                 Endpoint_ClearStatusStage();
 155                         }
 156
 157                         break;
 158         }
 159 }
 160
 161 /** Task to manage the Mass Storage interface, reading in Command Block Wrappers from the host, processing the SCSI commands they
 162  *  contain, and returning Command Status Wrappers back to the host to indicate the success or failure of the last issued command.
 163  */
 164 void MassStorage_Task(void)
 165 {
 166         /* Device must be connected and configured for the task to run */
 167         if (USB_DeviceState != DEVICE_STATE_Configured)
 168           return;
 169
 170         /* Process sent command block from the host if one has been sent */
 171         if (ReadInCommandBlock())
 172         {
 173                 /* Indicate busy */
 174                 LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 175
 176                 /* Check direction of command, select Data IN endpoint if data is from the device */
 177                 if (CommandBlock.Flags & COMMAND_DIRECTION_DATA_IN)
 178                   Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);
 179
 180                 /* Decode the received SCSI command, set returned status code */
 181                 CommandStatus.Status = SCSI_DecodeSCSICommand() ? Command_Pass : Command_Fail;
 182
 183                 /* Load in the CBW tag into the CSW to link them together */
 184                 CommandStatus.Tag = CommandBlock.Tag;
 185
 186                 /* Load in the data residue counter into the CSW */
 187                 CommandStatus.DataTransferResidue = CommandBlock.DataTransferLength;
 188
 189                 /* Stall the selected data pipe if command failed (if data is still to be transferred) */
 190                 if ((CommandStatus.Status == Command_Fail) && (CommandStatus.DataTransferResidue))
 191                   Endpoint_StallTransaction();
 192
 193                 /* Return command status block to the host */
 194                 ReturnCommandStatus();
 195
 196                 /* Indicate ready */
 197                 LEDs_SetAllLEDs(LEDMASK_USB_READY);
 198         }
 199
 200         /* Check if a Mass Storage Reset occurred */
 201         if (IsMassStoreReset)
 202         {
 203                 /* Reset the data endpoint banks */
 204                 Endpoint_ResetFIFO(MASS_STORAGE_OUT_EPNUM);
 205                 Endpoint_ResetFIFO(MASS_STORAGE_IN_EPNUM);
 206
 207                 Endpoint_SelectEndpoint(MASS_STORAGE_OUT_EPNUM);
 208                 Endpoint_ClearStall();
 209                 Endpoint_ResetDataToggle();
 210                 Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);
 211                 Endpoint_ClearStall();
 212                 Endpoint_ResetDataToggle();
 213
 214                 /* Clear the abort transfer flag */
 215                 IsMassStoreReset = false;
 216         }
 217 }
 218
 219 /** Function to read in a command block from the host, via the bulk data OUT endpoint. This function reads in the next command block
 220  *  if one has been issued, and performs validation to ensure that the block command is valid.
 221  *
 222  *  \return Boolean true if a valid command block has been read in from the endpoint, false otherwise
 223  */
 224 static bool ReadInCommandBlock(void)
 225 {
 226         /* Select the Data Out endpoint */
 227         Endpoint_SelectEndpoint(MASS_STORAGE_OUT_EPNUM);
 228
 229         /* Abort if no command has been sent from the host */
 230         if (!(Endpoint_IsOUTReceived()))
 231           return false;
 232
 233         /* Read in command block header */
 234         Endpoint_Read_Stream_LE(&CommandBlock, (sizeof(CommandBlock) - sizeof(CommandBlock.SCSICommandData)),
 235                                 StreamCallback_AbortOnMassStoreReset);
 236
 237         /* Check if the current command is being aborted by the host */
 238         if (IsMassStoreReset)
 239           return false;
 240
 241         /* Verify the command block - abort if invalid */
 242         if ((CommandBlock.Signature         != CBW_SIGNATURE) ||
 243             (CommandBlock.LUN               >= TOTAL_LUNS)    ||
 244                 (CommandBlock.Flags              & 0x1F)          ||
 245                 (CommandBlock.SCSICommandLength == 0)             ||
 246                 (CommandBlock.SCSICommandLength >  MAX_SCSI_COMMAND_LENGTH))
 247         {
 248                 /* Stall both data pipes until reset by host */
 249                 Endpoint_StallTransaction();
 250                 Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);
 251                 Endpoint_StallTransaction();
 252
 253                 return false;
 254         }
 255
 256         /* Read in command block command data */
 257         Endpoint_Read_Stream_LE(&CommandBlock.SCSICommandData,
 258                                 CommandBlock.SCSICommandLength,
 259                                 StreamCallback_AbortOnMassStoreReset);
 260
 261         /* Check if the current command is being aborted by the host */
 262         if (IsMassStoreReset)
 263           return false;
 264
 265         /* Finalize the stream transfer to send the last packet */
 266         Endpoint_ClearOUT();
 267
 268         return true;
 269 }
 270
 271 /** Returns the filled Command Status Wrapper back to the host via the bulk data IN endpoint, waiting for the host to clear any
 272  *  stalled data endpoints as needed.
 273  */
 274 static void ReturnCommandStatus(void)
 275 {
 276         /* Select the Data Out endpoint */
 277         Endpoint_SelectEndpoint(MASS_STORAGE_OUT_EPNUM);
 278
 279         /* While data pipe is stalled, wait until the host issues a control request to clear the stall */
 280         while (Endpoint_IsStalled())
 281         {
 282                 /* Check if the current command is being aborted by the host */
 283                 if (IsMassStoreReset)
 284                   return;
 285         }
 286
 287         /* Select the Data In endpoint */
 288         Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);
 289
 290         /* While data pipe is stalled, wait until the host issues a control request to clear the stall */
 291         while (Endpoint_IsStalled())
 292         {
 293                 /* Check if the current command is being aborted by the host */
 294                 if (IsMassStoreReset)
 295                   return;
 296         }
 297
 298         /* Write the CSW to the endpoint */
 299         Endpoint_Write_Stream_LE(&CommandStatus, sizeof(CommandStatus),
 300                                   StreamCallback_AbortOnMassStoreReset);
 301
 302         /* Check if the current command is being aborted by the host */
 303         if (IsMassStoreReset)
 304           return;
 305
 306         /* Finalize the stream transfer to send the last packet */
 307         Endpoint_ClearIN();
 308 }
 309
 310 /** Stream callback function for the Endpoint stream read and write functions. This callback will abort the current stream transfer
 311  *  if a Mass Storage Reset request has been issued to the control endpoint.
 312  */
 313 uint8_t StreamCallback_AbortOnMassStoreReset(void)
 314 {
 315         /* Abort if a Mass Storage reset command was received */
 316         if (IsMassStoreReset)
 317           return STREAMCALLBACK_Abort;
 318
 319         /* Continue with the current stream operation */
 320         return STREAMCALLBACK_Continue;
 321 }