projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Change AVRISP project's timeout to be interrupt based again, but make the interrupt...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / MassStorage.h
diff --git a/LUFA/Drivers/USB/Class/Device/MassStorage.h b/LUFA/Drivers/USB/Class/Device/MassStorage.h
index e648161..8eb150b 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all 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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
@@ -28,26 +28,35 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r
-/** \ingroup Group_USBDeviceClassDrivers\r
- *  @defgroup Group_USBClassMSDevice Mass Storage Device Class Driver - LUFA/Drivers/Class/Device/MassStorage.h\r
+/** \file\r
+ *  \brief Device mode driver for the library USB Mass Storage Class driver.\r
+ *\r
+ *  Device mode driver for the library USB Mass Storage Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.\r
+ */\r
+\r
+/** \ingroup Group_USBClassMS\r
+ *  @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver\r
  *\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r
  *    - LUFA/Drivers/USB/Class/Device/MassStorage.c\r
  *\r
  *  \section Module Description\r
  *\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r
  *    - LUFA/Drivers/USB/Class/Device/MassStorage.c\r
  *\r
  *  \section Module Description\r
- *  Functions, macros, variables, enums and types related to the management of USB Mass Storage Class interfaces\r
- *  within a USB device.\r
+ *  Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.\r
  *\r
  *  @{\r
  */\r
 \r
  *\r
  *  @{\r
  */\r
 \r
-#ifndef _MS_CLASS_H_\r
-#define _MS_CLASS_H_\r
+#ifndef _MS_CLASS_DEVICE_H_\r
+#define _MS_CLASS_DEVICE_H_\r
 \r
        /* Includes: */\r
                #include "../../USB.h"\r
 \r
        /* Includes: */\r
                #include "../../USB.h"\r
-\r
+               #include "../Common/MassStorage.h"\r
+               \r
                #include <string.h>\r
 \r
        /* Enable C linkage for C++ Compilers: */\r
                #include <string.h>\r
 \r
        /* Enable C linkage for C++ Compilers: */\r
@@ -55,127 +64,99 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\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
-               /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
-               #define MS_CBW_SIGNATURE           0x43425355UL\r
-\r
-               /** Magic signature for a Command Status Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
-               #define MS_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 MS_COMMAND_DIR_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 MS_COMMAND_DIR_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[16]; /**< 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
-                       SCSI_Command_Pass = 0, /**< Command completed with no error */\r
-                       SCSI_Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a SCSI REQUEST SENSE command */\r
-                       SCSI_Phase_Error  = 2  /**< Command failed due to being invalid in the current phase */\r
-               };\r
-               \r
-       /* Type Defines: */\r
-               /** Class state structure. An instance of this structure should be made for each Mass Storage interface\r
-                *  within the user application, and passed to each of the Mass Storage class driver functions as the\r
-                *  MSInterfaceInfo parameter. The contents of this structure should be set to their correct\r
-                *  values when used, or ommitted to force the library to use default values.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint8_t  InterfaceNumber; /**< Interface number of the Mass Storage interface within the device */\r
-\r
-                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the Mass Storage interface's IN data endpoint */\r
-                       uint16_t DataINEndpointSize; /**< Size in bytes of the Mass Storage interface's IN data endpoint */\r
-\r
-                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the Mass Storage interface's OUT data endpoint */\r
-                       uint16_t DataOUTEndpointSize;  /**< Size in bytes of the Mass Storage interface's OUT data endpoint */\r
-\r
-                       uint8_t  TotalLUNs; /**< Total number of logical drives in the Mass Storage interface */\r
-\r
-                       CommandBlockWrapper_t  CommandBlock; /**< Mass Storage class command block structure, used internally\r
-                                                             *   by the class driver\r
-                                                             */\r
-                       CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, used internally\r
-                                                             *   by the class driver\r
-                                                             */\r
-\r
-                       bool IsMassStoreReset; /**< Flag indicating that the host has requested that the Mass Storage interface be reset\r
-                                               *   and that all current Mass Storage operations should immediately abort\r
-                                                                       */\r
-               } USB_ClassInfo_MS_t;\r
-               \r
-       /* Function Prototypes: */\r
-               #if defined(INCLUDE_FROM_MS_CLASS_C)\r
-                       static void    MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
-                       static bool    MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
-                       static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);\r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_MS_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.\r
                #endif\r
                #endif\r
-       \r
-               /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library\r
-                *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
-                *  containing the given Mass Storage interface is selected.\r
-                *\r
-                *  \param MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.\r
-                *\r
-                *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
-                */\r
-               bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Type Defines: */                                                                             \r
+                       /** \brief Mass Storage Class Device Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made for each Mass Storage interface\r
+                        *  within the user application, and passed to each of the Mass Storage class driver functions as the\r
+                        *  MSInterfaceInfo parameter. This stores each Mass Storage interface's configuration and state information.\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               const struct\r
+                               {\r
+                                       uint8_t  InterfaceNumber; /**< Interface number of the Mass Storage interface within the device */\r
+\r
+                                       uint8_t  DataINEndpointNumber; /**< Endpoint number of the Mass Storage interface's IN data endpoint */\r
+                                       uint16_t DataINEndpointSize; /**< Size in bytes of the Mass Storage interface's IN data endpoint */\r
+                                       bool     DataINEndpointDoubleBank; /** Indicates if the Mass Storage interface's IN data endpoint should use double banking */\r
+\r
+                                       uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the Mass Storage interface's OUT data endpoint */\r
+                                       uint16_t DataOUTEndpointSize;  /**< Size in bytes of the Mass Storage interface's OUT data endpoint */\r
+                                       bool     DataOUTEndpointDoubleBank; /** Indicates if the Mass Storage interface's OUT data endpoint should use double banking */\r
+\r
+                                       uint8_t  TotalLUNs; /**< Total number of logical drives in the Mass Storage interface */\r
+                               } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
+                                          *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
+                                          */\r
+                               struct\r
+                               {\r
+                                       MS_CommandBlockWrapper_t  CommandBlock; /**< Mass Storage class command block structure, stores the received SCSI\r
+                                                                                                                        *   command from the host which is to be processed\r
+                                                                                                                        */\r
+                                       MS_CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, set elements to indicate\r
+                                                                                                                         *   the issued command's success or failure to the host\r
+                                                                                                                         */\r
+                                       volatile bool IsMassStoreReset; /**< Flag indicating that the host has requested that the Mass Storage interface be reset\r
+                                                                                                *   and that all current Mass Storage operations should immediately abort\r
+                                                                                                */\r
+                               } State; /**< State data for the USB class interface within the device. All elements in this section\r
+                                         *   are reset to their defaults when the interface is enumerated.\r
+                                         */\r
+                       } USB_ClassInfo_MS_Device_t;\r
+\r
+               /* Function Prototypes: */\r
+                       /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library\r
+                        *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+                        *  containing the given Mass Storage interface is selected.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state\r
+                        *\r
+                        *  \return Boolean true if the endpoints were successfully configured, false otherwise\r
+                        */\r
+                       bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Processes incoming control requests from the host, that are directed to the given Mass Storage class interface. This should be\r
+                        *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state\r
+                        */             \r
+                       void MS_Device_ProcessControlRequest(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should\r
+                        *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage configuration and state\r
+                        */\r
+                       void MS_Device_USBTask(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the\r
+                        *  host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible\r
+                        *  for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure\r
+                        *  inside the Mass Storage class state structure passed as a parameter to the callback function.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state\r
+                        *\r
+                        *  \return Boolean true if the SCSI command was successfully processed, false otherwise\r
+                        */\r
+                       bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
                \r
                \r
-               /** Processes incomming control requests from the host, that are directed to the given Mass Storage class interface. This should be\r
-                *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
-                *\r
-                *  \param MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.\r
-                */             \r
-               void MS_Device_ProcessControlPacket(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
-\r
-               /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should\r
-                *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
-                *\r
-                *  \param MSInterfaceInfo  Pointer to a structure containing a Mass Storage configuration and state.\r
-                */\r
-               void MS_Device_USBTask(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+       /* Private Interface - For use in library only: */\r
+       #if !defined(__DOXYGEN__)\r
+               /* Function Prototypes: */\r
+                       #if defined(__INCLUDE_FROM_MS_CLASS_DEVICE_C)\r
+                               static void    MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static bool    MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);\r
+                       #endif\r
                \r
                \r
-               /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the\r
-                *  host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible\r
-                *  for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure\r
-                *  inside the Mass Storage class state structure passed as a parameter to the callback function.\r
-                *\r
-                *  \param MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state.\r
-                *\r
-                *  \return Boolean true if the SCSI command was successfully processed, false otherwise\r
-                */\r
-               bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+       #endif\r
                \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
USB isp AVR programmer