Remove MIDI ClassDriver device demo's accidental inclusion of the unused ADC peripher...

[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 47a6fdb..606aa79 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h
@@ -42,7 +42,7 @@
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:

- *    - LUFA/Drivers/USB/Class/Host/MassStorage.c
+ *    - LUFA/Drivers/USB/Class/Host/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>

  *
  *  \section Module Description
  *  Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
  *
  *  \section Module Description
  *  Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.


@@ -93,11 +93,11 @@
                                           */
                                struct
                                {
                                           */
                                struct
                                {

-                                       bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
-                                                       *   after \ref MS_Host_ConfigurePipes() is called and the Host state machine is in the
-                                                       *   Configured state.
-                                                       */
-                                       uint8_t InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device. */
+                                       bool     IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
+                                                           *   after \ref MS_Host_ConfigurePipes() is called and the Host state machine is in the
+                                                           *   Configured state.
+                                                           */
+                                       uint8_t  InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device. */

 
                                        uint16_t DataINPipeSize; /**< Size in bytes of the Mass Storage interface's IN data pipe. */
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the Mass Storage interface's OUT data pipe. */
 
                                        uint16_t DataINPipeSize; /**< Size in bytes of the Mass Storage interface's IN data pipe. */
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the Mass Storage interface's OUT data pipe. */


@@ -122,12 +122,11 @@
                        } SCSI_Capacity_t;
 
                /* Enums: */
                        } SCSI_Capacity_t;
 
                /* Enums: */

-                       enum MSHost_EnumerationFailure_ErrorCodes_t
+                       enum MS_Host_EnumerationFailure_ErrorCodes_t

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

-                               MS_ENUMERROR_NoMSInterfaceFound         = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor. */
-                               MS_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces. */
+                               MS_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor. */

                        };
        
                /* Function Prototypes: */
                        };
        
                /* Function Prototypes: */


@@ -137,14 +136,19 @@
                         *  is found within the device. This should be called once after the stack has enumerated the attached device, while
                         *  the host state machine is in the Addressed state.
                         *
                         *  is found within the device. This should be called once after the stack has enumerated the attached device, while
                         *  the host state machine is in the Addressed state.
                         *

-                        *  \param[in,out] MSInterfaceInfo         Pointer to a structure containing an MS Class host configuration and state.
-                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
-                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
+                        *  \note The pipe index numbers as given in the interface's configuration structure must not overlap with any other
+                        *        interface, or pipe bank corruption will occur. Gaps in the allocated pipe numbers or non-sequential indexes
+                        *        within a single interface is allowed, but no two interfaces of any type have have interleaved pipe indexes.

                         *
                         *

-                        *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum.
+                        *  \param[in,out] MSInterfaceInfo       Pointer to a structure containing an MS Class host configuration and state.
+                        *  \param[in]     ConfigDescriptorSize  Length of the attached device's Configuration Descriptor.
+                        *  \param[in]     ConfigDescriptorData  Pointer to a buffer containing the attached device's Configuration Descriptor.
+                        *
+                        *  \return A value from the \ref MS_Host_EnumerationFailure_ErrorCodes_t enum.

                         */
                         */

-                       uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint16_t ConfigDescriptorSize,
-                                                      void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
+                       uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
+                                                      uint16_t ConfigDescriptorSize,
+                                                      void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);

 
                        /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
                         *  and readying it for the next Mass Storage command.
 
                        /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
                         *  and readying it for the next Mass Storage command.


@@ -168,8 +172,8 @@
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
                         */

-                       uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint8_t* const MaxLUNIndex)
-                                                 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+                       uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
+                                                 uint8_t* const MaxLUNIndex) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);

 
                        /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
                         *  properties.
 
                        /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
                         *  properties.


@@ -183,7 +187,8 @@
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED.
                         */

-                       uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
+                       uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
+                                                      const uint8_t LUNIndex,

                                                       SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1)
                                                       ATTR_NON_NULL_PTR_ARG(3);
 
                                                       SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1)
                                                       ATTR_NON_NULL_PTR_ARG(3);
 


@@ -194,8 +199,8 @@
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */

-                       uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex)
-                                                     ATTR_NON_NULL_PTR_ARG(1);
+                       uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
+                                                     const uint8_t LUNIndex) ATTR_NON_NULL_PTR_ARG(1);

 
                        /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.
                         *
 
                        /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.
                         *


@@ -208,7 +213,8 @@
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */

-                       uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
+                       uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
+                                                          const uint8_t LUNIndex,

                                                           SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1)
                                                           ATTR_NON_NULL_PTR_ARG(3);
                
                                                           SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1)
                                                           ATTR_NON_NULL_PTR_ARG(3);
                


@@ -224,7 +230,8 @@
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */

-                       uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
+                       uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
+                                                    const uint8_t LUNIndex,

                                                     SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1)
                                                     ATTR_NON_NULL_PTR_ARG(3);
                
                                                     SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1)
                                                     ATTR_NON_NULL_PTR_ARG(3);
                


@@ -240,7 +247,8 @@
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */

-                       uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
+                       uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
+                                                                 const uint8_t LUNIndex,

                                                                  const bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);
                        
                        /** Reads blocks of data from the attached Mass Storage device's medium.
                                                                  const bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);
                        
                        /** Reads blocks of data from the attached Mass Storage device's medium.


@@ -257,8 +265,11 @@
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */

-                       uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
-                                                        const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
+                       uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
+                                                        const uint8_t LUNIndex,
+                                                        const uint32_t BlockAddress,
+                                                        const uint8_t Blocks,
+                                                        const uint16_t BlockSize,

                                                         void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
                
                        /** Writes blocks of data to the attached Mass Storage device's medium.
                                                         void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
                
                        /** Writes blocks of data to the attached Mass Storage device's medium.


@@ -275,8 +286,11 @@
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready.
                         */

-                       uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
-                                                         const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
+                       uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
+                                                         const uint8_t LUNIndex,
+                                                         const uint32_t BlockAddress,
+                                                         const uint8_t Blocks,
+                                                         const uint16_t BlockSize,

                                                          const void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 
                /* Inline Functions: */
                                                          const void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 
                /* Inline Functions: */


@@ -309,22 +323,19 @@
                        #define COMMAND_DIRECTION_DATA_IN      (1 << 7)
                        
                        #define COMMAND_DATA_TIMEOUT_MS        10000
                        #define COMMAND_DIRECTION_DATA_IN      (1 << 7)
                        
                        #define COMMAND_DATA_TIMEOUT_MS        10000

-
-                       #define MS_FOUND_DATAPIPE_IN           (1 << 0)
-                       #define MS_FOUND_DATAPIPE_OUT          (1 << 1)

                        
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_MS_CLASS_HOST_C)             
                        
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_MS_CLASS_HOST_C)             

-                               static uint8_t DCOMP_MS_NextMSInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
-                               static uint8_t DCOMP_MS_NextMSInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+                               static uint8_t DCOMP_MS_Host_NextMSInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+                               static uint8_t DCOMP_MS_Host_NextMSInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

                                
                                static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
                                                                   MS_CommandBlockWrapper_t* const SCSICommandBlock,
                                                                   const void* const BufferPtr) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
                                static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
                                static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, 
                                
                                static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
                                                                   MS_CommandBlockWrapper_t* const SCSICommandBlock,
                                                                   const void* const BufferPtr) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
                                static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
                                static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, 

-                                                       MS_CommandBlockWrapper_t* const SCSICommandBlock, void* BufferPtr)
-                                                                       ATTR_NON_NULL_PTR_ARG(1)  ATTR_NON_NULL_PTR_ARG(2);
+                                                                      MS_CommandBlockWrapper_t* const SCSICommandBlock,
+                                                                      void* BufferPtr) ATTR_NON_NULL_PTR_ARG(1)  ATTR_NON_NULL_PTR_ARG(2);

                                static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
                                                                         MS_CommandStatusWrapper_t* const SCSICommandStatus)
                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
                                static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
                                                                         MS_CommandStatusWrapper_t* const SCSICommandStatus)
                                                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);