Projects/Incomplete/StandaloneProgrammer/Lib/SCSI.c

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