Fixed incorrect event name in the Benito project.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / MassStorage.h
index e869333..1e0c454 100644 (file)
@@ -3,7 +3,7 @@
      Copyright (C) Dean Camera, 2010.
 
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
@@ -78,6 +78,8 @@
                /** 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)
 
+               /** \name SCSI Commands*/
+               //@{
                /** SCSI Command Code for an INQUIRY command. */
                #define SCSI_CMD_INQUIRY                               0x12
 
 
                /** SCSI Command Code for a MODE SENSE (10) command. */
                #define SCSI_CMD_MODE_SENSE_10                         0x5A
-
+               //@}
+               
+               /** \name SCSI Sense Key Values */
+               //@{
                /** SCSI Sense Code to indicate no error has occurred. */
                #define SCSI_SENSE_KEY_GOOD                            0x00
 
 
                /** SCSI Sense Code to indicate that the source data did not match the data read from the medium. */
                #define SCSI_SENSE_KEY_MISCOMPARE                      0x0E
-
+               //@}
+               
+               /** \name SCSI Additional Sense Codes */
+               //@{
                /** 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 no removable medium is inserted into the device. */
                #define SCSI_ASENSE_MEDIUM_NOT_PRESENT                 0x3A
-
+               //@}
+               
+               /** \name SCSI Additional Sense Key Code Qualifiers */
+               //@{
                /** 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 an operation is currently in progress. */
                #define SCSI_ASENSEQ_OPERATION_IN_PROGRESS             0x07
-
+               //@}
+               
        /* Enums: */
+               /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Mass
+                *  Storage device class.
+                */
+               enum MS_Descriptor_ClassSubclassProtocol_t
+               {
+                       MS_CSCP_MassStorageClass          = 0x08, /**< Descriptor Class value indicating that the device or interface
+                                                                  *   belongs to the Mass Storage class.
+                                                                  */
+                       MS_CSCP_SCSITransparentSubclass   = 0x06, /**< Descriptor Subclass value indicating that the device or interface
+                                                                  *   belongs to the SCSI Transparent Command Set subclass of the Mass
+                                                                  *   storage class.
+                                                                  */
+                       MS_CSCP_BulkOnlyTransportProtocol = 0x50, /**< Descriptor Protocol value indicating that the device or interface
+                                                                  *   belongs to the Bulk Only Transport protocol of the Mass Storage class.
+                                                                  */
+               };
+       
                /** Enum for the Mass Storage class specific control requests that can be issued by the USB bus host. */
                enum MS_ClassRequests_t
                {
-                       MS_REQ_GetMaxLUN        = 0xFE, /**< Mass Storage class-specific request to retrieve the total number of Logical
-                                                        *   Units (drives) in the SCSI device.
-                                                        */
-                       MS_REQ_MassStorageReset = 0xFF, /**< Mass Storage class-specific request to reset the Mass Storage interface,
-                                                        *   ready for the next command.
-                                                    */
+                       MS_REQ_GetMaxLUN                  = 0xFE, /**< Mass Storage class-specific request to retrieve the total number of Logical
+                                                                  *   Units (drives) in the SCSI device.
+                                                                  */
+                       MS_REQ_MassStorageReset           = 0xFF, /**< Mass Storage class-specific request to reset the Mass Storage interface,
+                                                                  *   ready for the next command.
+                                                              */
                };
 
                /** Enum for the possible command status wrapper return status codes. */
                enum MS_CommandStatusCodes_t
                {
-                       MS_SCSI_COMMAND_Pass        = 0, /**< Command completed with no error */
-                       MS_SCSI_COMMAND_Fail        = 1, /**< Command failed to complete - host may check the exact error via a
-                                                         *   SCSI REQUEST SENSE command.
-                                                         */
-                       MS_SCSI_COMMAND_PhaseError  = 2, /**< Command failed due to being invalid in the current phase. */
+                       MS_SCSI_COMMAND_Pass              = 0, /**< Command completed with no error */
+                       MS_SCSI_COMMAND_Fail              = 1, /**< Command failed to complete - host may check the exact error via a
+                                                               *   SCSI REQUEST SENSE command.
+                                                               */
+                       MS_SCSI_COMMAND_PhaseError        = 2, /**< Command failed due to being invalid in the current phase. */
                };
 
        /* Type Defines: */