LUFA/Drivers/USB/Class/Common/MassStorage.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Common definitions and declarations for the library USB Mass Storage Class driver.
  33  *
  34  *  Common definitions and declarations for the library USB Mass Storage Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.
  38  */
  39
  40 /** \ingroup Group_USBClassMS
  41  *  @defgroup Group_USBClassMSCommon  Common Class Definitions
  42  *
  43  *  \section Module Description
  44  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  45  *  Mass Storage Class.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef _MS_CLASS_COMMON_H_
  51 #define _MS_CLASS_COMMON_H_
  52
  53         /* Includes: */
  54                 #include "../../USB.h"
  55
  56                 #include <string.h>
  57
  58         /* Enable C linkage for C++ Compilers: */
  59                 #if defined(__cplusplus)
  60                         extern "C" {
  61                 #endif
  62
  63         /* Preprocessor Checks: */
  64                 #if !defined(__INCLUDE_FROM_MS_DRIVER)
  65                         #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
  66                 #endif
  67
  68         /* Macros: */
  69                 /** Mass Storage class-specific request to reset the Mass Storage interface, ready for the next command. */
  70                 #define REQ_MassStorageReset       0xFF
  71
  72                 /** Mass Storage class-specific request to retrieve the total number of Logical Units (drives) in the SCSI device. */
  73                 #define REQ_GetMaxLUN              0xFE
  74
  75                 /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */
  76                 #define MS_CBW_SIGNATURE           0x43425355UL
  77
  78                 /** Magic signature for a Command Status Wrapper used in the Mass Storage Bulk-Only transport protocol. */
  79                 #define MS_CSW_SIGNATURE           0x53425355UL
  80
  81                 /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from host-to-device. */
  82                 #define MS_COMMAND_DIR_DATA_OUT    (0 << 7)
  83
  84                 /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from device-to-host. */
  85                 #define MS_COMMAND_DIR_DATA_IN     (1 << 7)
  86
  87                 /** SCSI Command Code for an INQUIRY command. */
  88                 #define SCSI_CMD_INQUIRY                               0x12
  89
  90                 /** SCSI Command Code for a REQUEST SENSE command. */
  91                 #define SCSI_CMD_REQUEST_SENSE                         0x03
  92
  93                 /** SCSI Command Code for a TEST UNIT READY command. */
  94                 #define SCSI_CMD_TEST_UNIT_READY                       0x00
  95
  96                 /** SCSI Command Code for a READ CAPACITY (10) command. */
  97                 #define SCSI_CMD_READ_CAPACITY_10                      0x25
  98
  99                 /** SCSI Command Code for a SEND DIAGNOSTIC command. */
 100                 #define SCSI_CMD_SEND_DIAGNOSTIC                       0x1D
 101
 102                 /** SCSI Command Code for a PREVENT ALLOW MEDIUM REMOVAL command. */
 103                 #define SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL          0x1E
 104
 105                 /** SCSI Command Code for a WRITE (10) command. */
 106                 #define SCSI_CMD_WRITE_10                              0x2A
 107
 108                 /** SCSI Command Code for a READ (10) command. */
 109                 #define SCSI_CMD_READ_10                               0x28
 110
 111                 /** SCSI Command Code for a WRITE (6) command. */
 112                 #define SCSI_CMD_WRITE_6                               0x0A
 113
 114                 /** SCSI Command Code for a READ (6) command. */
 115                 #define SCSI_CMD_READ_6                                0x08
 116
 117                 /** SCSI Command Code for a VERIFY (10) command. */
 118                 #define SCSI_CMD_VERIFY_10                             0x2F
 119
 120                 /** SCSI Command Code for a MODE SENSE (6) command. */
 121                 #define SCSI_CMD_MODE_SENSE_6                          0x1A
 122
 123                 /** SCSI Command Code for a MODE SENSE (10) command. */
 124                 #define SCSI_CMD_MODE_SENSE_10                         0x5A
 125
 126                 /** SCSI Sense Code to indicate no error has occurred. */
 127                 #define SCSI_SENSE_KEY_GOOD                            0x00
 128
 129                 /** SCSI Sense Code to indicate that the device has recovered from an error. */
 130                 #define SCSI_SENSE_KEY_RECOVERED_ERROR                 0x01
 131
 132                 /** SCSI Sense Code to indicate that the device is not ready for a new command. */
 133                 #define SCSI_SENSE_KEY_NOT_READY                       0x02
 134
 135                 /** SCSI Sense Code to indicate an error whilst accessing the medium. */
 136                 #define SCSI_SENSE_KEY_MEDIUM_ERROR                    0x03
 137
 138                 /** SCSI Sense Code to indicate a hardware has occurred. */
 139                 #define SCSI_SENSE_KEY_HARDWARE_ERROR                  0x04
 140
 141                 /** SCSI Sense Code to indicate that an illegal request has been issued. */
 142                 #define SCSI_SENSE_KEY_ILLEGAL_REQUEST                 0x05
 143
 144                 /** SCSI Sense Code to indicate that the unit requires attention from the host to indicate
 145                  *  a reset event, medium removal or other condition.
 146                  */
 147                 #define SCSI_SENSE_KEY_UNIT_ATTENTION                  0x06
 148
 149                 /** SCSI Sense Code to indicate that a write attempt on a protected block has been made. */
 150                 #define SCSI_SENSE_KEY_DATA_PROTECT                    0x07
 151
 152                 /** SCSI Sense Code to indicate an error while trying to write to a write-once medium. */
 153                 #define SCSI_SENSE_KEY_BLANK_CHECK                     0x08
 154
 155                 /** SCSI Sense Code to indicate a vendor specific error has occurred. */
 156                 #define SCSI_SENSE_KEY_VENDOR_SPECIFIC                 0x09
 157
 158                 /** SCSI Sense Code to indicate that an EXTENDED COPY command has aborted due to an error. */
 159                 #define SCSI_SENSE_KEY_COPY_ABORTED                    0x0A
 160
 161                 /** SCSI Sense Code to indicate that the device has aborted the issued command. */
 162                 #define SCSI_SENSE_KEY_ABORTED_COMMAND                 0x0B
 163
 164                 /** SCSI Sense Code to indicate an attempt to write past the end of a partition has been made. */
 165                 #define SCSI_SENSE_KEY_VOLUME_OVERFLOW                 0x0D
 166
 167                 /** SCSI Sense Code to indicate that the source data did not match the data read from the medium. */
 168                 #define SCSI_SENSE_KEY_MISCOMPARE                      0x0E
 169
 170                 /** SCSI Additional Sense Code to indicate no additional sense information is available. */
 171                 #define SCSI_ASENSE_NO_ADDITIONAL_INFORMATION          0x00
 172
 173                 /** SCSI Additional Sense Code to indicate that the logical unit (LUN) addressed is not ready. */
 174                 #define SCSI_ASENSE_LOGICAL_UNIT_NOT_READY             0x04
 175
 176                 /** SCSI Additional Sense Code to indicate an invalid field was encountered while processing the issued command. */
 177                 #define SCSI_ASENSE_INVALID_FIELD_IN_CDB               0x24
 178
 179                 /** SCSI Additional Sense Code to indicate that a medium that was previously indicated as not ready has now
 180                  *  become ready for use.
 181                  */
 182                 #define SCSI_ASENSE_NOT_READY_TO_READY_CHANGE          0x28
 183
 184                 /** SCSI Additional Sense Code to indicate that an attempt to write to a protected area was made. */
 185                 #define SCSI_ASENSE_WRITE_PROTECTED                    0x27
 186
 187                 /** SCSI Additional Sense Code to indicate an error whilst formatting the device medium. */
 188                 #define SCSI_ASENSE_FORMAT_ERROR                       0x31
 189
 190                 /** SCSI Additional Sense Code to indicate an invalid command was issued. */
 191                 #define SCSI_ASENSE_INVALID_COMMAND                    0x20
 192
 193                 /** SCSI Additional Sense Code to indicate a write to a block out outside of the medium's range was issued. */
 194                 #define SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE 0x21
 195
 196                 /** SCSI Additional Sense Code to indicate that no removable medium is inserted into the device. */
 197                 #define SCSI_ASENSE_MEDIUM_NOT_PRESENT                 0x3A
 198
 199                 /** SCSI Additional Sense Qualifier Code to indicate no additional sense qualifier information is available. */
 200                 #define SCSI_ASENSEQ_NO_QUALIFIER                      0x00
 201
 202                 /** SCSI Additional Sense Qualifier Code to indicate that a medium format command failed to complete. */
 203                 #define SCSI_ASENSEQ_FORMAT_COMMAND_FAILED             0x01
 204
 205                 /** SCSI Additional Sense Qualifier Code to indicate that an initializing command must be issued before the issued
 206                  *  command can be executed.
 207                  */
 208                 #define SCSI_ASENSEQ_INITIALIZING_COMMAND_REQUIRED     0x02
 209
 210                 /** SCSI Additional Sense Qualifier Code to indicate that an operation is currently in progress. */
 211                 #define SCSI_ASENSEQ_OPERATION_IN_PROGRESS             0x07
 212
 213         /* Type defines: */
 214                 /** \brief Mass Storage Class Command Block Wrapper.
 215                  *
 216                  *  Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */
 217                 typedef struct
 218                 {
 219                         uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block. */
 220                         uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper. */
 221                         uint32_t DataTransferLength; /**< Length of the optional data portion of the issued command, in bytes. */
 222                         uint8_t  Flags; /**< Command block flags, indicating command data direction. */
 223                         uint8_t  LUN; /**< Logical Unit number this command is issued to. */
 224                         uint8_t  SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array. */
 225                         uint8_t  SCSICommandData[16]; /**< Issued SCSI command in the Command Block. */
 226                 } MS_CommandBlockWrapper_t;
 227
 228                 /** \brief Mass Storage Class Command Status Wrapper.
 229                  *
 230                  *  Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol.
 231                  */
 232                 typedef struct
 233                 {
 234                         uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status. */
 235                         uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper. */
 236                         uint32_t DataTransferResidue; /**< Number of bytes of data not processed in the SCSI command. */
 237                         uint8_t  Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum. */
 238                 } MS_CommandStatusWrapper_t;
 239
 240                 /** \brief Mass Storage Class SCSI Sense Structure
 241                  *
 242                  *  Type define for a SCSI Sense structure. Structures of this type are filled out by the
 243                  *  device via the \ref MS_Host_RequestSense() function, indicating the current sense data of the
 244                  *  device (giving explicit error codes for the last issued command). For details of the
 245                  *  structure contents, refer to the SCSI specifications.
 246                  */
 247                 typedef struct
 248                 {
 249                         uint8_t       ResponseCode;
 250
 251                         uint8_t       SegmentNumber;
 252
 253                         unsigned char SenseKey            : 4;
 254                         unsigned char Reserved            : 1;
 255                         unsigned char ILI                 : 1;
 256                         unsigned char EOM                 : 1;
 257                         unsigned char FileMark            : 1;
 258
 259                         uint8_t      Information[4];
 260                         uint8_t      AdditionalLength;
 261                         uint8_t      CmdSpecificInformation[4];
 262                         uint8_t      AdditionalSenseCode;
 263                         uint8_t      AdditionalSenseQualifier;
 264                         uint8_t      FieldReplaceableUnitCode;
 265                         uint8_t      SenseKeySpecific[3];
 266                 } SCSI_Request_Sense_Response_t;
 267
 268                 /** \brief Mass Storage Class SCSI Inquiry Structure.
 269                  *
 270                  *  Type define for a SCSI Inquiry structure. Structures of this type are filled out by the
 271                  *  device via the \ref MS_Host_GetInquiryData() function, retrieving the attached device's
 272                  *  information.
 273                  *
 274                  *  For details of the structure contents, refer to the SCSI specifications.
 275                  */
 276                 typedef struct
 277                 {
 278                         unsigned char DeviceType          : 5;
 279                         unsigned char PeripheralQualifier : 3;
 280
 281                         unsigned char Reserved            : 7;
 282                         unsigned char Removable           : 1;
 283
 284                         uint8_t      Version;
 285
 286                         unsigned char ResponseDataFormat  : 4;
 287                         unsigned char Reserved2           : 1;
 288                         unsigned char NormACA             : 1;
 289                         unsigned char TrmTsk              : 1;
 290                         unsigned char AERC                : 1;
 291
 292                         uint8_t      AdditionalLength;
 293                         uint8_t      Reserved3[2];
 294
 295                         unsigned char SoftReset           : 1;
 296                         unsigned char CmdQue              : 1;
 297                         unsigned char Reserved4           : 1;
 298                         unsigned char Linked              : 1;
 299                         unsigned char Sync                : 1;
 300                         unsigned char WideBus16Bit        : 1;
 301                         unsigned char WideBus32Bit        : 1;
 302                         unsigned char RelAddr             : 1;
 303
 304                         uint8_t      VendorID[8];
 305                         uint8_t      ProductID[16];
 306                         uint8_t      RevisionID[4];
 307                 } SCSI_Inquiry_Response_t;
 308
 309         /* Enums: */
 310                 /** Enum for the possible command status wrapper return status codes. */
 311                 enum MassStorage_CommandStatusCodes_t
 312                 {
 313                         SCSI_Command_Pass = 0, /**< Command completed with no error */
 314                         SCSI_Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a
 315                                                 *   SCSI REQUEST SENSE command.
 316                                                 */
 317                         SCSI_Phase_Error  = 2  /**< Command failed due to being invalid in the current phase. */
 318                 };
 319
 320         /* Disable C linkage for C++ Compilers: */
 321                 #if defined(__cplusplus)
 322                         }
 323                 #endif
 324
 325 #endif
 326
 327 /** @} */