Update UC3 platform driver support to use the bitmasks defined in the header files...

[pub/USBasp.git] / Demos / Device / LowLevel / MassStorage / Lib / SCSI.c

diff --git a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c
index 7600595..4326786 100644 (file)
--- a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c
+++ b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

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

   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 2011  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.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -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,


@@ -94,13 +94,13 @@ bool SCSI_DecodeSCSICommand(void)
        switch (CommandBlock.SCSICommandData[0])
        {
                case SCSI_CMD_INQUIRY:
        switch (CommandBlock.SCSICommandData[0])
        {
                case SCSI_CMD_INQUIRY:

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

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

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

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


@@ -111,6 +111,9 @@ bool SCSI_DecodeSCSICommand(void)
                case SCSI_CMD_READ_10:
                        CommandSuccess = SCSI_Command_ReadWrite_10(DATA_READ);
                        break;
                case SCSI_CMD_READ_10:
                        CommandSuccess = SCSI_Command_ReadWrite_10(DATA_READ);
                        break;

+               case SCSI_CMD_MODE_SENSE_6:
+                       CommandSuccess = SCSI_Command_ModeSense_6();
+                       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:


@@ -125,14 +128,14 @@ bool SCSI_DecodeSCSICommand(void)
                                   SCSI_ASENSEQ_NO_QUALIFIER);
                        break;
        }
                                   SCSI_ASENSEQ_NO_QUALIFIER);
                        break;
        }

-       
+

        /* Check if command was successfully processed */
        if (CommandSuccess)
        {
                SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,
                               SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
                               SCSI_ASENSEQ_NO_QUALIFIER);
        /* Check if command was successfully processed */
        if (CommandSuccess)
        {
                SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,
                               SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
                               SCSI_ASENSEQ_NO_QUALIFIER);

-               
+

                return true;
        }
 
                return true;
        }
 


@@ -147,8 +150,7 @@ bool SCSI_DecodeSCSICommand(void)
 static bool SCSI_Command_Inquiry(void)
 {
        uint16_t AllocationLength  = SwapEndian_16(*(uint16_t*)&CommandBlock.SCSICommandData[3]);
 static bool SCSI_Command_Inquiry(void)
 {
        uint16_t AllocationLength  = SwapEndian_16(*(uint16_t*)&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 ((CommandBlock.SCSICommandData[1] & ((1 << 0) | (1 << 1))) ||
 
        /* Only the standard INQUIRY data is supported, check if any optional INQUIRY bits set */
        if ((CommandBlock.SCSICommandData[1] & ((1 << 0) | (1 << 1))) ||


@@ -163,19 +165,17 @@ static bool SCSI_Command_Inquiry(void)
        }
 
        /* Write the INQUIRY data to the endpoint */
        }
 
        /* Write the INQUIRY data to the endpoint */

-       Endpoint_Write_Stream_LE(&InquiryData, BytesTransferred, StreamCallback_AbortOnMassStoreReset);
+       Endpoint_Write_Stream_LE(&InquiryData, BytesTransferred, NULL);

 
 

-       uint8_t PadBytes[AllocationLength - BytesTransferred];
-       

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

-       Endpoint_Write_Stream_LE(&PadBytes, sizeof(PadBytes), StreamCallback_AbortOnMassStoreReset);
+       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 */
        CommandBlock.DataTransferLength -= BytesTransferred;
 
        /* Finalize the stream transfer to send the last packet */
        Endpoint_ClearIN();
 
        /* Succeed the command and update the bytes transferred counter */
        CommandBlock.DataTransferLength -= BytesTransferred;

-       
+

        return true;
 }
 
        return true;
 }
 


@@ -187,15 +187,13 @@ static bool SCSI_Command_Inquiry(void)
 static bool SCSI_Command_Request_Sense(void)
 {
        uint8_t  AllocationLength = CommandBlock.SCSICommandData[4];
 static bool SCSI_Command_Request_Sense(void)
 {
        uint8_t  AllocationLength = CommandBlock.SCSICommandData[4];

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

        /* Send the SENSE data - this indicates to the host the status of the last command */
        /* Send the SENSE data - this indicates to the host the status of the last command */

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

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

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

 
        /* Finalize the stream transfer to send the last packet */
        Endpoint_ClearIN();
 
        /* Finalize the stream transfer to send the last packet */
        Endpoint_ClearIN();


@@ -214,10 +212,10 @@ static bool SCSI_Command_Request_Sense(void)
 static bool SCSI_Command_Read_Capacity_10(void)
 {
        /* Send the total number of logical blocks in the current LUN */
 static bool SCSI_Command_Read_Capacity_10(void)
 {
        /* Send the total number of logical blocks in the current LUN */

-       Endpoint_Write_DWord_BE(LUN_MEDIA_BLOCKS - 1);
+       Endpoint_Write_32_BE(LUN_MEDIA_BLOCKS - 1);

 
        /* Send the logical block size of the device (must be 512 bytes) */
 
        /* Send the logical block size of the device (must be 512 bytes) */

-       Endpoint_Write_DWord_BE(VIRTUAL_MEMORY_BLOCK_SIZE);
+       Endpoint_Write_32_BE(VIRTUAL_MEMORY_BLOCK_SIZE);

 
        /* Check if the current command is being aborted by the host */
        if (IsMassStoreReset)
 
        /* Check if the current command is being aborted by the host */
        if (IsMassStoreReset)


@@ -228,7 +226,7 @@ static bool SCSI_Command_Read_Capacity_10(void)
 
        /* Succeed the command and update the bytes transferred counter */
        CommandBlock.DataTransferLength -= 8;
 
        /* Succeed the command and update the bytes transferred counter */
        CommandBlock.DataTransferLength -= 8;

-       
+

        return true;
 }
 
        return true;
 }
 


@@ -250,21 +248,21 @@ static bool SCSI_Command_Send_Diagnostic(void)
 
                return false;
        }
 
                return false;
        }

-       
+

        /* 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,
        /* 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,

-                              SCSI_ASENSEQ_NO_QUALIFIER);      
-       
+                              SCSI_ASENSEQ_NO_QUALIFIER);
+

                return false;
        }
                return false;
        }

-       
+

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

-       
+

        return true;
 }
 
        return true;
 }
 


@@ -278,9 +276,23 @@ static bool SCSI_Command_Send_Diagnostic(void)
  */
 static bool SCSI_Command_ReadWrite_10(const bool IsDataRead)
 {
  */
 static bool SCSI_Command_ReadWrite_10(const bool IsDataRead)
 {

-       uint32_t BlockAddress = SwapEndian_32(*(uint32_t*)&CommandBlock.SCSICommandData[2]);
-       uint16_t TotalBlocks  = SwapEndian_16(*(uint16_t*)&CommandBlock.SCSICommandData[7]);
+       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;           
+       }
+
+       BlockAddress = SwapEndian_32(*(uint32_t*)&CommandBlock.SCSICommandData[2]);
+       TotalBlocks  = SwapEndian_16(*(uint16_t*)&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)
        {


@@ -296,7 +308,7 @@ static bool SCSI_Command_ReadWrite_10(const bool IsDataRead)
        /* Adjust the given block address to the real media address based on the selected LUN */
        BlockAddress += ((uint32_t)CommandBlock.LUN * LUN_MEDIA_BLOCKS);
        #endif
        /* Adjust the given block address to the real media address based on the selected LUN */
        BlockAddress += ((uint32_t)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(BlockAddress, TotalBlocks);
        /* Determine if the packet is a READ (10) or WRITE (10) command, call appropriate function */
        if (IsDataRead == DATA_READ)
          DataflashManager_ReadBlocks(BlockAddress, TotalBlocks);


@@ -305,6 +317,26 @@ static bool SCSI_Command_ReadWrite_10(const bool IsDataRead)
 
        /* Update the bytes transferred counter and succeed the command */
        CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);
 
        /* Update the bytes transferred counter and succeed the command */
        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.
+ *
+ *  \return Boolean true if the command completed successfully, false otherwise.
+ */
+static bool SCSI_Command_ModeSense_6(void)
+{
+       /* 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 */
+       CommandBlock.DataTransferLength -= 4;
+

        return true;
 }
        return true;
 }