Demos/Device/LowLevel/MassStorage/Lib/SCSI.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 void SCSI_DecodeSCSICommand(void)
  88 {
  89         bool CommandSuccess = false;
  90
  91         /* Run the appropriate SCSI command hander function based on the passed command */
  92         switch (CommandBlock.SCSICommandData[0])
  93         {
  94                 case SCSI_CMD_INQUIRY:
  95                         CommandSuccess = SCSI_Command_Inquiry();
  96                         break;
  97                 case SCSI_CMD_REQUEST_SENSE:
  98                         CommandSuccess = SCSI_Command_Request_Sense();
  99                         break;
 100                 case SCSI_CMD_READ_CAPACITY_10:
 101                         CommandSuccess = SCSI_Command_Read_Capacity_10();
 102                         break;
 103                 case SCSI_CMD_SEND_DIAGNOSTIC:
 104                         CommandSuccess = SCSI_Command_Send_Diagnostic();
 105                         break;
 106                 case SCSI_CMD_WRITE_10:
 107                         CommandSuccess = SCSI_Command_ReadWrite_10(DATA_WRITE);
 108                         break;
 109                 case SCSI_CMD_READ_10:
 110                         CommandSuccess = SCSI_Command_ReadWrite_10(DATA_READ);
 111                         break;
 112                 case SCSI_CMD_TEST_UNIT_READY:
 113                 case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:
 114                 case SCSI_CMD_VERIFY_10:
 115                         /* These commands should just succeed, no handling required */
 116                         CommandSuccess = true;
 117                         CommandBlock.DataTransferLength = 0;
 118                         break;
 119                 default:
 120                         /* Update the SENSE key to reflect the invalid command */
 121                         SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 122                                    SCSI_ASENSE_INVALID_COMMAND,
 123                                    SCSI_ASENSEQ_NO_QUALIFIER);
 124                         break;
 125         }
 126
 127         /* Check if command was successfully processed */
 128         if (CommandSuccess)
 129         {
 130                 /* Command succeeded - set the CSW status and update the SENSE key */
 131                 CommandStatus.Status = Command_Pass;
 132
 133                 SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,
 134                                SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
 135                                SCSI_ASENSEQ_NO_QUALIFIER);
 136         }
 137         else
 138         {
 139                 /* Command failed - set the CSW status - failed command function updates the SENSE key */
 140                 CommandStatus.Status = Command_Fail;
 141         }
 142 }
 143
 144 /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features
 145  *  and capabilities to the host.
 146  *
 147  *  \return Boolean true if the command completed successfully, false otherwise.
 148  */
 149 static bool SCSI_Command_Inquiry(void)
 150 {
 151         uint16_t AllocationLength  = (((uint16_t)CommandBlock.SCSICommandData[3] << 8) |
 152                                                  CommandBlock.SCSICommandData[4]);
 153         uint16_t BytesTransferred  = (AllocationLength < sizeof(InquiryData))? AllocationLength :
 154                                                                                sizeof(InquiryData);
 155
 156         /* Only the standard INQUIRY data is supported, check if any optional INQUIRY bits set */
 157         if ((CommandBlock.SCSICommandData[1] & ((1 << 0) | (1 << 1))) ||
 158              CommandBlock.SCSICommandData[2])
 159         {
 160                 /* Optional but unsupported bits set - update the SENSE key and fail the request */
 161                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 162                                SCSI_ASENSE_INVALID_FIELD_IN_CDB,
 163                                SCSI_ASENSEQ_NO_QUALIFIER);
 164
 165                 return false;
 166         }
 167
 168         /* Write the INQUIRY data to the endpoint */
 169         Endpoint_Write_Stream_LE(&InquiryData, BytesTransferred, StreamCallback_AbortOnMassStoreReset);
 170
 171         uint8_t PadBytes[AllocationLength - BytesTransferred];
 172
 173         /* Pad out remaining bytes with 0x00 */
 174         Endpoint_Write_Stream_LE(&PadBytes, (AllocationLength - BytesTransferred), StreamCallback_AbortOnMassStoreReset);
 175
 176         /* Finalize the stream transfer to send the last packet */
 177         Endpoint_ClearIN();
 178
 179         /* Succeed the command and update the bytes transferred counter */
 180         CommandBlock.DataTransferLength -= BytesTransferred;
 181
 182         return true;
 183 }
 184
 185 /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command,
 186  *  including the error code and additional error information so that the host can determine why a command failed to complete.
 187  *
 188  *  \return Boolean true if the command completed successfully, false otherwise.
 189  */
 190 static bool SCSI_Command_Request_Sense(void)
 191 {
 192         uint8_t  AllocationLength = CommandBlock.SCSICommandData[4];
 193         uint8_t  BytesTransferred = (AllocationLength < sizeof(SenseData))? AllocationLength : sizeof(SenseData);
 194
 195         /* Send the SENSE data - this indicates to the host the status of the last command */
 196         Endpoint_Write_Stream_LE(&SenseData, BytesTransferred, StreamCallback_AbortOnMassStoreReset);
 197
 198         uint8_t PadBytes[AllocationLength - BytesTransferred];
 199
 200         /* Pad out remaining bytes with 0x00 */
 201         Endpoint_Write_Stream_LE(&PadBytes, (AllocationLength - BytesTransferred), StreamCallback_AbortOnMassStoreReset);
 202
 203         /* Finalize the stream transfer to send the last packet */
 204         Endpoint_ClearIN();
 205
 206         /* Succeed the command and update the bytes transferred counter */
 207         CommandBlock.DataTransferLength -= BytesTransferred;
 208
 209         return true;
 210 }
 211
 212 /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity
 213  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.
 214  *
 215  *  \return Boolean true if the command completed successfully, false otherwise.
 216  */
 217 static bool SCSI_Command_Read_Capacity_10(void)
 218 {
 219         /* Send the total number of logical blocks in the current LUN */
 220         Endpoint_Write_DWord_BE(LUN_MEDIA_BLOCKS - 1);
 221
 222         /* Send the logical block size of the device (must be 512 bytes) */
 223         Endpoint_Write_DWord_BE(VIRTUAL_MEMORY_BLOCK_SIZE);
 224
 225         /* Check if the current command is being aborted by the host */
 226         if (IsMassStoreReset)
 227           return false;
 228
 229         /* Send the endpoint data packet to the host */
 230         Endpoint_ClearIN();
 231
 232         /* Succeed the command and update the bytes transferred counter */
 233         CommandBlock.DataTransferLength -= 8;
 234
 235         return true;
 236 }
 237
 238 /** Command processing for an issued SCSI SEND DIAGNOSTIC command. This command performs a quick check of the Dataflash ICs on the
 239  *  board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is
 240  *  supported.
 241  *
 242  *  \return Boolean true if the command completed successfully, false otherwise.
 243  */
 244 static bool SCSI_Command_Send_Diagnostic(void)
 245 {
 246         uint8_t ReturnByte;
 247
 248         /* Check to see if the SELF TEST bit is not set */
 249         if (!(CommandBlock.SCSICommandData[1] & (1 << 2)))
 250         {
 251                 /* Only self-test supported - update SENSE key and fail the command */
 252                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 253                                SCSI_ASENSE_INVALID_FIELD_IN_CDB,
 254                                SCSI_ASENSEQ_NO_QUALIFIER);
 255
 256                 return false;
 257         }
 258
 259         /* Test first Dataflash IC is present and responding to commands */
 260         Dataflash_SelectChip(DATAFLASH_CHIP1);
 261         Dataflash_SendByte(DF_CMD_READMANUFACTURERDEVICEINFO);
 262         ReturnByte = Dataflash_ReceiveByte();
 263         Dataflash_DeselectChip();
 264
 265         /* If returned data is invalid, fail the command */
 266         if (ReturnByte != DF_MANUFACTURER_ATMEL)
 267         {
 268                 /* Update SENSE key with a hardware error condition and return command fail */
 269                 SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,
 270                                SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
 271                                SCSI_ASENSEQ_NO_QUALIFIER);
 272
 273                 return false;
 274         }
 275
 276         #if (DATAFLASH_TOTALCHIPS == 2)
 277         /* Test second Dataflash IC is present and responding to commands */
 278         Dataflash_SelectChip(DATAFLASH_CHIP2);
 279         Dataflash_SendByte(DF_CMD_READMANUFACTURERDEVICEINFO);
 280         ReturnByte = Dataflash_ReceiveByte();
 281         Dataflash_DeselectChip();
 282
 283         /* If returned data is invalid, fail the command */
 284         if (ReturnByte != DF_MANUFACTURER_ATMEL)
 285         {
 286                 /* Update SENSE key with a hardware error condition and return command fail */
 287                 SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,
 288                                SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
 289                                SCSI_ASENSEQ_NO_QUALIFIER);
 290
 291                 return false;
 292         }
 293         #endif
 294
 295         /* Succeed the command and update the bytes transferred counter */
 296         CommandBlock.DataTransferLength = 0;
 297
 298         return true;
 299 }
 300
 301 /** Command processing for an issued SCSI READ (10) or WRITE (10) command. This command reads in the block start address
 302  *  and total number of blocks to process, then calls the appropriate low-level dataflash routine to handle the actual
 303  *  reading and writing of the data.
 304  *
 305  *  \param[in] IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)
 306  *
 307  *  \return Boolean true if the command completed successfully, false otherwise.
 308  */
 309 static bool SCSI_Command_ReadWrite_10(const bool IsDataRead)
 310 {
 311         uint32_t BlockAddress;
 312         uint16_t TotalBlocks;
 313
 314         /* Load in the 32-bit block address (SCSI uses big-endian, so have to do it byte-by-byte) */
 315         ((uint8_t*)&BlockAddress)[3] = CommandBlock.SCSICommandData[2];
 316         ((uint8_t*)&BlockAddress)[2] = CommandBlock.SCSICommandData[3];
 317         ((uint8_t*)&BlockAddress)[1] = CommandBlock.SCSICommandData[4];
 318         ((uint8_t*)&BlockAddress)[0] = CommandBlock.SCSICommandData[5];
 319
 320         /* Load in the 16-bit total blocks (SCSI uses big-endian, so have to do it byte-by-byte) */
 321         ((uint8_t*)&TotalBlocks)[1]  = CommandBlock.SCSICommandData[7];
 322         ((uint8_t*)&TotalBlocks)[0]  = CommandBlock.SCSICommandData[8];
 323
 324         /* Check if the block address is outside the maximum allowable value for the LUN */
 325         if (BlockAddress >= LUN_MEDIA_BLOCKS)
 326         {
 327                 /* Block address is invalid, update SENSE key and return command fail */
 328                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 329                                SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE,
 330                                SCSI_ASENSEQ_NO_QUALIFIER);
 331
 332                 return false;
 333         }
 334
 335         #if (TOTAL_LUNS > 1)
 336         /* Adjust the given block address to the real media address based on the selected LUN */
 337         BlockAddress += ((uint32_t)CommandBlock.LUN * LUN_MEDIA_BLOCKS);
 338         #endif
 339
 340         /* Determine if the packet is a READ (10) or WRITE (10) command, call appropriate function */
 341         if (IsDataRead == DATA_READ)
 342           DataflashManager_ReadBlocks(BlockAddress, TotalBlocks);
 343         else
 344           DataflashManager_WriteBlocks(BlockAddress, TotalBlocks);
 345
 346         /* Update the bytes transferred counter and succeed the command */
 347         CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);
 348
 349         return true;
 350 }