Add Doxygen documentation to the completed portions of the PDI programming protocol...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / MassStorage.h
index 4cd37bd..aa70733 100644 (file)
                                        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
-                                       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
-\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       ResponseCode;\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
                         *  \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
-                                                      void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(13);\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
                         *  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
-                       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
                         *  \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
                         *  \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
                         *  \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
                         *  \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
                        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(16);\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
                        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(16);\r
+                                                         void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\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