Fixed DFU and CDC class bootloaders on the AT90USBXXX2 series USB AVRs.

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / MassStorage.h

diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h
index 18b2cf4..ff2e901 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h
@@ -54,6 +54,9 @@
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r

+               /* Macros: */\r
+                       #define MS_ERROR_LOGICAL_CMD_FAILED              0xC0\r
+       \r

                /* Type Defines: */\r
                        /** Class state structure. An instance of this structure should be made within the user application,\r
                         *  and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This\r
                /* Type Defines: */\r
                        /** Class state structure. An instance of this structure should be made within the user application,\r
                         *  and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This\r


@@ -70,34 +73,232 @@
                                           */\r
                                struct\r
                                {\r
                                           */\r
                                struct\r
                                {\r

-                                       bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid\r
-                                                     *   after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the\r
-                                                     *   Configured state\r
-                                                     */\r
+                                       bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid\r
+                                                       *   after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the\r
+                                                       *   Configured state\r
+                                                       */\r

                                        uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device */\r
 \r
                                        uint16_t DataINPipeSize; /**< Size in bytes of the MS interface's IN data pipe */\r
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the MS interface's OUT data pipe */\r
                                        uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device */\r
 \r
                                        uint16_t DataINPipeSize; /**< Size in bytes of the MS interface's IN data pipe */\r
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the MS interface's OUT data pipe */\r

+                                       \r
+                                       uint32_t TransactionTag; /**< Current transaction tag for data synchronising of packets */\r

                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                                  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
                                                  *   the interface is enumerated.\r
                                                  */\r
                        } USB_ClassInfo_MS_Host_t;\r
 \r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                                  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
                                                  *   the interface is enumerated.\r
                                                  */\r
                        } USB_ClassInfo_MS_Host_t;\r
 \r

+                       /** Type define for a SCSI Sense structure. Structures of this type are filled out by the\r
+                        *  device via the MassStore_RequestSense() function, indicating the current sense data of the\r
+                        *  device (giving explicit error codes for the last issued command). For details of the\r
+                        *  structure contents, refer to the SCSI specifications.\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t       ReponseCode;\r
+\r
+                               uint8_t       SegmentNumber;\r
+                               \r
+                               unsigned char SenseKey            : 4;\r
+                               unsigned char _RESERVED1          : 1;\r
+                               unsigned char ILI                 : 1;\r
+                               unsigned char EOM                 : 1;\r
+                               unsigned char FileMark            : 1;\r
+                               \r
+                               uint8_t      Information[4];\r
+                               uint8_t      AdditionalLength;\r
+                               uint8_t      CmdSpecificInformation[4];\r
+                               uint8_t      AdditionalSenseCode;\r
+                               uint8_t      AdditionalSenseQualifier;\r
+                               uint8_t      FieldReplaceableUnitCode;\r
+                               uint8_t      SenseKeySpecific[3];\r
+                       } SCSI_Request_Sense_Response_t;\r
+\r
+                       /** Type define for a SCSI Inquiry structure. Structures of this type are filled out by the\r
+                        *  device via the MassStore_Inquiry() function, retrieving the attached device's information.\r
+                        *  For details of the structure contents, refer to the SCSI specifications.\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               unsigned char DeviceType          : 5;\r
+                               unsigned char PeripheralQualifier : 3;\r
+                               \r
+                               unsigned char _RESERVED1          : 7;\r
+                               unsigned char Removable           : 1;\r
+                               \r
+                               uint8_t      Version;\r
+                               \r
+                               unsigned char ResponseDataFormat  : 4;\r
+                               unsigned char _RESERVED2          : 1;\r
+                               unsigned char NormACA             : 1;\r
+                               unsigned char TrmTsk              : 1;\r
+                               unsigned char AERC                : 1;\r
+\r
+                               uint8_t      AdditionalLength;\r
+                               uint8_t      _RESERVED3[2];\r
+\r
+                               unsigned char SoftReset           : 1;\r
+                               unsigned char CmdQue              : 1;\r
+                               unsigned char _RESERVED4          : 1;\r
+                               unsigned char Linked              : 1;\r
+                               unsigned char Sync                : 1;\r
+                               unsigned char WideBus16Bit        : 1;\r
+                               unsigned char WideBus32Bit        : 1;\r
+                               unsigned char RelAddr             : 1;\r
+                               \r
+                               uint8_t      VendorID[8];\r
+                               uint8_t      ProductID[16];\r
+                               uint8_t      RevisionID[4];\r
+                       } SCSI_Inquiry_Response_t;\r
+                       \r
+                       /** SCSI capacity structure, to hold the total capacity of the device in both the number\r
+                        *  of blocks in the current LUN, and the size of each block. This structure is filled by\r
+                        *  the device when the MassStore_ReadCapacity() function is called.\r
+                        */\r
+                       typedef struct\r
+                       {\r
+                               uint32_t Blocks; /**< Number of blocks in the addressed LUN of the device */\r
+                               uint32_t BlockSize; /**< Number of bytes in each block in the addressed LUN */\r
+                       } SCSI_Capacity_t;\r
+\r

                /* Enums: */\r
                /* Enums: */\r

-                       enum\r
+                       enum MSHost_EnumerationFailure_ErrorCodes_t\r

                        {\r
                                MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                                MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */\r
                        {\r
                                MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                                MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */\r

-                               MS_ENUMERROR_NoMSInterfaceFound        = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */\r
+                               MS_ENUMERROR_NoMSInterfaceFound         = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */\r

                                MS_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */\r
                                MS_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */\r

-                       } MSHost_EnumerationFailure_ErrorCodes_t;\r
+                       };\r

        \r
                /* Function Prototypes: */\r
        \r
                /* Function Prototypes: */\r

-                       void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* MSInterfaceInfo);\r
+                       /** General management task for a given Mass Storage host class interface, required for the correct operation of\r
+                        *  the interface. This should be called frequently in the main program loop, before the master USB management task\r
+                        *  \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state\r
+                        */\r
+                       void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Host interface configuration routine, to configure a given Mass Storage host interface instance using the\r
+                        *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Mass\r
+                        *  Storage Host instance's state values and configures the pipes required to communicate with the interface if it\r
+                        *  is found within the device. This should be called once after the stack has enumerated the attached device, while\r
+                        *  the host state machine is in the Addressed state.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state\r
+                        *  \param[in] ConfigDescriptorLength  Length of the attached device's Configuration Descriptor\r
+                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor\r
+                        *\r
+                        *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum\r
+                        */\r

                        uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint16_t ConfigDescriptorLength,\r
                        uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint16_t ConfigDescriptorLength,\r

-                                                      uint8_t* DeviceConfigDescriptor);\r
+                                                      uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+\r
+                       /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface\r
+                        *  and readying it for the next Mass Storage command.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
+                        */\r
+                       uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Sends a GET MAX LUN control request to the attached device, retrieving the index of the highest LUN (Logical\r
+                        *  UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage\r
+                        *  Host mode Class driver to address a specific LUN within the device.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
+                        *  \param[out] MaxLUNIndex  Pointer to a location where the highest LUN index value should be stored\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
+                        */\r
+                       uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t* MaxLUNIndex) ATTR_NON_NULL_PTR_ARG(1, 2);\r
+\r
+                       /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and\r
+                        *  properties.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
+                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
+                        *  \param[out] InquiryData  Location where the read inquiry data should be stored\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED\r
+                        */\r
+                       uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex,\r
+                                                      SCSI_Inquiry_Response_t* InquiryData) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+\r
+                       /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
+                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+                        */\r
+                       uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
+                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
+                        *  \param[out] DeviceCapacity  Pointer to the location where the capacity information should be stored\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+                        */\r
+                       uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex,\r
+                                                          SCSI_Capacity_t* DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+               \r
+                       /** Retrieves the device sense data, indicating the current device state and error codes for the previously\r
+                        *  issued command.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
+                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
+                        *  \param[out] SenseData  Pointer to the location where the sense information should be stored\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+                        */\r
+                       uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex,\r
+                                                    SCSI_Request_Sense_Response_t* SenseData) ATTR_NON_NULL_PTR_ARG(1, 3);\r

                \r
                \r

+                       /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock\r
+                        *  the device from removal so that blocks of data on the medium can be read or altered.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
+                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
+                        *  \param[in] PreventRemoval  Boolean true if the device should be locked from removal, false otherwise\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+                        */\r
+                       uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex,\r
+                                                                 bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Reads blocks of data from the attached Mass Storage device's medium.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
+                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
+                        *  \param[in] BlockAddress  Starting block address within the device to read from\r
+                        *  \param[in] Blocks  Total number of blocks to read\r
+                        *  \param[in] BlockSize  Size in bytes of each block within the device\r
+                        *  \param[out] BlockBuffer  Pointer to where the read data from the device should be stored\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+                        */\r
+                       uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex, uint32_t BlockAddress,\r
+                                                        uint8_t Blocks, uint16_t BlockSize, void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1, 6);\r
+               \r
+                       /** Writes blocks of data to the attached Mass Storage device's medium.\r
+                        *\r
+                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state\r
+                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to\r
+                        *  \param[in] BlockAddress  Starting block address within the device to write to\r
+                        *  \param[in] Blocks  Total number of blocks to read\r
+                        *  \param[in] BlockSize  Size in bytes of each block within the device\r
+                        *  \param[in] BlockBuffer  Pointer to where the data to write should be sourced from\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+                        */\r
+                       uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex, uint32_t BlockAddress,\r
+                                                         uint8_t Blocks, uint16_t BlockSize, void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1, 6);\r
+\r

        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r


@@ -105,13 +306,33 @@
                        #define MASS_STORE_SUBCLASS            0x06\r
                        #define MASS_STORE_PROTOCOL            0x50\r
 \r
                        #define MASS_STORE_SUBCLASS            0x06\r
                        #define MASS_STORE_PROTOCOL            0x50\r
 \r

+                       #define REQ_MassStorageReset           0xFF\r
+                       #define REQ_GetMaxLUN                  0xFE\r
+\r
+                       #define CBW_SIGNATURE                  0x43425355UL\r
+                       #define CSW_SIGNATURE                  0x53425355UL\r
+                       \r
+                       #define COMMAND_DIRECTION_DATA_OUT     (0 << 7)\r
+                       #define COMMAND_DIRECTION_DATA_IN      (1 << 7)\r
+                       \r
+                       #define COMMAND_DATA_TIMEOUT_MS        2000\r
+\r

                        #define MS_FOUND_DATAPIPE_IN           (1 << 0)\r
                        #define MS_FOUND_DATAPIPE_OUT          (1 << 1)\r
                        \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_MS_CLASS_HOST_C)               \r
                        #define MS_FOUND_DATAPIPE_IN           (1 << 0)\r
                        #define MS_FOUND_DATAPIPE_OUT          (1 << 1)\r
                        \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_MS_CLASS_HOST_C)               \r

-                               static uint8_t DComp_NextMassStorageInterface(void* CurrentDescriptor);\r
-                               static uint8_t DComp_NextInterfaceBulkDataEndpoint(void* CurrentDescriptor);\r
+                               static uint8_t DComp_NextMSInterface(void* CurrentDescriptor);\r
+                               static uint8_t DComp_NextMSInterfaceEndpoint(void* CurrentDescriptor);\r
+                               \r
+                               static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,\r
+                                                                  MS_CommandBlockWrapper_t* SCSICommandBlock,\r
+                                                                  void* BufferPtr);\r
+                               static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* MSInterfaceInfo);\r
+                               static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, \r
+                                                       MS_CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr);\r
+                               static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,\r
+                                                                        MS_CommandStatusWrapper_t* SCSICommandStatus);\r

                        #endif\r
        #endif\r
        \r
                        #endif\r
        #endif\r
        \r