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 111c3b7..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,


@@ -88,36 +88,37 @@ SCSI_Request_Sense_Response_t SenseData =
  */
 bool SCSI_DecodeSCSICommand(void)
 {
  */
 bool SCSI_DecodeSCSICommand(void)
 {

-       /* Set initial sense data, before the requested command is processed */
-       SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,
-                      SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,
-                      SCSI_ASENSEQ_NO_QUALIFIER);
+       bool CommandSuccess = false;

 
        /* Run the appropriate SCSI command hander function based on the passed command */
        switch (CommandBlock.SCSICommandData[0])
        {
                case SCSI_CMD_INQUIRY:
 
        /* Run the appropriate SCSI command hander function based on the passed command */
        switch (CommandBlock.SCSICommandData[0])
        {
                case SCSI_CMD_INQUIRY:

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

                        break;
                case SCSI_CMD_REQUEST_SENSE:
                        break;
                case SCSI_CMD_REQUEST_SENSE:

-                       SCSI_Command_Request_Sense();
+                       CommandSuccess = SCSI_Command_Request_Sense();

                        break;
                case SCSI_CMD_READ_CAPACITY_10:
                        break;
                case SCSI_CMD_READ_CAPACITY_10:

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

                        break;
                case SCSI_CMD_SEND_DIAGNOSTIC:
                        break;
                case SCSI_CMD_SEND_DIAGNOSTIC:

-                       SCSI_Command_Send_Diagnostic();
+                       CommandSuccess = SCSI_Command_Send_Diagnostic();

                        break;
                case SCSI_CMD_WRITE_10:
                        break;
                case SCSI_CMD_WRITE_10:

-                       SCSI_Command_ReadWrite_10(DATA_WRITE);
+                       CommandSuccess = SCSI_Command_ReadWrite_10(DATA_WRITE);

                        break;
                case SCSI_CMD_READ_10:
                        break;
                case SCSI_CMD_READ_10:

-                       SCSI_Command_ReadWrite_10(DATA_READ);
+                       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:
                        /* These commands should just succeed, no handling required */
                        break;
                case SCSI_CMD_TEST_UNIT_READY:
                case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:
                case SCSI_CMD_VERIFY_10:
                        /* These commands should just succeed, no handling required */

+                       CommandSuccess = true;

                        CommandBlock.DataTransferLength = 0;
                        break;
                default:
                        CommandBlock.DataTransferLength = 0;
                        break;
                default:


@@ -127,19 +128,29 @@ bool SCSI_DecodeSCSICommand(void)
                                   SCSI_ASENSEQ_NO_QUALIFIER);
                        break;
        }
                                   SCSI_ASENSEQ_NO_QUALIFIER);
                        break;
        }

-       
-       return (SenseData.SenseKey == SCSI_SENSE_KEY_GOOD);
+
+       /* 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 false;

 }
 
 /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features
  *  and capabilities to the host.
 }
 
 /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features
  *  and capabilities to the host.

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

  */
  */

-static void SCSI_Command_Inquiry(void)
+static bool SCSI_Command_Inquiry(void)

 {
 {

-       uint16_t AllocationLength  = (((uint16_t)CommandBlock.SCSICommandData[3] << 8) |
-                                                CommandBlock.SCSICommandData[4]);
-       uint16_t BytesTransferred  = (AllocationLength < sizeof(InquiryData))? AllocationLength :
-                                                                              sizeof(InquiryData);
+       uint16_t AllocationLength  = SwapEndian_16(*(uint16_t*)&CommandBlock.SCSICommandData[3]);
+       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))) ||


@@ -150,74 +161,82 @@ static void SCSI_Command_Inquiry(void)
                               SCSI_ASENSE_INVALID_FIELD_IN_CDB,
                               SCSI_ASENSEQ_NO_QUALIFIER);
 
                               SCSI_ASENSE_INVALID_FIELD_IN_CDB,
                               SCSI_ASENSEQ_NO_QUALIFIER);
 

-               return;
+               return false;

        }
 
        /* 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;

 }
 
 /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command,
  *  including the error code and additional error information so that the host can determine why a command failed to complete.
 }
 
 /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command,
  *  including the error code and additional error information so that the host can determine why a command failed to complete.

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

  */
  */

-static void SCSI_Command_Request_Sense(void)
+static bool SCSI_Command_Request_Sense(void)

 {
        uint8_t  AllocationLength = CommandBlock.SCSICommandData[4];
 {
        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();
 
        /* 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;

 }
 
 /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity
  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.
 }
 
 /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity
  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.

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

  */
  */

-static void SCSI_Command_Read_Capacity_10(void)
+static bool SCSI_Command_Read_Capacity_10(void)

 {
        /* Send the total number of logical blocks in the current LUN */
 {
        /* 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)

-         return;
+         return false;

 
        /* Send the endpoint data packet to the host */
        Endpoint_ClearIN();
 
        /* Succeed the command and update the bytes transferred counter */
        CommandBlock.DataTransferLength -= 8;
 
        /* Send the endpoint data packet to the host */
        Endpoint_ClearIN();
 
        /* Succeed the command and update the bytes transferred counter */
        CommandBlock.DataTransferLength -= 8;

+
+       return true;

 }
 
 /** Command processing for an issued SCSI SEND DIAGNOSTIC command. This command performs a quick check of the Dataflash ICs on the
  *  board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is
  *  supported.
 }
 
 /** Command processing for an issued SCSI SEND DIAGNOSTIC command. This command performs a quick check of the Dataflash ICs on the
  *  board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is
  *  supported.

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

  */
  */

-static void SCSI_Command_Send_Diagnostic(void)
+static bool SCSI_Command_Send_Diagnostic(void)

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


@@ -227,41 +246,53 @@ static void SCSI_Command_Send_Diagnostic(void)
                               SCSI_ASENSE_INVALID_FIELD_IN_CDB,
                               SCSI_ASENSEQ_NO_QUALIFIER);
 
                               SCSI_ASENSE_INVALID_FIELD_IN_CDB,
                               SCSI_ASENSEQ_NO_QUALIFIER);
 

-               return;
+               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);      
-       
-               return;
+                              SCSI_ASENSEQ_NO_QUALIFIER);
+
+               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;

 }
 
 /** Command processing for an issued SCSI READ (10) or WRITE (10) command. This command reads in the block start address
 }
 
 /** Command processing for an issued SCSI READ (10) or WRITE (10) command. This command reads in the block start address

- *  and total number of blocks to process, then calls the appropriate low-level dataflash routine to handle the actual
+ *  and total number of blocks to process, then calls the appropriate low-level Dataflash routine to handle the actual

  *  reading and writing of the data.
  *
  *  \param[in] IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)
  *  reading and writing of the data.
  *
  *  \param[in] IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)

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

  */
  */

-static void SCSI_Command_ReadWrite_10(const bool IsDataRead)
+static bool SCSI_Command_ReadWrite_10(const bool IsDataRead)

 {
        uint32_t BlockAddress;
        uint16_t TotalBlocks;
 {
        uint32_t BlockAddress;
        uint16_t TotalBlocks;

-       
-       /* Load in the 32-bit block address (SCSI uses big-endian, so have to reverse the byte order) */
-       BlockAddress = SwapEndian_32(*(uint32_t*)&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*)&CommandBlock.SCSICommandData[7]);
+       /* 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)
        {


@@ -270,14 +301,14 @@ static void SCSI_Command_ReadWrite_10(const bool IsDataRead)
                               SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE,
                               SCSI_ASENSEQ_NO_QUALIFIER);
 
                               SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE,
                               SCSI_ASENSEQ_NO_QUALIFIER);
 

-               return;
+               return false;

        }
 
        #if (TOTAL_LUNS > 1)
        /* Adjust the given block address to the real media address based on the selected LUN */
        BlockAddress += ((uint32_t)CommandBlock.LUN * LUN_MEDIA_BLOCKS);
        #endif
        }
 
        #if (TOTAL_LUNS > 1)
        /* 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);


@@ -286,4 +317,26 @@ static void 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;

 }
 }