Fix incorrect URLs for the Stange-ISP board.

[pub/USBasp.git] / Demos / Device / ClassDriver / MassStorageKeyboard / Lib / SCSI.c

diff --git a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c
index 0dac650..078f6fe 100644 (file)
--- a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c
+++ b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c
@@ -1,24 +1,24 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2013.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


@@ -34,29 +34,29 @@
  *  devices use a thin "Bulk-Only Transport" protocol for issuing commands and status information,
  *  which wrap around standard SCSI device commands for controlling the actual storage medium.
  */
  *  devices use a thin "Bulk-Only Transport" protocol for issuing commands and status information,
  *  which wrap around standard SCSI device commands for controlling the actual storage medium.
  */

- 
+

 #define  INCLUDE_FROM_SCSI_C
 #include "SCSI.h"
 
 /** Structure to hold the SCSI response data to a SCSI INQUIRY command. This gives information about the device's
  *  features and capabilities.
  */
 #define  INCLUDE_FROM_SCSI_C
 #include "SCSI.h"
 
 /** Structure to hold the SCSI response data to a SCSI INQUIRY command. This gives information about the device's
  *  features and capabilities.
  */

-SCSI_Inquiry_Response_t InquiryData = 
+static const SCSI_Inquiry_Response_t InquiryData =

        {
                .DeviceType          = DEVICE_TYPE_BLOCK,
                .PeripheralQualifier = 0,
        {
                .DeviceType          = DEVICE_TYPE_BLOCK,
                .PeripheralQualifier = 0,

-                       
+

                .Removable           = true,
                .Removable           = true,

-                       
+

                .Version             = 0,
                .Version             = 0,

-                       
+

                .ResponseDataFormat  = 2,
                .NormACA             = false,
                .TrmTsk              = false,
                .AERC                = false,
 
                .AdditionalLength    = 0x1F,
                .ResponseDataFormat  = 2,
                .NormACA             = false,
                .TrmTsk              = false,
                .AERC                = false,
 
                .AdditionalLength    = 0x1F,

-                       
+

                .SoftReset           = false,
                .CmdQue              = false,
                .Linked              = false,
                .SoftReset           = false,
                .CmdQue              = false,
                .Linked              = false,


@@ -64,7 +64,7 @@ SCSI_Inquiry_Response_t InquiryData =
                .WideBus16Bit        = false,
                .WideBus32Bit        = false,
                .RelAddr             = false,
                .WideBus16Bit        = false,
                .WideBus32Bit        = false,
                .RelAddr             = false,

-               
+

                .VendorID            = "LUFA",
                .ProductID           = "Dataflash Disk",
                .RevisionID          = {'0','.','0','0'},
                .VendorID            = "LUFA",
                .ProductID           = "Dataflash Disk",
                .RevisionID          = {'0','.','0','0'},


@@ -73,7 +73,7 @@ SCSI_Inquiry_Response_t InquiryData =
 /** Structure to hold the sense data for the last issued SCSI command, which is returned to the host after a SCSI REQUEST SENSE
  *  command is issued. This gives information on exactly why the last command failed to complete.
  */
 /** Structure to hold the sense data for the last issued SCSI command, which is returned to the host after a SCSI REQUEST SENSE
  *  command is issued. This gives information on exactly why the last command failed to complete.
  */

-SCSI_Request_Sense_Response_t SenseData =
+static SCSI_Request_Sense_Response_t SenseData =

        {
                .ResponseCode        = 0x70,
                .AdditionalLength    = 0x0A,
        {
                .ResponseCode        = 0x70,
                .AdditionalLength    = 0x0A,


@@ -85,6 +85,8 @@ SCSI_Request_Sense_Response_t SenseData =
  *  a command failure due to a ILLEGAL REQUEST.
  *
  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
  *  a command failure due to a ILLEGAL REQUEST.
  *
  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with

+ *
+ *  \return Boolean true if the command completed successfully, false otherwise

  */
 bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 {
  */
 bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 {


@@ -94,13 +96,13 @@ bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
        switch (MSInterfaceInfo->State.CommandBlock.SCSICommandData[0])
        {
                case SCSI_CMD_INQUIRY:
        switch (MSInterfaceInfo->State.CommandBlock.SCSICommandData[0])
        {
                case SCSI_CMD_INQUIRY:

-                       CommandSuccess = SCSI_Command_Inquiry(MSInterfaceInfo);                 
+                       CommandSuccess = SCSI_Command_Inquiry(MSInterfaceInfo);

                        break;
                case SCSI_CMD_REQUEST_SENSE:
                        CommandSuccess = SCSI_Command_Request_Sense(MSInterfaceInfo);
                        break;
                case SCSI_CMD_READ_CAPACITY_10:
                        break;
                case SCSI_CMD_REQUEST_SENSE:
                        CommandSuccess = SCSI_Command_Request_Sense(MSInterfaceInfo);
                        break;
                case SCSI_CMD_READ_CAPACITY_10:

-                       CommandSuccess = SCSI_Command_Read_Capacity_10(MSInterfaceInfo);                        
+                       CommandSuccess = SCSI_Command_Read_Capacity_10(MSInterfaceInfo);

                        break;
                case SCSI_CMD_SEND_DIAGNOSTIC:
                        CommandSuccess = SCSI_Command_Send_Diagnostic(MSInterfaceInfo);
                        break;
                case SCSI_CMD_SEND_DIAGNOSTIC:
                        CommandSuccess = SCSI_Command_Send_Diagnostic(MSInterfaceInfo);


@@ -111,6 +113,9 @@ bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
                case SCSI_CMD_READ_10:
                        CommandSuccess = SCSI_Command_ReadWrite_10(MSInterfaceInfo, DATA_READ);
                        break;
                case SCSI_CMD_READ_10:
                        CommandSuccess = SCSI_Command_ReadWrite_10(MSInterfaceInfo, DATA_READ);
                        break;

+               case SCSI_CMD_MODE_SENSE_6:
+                       CommandSuccess = SCSI_Command_ModeSense_6(MSInterfaceInfo);
+                       break;

                case SCSI_CMD_TEST_UNIT_READY:
                case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:
                case SCSI_CMD_VERIFY_10:
                case SCSI_CMD_TEST_UNIT_READY:
                case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:
                case SCSI_CMD_VERIFY_10:


@@ -132,7 +137,7 @@ bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
                SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,
                               SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
                               SCSI_ASENSEQ_NO_QUALIFIER);
                SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,
                               SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
                               SCSI_ASENSEQ_NO_QUALIFIER);

-               
+

                return true;
        }
 
                return true;
        }
 


@@ -149,8 +154,7 @@ bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 {
        uint16_t AllocationLength  = SwapEndian_16(*(uint16_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[3]);
 static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 {
        uint16_t AllocationLength  = SwapEndian_16(*(uint16_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[3]);

-       uint16_t BytesTransferred  = (AllocationLength < sizeof(InquiryData))? AllocationLength :
-                                                                              sizeof(InquiryData);
+       uint16_t BytesTransferred  = MIN(AllocationLength, sizeof(InquiryData));

 
        /* Only the standard INQUIRY data is supported, check if any optional INQUIRY bits set */
        if ((MSInterfaceInfo->State.CommandBlock.SCSICommandData[1] & ((1 << 0) | (1 << 1))) ||
 
        /* Only the standard INQUIRY data is supported, check if any optional INQUIRY bits set */
        if ((MSInterfaceInfo->State.CommandBlock.SCSICommandData[1] & ((1 << 0) | (1 << 1))) ||


@@ -163,20 +167,18 @@ static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
 
                return false;
        }
 
                return false;
        }

-       
-       Endpoint_Write_Stream_LE(&InquiryData, BytesTransferred, NO_STREAM_CALLBACK);

 
 

-       uint8_t PadBytes[AllocationLength - BytesTransferred];
-       
+       Endpoint_Write_Stream_LE(&InquiryData, BytesTransferred, NULL);
+

        /* Pad out remaining bytes with 0x00 */
        /* Pad out remaining bytes with 0x00 */

-       Endpoint_Write_Stream_LE(&PadBytes, sizeof(PadBytes), NO_STREAM_CALLBACK);
+       Endpoint_Null_Stream((AllocationLength - BytesTransferred), NULL);

 
        /* Finalize the stream transfer to send the last packet */
        Endpoint_ClearIN();
 
        /* Succeed the command and update the bytes transferred counter */
        MSInterfaceInfo->State.CommandBlock.DataTransferLength -= BytesTransferred;
 
        /* Finalize the stream transfer to send the last packet */
        Endpoint_ClearIN();
 
        /* Succeed the command and update the bytes transferred counter */
        MSInterfaceInfo->State.CommandBlock.DataTransferLength -= BytesTransferred;

-       
+

        return true;
 }
 
        return true;
 }
 


@@ -190,12 +192,10 @@ static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
 static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 {
        uint8_t  AllocationLength = MSInterfaceInfo->State.CommandBlock.SCSICommandData[4];
 static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 {
        uint8_t  AllocationLength = MSInterfaceInfo->State.CommandBlock.SCSICommandData[4];

-       uint8_t  BytesTransferred = (AllocationLength < sizeof(SenseData))? AllocationLength : sizeof(SenseData);
-       
-       uint8_t PadBytes[AllocationLength - BytesTransferred];
+       uint8_t  BytesTransferred = MIN(AllocationLength, sizeof(SenseData));

 
 

-       Endpoint_Write_Stream_LE(&SenseData, BytesTransferred, NO_STREAM_CALLBACK);
-       Endpoint_Write_Stream_LE(&PadBytes, sizeof(PadBytes), NO_STREAM_CALLBACK);
+       Endpoint_Write_Stream_LE(&SenseData, BytesTransferred, NULL);
+       Endpoint_Null_Stream((AllocationLength - BytesTransferred), NULL);

        Endpoint_ClearIN();
 
        /* Succeed the command and update the bytes transferred counter */
        Endpoint_ClearIN();
 
        /* Succeed the command and update the bytes transferred counter */


@@ -216,13 +216,13 @@ static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInt
        uint32_t LastBlockAddressInLUN = (LUN_MEDIA_BLOCKS - 1);
        uint32_t MediaBlockSize        = VIRTUAL_MEMORY_BLOCK_SIZE;
 
        uint32_t LastBlockAddressInLUN = (LUN_MEDIA_BLOCKS - 1);
        uint32_t MediaBlockSize        = VIRTUAL_MEMORY_BLOCK_SIZE;
 

-       Endpoint_Write_Stream_BE(&LastBlockAddressInLUN, sizeof(LastBlockAddressInLUN), NO_STREAM_CALLBACK);
-       Endpoint_Write_Stream_BE(&MediaBlockSize, sizeof(MediaBlockSize), NO_STREAM_CALLBACK);
+       Endpoint_Write_Stream_BE(&LastBlockAddressInLUN, sizeof(LastBlockAddressInLUN), NULL);
+       Endpoint_Write_Stream_BE(&MediaBlockSize, sizeof(MediaBlockSize), NULL);

        Endpoint_ClearIN();
        Endpoint_ClearIN();

-       
+

        /* Succeed the command and update the bytes transferred counter */
        MSInterfaceInfo->State.CommandBlock.DataTransferLength -= 8;
        /* Succeed the command and update the bytes transferred counter */
        MSInterfaceInfo->State.CommandBlock.DataTransferLength -= 8;

-       
+

        return true;
 }
 
        return true;
 }
 


@@ -236,8 +236,6 @@ static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInt
  */
 static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 {
  */
 static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 {

-       uint8_t ReturnByte;
-

        /* Check to see if the SELF TEST bit is not set */
        if (!(MSInterfaceInfo->State.CommandBlock.SCSICommandData[1] & (1 << 2)))
        {
        /* Check to see if the SELF TEST bit is not set */
        if (!(MSInterfaceInfo->State.CommandBlock.SCSICommandData[1] & (1 << 2)))
        {


@@ -248,46 +246,21 @@ static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInte
 
                return false;
        }
 
                return false;
        }

-       
-       /* Test first Dataflash IC is present and responding to commands */
-       Dataflash_SelectChip(DATAFLASH_CHIP1);
-       Dataflash_SendByte(DF_CMD_READMANUFACTURERDEVICEINFO);
-       ReturnByte = Dataflash_ReceiveByte();
-       Dataflash_DeselectChip();
-
-       /* If returned data is invalid, fail the command */
-       if (ReturnByte != DF_MANUFACTURER_ATMEL)
-       {
-               /* Update SENSE key with a hardware error condition and return command fail */
-               SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,
-                              SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
-                              SCSI_ASENSEQ_NO_QUALIFIER);      
-       
-               return false;
-       }
-
-       #if (DATAFLASH_TOTALCHIPS == 2)
-       /* Test second Dataflash IC is present and responding to commands */
-       Dataflash_SelectChip(DATAFLASH_CHIP2);
-       Dataflash_SendByte(DF_CMD_READMANUFACTURERDEVICEINFO);
-       ReturnByte = Dataflash_ReceiveByte();
-       Dataflash_DeselectChip();

 
 

-       /* If returned data is invalid, fail the command */
-       if (ReturnByte != DF_MANUFACTURER_ATMEL)
+       /* Check to see if all attached Dataflash ICs are functional */
+       if (!(DataflashManager_CheckDataflashOperation()))

        {
                /* Update SENSE key with a hardware error condition and return command fail */
                SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,
                               SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
        {
                /* Update SENSE key with a hardware error condition and return command fail */
                SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,
                               SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,

-                              SCSI_ASENSEQ_NO_QUALIFIER);      
-       
+                              SCSI_ASENSEQ_NO_QUALIFIER);
+

                return false;
        }
                return false;
        }

-       #endif
-       
+

        /* Succeed the command and update the bytes transferred counter */
        MSInterfaceInfo->State.CommandBlock.DataTransferLength = 0;
        /* Succeed the command and update the bytes transferred counter */
        MSInterfaceInfo->State.CommandBlock.DataTransferLength = 0;

-       
+

        return true;
 }
 
        return true;
 }
 


@@ -305,13 +278,24 @@ static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfa
 {
        uint32_t BlockAddress;
        uint16_t TotalBlocks;
 {
        uint32_t BlockAddress;
        uint16_t TotalBlocks;

-       
+
+       /* Check if the disk is write protected or not */
+       if ((IsDataRead == DATA_WRITE) && DISK_READ_ONLY)
+       {
+               /* Block address is invalid, update SENSE key and return command fail */
+               SCSI_SET_SENSE(SCSI_SENSE_KEY_DATA_PROTECT,
+                              SCSI_ASENSE_WRITE_PROTECTED,
+                              SCSI_ASENSEQ_NO_QUALIFIER);
+
+               return false;
+       }
+

        /* Load in the 32-bit block address (SCSI uses big-endian, so have to reverse the byte order) */
        BlockAddress = SwapEndian_32(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[2]);
 
        /* Load in the 16-bit total blocks (SCSI uses big-endian, so have to reverse the byte order) */
        TotalBlocks  = SwapEndian_16(*(uint16_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[7]);
        /* Load in the 32-bit block address (SCSI uses big-endian, so have to reverse the byte order) */
        BlockAddress = SwapEndian_32(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[2]);
 
        /* Load in the 16-bit total blocks (SCSI uses big-endian, so have to reverse the byte order) */
        TotalBlocks  = SwapEndian_16(*(uint16_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[7]);

-       
+

        /* Check if the block address is outside the maximum allowable value for the LUN */
        if (BlockAddress >= LUN_MEDIA_BLOCKS)
        {
        /* Check if the block address is outside the maximum allowable value for the LUN */
        if (BlockAddress >= LUN_MEDIA_BLOCKS)
        {


@@ -327,7 +311,7 @@ static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfa
        /* Adjust the given block address to the real media address based on the selected LUN */
        BlockAddress += ((uint32_t)MSInterfaceInfo->State.CommandBlock.LUN * LUN_MEDIA_BLOCKS);
        #endif
        /* Adjust the given block address to the real media address based on the selected LUN */
        BlockAddress += ((uint32_t)MSInterfaceInfo->State.CommandBlock.LUN * LUN_MEDIA_BLOCKS);
        #endif

-       
+

        /* Determine if the packet is a READ (10) or WRITE (10) command, call appropriate function */
        if (IsDataRead == DATA_READ)
          DataflashManager_ReadBlocks(MSInterfaceInfo, BlockAddress, TotalBlocks);
        /* Determine if the packet is a READ (10) or WRITE (10) command, call appropriate function */
        if (IsDataRead == DATA_READ)
          DataflashManager_ReadBlocks(MSInterfaceInfo, BlockAddress, TotalBlocks);


@@ -336,6 +320,29 @@ static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfa
 
        /* Update the bytes transferred counter and succeed the command */
        MSInterfaceInfo->State.CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);
 
        /* Update the bytes transferred counter and succeed the command */
        MSInterfaceInfo->State.CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);

-       
+
+       return true;
+}
+
+/** Command processing for an issued SCSI MODE SENSE (6) command. This command returns various informational pages about
+ *  the SCSI device, as well as the device's Write Protect status.
+ *
+ *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with
+ *
+ *  \return Boolean true if the command completed successfully, false otherwise.
+ */
+static bool SCSI_Command_ModeSense_6(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
+{
+       /* Send an empty header response with the Write Protect flag status */
+       Endpoint_Write_8(0x00);
+       Endpoint_Write_8(0x00);
+       Endpoint_Write_8(DISK_READ_ONLY ? 0x80 : 0x00);
+       Endpoint_Write_8(0x00);
+       Endpoint_ClearIN();
+
+       /* Update the bytes transferred counter and succeed the command */
+       MSInterfaceInfo->State.CommandBlock.DataTransferLength -= 4;
+

        return true;
 }
        return true;
 }

+