Device mode class driver callbacks are now fired before the control request status...
[pub/USBasp.git] / Demos / Device / ClassDriver / MassStorage / Lib / SCSI.c
index 4e6c050..dd31dd1 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
@@ -84,38 +84,40 @@ SCSI_Request_Sense_Response_t SenseData =
  *  to the appropriate SCSI command handling routine if the issued command is supported by the device, else it returns\r
  *  a command failure due to a ILLEGAL REQUEST.\r
  *\r
- *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
+ *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
  */\r
 bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)\r
 {\r
-       bool CommandSuccess = false;\r
-\r
+       /* Set initial sense data, before the requested command is processed */\r
+       SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,\r
+                      SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,\r
+                      SCSI_ASENSEQ_NO_QUALIFIER);\r
+                                          \r
        /* Run the appropriate SCSI command hander function based on the passed command */\r
        switch (MSInterfaceInfo->State.CommandBlock.SCSICommandData[0])\r
        {\r
                case SCSI_CMD_INQUIRY:\r
-                       CommandSuccess = SCSI_Command_Inquiry(MSInterfaceInfo);                 \r
+                       SCSI_Command_Inquiry(MSInterfaceInfo);                  \r
                        break;\r
                case SCSI_CMD_REQUEST_SENSE:\r
-                       CommandSuccess = SCSI_Command_Request_Sense(MSInterfaceInfo);\r
+                       SCSI_Command_Request_Sense(MSInterfaceInfo);\r
                        break;\r
                case SCSI_CMD_READ_CAPACITY_10:\r
-                       CommandSuccess = SCSI_Command_Read_Capacity_10(MSInterfaceInfo);                        \r
+                       SCSI_Command_Read_Capacity_10(MSInterfaceInfo);                 \r
                        break;\r
                case SCSI_CMD_SEND_DIAGNOSTIC:\r
-                       CommandSuccess = SCSI_Command_Send_Diagnostic(MSInterfaceInfo);\r
+                       SCSI_Command_Send_Diagnostic(MSInterfaceInfo);\r
                        break;\r
                case SCSI_CMD_WRITE_10:\r
-                       CommandSuccess = SCSI_Command_ReadWrite_10(MSInterfaceInfo, DATA_WRITE);\r
+                       SCSI_Command_ReadWrite_10(MSInterfaceInfo, DATA_WRITE);\r
                        break;\r
                case SCSI_CMD_READ_10:\r
-                       CommandSuccess = SCSI_Command_ReadWrite_10(MSInterfaceInfo, DATA_READ);\r
+                       SCSI_Command_ReadWrite_10(MSInterfaceInfo, DATA_READ);\r
                        break;\r
                case SCSI_CMD_TEST_UNIT_READY:\r
                case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:\r
                case SCSI_CMD_VERIFY_10:\r
                        /* These commands should just succeed, no handling required */\r
-                       CommandSuccess = true;\r
                        MSInterfaceInfo->State.CommandBlock.DataTransferLength = 0;\r
                        break;\r
                default:\r
@@ -126,27 +128,15 @@ bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
                        break;\r
        }\r
 \r
-       /* Check if command was successfully processed */\r
-       if (CommandSuccess)\r
-       {\r
-               SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,\r
-                              SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,\r
-                              SCSI_ASENSEQ_NO_QUALIFIER);\r
-               \r
-               return true;\r
-       }\r
-\r
-       return false;\r
+       return (SenseData.SenseKey == SCSI_SENSE_KEY_GOOD);\r
 }\r
 \r
 /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features\r
  *  and capabilities to the host.\r
  *\r
- *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
- *\r
- *  \return Boolean true if the command completed successfully, false otherwise.\r
+ *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
  */\r
-static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)\r
+static void SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)\r
 {\r
        uint16_t AllocationLength  = (((uint16_t)MSInterfaceInfo->State.CommandBlock.SCSICommandData[3] << 8) |\r
                                                 MSInterfaceInfo->State.CommandBlock.SCSICommandData[4]);\r
@@ -162,7 +152,7 @@ static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
                               SCSI_ASENSE_INVALID_FIELD_IN_CDB,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);\r
 \r
-               return false;\r
+               return;\r
        }\r
        \r
        Endpoint_Write_Stream_LE(&InquiryData, BytesTransferred, NO_STREAM_CALLBACK);\r
@@ -177,18 +167,14 @@ static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
 \r
        /* Succeed the command and update the bytes transferred counter */\r
        MSInterfaceInfo->State.CommandBlock.DataTransferLength -= BytesTransferred;\r
-       \r
-       return true;\r
 }\r
 \r
 /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command,\r
  *  including the error code and additional error information so that the host can determine why a command failed to complete.\r
  *\r
- *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
- *\r
- *  \return Boolean true if the command completed successfully, false otherwise.\r
+ *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
  */\r
-static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)\r
+static void SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)\r
 {\r
        uint8_t  AllocationLength = MSInterfaceInfo->State.CommandBlock.SCSICommandData[4];\r
        uint8_t  BytesTransferred = (AllocationLength < sizeof(SenseData))? AllocationLength : sizeof(SenseData);\r
@@ -201,44 +187,34 @@ static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* MSInterfaceInf
 \r
        /* Succeed the command and update the bytes transferred counter */\r
        MSInterfaceInfo->State.CommandBlock.DataTransferLength -= BytesTransferred;\r
-\r
-       return true;\r
 }\r
 \r
 /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity\r
  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.\r
  *\r
- *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
- *\r
- *  \return Boolean true if the command completed successfully, false otherwise.\r
+ *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
  */\r
-static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)\r
+static void SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)\r
 {\r
-       uint32_t TotalLUNs      = (LUN_MEDIA_BLOCKS - 1);\r
-       uint32_t MediaBlockSize = VIRTUAL_MEMORY_BLOCK_SIZE;\r
+       uint32_t LastBlockAddressInLUN = (LUN_MEDIA_BLOCKS - 1);\r
+       uint32_t MediaBlockSize        = VIRTUAL_MEMORY_BLOCK_SIZE;\r
 \r
-       Endpoint_Write_Stream_BE(&TotalLUNs, sizeof(TotalLUNs), NO_STREAM_CALLBACK);\r
+       Endpoint_Write_Stream_BE(&LastBlockAddressInLUN, sizeof(LastBlockAddressInLUN), NO_STREAM_CALLBACK);\r
        Endpoint_Write_Stream_BE(&MediaBlockSize, sizeof(MediaBlockSize), NO_STREAM_CALLBACK);\r
        Endpoint_ClearIN();\r
        \r
        /* Succeed the command and update the bytes transferred counter */\r
        MSInterfaceInfo->State.CommandBlock.DataTransferLength -= 8;\r
-       \r
-       return true;\r
 }\r
 \r
 /** Command processing for an issued SCSI SEND DIAGNOSTIC command. This command performs a quick check of the Dataflash ICs on the\r
  *  board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is\r
  *  supported.\r
  *\r
- *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
- *\r
- *  \return Boolean true if the command completed successfully, false otherwise.\r
+ *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
  */\r
-static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)\r
+static void SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)\r
 {\r
-       uint8_t ReturnByte;\r
-\r
        /* Check to see if the SELF TEST bit is not set */\r
        if (!(MSInterfaceInfo->State.CommandBlock.SCSICommandData[1] & (1 << 2)))\r
        {\r
@@ -247,74 +223,41 @@ static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* MSInterfaceI
                               SCSI_ASENSE_INVALID_FIELD_IN_CDB,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);\r
 \r
-               return false;\r
+               return;\r
        }\r
        \r
-       /* Test first Dataflash IC is present and responding to commands */\r
-       Dataflash_SelectChip(DATAFLASH_CHIP1);\r
-       Dataflash_SendByte(DF_CMD_READMANUFACTURERDEVICEINFO);\r
-       ReturnByte = Dataflash_ReceiveByte();\r
-       Dataflash_DeselectChip();\r
-\r
-       /* If returned data is invalid, fail the command */\r
-       if (ReturnByte != DF_MANUFACTURER_ATMEL)\r
+       /* Check to see if all attached Dataflash ICs are functional */\r
+       if (!(DataflashManager_CheckDataflashOperation()))\r
        {\r
                /* Update SENSE key with a hardware error condition and return command fail */\r
                SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,\r
                               SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);      \r
        \r
-               return false;\r
+               return;\r
        }\r
-\r
-       #if (DATAFLASH_TOTALCHIPS == 2)\r
-       /* Test second Dataflash IC is present and responding to commands */\r
-       Dataflash_SelectChip(DATAFLASH_CHIP2);\r
-       Dataflash_SendByte(DF_CMD_READMANUFACTURERDEVICEINFO);\r
-       ReturnByte = Dataflash_ReceiveByte();\r
-       Dataflash_DeselectChip();\r
-\r
-       /* If returned data is invalid, fail the command */\r
-       if (ReturnByte != DF_MANUFACTURER_ATMEL)\r
-       {\r
-               /* Update SENSE key with a hardware error condition and return command fail */\r
-               SCSI_SET_SENSE(SCSI_SENSE_KEY_HARDWARE_ERROR,\r
-                              SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,\r
-                              SCSI_ASENSEQ_NO_QUALIFIER);      \r
-       \r
-               return false;\r
-       }\r
-       #endif\r
        \r
        /* Succeed the command and update the bytes transferred counter */\r
        MSInterfaceInfo->State.CommandBlock.DataTransferLength = 0;\r
-       \r
-       return true;\r
 }\r
 \r
 /** Command processing for an issued SCSI READ (10) or WRITE (10) command. This command reads in the block start address\r
  *  and total number of blocks to process, then calls the appropriate low-level dataflash routine to handle the actual\r
  *  reading and writing of the data.\r
  *\r
- *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
- *  \param IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)\r
- *\r
- *  \return Boolean true if the command completed successfully, false otherwise.\r
+ *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
+ *  \param[in] IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)\r
  */\r
-static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo, const bool IsDataRead)\r
+static void SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo, const bool IsDataRead)\r
 {\r
        uint32_t BlockAddress;\r
        uint16_t TotalBlocks;\r
        \r
-       /* Load in the 32-bit block address (SCSI uses big-endian, so have to do it byte-by-byte) */\r
-       ((uint8_t*)&BlockAddress)[3] = MSInterfaceInfo->State.CommandBlock.SCSICommandData[2];\r
-       ((uint8_t*)&BlockAddress)[2] = MSInterfaceInfo->State.CommandBlock.SCSICommandData[3];\r
-       ((uint8_t*)&BlockAddress)[1] = MSInterfaceInfo->State.CommandBlock.SCSICommandData[4];\r
-       ((uint8_t*)&BlockAddress)[0] = MSInterfaceInfo->State.CommandBlock.SCSICommandData[5];\r
+       /* Load in the 32-bit block address (SCSI uses big-endian, so have to reverse the byte order) */\r
+       BlockAddress = SwapEndian_32(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[2]);\r
 \r
-       /* Load in the 16-bit total blocks (SCSI uses big-endian, so have to do it byte-by-byte) */\r
-       ((uint8_t*)&TotalBlocks)[1]  = MSInterfaceInfo->State.CommandBlock.SCSICommandData[7];\r
-       ((uint8_t*)&TotalBlocks)[0]  = MSInterfaceInfo->State.CommandBlock.SCSICommandData[8];\r
+       /* Load in the 16-bit total blocks (SCSI uses big-endian, so have to reverse the byte order) */\r
+       TotalBlocks  = SwapEndian_16(*(uint32_t*)&MSInterfaceInfo->State.CommandBlock.SCSICommandData[7]);\r
        \r
        /* Check if the block address is outside the maximum allowable value for the LUN */\r
        if (BlockAddress >= LUN_MEDIA_BLOCKS)\r
@@ -324,7 +267,7 @@ static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo
                               SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);\r
 \r
-               return false;\r
+               return;\r
        }\r
 \r
        #if (TOTAL_LUNS > 1)\r
@@ -340,6 +283,4 @@ static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo
 \r
        /* Update the bytes transferred counter and succeed the command */\r
        MSInterfaceInfo->State.CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);\r
-       \r
-       return true;\r
 }\r