Renamed all driver termination *_ShutDown() functions to the more logical name *_Disa...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / MassStorage.h

diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h
index 78baece..761141b 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   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 
+  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 without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -33,14 +33,14 @@
  *
  *  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.
+ *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ *        dispatch header located in LUFA/Drivers/USB.h.

  */
 
 /** \ingroup Group_USBClassMS
  *  @defgroup Group_USBClassMSCommon  Common Class Definitions
  *
  */
 
 /** \ingroup Group_USBClassMS
  *  @defgroup Group_USBClassMSCommon  Common Class Definitions
  *

- *  \section Module Description
+ *  \section Sec_ModDescription Module Description

  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  Mass Storage Class.
  *
  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  Mass Storage Class.
  *


@@ -51,7 +51,7 @@
 #define _MS_CLASS_COMMON_H_
 
        /* Includes: */
 #define _MS_CLASS_COMMON_H_
 
        /* Includes: */

-               #include "../../USB.h"
+               #include "../../HighLevel/StdDescriptors.h"

 
                #include <string.h>
 
 
                #include <string.h>
 


@@ -62,28 +62,24 @@
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_MS_DRIVER)
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_MS_DRIVER)

-                       #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
+                       #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.

                #endif
                #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
-               
+       /* Macros: */

                /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */
                /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */

-               #define MS_CBW_SIGNATURE           0x43425355UL
+               #define MS_CBW_SIGNATURE                               0x43425355UL

 
                /** Magic signature for a Command Status Wrapper used in the Mass Storage Bulk-Only transport protocol. */
 
                /** Magic signature for a Command Status Wrapper used in the Mass Storage Bulk-Only transport protocol. */

-               #define MS_CSW_SIGNATURE           0x53425355UL
-               
+               #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. */
                /** 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)
+               #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. */
 
                /** 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)
+               #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 an INQUIRY command. */
                #define SCSI_CMD_INQUIRY                               0x12
 


@@ -122,7 +118,10 @@
 
                /** SCSI Command Code for a MODE SENSE (10) command. */
                #define SCSI_CMD_MODE_SENSE_10                         0x5A
 
                /** 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 no error has occurred. */
                #define SCSI_SENSE_KEY_GOOD                            0x00
 


@@ -166,7 +165,10 @@
 
                /** 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 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 no additional sense information is available. */
                #define SCSI_ASENSE_NO_ADDITIONAL_INFORMATION          0x00
 


@@ -176,6 +178,11 @@
                /** 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 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 a medium that was previously indicated as not ready has now
+                *  become ready for use.
+                */
+               #define SCSI_ASENSE_NOT_READY_TO_READY_CHANGE          0x28
+

                /** 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 that an attempt to write to a protected area was made. */
                #define SCSI_ASENSE_WRITE_PROTECTED                    0x27
 


@@ -190,7 +197,10 @@
 
                /** 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 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 no additional sense qualifier information is available. */
                #define SCSI_ASENSEQ_NO_QUALIFIER                      0x00
 


@@ -204,38 +214,78 @@
 
                /** SCSI Additional Sense Qualifier Code to indicate that an operation is currently in progress. */
                #define SCSI_ASENSEQ_OPERATION_IN_PROGRESS             0x07
 
                /** SCSI Additional Sense Qualifier Code to indicate that an operation is currently in progress. */
                #define SCSI_ASENSEQ_OPERATION_IN_PROGRESS             0x07

+               //@}

                
                

-       /* Type defines: */
+       /* 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.
+                                                              */
+               };
+
+               /** 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. */
+               };
+
+       /* 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
                {
                /** \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 */
+                       uint32_t Signature; /**< Command block signature, must be \ref MS_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;
                } 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
                {
                /** \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 */
+                       uint32_t Signature; /**< Status block signature, must be \ref MS_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 \ref MS_CommandStatusCodes_t enum. */

                } MS_CommandStatusWrapper_t;
                } MS_CommandStatusWrapper_t;

-               
+

                /** \brief Mass Storage Class SCSI Sense Structure
                /** \brief Mass Storage Class SCSI Sense Structure

-                *  
+                *

                 *  Type define for a SCSI Sense structure. Structures of this type are filled out by the
                 *  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 via the \ref MS_Host_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.
                 */
                 *  device (giving explicit error codes for the last issued command). For details of the
                 *  structure contents, refer to the SCSI specifications.
                 */


@@ -244,75 +294,69 @@
                        uint8_t       ResponseCode;
 
                        uint8_t       SegmentNumber;
                        uint8_t       ResponseCode;
 
                        uint8_t       SegmentNumber;

-                       
+

                        unsigned char SenseKey            : 4;
                        unsigned char SenseKey            : 4;

-                       unsigned char _RESERVED1          : 1;
+                       unsigned char Reserved            : 1;

                        unsigned char ILI                 : 1;
                        unsigned char EOM                 : 1;
                        unsigned char FileMark            : 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];
+
+                       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
                } 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.
+                *  device via the \ref MS_Host_GetInquiryData() 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;
                 *  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 Reserved            : 7;

                        unsigned char Removable           : 1;
                        unsigned char Removable           : 1;

-                       
-                       uint8_t      Version;
-                       
+
+                       uint8_t       Version;
+

                        unsigned char ResponseDataFormat  : 4;
                        unsigned char ResponseDataFormat  : 4;

-                       unsigned char _RESERVED2          : 1;
+                       unsigned char Reserved2           : 1;

                        unsigned char NormACA             : 1;
                        unsigned char TrmTsk              : 1;
                        unsigned char AERC                : 1;
 
                        unsigned char NormACA             : 1;
                        unsigned char TrmTsk              : 1;
                        unsigned char AERC                : 1;
 

-                       uint8_t      AdditionalLength;
-                       uint8_t      _RESERVED3[2];
+                       uint8_t       AdditionalLength;
+                       uint8_t       Reserved3[2];

 
                        unsigned char SoftReset           : 1;
                        unsigned char CmdQue              : 1;
 
                        unsigned char SoftReset           : 1;
                        unsigned char CmdQue              : 1;

-                       unsigned char _RESERVED4          : 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;
                        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];
+
+                       uint8_t       VendorID[8];
+                       uint8_t       ProductID[16];
+                       uint8_t       RevisionID[4];

                } SCSI_Inquiry_Response_t;
 
                } 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
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif

-               
+

 #endif
 
 /** @} */
 #endif
 
 /** @} */

+