Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c

   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  *
  33  *  SCSI command processing routines, for SCSI commands issued by the host. Mass Storage
  34  *  devices use a thin "Bulk-Only Transport" protocol for issuing commands and status information,
  35  *  which wrap around standard SCSI device commands for controlling the actual storage medium.
  36  */
  37
  38 #define  INCLUDE_FROM_SCSI_C
  39 #include "SCSI.h"
  40
  41 /** Structure to hold the SCSI response data to a SCSI INQUIRY command. This gives information about the device's
  42  *  features and capabilities.
  43  */
  44 SCSI_Inquiry_Response_t InquiryData =
  45         {
  46                 .DeviceType          = DEVICE_TYPE_BLOCK,
  47                 .PeripheralQualifier = 0,
  48
  49                 .Removable           = true,
  50
  51                 .Version             = 0,
  52
  53                 .ResponseDataFormat  = 2,
  54                 .NormACA             = false,
  55                 .TrmTsk              = false,
  56                 .AERC                = false,
  57
  58                 .AdditionalLength    = 0x1F,
  59
  60                 .SoftReset           = false,
  61                 .CmdQue              = false,
  62                 .Linked              = false,
  63                 .Sync                = false,
  64                 .WideBus16Bit        = false,
  65                 .WideBus32Bit        = false,
  66                 .RelAddr             = false,
  67
  68                 .VendorID            = "LUFA",
  69                 .ProductID           = "Dataflash Disk",
  70                 .RevisionID          = {'0','.','0','0'},
  71         };
  72
  73 /** Structure to hold the sense data for the last issued SCSI command, which is returned to the host after a SCSI REQUEST SENSE
  74  *  command is issued. This gives information on exactly why the last command failed to complete.
  75  */
  76 SCSI_Request_Sense_Response_t SenseData =
  77         {
  78                 .ResponseCode        = 0x70,
  79                 .AdditionalLength    = 0x0A,
  80         };
  81
  82
  83 /** Main routine to process the SCSI command located in the Command Block Wrapper read from the host. This dispatches
  84  *  to the appropriate SCSI command handling routine if the issued command is supported by the device, else it returns
  85  *  a command failure due to a ILLEGAL REQUEST.
  86  *
  87  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
  88  */
  89 bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
  90 {
  91         bool CommandSuccess = false;
  92
  93         /* Run the appropriate SCSI command hander function based on the passed command */
  94         switch (MSInterfaceInfo->State.CommandBlock.SCSICommandData[0])
  95         {
  96                 case SCSI_CMD_INQUIRY:
  97                         CommandSuccess = SCSI_Command_Inquiry(MSInterfaceInfo);
  98                         break;
  99                 case SCSI_CMD_REQUEST_SENSE:
 100                         CommandSuccess = SCSI_Command_Request_Sense(MSInterfaceInfo);
 101                         break;
 102                 case SCSI_CMD_READ_CAPACITY_10:
 103                         CommandSuccess = SCSI_Command_Read_Capacity_10(MSInterfaceInfo);
 104                         break;
 105                 case SCSI_CMD_SEND_DIAGNOSTIC:
 106                         CommandSuccess = SCSI_Command_Send_Diagnostic(MSInterfaceInfo);
 107                         break;
 108                 case SCSI_CMD_WRITE_10:
 109                         CommandSuccess = SCSI_Command_ReadWrite_10(MSInterfaceInfo, DATA_WRITE);
 110                         break;
 111                 case SCSI_CMD_READ_10:
 112                         CommandSuccess = SCSI_Command_ReadWrite_10(MSInterfaceInfo, DATA_READ);
 113                         break;
 114                 case SCSI_CMD_TEST_UNIT_READY:
 115                 case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:
 116                 case SCSI_CMD_VERIFY_10:
 117                         /* These commands should just succeed, no handling required */
 118                         CommandSuccess = true;
 119                         MSInterfaceInfo->State.CommandBlock.DataTransferLength = 0;
 120                         break;
 121                 default:
 122                         /* Update the SENSE key to reflect the invalid command */
 123                         SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 124                                    SCSI_ASENSE_INVALID_COMMAND,
 125                                    SCSI_ASENSEQ_NO_QUALIFIER);
 126                         break;
 127         }
 128
 129         /* Check if command was successfully processed */
 130         if (CommandSuccess)
 131         {
 132                 SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,
 133                                SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
 134                                SCSI_ASENSEQ_NO_QUALIFIER);
 135
 136                 return true;
 137         }
 138
 139         return false;
 140 }
 141
 142 /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features
 143  *  and capabilities to the host.
 144  *
 145  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 146  *
 147  *  \return Boolean true if the command completed successfully, false otherwise.
 148  */
 149 static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
 150 {
 151         uint16_t AllocationLength  = SwapEndian_16(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[3]);
 152         uint16_t BytesTransferred  = (AllocationLength < sizeof(InquiryData))? AllocationLength :
 153                                                                                sizeof(InquiryData);
 154
 155         /* Only the standard INQUIRY data is supported, check if any optional INQUIRY bits set */
 156         if ((MSInterfaceInfo->State.CommandBlock.SCSICommandData[1] & ((1 << 0) | (1 << 1))) ||
 157              MSInterfaceInfo->State.CommandBlock.SCSICommandData[2])
 158         {
 159                 /* Optional but unsupported bits set - update the SENSE key and fail the request */
 160                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 161                                SCSI_ASENSE_INVALID_FIELD_IN_CDB,
 162                                SCSI_ASENSEQ_NO_QUALIFIER);
 163
 164                 return false;
 165         }
 166
 167         Endpoint_Write_Stream_LE(&InquiryData, BytesTransferred, NO_STREAM_CALLBACK);
 168
 169         uint8_t PadBytes[AllocationLength - BytesTransferred];
 170
 171         /* Pad out remaining bytes with 0x00 */
 172         Endpoint_Write_Stream_LE(&PadBytes, sizeof(PadBytes), NO_STREAM_CALLBACK);
 173
 174         /* Finalize the stream transfer to send the last packet */
 175         Endpoint_ClearIN();
 176
 177         /* Succeed the command and update the bytes transferred counter */
 178         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= BytesTransferred;
 179
 180         return true;
 181 }
 182
 183 /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command,
 184  *  including the error code and additional error information so that the host can determine why a command failed to complete.
 185  *
 186  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 187  *
 188  *  \return Boolean true if the command completed successfully, false otherwise.
 189  */
 190 static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
 191 {
 192         uint8_t  AllocationLength = MSInterfaceInfo->State.CommandBlock.SCSICommandData[4];
 193         uint8_t  BytesTransferred = (AllocationLength < sizeof(SenseData))? AllocationLength : sizeof(SenseData);
 194
 195         uint8_t PadBytes[AllocationLength - BytesTransferred];
 196
 197         Endpoint_Write_Stream_LE(&SenseData, BytesTransferred, NO_STREAM_CALLBACK);
 198         Endpoint_Write_Stream_LE(&PadBytes, sizeof(PadBytes), NO_STREAM_CALLBACK);
 199         Endpoint_ClearIN();
 200
 201         /* Succeed the command and update the bytes transferred counter */
 202         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= BytesTransferred;
 203
 204         return true;
 205 }
 206
 207 /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity
 208  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.
 209  *
 210  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 211  *
 212  *  \return Boolean true if the command completed successfully, false otherwise.
 213  */
 214 static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
 215 {
 216         uint32_t LastBlockAddressInLUN = (LUN_MEDIA_BLOCKS - 1);
 217         uint32_t MediaBlockSize        = VIRTUAL_MEMORY_BLOCK_SIZE;
 218
 219         Endpoint_Write_Stream_BE(&LastBlockAddressInLUN, sizeof(LastBlockAddressInLUN), NO_STREAM_CALLBACK);
 220         Endpoint_Write_Stream_BE(&MediaBlockSize, sizeof(MediaBlockSize), NO_STREAM_CALLBACK);
 221         Endpoint_ClearIN();
 222
 223         /* Succeed the command and update the bytes transferred counter */
 224         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= 8;
 225
 226         return true;
 227 }
 228
 229 /** Command processing for an issued SCSI SEND DIAGNOSTIC command. This command performs a quick check of the Dataflash ICs on the
 230  *  board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is
 231  *  supported.
 232  *
 233  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 234  *
 235  *  \return Boolean true if the command completed successfully, false otherwise.
 236  */
 237 static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
 238 {
 239         uint8_t ReturnByte;
 240
 241         /* Check to see if the SELF TEST bit is not set */
 242         if (!(MSInterfaceInfo->State.CommandBlock.SCSICommandData[1] & (1 << 2)))
 243         {
 244                 /* Only self-test supported - update SENSE key and fail the command */
 245                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 246                                SCSI_ASENSE_INVALID_FIELD_IN_CDB,
 247                                SCSI_ASENSEQ_NO_QUALIFIER);
 248
 249                 return false;
 250         }
 251
 252         /* Test first Dataflash IC is present and responding to commands */
 253         Dataflash_SelectChip(DATAFLASH_CHIP1);
 254         Dataflash_SendByte(DF_CMD_READMANUFACTURERDEVICEINFO);
 255         ReturnByte = Dataflash_ReceiveByte();
 256         Dataflash_DeselectChip();
 257
 258         /* If returned data is invalid, fail the command */
 259         if (ReturnByte != DF_MANUFACTURER_ATMEL)
 260         {
 261                 /* Update SENSE key with a hardware error condition and return command fail */
 262                 SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,
 263                                SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
 264                                SCSI_ASENSEQ_NO_QUALIFIER);
 265
 266                 return false;
 267         }
 268
 269         #if (DATAFLASH_TOTALCHIPS == 2)
 270         /* Test second Dataflash IC is present and responding to commands */
 271         Dataflash_SelectChip(DATAFLASH_CHIP2);
 272         Dataflash_SendByte(DF_CMD_READMANUFACTURERDEVICEINFO);
 273         ReturnByte = Dataflash_ReceiveByte();
 274         Dataflash_DeselectChip();
 275
 276         /* If returned data is invalid, fail the command */
 277         if (ReturnByte != DF_MANUFACTURER_ATMEL)
 278         {
 279                 /* Update SENSE key with a hardware error condition and return command fail */
 280                 SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,
 281                                SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
 282                                SCSI_ASENSEQ_NO_QUALIFIER);
 283
 284                 return false;
 285         }
 286         #endif
 287
 288         /* Succeed the command and update the bytes transferred counter */
 289         MSInterfaceInfo->State.CommandBlock.DataTransferLength = 0;
 290
 291         return true;
 292 }
 293
 294 /** Command processing for an issued SCSI READ (10) or WRITE (10) command. This command reads in the block start address
 295  *  and total number of blocks to process, then calls the appropriate low-level dataflash routine to handle the actual
 296  *  reading and writing of the data.
 297  *
 298  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 299  *  \param[in] IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)
 300  *
 301  *  \return Boolean true if the command completed successfully, false otherwise.
 302  */
 303 static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo, const bool IsDataRead)
 304 {
 305         uint32_t BlockAddress;
 306         uint16_t TotalBlocks;
 307
 308         /* Load in the 32-bit block address (SCSI uses big-endian, so have to reverse the byte order) */
 309         BlockAddress = SwapEndian_32(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[2]);
 310
 311         /* Load in the 16-bit total blocks (SCSI uses big-endian, so have to reverse the byte order) */
 312         TotalBlocks  = SwapEndian_16(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[7]);
 313
 314         /* Check if the block address is outside the maximum allowable value for the LUN */
 315         if (BlockAddress >= LUN_MEDIA_BLOCKS)
 316         {
 317                 /* Block address is invalid, update SENSE key and return command fail */
 318                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 319                                SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE,
 320                                SCSI_ASENSEQ_NO_QUALIFIER);
 321
 322                 return false;
 323         }
 324
 325         #if (TOTAL_LUNS > 1)
 326         /* Adjust the given block address to the real media address based on the selected LUN */
 327         BlockAddress += ((uint32_t)MSInterfaceInfo->State.CommandBlock.LUN * LUN_MEDIA_BLOCKS);
 328         #endif
 329
 330         /* Determine if the packet is a READ (10) or WRITE (10) command, call appropriate function */
 331         if (IsDataRead == DATA_READ)
 332           DataflashManager_ReadBlocks(MSInterfaceInfo, BlockAddress, TotalBlocks);
 333         else
 334           DataflashManager_WriteBlocks(MSInterfaceInfo, BlockAddress, TotalBlocks);
 335
 336         /* Update the bytes transferred counter and succeed the command */
 337         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);
 338
 339         return true;
 340 }