--- /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
+ * Header file for MassStorage.c.\r
+ */\r
+\r
+#ifndef _MASS_STORAGE_H_\r
+#define _MASS_STORAGE_H_\r
+\r
+ /* Includes: */\r
+ #include <avr/io.h>\r
+ #include <avr/wdt.h>\r
+ #include <avr/power.h>\r
+\r
+ #include "Descriptors.h"\r
+ #include "SCSI.h"\r
+ #include "DataflashManager.h"\r
+\r
+ #include <LUFA/Version.h> // Library Version Information\r
+ #include <LUFA/Common/ButtLoadTag.h> // PROGMEM tags readable by the ButtLoad project\r
+ #include <LUFA/Drivers/USB/USB.h> // USB Functionality\r
+ #include <LUFA/Drivers/Board/LEDs.h> // LEDs driver\r
+ #include <LUFA/Drivers/Board/Dataflash.h> // Dataflash chip driver\r
+ #include <LUFA/Scheduler/Scheduler.h> // Simple scheduler for task management\r
+\r
+ /* Macros: */\r
+ /** Mass Storage Class specific request to reset the Mass Storage interface, ready for the next command. */\r
+ #define REQ_MassStorageReset 0xFF\r
+\r
+ /** Mass Storage Class specific request to retrieve the total number of Logical Units (drives) in the SCSI device. */\r
+ #define REQ_GetMaxLUN 0xFE\r
+\r
+ /** Maximum length of a SCSI command which can be issued by the device or host in a Mass Storage bulk wrapper. */\r
+ #define MAX_SCSI_COMMAND_LENGTH 16\r
+ \r
+ /** Total number of Logical Units (drives) in the device. The total device capacity is shared equally between\r
+ * each drive - this can be set to any positive non-zero amount.\r
+ */\r
+ #define TOTAL_LUNS 2\r
+ \r
+ /** Blocks in each LUN, calculated from the total capacity divided by the total number of Logical Units in the device. */\r
+ #define LUN_MEDIA_BLOCKS (VIRTUAL_MEMORY_BLOCKS / TOTAL_LUNS) \r
+ \r
+ /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
+ #define CBW_SIGNATURE 0x43425355UL\r
+\r
+ /** Magic signature for a Command Status Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
+ #define CSW_SIGNATURE 0x53425355UL\r
+ \r
+ /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from host-to-device. */\r
+ #define COMMAND_DIRECTION_DATA_OUT (0 << 7)\r
+\r
+ /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from device-to-host. */\r
+ #define COMMAND_DIRECTION_DATA_IN (1 << 7)\r
+\r
+ /* Type defines: */\r
+ /** Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
+ typedef struct\r
+ {\r
+ uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block */\r
+ uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */\r
+ uint32_t DataTransferLength; /** Length of the optional data portion of the issued command, in bytes */\r
+ uint8_t Flags; /**< Command block flags, indicating command data direction */\r
+ uint8_t LUN; /**< Logical Unit number this command is issued to */\r
+ uint8_t SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array */\r
+ uint8_t SCSICommandData[MAX_SCSI_COMMAND_LENGTH]; /**< Issued SCSI command in the Command Block */\r
+ } CommandBlockWrapper_t;\r
+ \r
+ /** Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
+ typedef struct\r
+ {\r
+ uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status */\r
+ uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */\r
+ uint32_t DataTransferResidue; /**< Number of bytes of data not processed in the SCSI command */\r
+ uint8_t Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */\r
+ } CommandStatusWrapper_t;\r
+ \r
+ /* Enums: */\r
+ /** Enum for the possible command status wrapper return status codes. */\r
+ enum MassStorage_CommandStatusCodes_t\r
+ {\r
+ Command_Pass = 0, /**< Command completed with no error */\r
+ Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a SCSI REQUEST SENSE command */\r
+ Phase_Error = 2 /**< Command failed due to being invalid in the current phase */\r
+ };\r
+\r
+ /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
+ enum MassStorage_StatusCodes_t\r
+ {\r
+ Status_USBNotReady = 0, /**< USB is not ready (disconnected from a USB host) */\r
+ Status_USBEnumerating = 1, /**< USB interface is enumerating */\r
+ Status_USBReady = 2, /**< USB interface is connected and ready */\r
+ Status_CommandBlockError = 3, /**< Processing a SCSI command block from the host */\r
+ Status_ProcessingCommandBlock = 4, /**< Error during the processing of a SCSI command block from the host */\r
+ };\r
+ \r
+ /* Global Variables: */\r
+ extern CommandBlockWrapper_t CommandBlock;\r
+ extern CommandStatusWrapper_t CommandStatus;\r
+ extern volatile bool IsMassStoreReset;\r
+\r
+ /* Task Definitions: */\r
+ TASK(USB_MassStorage);\r
+ \r
+ /* Stream Callbacks: */\r
+ STREAM_CALLBACK(AbortOnMassStoreReset);\r
+\r
+ /* Event Handlers: */\r
+ /** Indicates that this module will catch the USB_Reset event when thrown by the library. */\r
+ HANDLES_EVENT(USB_Reset);\r
+\r
+ /** Indicates that this module will catch the USB_Connect event when thrown by the library. */\r
+ HANDLES_EVENT(USB_Connect);\r
+\r
+ /** Indicates that this module will catch the USB_Disconnect event when thrown by the library. */\r
+ HANDLES_EVENT(USB_Disconnect);\r
+\r
+ /** Indicates that this module will catch the USB_ConfigurationChanged event when thrown by the library. */\r
+ HANDLES_EVENT(USB_ConfigurationChanged);\r
+\r
+ /** Indicates that this module will catch the USB_UnhandledControlPacket event when thrown by the library. */\r
+ HANDLES_EVENT(USB_UnhandledControlPacket);\r
+\r
+ /* Function Prototypes: */\r
+ void UpdateStatus(uint8_t CurrentStatus);\r
+\r
+ #if defined(INCLUDE_FROM_MASSSTORAGE_C)\r
+ static bool ReadInCommandBlock(void);\r
+ static void ReturnCommandStatus(void);\r
+ #endif\r
+\r
+#endif\r
projects / pub / lufa.git / blobdiff