Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / MassStorage.h
index b5e590e..bc56f22 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *  \brief Common definitions and declarations for the library USB Mass Storage Class driver.\r
- *\r
- *  Common definitions and declarations 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_USBClassMSCommon  Common Class Definitions\r
- *\r
- *  \section Module Description\r
- *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB\r
- *  Mass Storage Class.\r
- *\r
- *  @{\r
- */\r
-\r
-#ifndef _MS_CLASS_COMMON_H_\r
-#define _MS_CLASS_COMMON_H_\r
-\r
-       /* Includes: */\r
-               #include "../../USB.h"\r
-\r
-               #include <string.h>\r
-\r
-       /* Enable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\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
-       /* Macros: */\r
-               /** Mass Storage Class specific request to reset the Mass Storage interface, ready for the next command. */\r
-               #define REQ_MassStorageReset       0xFF\r
-\r
-               /** Mass Storage Class specific request to retrieve the total number of Logical Units (drives) in the SCSI device. */\r
-               #define REQ_GetMaxLUN              0xFE\r
-               \r
-               /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
-               #define MS_CBW_SIGNATURE           0x43425355UL\r
-\r
-               /** Magic signature for a Command Status Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
-               #define MS_CSW_SIGNATURE           0x53425355UL\r
-               \r
-               /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from host-to-device. */\r
-               #define MS_COMMAND_DIR_DATA_OUT    (0 << 7)\r
-\r
-               /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from device-to-host. */\r
-               #define MS_COMMAND_DIR_DATA_IN     (1 << 7)\r
-\r
-               /** SCSI Command Code for an INQUIRY command. */\r
-               #define SCSI_CMD_INQUIRY                               0x12\r
-\r
-               /** SCSI Command Code for a REQUEST SENSE command. */\r
-               #define SCSI_CMD_REQUEST_SENSE                         0x03\r
-\r
-               /** SCSI Command Code for a TEST UNIT READY command. */\r
-               #define SCSI_CMD_TEST_UNIT_READY                       0x00\r
-\r
-               /** SCSI Command Code for a READ CAPACITY (10) command. */\r
-               #define SCSI_CMD_READ_CAPACITY_10                      0x25\r
-\r
-               /** SCSI Command Code for a SEND DIAGNOSTIC command. */\r
-               #define SCSI_CMD_SEND_DIAGNOSTIC                       0x1D\r
-\r
-               /** SCSI Command Code for a PREVENT ALLOW MEDIUM REMOVAL command. */\r
-               #define SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL          0x1E\r
-\r
-               /** SCSI Command Code for a WRITE (10) command. */\r
-               #define SCSI_CMD_WRITE_10                              0x2A\r
-\r
-               /** SCSI Command Code for a READ (10) command. */\r
-               #define SCSI_CMD_READ_10                               0x28\r
-\r
-               /** SCSI Command Code for a WRITE (6) command. */\r
-               #define SCSI_CMD_WRITE_6                               0x0A\r
-\r
-               /** SCSI Command Code for a READ (6) command. */\r
-               #define SCSI_CMD_READ_6                                0x08\r
-\r
-               /** SCSI Command Code for a VERIFY (10) command. */\r
-               #define SCSI_CMD_VERIFY_10                             0x2F\r
-\r
-               /** SCSI Command Code for a MODE SENSE (6) command. */\r
-               #define SCSI_CMD_MODE_SENSE_6                          0x1A\r
-\r
-               /** SCSI Command Code for a MODE SENSE (10) command. */\r
-               #define SCSI_CMD_MODE_SENSE_10                         0x5A\r
-\r
-               /** SCSI Sense Code to indicate no error has occurred. */\r
-               #define SCSI_SENSE_KEY_GOOD                            0x00\r
-\r
-               /** SCSI Sense Code to indicate that the device has recovered from an error. */\r
-               #define SCSI_SENSE_KEY_RECOVERED_ERROR                 0x01\r
-\r
-               /** SCSI Sense Code to indicate that the device is not ready for a new command. */\r
-               #define SCSI_SENSE_KEY_NOT_READY                       0x02\r
-\r
-               /** SCSI Sense Code to indicate an error whilst accessing the medium. */\r
-               #define SCSI_SENSE_KEY_MEDIUM_ERROR                    0x03\r
-\r
-               /** SCSI Sense Code to indicate a hardware has occurred. */\r
-               #define SCSI_SENSE_KEY_HARDWARE_ERROR                  0x04\r
-\r
-               /** SCSI Sense Code to indicate that an illegal request has been issued. */\r
-               #define SCSI_SENSE_KEY_ILLEGAL_REQUEST                 0x05\r
-\r
-               /** SCSI Sense Code to indicate that the unit requires attention from the host to indicate\r
-                *  a reset event, medium removal or other condition.\r
-                */\r
-               #define SCSI_SENSE_KEY_UNIT_ATTENTION                  0x06\r
-\r
-               /** SCSI Sense Code to indicate that a write attempt on a protected block has been made. */\r
-               #define SCSI_SENSE_KEY_DATA_PROTECT                    0x07\r
-\r
-               /** SCSI Sense Code to indicate an error while trying to write to a write-once medium. */\r
-               #define SCSI_SENSE_KEY_BLANK_CHECK                     0x08\r
-\r
-               /** SCSI Sense Code to indicate a vendor specific error has occurred. */\r
-               #define SCSI_SENSE_KEY_VENDOR_SPECIFIC                 0x09\r
-\r
-               /** SCSI Sense Code to indicate that an EXTENDED COPY command has aborted due to an error. */\r
-               #define SCSI_SENSE_KEY_COPY_ABORTED                    0x0A\r
-\r
-               /** SCSI Sense Code to indicate that the device has aborted the issued command. */\r
-               #define SCSI_SENSE_KEY_ABORTED_COMMAND                 0x0B\r
-\r
-               /** SCSI Sense Code to indicate an attempt to write past the end of a partition has been made. */\r
-               #define SCSI_SENSE_KEY_VOLUME_OVERFLOW                 0x0D\r
-\r
-               /** SCSI Sense Code to indicate that the source data did not match the data read from the medium. */\r
-               #define SCSI_SENSE_KEY_MISCOMPARE                      0x0E\r
-\r
-               /** SCSI Additional Sense Code to indicate no additional sense information is available. */\r
-               #define SCSI_ASENSE_NO_ADDITIONAL_INFORMATION          0x00\r
-\r
-               /** SCSI Additional Sense Code to indicate that the logical unit (LUN) addressed is not ready. */\r
-               #define SCSI_ASENSE_LOGICAL_UNIT_NOT_READY             0x04\r
-\r
-               /** SCSI Additional Sense Code to indicate an invalid field was encountered while processing the issued command. */\r
-               #define SCSI_ASENSE_INVALID_FIELD_IN_CDB               0x24\r
-\r
-               /** SCSI Additional Sense Code to indicate that an attempt to write to a protected area was made. */\r
-               #define SCSI_ASENSE_WRITE_PROTECTED                    0x27\r
-\r
-               /** SCSI Additional Sense Code to indicate an error whilst formatting the device medium. */\r
-               #define SCSI_ASENSE_FORMAT_ERROR                       0x31\r
-\r
-               /** SCSI Additional Sense Code to indicate an invalid command was issued. */\r
-               #define SCSI_ASENSE_INVALID_COMMAND                    0x20\r
-\r
-               /** SCSI Additional Sense Code to indicate a write to a block out outside of the medium's range was issued. */\r
-               #define SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE 0x21\r
-\r
-               /** SCSI Additional Sense Code to indicate that no removable medium is inserted into the device. */\r
-               #define SCSI_ASENSE_MEDIUM_NOT_PRESENT                 0x3A\r
-\r
-               /** SCSI Additional Sense Qualifier Code to indicate no additional sense qualifier information is available. */\r
-               #define SCSI_ASENSEQ_NO_QUALIFIER                      0x00\r
-\r
-               /** SCSI Additional Sense Qualifier Code to indicate that a medium format command failed to complete. */\r
-               #define SCSI_ASENSEQ_FORMAT_COMMAND_FAILED             0x01\r
-\r
-               /** SCSI Additional Sense Qualifier Code to indicate that an initializing command must be issued before the issued\r
-                *  command can be executed.\r
-                */\r
-               #define SCSI_ASENSEQ_INITIALIZING_COMMAND_REQUIRED     0x02\r
-\r
-               /** SCSI Additional Sense Qualifier Code to indicate that an operation is currently in progress. */\r
-               #define SCSI_ASENSEQ_OPERATION_IN_PROGRESS             0x07\r
-               \r
-       /* Type defines: */\r
-               /** \brief Mass Storage Class Command Block Wrapper.\r
-                *\r
-                *  Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
-               typedef struct\r
-               {\r
-                       uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block */\r
-                       uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */\r
-                       uint32_t DataTransferLength; /** Length of the optional data portion of the issued command, in bytes */\r
-                       uint8_t  Flags; /**< Command block flags, indicating command data direction */\r
-                       uint8_t  LUN; /**< Logical Unit number this command is issued to */\r
-                       uint8_t  SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array */\r
-                       uint8_t  SCSICommandData[16]; /**< Issued SCSI command in the Command Block */\r
-               } MS_CommandBlockWrapper_t;\r
-               \r
-               /** \brief Mass Storage Class Command Status Wrapper.\r
-                *\r
-                *  Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status */\r
-                       uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */\r
-                       uint32_t DataTransferResidue; /**< Number of bytes of data not processed in the SCSI command */\r
-                       uint8_t  Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */\r
-               } MS_CommandStatusWrapper_t;\r
-               \r
-               /** \brief Mass Storage Class SCSI Sense Structure\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
-               /** \brief Mass Storage Class SCSI Inquiry Structure.\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
-       /* Enums: */\r
-               /** Enum for the possible command status wrapper return status codes. */\r
-               enum MassStorage_CommandStatusCodes_t\r
-               {\r
-                       SCSI_Command_Pass = 0, /**< Command completed with no error */\r
-                       SCSI_Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a SCSI REQUEST SENSE command */\r
-                       SCSI_Phase_Error  = 2  /**< Command failed due to being invalid in the current phase */\r
-               };\r
-       \r
-       /* Disable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\r
-                       }\r
-               #endif\r
-               \r
-#endif\r
-\r
-/** @} */\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this 
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in 
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting 
+  documentation, and that the name of the author not be used in 
+  advertising or publicity pertaining to distribution of the 
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief Common definitions and declarations for the library USB Mass Storage Class driver.
+ *
+ *  Common definitions and declarations for the library USB Mass Storage Class driver.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver
+ *        dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.
+ */
+
+/** \ingroup Group_USBClassMS
+ *  @defgroup Group_USBClassMSCommon  Common Class Definitions
+ *
+ *  \section Module Description
+ *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
+ *  Mass Storage Class.
+ *
+ *  @{
+ */
+
+#ifndef _MS_CLASS_COMMON_H_
+#define _MS_CLASS_COMMON_H_
+
+       /* Includes: */
+               #include "../../USB.h"
+
+               #include <string.h>
+
+       /* Enable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       extern "C" {
+               #endif
+
+       /* Preprocessor Checks: */
+               #if !defined(__INCLUDE_FROM_MS_DRIVER)
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
+               #endif
+               
+       /* Macros: */
+               /** Mass Storage Class specific request to reset the Mass Storage interface, ready for the next command. */
+               #define REQ_MassStorageReset       0xFF
+
+               /** Mass Storage Class specific request to retrieve the total number of Logical Units (drives) in the SCSI device. */
+               #define REQ_GetMaxLUN              0xFE
+               
+               /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */
+               #define MS_CBW_SIGNATURE           0x43425355UL
+
+               /** Magic signature for a Command Status Wrapper used in the Mass Storage Bulk-Only transport protocol. */
+               #define MS_CSW_SIGNATURE           0x53425355UL
+               
+               /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from host-to-device. */
+               #define MS_COMMAND_DIR_DATA_OUT    (0 << 7)
+
+               /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from device-to-host. */
+               #define MS_COMMAND_DIR_DATA_IN     (1 << 7)
+
+               /** SCSI Command Code for an INQUIRY command. */
+               #define SCSI_CMD_INQUIRY                               0x12
+
+               /** SCSI Command Code for a REQUEST SENSE command. */
+               #define SCSI_CMD_REQUEST_SENSE                         0x03
+
+               /** SCSI Command Code for a TEST UNIT READY command. */
+               #define SCSI_CMD_TEST_UNIT_READY                       0x00
+
+               /** SCSI Command Code for a READ CAPACITY (10) command. */
+               #define SCSI_CMD_READ_CAPACITY_10                      0x25
+
+               /** SCSI Command Code for a SEND DIAGNOSTIC command. */
+               #define SCSI_CMD_SEND_DIAGNOSTIC                       0x1D
+
+               /** SCSI Command Code for a PREVENT ALLOW MEDIUM REMOVAL command. */
+               #define SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL          0x1E
+
+               /** SCSI Command Code for a WRITE (10) command. */
+               #define SCSI_CMD_WRITE_10                              0x2A
+
+               /** SCSI Command Code for a READ (10) command. */
+               #define SCSI_CMD_READ_10                               0x28
+
+               /** SCSI Command Code for a WRITE (6) command. */
+               #define SCSI_CMD_WRITE_6                               0x0A
+
+               /** SCSI Command Code for a READ (6) command. */
+               #define SCSI_CMD_READ_6                                0x08
+
+               /** SCSI Command Code for a VERIFY (10) command. */
+               #define SCSI_CMD_VERIFY_10                             0x2F
+
+               /** SCSI Command Code for a MODE SENSE (6) command. */
+               #define SCSI_CMD_MODE_SENSE_6                          0x1A
+
+               /** SCSI Command Code for a MODE SENSE (10) command. */
+               #define SCSI_CMD_MODE_SENSE_10                         0x5A
+
+               /** SCSI Sense Code to indicate no error has occurred. */
+               #define SCSI_SENSE_KEY_GOOD                            0x00
+
+               /** SCSI Sense Code to indicate that the device has recovered from an error. */
+               #define SCSI_SENSE_KEY_RECOVERED_ERROR                 0x01
+
+               /** SCSI Sense Code to indicate that the device is not ready for a new command. */
+               #define SCSI_SENSE_KEY_NOT_READY                       0x02
+
+               /** SCSI Sense Code to indicate an error whilst accessing the medium. */
+               #define SCSI_SENSE_KEY_MEDIUM_ERROR                    0x03
+
+               /** SCSI Sense Code to indicate a hardware has occurred. */
+               #define SCSI_SENSE_KEY_HARDWARE_ERROR                  0x04
+
+               /** SCSI Sense Code to indicate that an illegal request has been issued. */
+               #define SCSI_SENSE_KEY_ILLEGAL_REQUEST                 0x05
+
+               /** SCSI Sense Code to indicate that the unit requires attention from the host to indicate
+                *  a reset event, medium removal or other condition.
+                */
+               #define SCSI_SENSE_KEY_UNIT_ATTENTION                  0x06
+
+               /** SCSI Sense Code to indicate that a write attempt on a protected block has been made. */
+               #define SCSI_SENSE_KEY_DATA_PROTECT                    0x07
+
+               /** SCSI Sense Code to indicate an error while trying to write to a write-once medium. */
+               #define SCSI_SENSE_KEY_BLANK_CHECK                     0x08
+
+               /** SCSI Sense Code to indicate a vendor specific error has occurred. */
+               #define SCSI_SENSE_KEY_VENDOR_SPECIFIC                 0x09
+
+               /** SCSI Sense Code to indicate that an EXTENDED COPY command has aborted due to an error. */
+               #define SCSI_SENSE_KEY_COPY_ABORTED                    0x0A
+
+               /** SCSI Sense Code to indicate that the device has aborted the issued command. */
+               #define SCSI_SENSE_KEY_ABORTED_COMMAND                 0x0B
+
+               /** SCSI Sense Code to indicate an attempt to write past the end of a partition has been made. */
+               #define SCSI_SENSE_KEY_VOLUME_OVERFLOW                 0x0D
+
+               /** SCSI Sense Code to indicate that the source data did not match the data read from the medium. */
+               #define SCSI_SENSE_KEY_MISCOMPARE                      0x0E
+
+               /** SCSI Additional Sense Code to indicate no additional sense information is available. */
+               #define SCSI_ASENSE_NO_ADDITIONAL_INFORMATION          0x00
+
+               /** SCSI Additional Sense Code to indicate that the logical unit (LUN) addressed is not ready. */
+               #define SCSI_ASENSE_LOGICAL_UNIT_NOT_READY             0x04
+
+               /** SCSI Additional Sense Code to indicate an invalid field was encountered while processing the issued command. */
+               #define SCSI_ASENSE_INVALID_FIELD_IN_CDB               0x24
+
+               /** SCSI Additional Sense Code to indicate that an attempt to write to a protected area was made. */
+               #define SCSI_ASENSE_WRITE_PROTECTED                    0x27
+
+               /** SCSI Additional Sense Code to indicate an error whilst formatting the device medium. */
+               #define SCSI_ASENSE_FORMAT_ERROR                       0x31
+
+               /** SCSI Additional Sense Code to indicate an invalid command was issued. */
+               #define SCSI_ASENSE_INVALID_COMMAND                    0x20
+
+               /** SCSI Additional Sense Code to indicate a write to a block out outside of the medium's range was issued. */
+               #define SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE 0x21
+
+               /** SCSI Additional Sense Code to indicate that no removable medium is inserted into the device. */
+               #define SCSI_ASENSE_MEDIUM_NOT_PRESENT                 0x3A
+
+               /** SCSI Additional Sense Qualifier Code to indicate no additional sense qualifier information is available. */
+               #define SCSI_ASENSEQ_NO_QUALIFIER                      0x00
+
+               /** SCSI Additional Sense Qualifier Code to indicate that a medium format command failed to complete. */
+               #define SCSI_ASENSEQ_FORMAT_COMMAND_FAILED             0x01
+
+               /** SCSI Additional Sense Qualifier Code to indicate that an initializing command must be issued before the issued
+                *  command can be executed.
+                */
+               #define SCSI_ASENSEQ_INITIALIZING_COMMAND_REQUIRED     0x02
+
+               /** SCSI Additional Sense Qualifier Code to indicate that an operation is currently in progress. */
+               #define SCSI_ASENSEQ_OPERATION_IN_PROGRESS             0x07
+               
+       /* Type defines: */
+               /** \brief Mass Storage Class Command Block Wrapper.
+                *
+                *  Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */
+               typedef struct
+               {
+                       uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block */
+                       uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */
+                       uint32_t DataTransferLength; /** Length of the optional data portion of the issued command, in bytes */
+                       uint8_t  Flags; /**< Command block flags, indicating command data direction */
+                       uint8_t  LUN; /**< Logical Unit number this command is issued to */
+                       uint8_t  SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array */
+                       uint8_t  SCSICommandData[16]; /**< Issued SCSI command in the Command Block */
+               } MS_CommandBlockWrapper_t;
+               
+               /** \brief Mass Storage Class Command Status Wrapper.
+                *
+                *  Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol.
+                */
+               typedef struct
+               {
+                       uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status */
+                       uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */
+                       uint32_t DataTransferResidue; /**< Number of bytes of data not processed in the SCSI command */
+                       uint8_t  Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */
+               } MS_CommandStatusWrapper_t;
+               
+               /** \brief Mass Storage Class SCSI Sense Structure
+                *  
+                *  Type define for a SCSI Sense structure. Structures of this type are filled out by the
+                *  device via the MassStore_RequestSense() function, indicating the current sense data of the
+                *  device (giving explicit error codes for the last issued command). For details of the
+                *  structure contents, refer to the SCSI specifications.
+                */
+               typedef struct
+               {
+                       uint8_t       ResponseCode;
+
+                       uint8_t       SegmentNumber;
+                       
+                       unsigned char SenseKey            : 4;
+                       unsigned char _RESERVED1          : 1;
+                       unsigned char ILI                 : 1;
+                       unsigned char EOM                 : 1;
+                       unsigned char FileMark            : 1;
+                       
+                       uint8_t      Information[4];
+                       uint8_t      AdditionalLength;
+                       uint8_t      CmdSpecificInformation[4];
+                       uint8_t      AdditionalSenseCode;
+                       uint8_t      AdditionalSenseQualifier;
+                       uint8_t      FieldReplaceableUnitCode;
+                       uint8_t      SenseKeySpecific[3];
+               } SCSI_Request_Sense_Response_t;
+
+               /** \brief Mass Storage Class SCSI Inquiry Structure.
+                *
+                *  Type define for a SCSI Inquiry structure. Structures of this type are filled out by the
+                *  device via the MassStore_Inquiry() function, retrieving the attached device's information.
+                *  For details of the structure contents, refer to the SCSI specifications.
+                */
+               typedef struct
+               {
+                       unsigned char DeviceType          : 5;
+                       unsigned char PeripheralQualifier : 3;
+                       
+                       unsigned char _RESERVED1          : 7;
+                       unsigned char Removable           : 1;
+                       
+                       uint8_t      Version;
+                       
+                       unsigned char ResponseDataFormat  : 4;
+                       unsigned char _RESERVED2          : 1;
+                       unsigned char NormACA             : 1;
+                       unsigned char TrmTsk              : 1;
+                       unsigned char AERC                : 1;
+
+                       uint8_t      AdditionalLength;
+                       uint8_t      _RESERVED3[2];
+
+                       unsigned char SoftReset           : 1;
+                       unsigned char CmdQue              : 1;
+                       unsigned char _RESERVED4          : 1;
+                       unsigned char Linked              : 1;
+                       unsigned char Sync                : 1;
+                       unsigned char WideBus16Bit        : 1;
+                       unsigned char WideBus32Bit        : 1;
+                       unsigned char RelAddr             : 1;
+                       
+                       uint8_t      VendorID[8];
+                       uint8_t      ProductID[16];
+                       uint8_t      RevisionID[4];
+               } SCSI_Inquiry_Response_t;
+
+       /* Enums: */
+               /** Enum for the possible command status wrapper return status codes. */
+               enum MassStorage_CommandStatusCodes_t
+               {
+                       SCSI_Command_Pass = 0, /**< Command completed with no error */
+                       SCSI_Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a SCSI REQUEST SENSE command */
+                       SCSI_Phase_Error  = 2  /**< Command failed due to being invalid in the current phase */
+               };
+       
+       /* Disable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       }
+               #endif
+               
+#endif
+
+/** @} */