+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * Main source file for the Mass Storage demo. This file contains the main tasks of the demo and\r
- * is responsible for the initial application hardware configuration.\r
- */\r
-\r
-#define INCLUDE_FROM_MASSSTORAGE_C\r
-#include "MassStorage.h"\r
-\r
-/* Project Tags, for reading out using the ButtLoad project */\r
-BUTTLOADTAG(ProjName, "LUFA MassStore App");\r
-BUTTLOADTAG(BuildTime, __TIME__);\r
-BUTTLOADTAG(BuildDate, __DATE__);\r
-BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
-\r
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
- { Task: USB_MassStorage , TaskStatus: TASK_STOP },\r
-};\r
-\r
-/* Global Variables */\r
-/** Structure to hold the latest Command Block Wrapper issued by the host, containing a SCSI command to execute. */\r
-CommandBlockWrapper_t CommandBlock;\r
-\r
-/** Structure to hold the latest Command Status Wrapper to return to the host, containing the status of the last issued command. */\r
-CommandStatusWrapper_t CommandStatus = { Signature: CSW_SIGNATURE };\r
-\r
-/** Flag to asyncronously abort any in-progress data transfers upon the reception of a mass storage reset command. */\r
-volatile bool IsMassStoreReset = false;\r
-\r
-/** Main program entry point. This routine configures the hardware required by the application, then\r
- * starts the scheduler to run the application tasks.\r
- */\r
-int main(void)\r
-{\r
- /* Disable watchdog if enabled by bootloader/fuses */\r
- MCUSR &= ~(1 << WDRF);\r
- wdt_disable();\r
-\r
- /* Disable clock division */\r
- clock_prescale_set(clock_div_1);\r
-\r
- /* Hardware Initialization */\r
- LEDs_Init();\r
- Dataflash_Init(SPI_SPEED_FCPU_DIV_2);\r
-\r
- /* Clear Dataflash sector protections, if enabled */\r
- DataflashManager_ResetDataflashProtections();\r
- \r
- /* Indicate USB not ready */\r
- UpdateStatus(Status_USBNotReady);\r
- \r
- /* Initialize Scheduler so that it can be used */\r
- Scheduler_Init();\r
-\r
- /* Initialize USB Subsystem */\r
- USB_Init();\r
-\r
- /* Scheduling - routine never returns, so put this last in the main function */\r
- Scheduler_Start();\r
-}\r
-\r
-/** Event handler for the USB_Reset event. This fires when the USB interface is reset by the USB host, before the\r
- * enumeration process begins, and enables the control endpoint interrupt so that control requests can be handled\r
- * asynchronously when they arrive rather than when the control endpoint is polled manually.\r
- */\r
-EVENT_HANDLER(USB_Reset)\r
-{\r
- /* Select the control endpoint */\r
- Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);\r
-\r
- /* Enable the endpoint SETUP interrupt ISR for the control endpoint */\r
- USB_INT_Enable(ENDPOINT_INT_SETUP);\r
-}\r
-\r
-/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */\r
-EVENT_HANDLER(USB_Connect)\r
-{\r
- /* Indicate USB enumerating */\r
- UpdateStatus(Status_USBEnumerating);\r
- \r
- /* Reset the MSReset flag upon connection */\r
- IsMassStoreReset = false;\r
-}\r
-\r
-/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
- * the status LEDs and stops the Mass Storage management task.\r
- */\r
-EVENT_HANDLER(USB_Disconnect)\r
-{\r
- /* Stop running mass storage task */\r
- Scheduler_SetTaskMode(USB_MassStorage, TASK_STOP);\r
-\r
- /* Indicate USB not ready */\r
- UpdateStatus(Status_USBNotReady);\r
-}\r
-\r
-/** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration\r
- * of the USB device after enumeration - the device endpoints are configured and the Mass Storage management task started.\r
- */\r
-EVENT_HANDLER(USB_ConfigurationChanged)\r
-{\r
- /* Setup Mass Storage In and Out Endpoints */\r
- Endpoint_ConfigureEndpoint(MASS_STORAGE_IN_EPNUM, EP_TYPE_BULK,\r
- ENDPOINT_DIR_IN, MASS_STORAGE_IO_EPSIZE,\r
- ENDPOINT_BANK_DOUBLE);\r
-\r
- Endpoint_ConfigureEndpoint(MASS_STORAGE_OUT_EPNUM, EP_TYPE_BULK,\r
- ENDPOINT_DIR_OUT, MASS_STORAGE_IO_EPSIZE,\r
- ENDPOINT_BANK_DOUBLE);\r
-\r
- /* Indicate USB connected and ready */\r
- UpdateStatus(Status_USBReady);\r
- \r
- /* Start mass storage task */\r
- Scheduler_SetTaskMode(USB_MassStorage, TASK_RUN);\r
-}\r
-\r
-/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific\r
- * control requests that are not handled internally by the USB library (including the Mass Storage class-specific\r
- * requests) so that they can be handled appropriately for the application.\r
- */\r
-EVENT_HANDLER(USB_UnhandledControlPacket)\r
-{\r
- /* Process UFI specific control requests */\r
- switch (bRequest)\r
- {\r
- case REQ_MassStorageReset:\r
- if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- Endpoint_ClearSetupReceived();\r
-\r
- /* Indicate that the current transfer should be aborted */\r
- IsMassStoreReset = true; \r
-\r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsSetupINReady()));\r
- Endpoint_ClearSetupIN();\r
- }\r
-\r
- break;\r
- case REQ_GetMaxLUN:\r
- if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- /* Indicate to the host the number of supported LUNs (virtual disks) on the device */\r
- Endpoint_ClearSetupReceived();\r
-\r
- Endpoint_Write_Byte(TOTAL_LUNS - 1);\r
- \r
- Endpoint_ClearSetupIN();\r
- \r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsSetupOUTReceived()));\r
- Endpoint_ClearSetupOUT();\r
- }\r
- \r
- break;\r
- }\r
-}\r
-\r
-/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
- * log to a serial port, or anything else that is suitable for status updates.\r
- *\r
- * \param CurrentStatus Current status of the system, from the MassStorage_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
-{\r
- uint8_t LEDMask = LEDS_NO_LEDS;\r
- \r
- /* Set the LED mask to the appropriate LED mask based on the given status code */\r
- switch (CurrentStatus)\r
- {\r
- case Status_USBNotReady:\r
- LEDMask = (LEDS_LED1);\r
- break;\r
- case Status_USBEnumerating:\r
- LEDMask = (LEDS_LED1 | LEDS_LED2);\r
- break;\r
- case Status_USBReady:\r
- LEDMask = (LEDS_LED2 | LEDS_LED4);\r
- break;\r
- case Status_CommandBlockError:\r
- LEDMask = (LEDS_LED1);\r
- break;\r
- case Status_ProcessingCommandBlock:\r
- LEDMask = (LEDS_LED1 | LEDS_LED2);\r
- break;\r
- }\r
- \r
- /* Set the board LEDs to the new LED mask */\r
- LEDs_SetAllLEDs(LEDMask);\r
-}\r
-\r
-/** Task to manage the Mass Storage interface, reading in Command Block Wrappers from the host, processing the SCSI commands they\r
- * contain, and returning Command Status Wrappers back to the host to indicate the success or failure of the last issued command.\r
- */\r
-TASK(USB_MassStorage)\r
-{\r
- /* Check if the USB System is connected to a Host */\r
- if (USB_IsConnected)\r
- {\r
- /* Select the Data Out Endpoint */\r
- Endpoint_SelectEndpoint(MASS_STORAGE_OUT_EPNUM);\r
- \r
- /* Check to see if a command from the host has been issued */\r
- if (Endpoint_ReadWriteAllowed())\r
- { \r
- /* Indicate busy */\r
- UpdateStatus(Status_ProcessingCommandBlock);\r
-\r
- /* Process sent command block from the host */\r
- if (ReadInCommandBlock())\r
- {\r
- /* Check direction of command, select Data IN endpoint if data is from the device */\r
- if (CommandBlock.Flags & COMMAND_DIRECTION_DATA_IN)\r
- Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);\r
-\r
- /* Decode the received SCSI command */\r
- SCSI_DecodeSCSICommand();\r
-\r
- /* Load in the CBW tag into the CSW to link them together */\r
- CommandStatus.Tag = CommandBlock.Tag;\r
-\r
- /* Load in the data residue counter into the CSW */\r
- CommandStatus.DataTransferResidue = CommandBlock.DataTransferLength;\r
-\r
- /* Stall the selected data pipe if command failed (if data is still to be transferred) */\r
- if ((CommandStatus.Status == Command_Fail) && (CommandStatus.DataTransferResidue))\r
- Endpoint_StallTransaction();\r
-\r
- /* Return command status block to the host */\r
- ReturnCommandStatus();\r
- \r
- /* Check if a Mass Storage Reset ocurred */\r
- if (IsMassStoreReset)\r
- {\r
- /* Reset the data endpoint banks */\r
- Endpoint_ResetFIFO(MASS_STORAGE_OUT_EPNUM);\r
- Endpoint_ResetFIFO(MASS_STORAGE_IN_EPNUM);\r
-\r
- /* Clear the abort transfer flag */\r
- IsMassStoreReset = false;\r
- }\r
-\r
- /* Indicate ready */\r
- UpdateStatus(Status_USBReady);\r
- }\r
- else\r
- {\r
- /* Indicate error reading in the command block from the host */\r
- UpdateStatus(Status_CommandBlockError);\r
- }\r
- }\r
- }\r
-}\r
-\r
-/** Function to read in a command block from the host, via the bulk data OUT endpoint. This function reads in the next command block\r
- * if one has been issued, and performs validation to ensure that the block command is valid.\r
- *\r
- * \return Boolean true if a valid command block has been read in from the endpoint, false otherwise\r
- */\r
-static bool ReadInCommandBlock(void)\r
-{\r
- /* Select the Data Out endpoint */\r
- Endpoint_SelectEndpoint(MASS_STORAGE_OUT_EPNUM);\r
-\r
- /* Read in command block header */\r
- Endpoint_Read_Stream_LE(&CommandBlock, (sizeof(CommandBlock) - sizeof(CommandBlock.SCSICommandData)),\r
- AbortOnMassStoreReset);\r
-\r
- /* Check if the current command is being aborted by the host */\r
- if (IsMassStoreReset)\r
- return false;\r
-\r
- /* Verify the command block - abort if invalid */\r
- if ((CommandBlock.Signature != CBW_SIGNATURE) ||\r
- (CommandBlock.LUN >= TOTAL_LUNS) ||\r
- (CommandBlock.SCSICommandLength > MAX_SCSI_COMMAND_LENGTH))\r
- {\r
- /* Stall both data pipes until reset by host */\r
- Endpoint_StallTransaction();\r
- Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);\r
- Endpoint_StallTransaction();\r
- \r
- return false;\r
- }\r
-\r
- /* Read in command block command data */\r
- Endpoint_Read_Stream_LE(&CommandBlock.SCSICommandData,\r
- CommandBlock.SCSICommandLength,\r
- AbortOnMassStoreReset);\r
- \r
- /* Check if the current command is being aborted by the host */\r
- if (IsMassStoreReset)\r
- return false;\r
-\r
- /* Finalize the stream transfer to send the last packet */\r
- Endpoint_ClearCurrentBank();\r
- \r
- return true;\r
-}\r
-\r
-/** Returns the filled Command Status Wrapper back to the host via the bulk data IN endpoint, waiting for the host to clear any\r
- * stalled data endpoints as needed.\r
- */\r
-static void ReturnCommandStatus(void)\r
-{\r
- /* Select the Data Out endpoint */\r
- Endpoint_SelectEndpoint(MASS_STORAGE_OUT_EPNUM);\r
-\r
- /* While data pipe is stalled, wait until the host issues a control request to clear the stall */\r
- while (Endpoint_IsStalled())\r
- {\r
- /* Check if the current command is being aborted by the host */\r
- if (IsMassStoreReset)\r
- return;\r
- }\r
-\r
- /* Select the Data In endpoint */\r
- Endpoint_SelectEndpoint(MASS_STORAGE_IN_EPNUM);\r
-\r
- /* While data pipe is stalled, wait until the host issues a control request to clear the stall */\r
- while (Endpoint_IsStalled())\r
- {\r
- /* Check if the current command is being aborted by the host */\r
- if (IsMassStoreReset)\r
- return;\r
- }\r
- \r
- /* Write the CSW to the endpoint */\r
- Endpoint_Write_Stream_LE(&CommandStatus, sizeof(CommandStatus),\r
- AbortOnMassStoreReset);\r
- \r
- /* Check if the current command is being aborted by the host */\r
- if (IsMassStoreReset)\r
- return;\r
-\r
- /* Finalize the stream transfer to send the last packet */\r
- Endpoint_ClearCurrentBank();\r
-}\r
-\r
-/** Stream callback function for the Endpoint stream read and write functions. This callback will abort the current stream transfer\r
- * if a Mass Storage Reset request has been issued to the control endpoint.\r
- */\r
-STREAM_CALLBACK(AbortOnMassStoreReset)\r
-{ \r
- /* Abort if a Mass Storage reset command was received */\r
- if (IsMassStoreReset)\r
- return STREAMCALLBACK_Abort;\r
- \r
- /* Continue with the current stream operation */\r
- return STREAMCALLBACK_Continue;\r
-}\r
-\r
-/** ISR for the general Pipe/Endpoint interrupt vector. This ISR fires when a control request has been issued to the control endpoint,\r
- * so that the request can be processed. As several elements of the Mass Storage implementation require asynchronous control requests\r
- * (such as endpoint stall clearing and Mass Storage Reset requests during data transfers) this is done via interrupts rather than\r
- * polling.\r
- */\r
-ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
-{\r
- /* Check if the control endpoint has received a request */\r
- if (Endpoint_HasEndpointInterrupted(ENDPOINT_CONTROLEP))\r
- {\r
- /* Clear the endpoint interrupt */\r
- Endpoint_ClearEndpointInterrupt(ENDPOINT_CONTROLEP);\r
-\r
- /* Process the control request */\r
- USB_USBTask();\r
-\r
- /* Handshake the endpoint setup interrupt - must be after the call to USB_USBTask() */\r
- USB_INT_Clear(ENDPOINT_INT_SETUP);\r
- }\r
-}\r