Added new "Common" section to the class drivers, to hold all mode-independant definit...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / MassStorage.h
index f7e4df3..6f5dd89 100644 (file)
 */\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
                /** 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 ocurred. */\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 ocurred. */\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 ocurred. */\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 attemp 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
                /** Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
                typedef struct\r