Projects/Incomplete/StandaloneProgrammer/Lib/SCSI.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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_MODE_SENSE_6:
 118                         CommandSuccess = SCSI_Command_ModeSense_6(MSInterfaceInfo);
 119                         break;
 120                 case SCSI_CMD_TEST_UNIT_READY:
 121                 case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:
 122                 case SCSI_CMD_VERIFY_10:
 123                         /* These commands should just succeed, no handling required */
 124                         CommandSuccess = true;
 125                         MSInterfaceInfo->State.CommandBlock.DataTransferLength = 0;
 126                         break;
 127                 default:
 128                         /* Update the SENSE key to reflect the invalid command */
 129                         SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 130                                    SCSI_ASENSE_INVALID_COMMAND,
 131                                    SCSI_ASENSEQ_NO_QUALIFIER);
 132                         break;
 133         }
 134
 135         /* Check if command was successfully processed */
 136         if (CommandSuccess)
 137         {
 138                 SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,
 139                                SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
 140                                SCSI_ASENSEQ_NO_QUALIFIER);
 141
 142                 return true;
 143         }
 144
 145         return false;
 146 }
 147
 148 /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features
 149  *  and capabilities to the host.
 150  *
 151  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 152  *
 153  *  \return Boolean true if the command completed successfully, false otherwise.
 154  */
 155 static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 156 {
 157         uint16_t AllocationLength  = SwapEndian_16(*(uint16_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[3]);
 158         uint16_t BytesTransferred  = (AllocationLength < sizeof(InquiryData))? AllocationLength :
 159                                                                                sizeof(InquiryData);
 160
 161         /* Only the standard INQUIRY data is supported, check if any optional INQUIRY bits set */
 162         if ((MSInterfaceInfo->State.CommandBlock.SCSICommandData[1] & ((1 << 0) | (1 << 1))) ||
 163              MSInterfaceInfo->State.CommandBlock.SCSICommandData[2])
 164         {
 165                 /* Optional but unsupported bits set - update the SENSE key and fail the request */
 166                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 167                                SCSI_ASENSE_INVALID_FIELD_IN_CDB,
 168                                SCSI_ASENSEQ_NO_QUALIFIER);
 169
 170                 return false;
 171         }
 172
 173         Endpoint_Write_Stream_LE(&InquiryData, BytesTransferred, NULL);
 174
 175         /* Pad out remaining bytes with 0x00 */
 176         Endpoint_Null_Stream((AllocationLength - BytesTransferred), NULL);
 177
 178         /* Finalize the stream transfer to send the last packet */
 179         Endpoint_ClearIN();
 180
 181         /* Succeed the command and update the bytes transferred counter */
 182         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= BytesTransferred;
 183
 184         return true;
 185 }
 186
 187 /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command,
 188  *  including the error code and additional error information so that the host can determine why a command failed to complete.
 189  *
 190  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 191  *
 192  *  \return Boolean true if the command completed successfully, false otherwise.
 193  */
 194 static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 195 {
 196         uint8_t  AllocationLength = MSInterfaceInfo->State.CommandBlock.SCSICommandData[4];
 197         uint8_t  BytesTransferred = (AllocationLength < sizeof(SenseData))? AllocationLength : sizeof(SenseData);
 198
 199         Endpoint_Write_Stream_LE(&SenseData, BytesTransferred, NULL);
 200         Endpoint_Null_Stream((AllocationLength - BytesTransferred), NULL);
 201         Endpoint_ClearIN();
 202
 203         /* Succeed the command and update the bytes transferred counter */
 204         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= BytesTransferred;
 205
 206         return true;
 207 }
 208
 209 /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity
 210  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.
 211  *
 212  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 213  *
 214  *  \return Boolean true if the command completed successfully, false otherwise.
 215  */
 216 static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 217 {
 218         uint32_t LastBlockAddressInLUN = (VIRTUAL_MEMORY_BLOCKS - 1);
 219         uint32_t MediaBlockSize        = VIRTUAL_MEMORY_BLOCK_SIZE;
 220
 221         Endpoint_Write_Stream_BE(&LastBlockAddressInLUN, sizeof(LastBlockAddressInLUN), NULL);
 222         Endpoint_Write_Stream_BE(&MediaBlockSize, sizeof(MediaBlockSize), NULL);
 223         Endpoint_ClearIN();
 224
 225         /* Succeed the command and update the bytes transferred counter */
 226         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= 8;
 227
 228         return true;
 229 }
 230
 231 /** Command processing for an issued SCSI SEND DIAGNOSTIC command. This command performs a quick check of the Dataflash ICs on the
 232  *  board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is
 233  *  supported.
 234  *
 235  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 236  *
 237  *  \return Boolean true if the command completed successfully, false otherwise.
 238  */
 239 static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 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         /* Check to see if all attached Dataflash ICs are functional */
 253         if (!(DataflashManager_CheckDataflashOperation()))
 254         {
 255                 /* Update SENSE key with a hardware error condition and return command fail */
 256                 SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,
 257                                SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
 258                                SCSI_ASENSEQ_NO_QUALIFIER);
 259
 260                 return false;
 261         }
 262
 263         /* Succeed the command and update the bytes transferred counter */
 264         MSInterfaceInfo->State.CommandBlock.DataTransferLength = 0;
 265
 266         return true;
 267 }
 268
 269 /** Command processing for an issued SCSI READ (10) or WRITE (10) command. This command reads in the block start address
 270  *  and total number of blocks to process, then calls the appropriate low-level Dataflash routine to handle the actual
 271  *  reading and writing of the data.
 272  *
 273  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 274  *  \param[in] IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)
 275  *
 276  *  \return Boolean true if the command completed successfully, false otherwise.
 277  */
 278 static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
 279                                       const bool IsDataRead)
 280 {
 281         uint32_t BlockAddress;
 282         uint16_t TotalBlocks;
 283
 284         /* Check if the disk is write protected or not */
 285         if ((IsDataRead == DATA_WRITE) && DISK_READ_ONLY)
 286         {
 287                 /* Block address is invalid, update SENSE key and return command fail */
 288                 SCSI_SET_SENSE(SCSI_SENSE_KEY_DATA_PROTECT,
 289                                SCSI_ASENSE_WRITE_PROTECTED,
 290                                SCSI_ASENSEQ_NO_QUALIFIER);
 291
 292                 return false;
 293         }
 294
 295         /* Load in the 32-bit block address (SCSI uses big-endian, so have to reverse the byte order) */
 296         BlockAddress = SwapEndian_32(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[2]);
 297
 298         /* Load in the 16-bit total blocks (SCSI uses big-endian, so have to reverse the byte order) */
 299         TotalBlocks  = SwapEndian_16(*(uint16_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[7]);
 300
 301         /* Check if the block address is outside the maximum allowable value for the LUN */
 302         if (BlockAddress >= VIRTUAL_MEMORY_BLOCKS)
 303         {
 304                 /* Block address is invalid, update SENSE key and return command fail */
 305                 SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,
 306                                SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE,
 307                                SCSI_ASENSEQ_NO_QUALIFIER);
 308
 309                 return false;
 310         }
 311
 312         /* Determine if the packet is a READ (10) or WRITE (10) command, call appropriate function */
 313         if (IsDataRead == DATA_READ)
 314           DataflashManager_ReadBlocks(MSInterfaceInfo, BlockAddress, TotalBlocks);
 315         else
 316           DataflashManager_WriteBlocks(MSInterfaceInfo, BlockAddress, TotalBlocks);
 317
 318         /* Update the bytes transferred counter and succeed the command */
 319         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);
 320
 321         return true;
 322 }
 323
 324 /** Command processing for an issued SCSI MODE SENSE (6) command. This command returns various informational pages about
 325  *  the SCSI device, as well as the device's Write Protect status.
 326  *
 327  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
 328  *
 329  *  \return Boolean true if the command completed successfully, false otherwise.
 330  */
 331 static bool SCSI_Command_ModeSense_6(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 332 {
 333         /* Send an empty header response with the Write Protect flag status */
 334         Endpoint_Write_Byte(0x00);
 335         Endpoint_Write_Byte(0x00);
 336         Endpoint_Write_Byte(DISK_READ_ONLY ? 0x80 : 0x00);
 337         Endpoint_Write_Byte(0x00);
 338         Endpoint_ClearIN();
 339
 340         /* Update the bytes transferred counter and succeed the command */
 341         MSInterfaceInfo->State.CommandBlock.DataTransferLength -= 4;
 342
 343         return true;
 344 }
 345 #endif