Demos/Device/ClassDriver/MassStorage/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         /* Set initial sense data, before the requested command is processed */
  92         SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,
  93                        SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
  94                        SCSI_ASENSEQ_NO_QUALIFIER);
  95
  96         /* Run the appropriate SCSI command hander function based on the passed command */
  97         switch (MSInterfaceInfo->State.CommandBlock.SCSICommandData[0])
  98         {
  99                 case SCSI_CMD_INQUIRY:
 100                         SCSI_Command_Inquiry(MSInterfaceInfo);
 101                         break;
 102                 case SCSI_CMD_REQUEST_SENSE:
 103                         SCSI_Command_Request_Sense(MSInterfaceInfo);
 104                         break;
 105                 case SCSI_CMD_READ_CAPACITY_10:
 106                         SCSI_Command_Read_Capacity_10(MSInterfaceInfo);
 107                         break;
 108                 case SCSI_CMD_SEND_DIAGNOSTIC:
 109                         SCSI_Command_Send_Diagnostic(MSInterfaceInfo);
 110                         break;
 111                 case SCSI_CMD_WRITE_10:
 112                         SCSI_Command_ReadWrite_10(MSInterfaceInfo, DATA_WRITE);
 113                         break;
 114                 case SCSI_CMD_READ_10:
 115                         SCSI_Command_ReadWrite_10(MSInterfaceInfo, DATA_READ);
 116                         break;
 117                 case SCSI_CMD_TEST_UNIT_READY:
 118                 case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:
 119                 case SCSI_CMD_VERIFY_10:
 120                         /* These commands should just succeed, no handling required */
 121                         MSInterfaceInfo->State.CommandBlock.DataTransferLength = 0;
 122                         break;
 123                 default:
 124                         /* Update the SENSE key to reflect the invalid command */
 125                         SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 126                                    SCSI_ASENSE_INVALID_COMMAND,
 127                                    SCSI_ASENSEQ_NO_QUALIFIER);
 128                         break;
 129         }
 130
 131         return (SenseData.SenseKey == SCSI_SENSE_KEY_GOOD);
 132 }
 133
 134 /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features
 135  *  and capabilities to the host.
 136  *
 137  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 138  */
 139 static void SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
 140 {
 141         uint16_t AllocationLength  = SwapEndian_16(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[3]);
 142         uint16_t BytesTransferred  = (AllocationLength < sizeof(InquiryData))? AllocationLength :
 143                                                                                sizeof(InquiryData);
 144
 145         /* Only the standard INQUIRY data is supported, check if any optional INQUIRY bits set */
 146         if ((MSInterfaceInfo->State.CommandBlock.SCSICommandData[1] & ((1 << 0) | (1 << 1))) ||
 147              MSInterfaceInfo->State.CommandBlock.SCSICommandData[2])
 148         {
 149                 /* Optional but unsupported bits set - update the SENSE key and fail the request */
 150                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 151                                SCSI_ASENSE_INVALID_FIELD_IN_CDB,
 152                                SCSI_ASENSEQ_NO_QUALIFIER);
 153
 154                 return;
 155         }
 156
 157         Endpoint_Write_Stream_LE(&InquiryData, BytesTransferred, NO_STREAM_CALLBACK);
 158
 159         uint8_t PadBytes[AllocationLength - BytesTransferred];
 160
 161         /* Pad out remaining bytes with 0x00 */
 162         Endpoint_Write_Stream_LE(&PadBytes, sizeof(PadBytes), NO_STREAM_CALLBACK);
 163
 164         /* Finalize the stream transfer to send the last packet */
 165         Endpoint_ClearIN();
 166
 167         /* Succeed the command and update the bytes transferred counter */
 168         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= BytesTransferred;
 169 }
 170
 171 /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command,
 172  *  including the error code and additional error information so that the host can determine why a command failed to complete.
 173  *
 174  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 175  */
 176 static void SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
 177 {
 178         uint8_t  AllocationLength = MSInterfaceInfo->State.CommandBlock.SCSICommandData[4];
 179         uint8_t  BytesTransferred = (AllocationLength < sizeof(SenseData))? AllocationLength : sizeof(SenseData);
 180
 181         uint8_t PadBytes[AllocationLength - BytesTransferred];
 182
 183         Endpoint_Write_Stream_LE(&SenseData, BytesTransferred, NO_STREAM_CALLBACK);
 184         Endpoint_Write_Stream_LE(&PadBytes, (AllocationLength - BytesTransferred), NO_STREAM_CALLBACK);
 185         Endpoint_ClearIN();
 186
 187         /* Succeed the command and update the bytes transferred counter */
 188         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= BytesTransferred;
 189 }
 190
 191 /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity
 192  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.
 193  *
 194  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 195  */
 196 static void SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
 197 {
 198         uint32_t LastBlockAddressInLUN = (LUN_MEDIA_BLOCKS - 1);
 199         uint32_t MediaBlockSize        = VIRTUAL_MEMORY_BLOCK_SIZE;
 200
 201         Endpoint_Write_Stream_BE(&LastBlockAddressInLUN, sizeof(LastBlockAddressInLUN), NO_STREAM_CALLBACK);
 202         Endpoint_Write_Stream_BE(&MediaBlockSize, sizeof(MediaBlockSize), NO_STREAM_CALLBACK);
 203         Endpoint_ClearIN();
 204
 205         /* Succeed the command and update the bytes transferred counter */
 206         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= 8;
 207 }
 208
 209 /** Command processing for an issued SCSI SEND DIAGNOSTIC command. This command performs a quick check of the Dataflash ICs on the
 210  *  board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is
 211  *  supported.
 212  *
 213  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 214  */
 215 static void SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
 216 {
 217         /* Check to see if the SELF TEST bit is not set */
 218         if (!(MSInterfaceInfo->State.CommandBlock.SCSICommandData[1] & (1 << 2)))
 219         {
 220                 /* Only self-test supported - update SENSE key and fail the command */
 221                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 222                                SCSI_ASENSE_INVALID_FIELD_IN_CDB,
 223                                SCSI_ASENSEQ_NO_QUALIFIER);
 224
 225                 return;
 226         }
 227
 228         /* Check to see if all attached Dataflash ICs are functional */
 229         if (!(DataflashManager_CheckDataflashOperation()))
 230         {
 231                 /* Update SENSE key with a hardware error condition and return command fail */
 232                 SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,
 233                                SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
 234                                SCSI_ASENSEQ_NO_QUALIFIER);
 235
 236                 return;
 237         }
 238
 239         /* Succeed the command and update the bytes transferred counter */
 240         MSInterfaceInfo->State.CommandBlock.DataTransferLength = 0;
 241 }
 242
 243 /** Command processing for an issued SCSI READ (10) or WRITE (10) command. This command reads in the block start address
 244  *  and total number of blocks to process, then calls the appropriate low-level dataflash routine to handle the actual
 245  *  reading and writing of the data.
 246  *
 247  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 248  *  \param[in] IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)
 249  */
 250 static void SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo, const bool IsDataRead)
 251 {
 252         uint32_t BlockAddress;
 253         uint16_t TotalBlocks;
 254
 255         /* Load in the 32-bit block address (SCSI uses big-endian, so have to reverse the byte order) */
 256         BlockAddress = SwapEndian_32(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[2]);
 257
 258         /* Load in the 16-bit total blocks (SCSI uses big-endian, so have to reverse the byte order) */
 259         TotalBlocks  = SwapEndian_16(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[7]);
 260
 261         /* Check if the block address is outside the maximum allowable value for the LUN */
 262         if (BlockAddress >= LUN_MEDIA_BLOCKS)
 263         {
 264                 /* Block address is invalid, update SENSE key and return command fail */
 265                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 266                                SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE,
 267                                SCSI_ASENSEQ_NO_QUALIFIER);
 268
 269                 return;
 270         }
 271
 272         #if (TOTAL_LUNS > 1)
 273         /* Adjust the given block address to the real media address based on the selected LUN */
 274         BlockAddress += ((uint32_t)MSInterfaceInfo->State.CommandBlock.LUN * LUN_MEDIA_BLOCKS);
 275         #endif
 276
 277         /* Determine if the packet is a READ (10) or WRITE (10) command, call appropriate function */
 278         if (IsDataRead == DATA_READ)
 279           DataflashManager_ReadBlocks(MSInterfaceInfo, BlockAddress, TotalBlocks);
 280         else
 281           DataflashManager_WriteBlocks(MSInterfaceInfo, BlockAddress, TotalBlocks);
 282
 283         /* Update the bytes transferred counter and succeed the command */
 284         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);
 285 }