Add start of a SDP service table, which will be linked to the Bluetooth SDP code.

[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 a65a352..d2ab970 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Host/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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r

 \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
+  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,6 +28,15 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Host mode driver for the library USB Mass Storage Class driver.\r
+ *\r
+ *  Host 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_USBClassMassStorageHost Mass Storage Class Host Mode Driver\r
  *\r
 /** \ingroup Group_USBClassMS\r
  *  @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver\r
  *\r


@@ -53,107 +62,56 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \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
+\r

        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Error code for some Mass Storage Host functions, indicating a logical (and not hardware) error */\r
                        #define MS_ERROR_LOGICAL_CMD_FAILED              0x80\r
        \r
                /* Type Defines: */\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Error code for some Mass Storage Host functions, indicating a logical (and not hardware) error */\r
                        #define MS_ERROR_LOGICAL_CMD_FAILED              0x80\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
-                        *  stores each HID interface's configuration and state information.\r
+                       /** \brief Mass Storage Class Host Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made within the user application,\r
+                        *  and passed to each of the Mass Storage class driver functions as the MSInterfaceInfo parameter. This\r
+                        *  stores each Mass Storage interface's configuration and state information.\r

                         */\r
                        typedef struct\r
                        {\r
                                const struct\r
                                {\r
                         */\r
                        typedef struct\r
                        {\r
                                const struct\r
                                {\r

-                                       uint8_t  DataINPipeNumber; /**< Pipe number of the MS interface's IN data pipe */\r
-                                       uint8_t  DataOUTPipeNumber; /**< Pipe number of the MS interface's OUT data pipe */\r
+                                       uint8_t  DataINPipeNumber; /**< Pipe number of the Mass Storage interface's IN data pipe */\r
+                                       bool     DataINPipeDoubleBank; /** Indicates if the Mass Storage interface's IN data pipe should use double banking */\r
+\r
+                                       uint8_t  DataOUTPipeNumber; /**< Pipe number of the Mass Storage interface's OUT data pipe */\r
+                                       bool     DataOUTPipeDoubleBank; /** Indicates if the Mass Storage interface's OUT data pipe should use double banking */\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
                                        bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid\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
                                        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
+                                                       *   after \ref MS_Host_ConfigurePipes() is called and the Host state machine is in the\r

                                                        *   Configured state\r
                                                        */\r
                                                        *   Configured state\r
                                                        */\r

-                                       uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device */\r
+                                       uint8_t InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device */\r

 \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
+                                       uint16_t DataINPipeSize; /**< Size in bytes of the Mass Storage interface's IN data pipe */\r
+                                       uint16_t DataOUTPipeSize;  /**< Size in bytes of the Mass Storage interface's OUT data pipe */\r

                                        \r
                                        \r

-                                       uint32_t TransactionTag; /**< Current transaction tag for data synchronising of packets */\r
+                                       uint32_t TransactionTag; /**< Current transaction tag for data synchronizing 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
                                } 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
                        \r

-                       /** SCSI capacity structure, to hold the total capacity of the device in both the number\r
+                       /** \brief SCSI Device LUN Capacity Structure.\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
                         *  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


@@ -173,14 +131,6 @@
                        };\r
        \r
                /* Function Prototypes: */\r
                        };\r
        \r
                /* Function Prototypes: */\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* const 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
                        /** 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


@@ -194,7 +144,7 @@
                         *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum\r
                         */\r
                        uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint16_t ConfigDescriptorSize,\r
                         *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum\r
                         */\r
                        uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint16_t ConfigDescriptorSize,\r

-                                                      uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                                                      void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(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
                        /** 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


@@ -209,16 +159,24 @@
                         *  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
                         *  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

+                        *  \note Some devices do not support this request, and will STALL it when issued. To get around this,\r
+                        *        on unsupported devices the max LUN index will be reported as zero and no error will be returned\r
+                        *        if the device STALLs the request.\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
                         *  \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* const MSInterfaceInfo, uint8_t* const MaxLUNIndex) ATTR_NON_NULL_PTR_ARG(1, 2);\r
+                       uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint8_t* const MaxLUNIndex)\r
+                                                 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r

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

+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
                         *  \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


@@ -226,7 +184,8 @@
                         *  \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* const MSInterfaceInfo, const uint8_t LUNIndex,\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* const MSInterfaceInfo, const uint8_t LUNIndex,\r

-                                                      SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                                                      SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1)\r
+                                                      ATTR_NON_NULL_PTR_ARG(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
 \r
                        /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.\r
                         *\r


@@ -235,10 +194,14 @@
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
                         */\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* const MSInterfaceInfo, const uint8_t LUNIndex) ATTR_NON_NULL_PTR_ARG(1);\r
+                       uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex)\r
+                                                     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
 \r
                        /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.\r
                         *\r

+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
                         *  \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


@@ -246,11 +209,15 @@
                         *  \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* const MSInterfaceInfo, const uint8_t LUNIndex,\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* const MSInterfaceInfo, const uint8_t LUNIndex,\r

-                                                          SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                                                          SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1)\r
+                                                          ATTR_NON_NULL_PTR_ARG(3);\r

                \r
                        /** Retrieves the device sense data, indicating the current device state and error codes for the previously\r
                         *  issued command.\r
                         *\r
                \r
                        /** Retrieves the device sense data, indicating the current device state and error codes for the previously\r
                         *  issued command.\r
                         *\r

+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
                         *  \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


@@ -258,11 +225,15 @@
                         *  \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* const MSInterfaceInfo, const uint8_t LUNIndex,\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* const MSInterfaceInfo, const uint8_t LUNIndex,\r

-                                                    SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                                                    SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1)\r
+                                                    ATTR_NON_NULL_PTR_ARG(3);\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
                \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

+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
                         *  \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


@@ -274,6 +245,9 @@
                        \r
                        /** Reads blocks of data from the attached Mass Storage device's medium.\r
                         *\r
                        \r
                        /** Reads blocks of data from the attached Mass Storage device's medium.\r
                         *\r

+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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,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


@@ -285,10 +259,13 @@
                         */\r
                        uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,\r
                                                         const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,\r
                         */\r
                        uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,\r
                                                         const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,\r

-                                                        void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1, 6);\r
+                                                        void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);\r

                \r
                        /** Writes blocks of data to the attached Mass Storage device's medium.\r
                         *\r
                \r
                        /** Writes blocks of data to the attached Mass Storage device's medium.\r
                         *\r

+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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,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


@@ -300,7 +277,20 @@
                         */\r
                        uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,\r
                                                          const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,\r
                         */\r
                        uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,\r
                                                          const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,\r

-                                                         void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1, 6);\r
+                                                         const void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);\r
+\r
+               /* Inline Functions: */\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
+                       static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);\r
+                       static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo)\r
+                       {\r
+                               (void)MSInterfaceInfo;\r
+                       }\r

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


@@ -318,24 +308,24 @@
                        #define COMMAND_DIRECTION_DATA_OUT     (0 << 7)\r
                        #define COMMAND_DIRECTION_DATA_IN      (1 << 7)\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
+                       #define COMMAND_DATA_TIMEOUT_MS        10000\r

 \r
                        #define MS_FOUND_DATAPIPE_IN           (1 << 0)\r
                        #define MS_FOUND_DATAPIPE_OUT          (1 << 1)\r
                        \r
                /* Function Prototypes: */\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
-                               static uint8_t DComp_NextMSInterface(void* CurrentDescriptor);\r
-                               static uint8_t DComp_NextMSInterfaceEndpoint(void* CurrentDescriptor);\r
+                       #if defined(__INCLUDE_FROM_MS_CLASS_HOST_C)             \r
+                               static uint8_t DComp_NextMSInterface(void* const CurrentDescriptor);\r
+                               static uint8_t DComp_NextMSInterfaceEndpoint(void* const CurrentDescriptor);\r

                                \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
+                               static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,\r
+                                                                  MS_CommandBlockWrapper_t* const SCSICommandBlock,\r
+                                                                  const void* const BufferPtr);\r
+                               static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);\r
+                               static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, \r
+                                                       MS_CommandBlockWrapper_t* const SCSICommandBlock, void* BufferPtr);\r
+                               static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,\r
+                                                                        MS_CommandStatusWrapper_t* const SCSICommandStatus);\r

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