+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2009.\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
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * SCSI command processing routines, for SCSI commands issued by the host. Mass Storage\r
- * devices use a thin "Bulk-Only Transport" protocol for issuing commands and status information,\r
- * which wrap around standard SCSI device commands for controlling the actual storage medium.\r
- */\r
- \r
-#define INCLUDE_FROM_SCSI_C\r
-#include "SCSI.h"\r
-\r
-/** Structure to hold the SCSI response data to a SCSI INQUIRY command. This gives information about the device's\r
- * features and capabilities.\r
- */\r
-SCSI_Inquiry_Response_t InquiryData = \r
- {\r
- .DeviceType = DEVICE_TYPE_BLOCK,\r
- .PeripheralQualifier = 0,\r
- \r
- .Removable = true,\r
- \r
- .Version = 0,\r
- \r
- .ResponseDataFormat = 2,\r
- .NormACA = false,\r
- .TrmTsk = false,\r
- .AERC = false,\r
-\r
- .AdditionalLength = 0x1F,\r
- \r
- .SoftReset = false,\r
- .CmdQue = false,\r
- .Linked = false,\r
- .Sync = false,\r
- .WideBus16Bit = false,\r
- .WideBus32Bit = false,\r
- .RelAddr = false,\r
- \r
- .VendorID = "LUFA",\r
- .ProductID = "Dataflash Disk",\r
- .RevisionID = {'0','.','0','0'},\r
- };\r
-\r
-/** Structure to hold the sense data for the last issued SCSI command, which is returned to the host after a SCSI REQUEST SENSE\r
- * command is issued. This gives information on exactly why the last command failed to complete.\r
- */\r
-SCSI_Request_Sense_Response_t SenseData =\r
- {\r
- .ResponseCode = 0x70,\r
- .AdditionalLength = 0x0A,\r
- };\r
-\r
-\r
-/** Main routine to process the SCSI command located in the Command Block Wrapper read from the host. This dispatches\r
- * 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
- */\r
-bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
-{\r
- bool CommandSuccess = false;\r
-\r
- /* Run the appropriate SCSI command hander function based on the passed command */\r
- switch (MSInterfaceInfo->CommandBlock.SCSICommandData[0])\r
- {\r
- case SCSI_CMD_INQUIRY:\r
- CommandSuccess = SCSI_Command_Inquiry(MSInterfaceInfo); \r
- break;\r
- case SCSI_CMD_REQUEST_SENSE:\r
- CommandSuccess = SCSI_Command_Request_Sense(MSInterfaceInfo);\r
- break;\r
- case SCSI_CMD_READ_CAPACITY_10:\r
- CommandSuccess = SCSI_Command_Read_Capacity_10(MSInterfaceInfo); \r
- break;\r
- case SCSI_CMD_SEND_DIAGNOSTIC:\r
- CommandSuccess = SCSI_Command_Send_Diagnostic(MSInterfaceInfo);\r
- break;\r
- case SCSI_CMD_WRITE_10:\r
- CommandSuccess = 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
- 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->CommandBlock.DataTransferLength = 0;\r
- break;\r
- default:\r
- /* Update the SENSE key to reflect the invalid command */\r
- SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,\r
- SCSI_ASENSE_INVALID_COMMAND,\r
- SCSI_ASENSEQ_NO_QUALIFIER);\r
- 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
-}\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
- */\r
-static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
-{\r
- uint16_t AllocationLength = (((uint16_t)MSInterfaceInfo->CommandBlock.SCSICommandData[3] << 8) |\r
- MSInterfaceInfo->CommandBlock.SCSICommandData[4]);\r
- uint16_t BytesTransferred = (AllocationLength < sizeof(InquiryData))? AllocationLength :\r
- sizeof(InquiryData);\r
-\r
- /* Only the standard INQUIRY data is supported, check if any optional INQUIRY bits set */\r
- if ((MSInterfaceInfo->CommandBlock.SCSICommandData[1] & ((1 << 0) | (1 << 1))) ||\r
- MSInterfaceInfo->CommandBlock.SCSICommandData[2])\r
- {\r
- /* Optional but unsupported bits set - update the SENSE key and fail the request */\r
- SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,\r
- SCSI_ASENSE_INVALID_FIELD_IN_CDB,\r
- SCSI_ASENSEQ_NO_QUALIFIER);\r
-\r
- return false;\r
- }\r
- \r
- Endpoint_Write_Stream_LE(&InquiryData, BytesTransferred, NO_STREAM_CALLBACK);\r
-\r
- uint8_t PadBytes[AllocationLength - BytesTransferred];\r
- \r
- /* Pad out remaining bytes with 0x00 */\r
- Endpoint_Write_Stream_LE(&PadBytes, (AllocationLength - BytesTransferred), NO_STREAM_CALLBACK);\r
-\r
- /* Finalize the stream transfer to send the last packet */\r
- Endpoint_ClearIN();\r
-\r
- /* Succeed the command and update the bytes transferred counter */\r
- MSInterfaceInfo->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
- */\r
-static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
-{\r
- uint8_t AllocationLength = MSInterfaceInfo->CommandBlock.SCSICommandData[4];\r
- uint8_t BytesTransferred = (AllocationLength < sizeof(SenseData))? AllocationLength : sizeof(SenseData);\r
- \r
- uint8_t PadBytes[AllocationLength - BytesTransferred];\r
-\r
- Endpoint_Write_Stream_LE(&SenseData, BytesTransferred, NO_STREAM_CALLBACK);\r
- Endpoint_Write_Stream_LE(&PadBytes, (AllocationLength - BytesTransferred), NO_STREAM_CALLBACK);\r
- Endpoint_ClearIN();\r
-\r
- /* Succeed the command and update the bytes transferred counter */\r
- MSInterfaceInfo->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
- */\r
-static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
-{\r
- uint32_t TotalLUNs = (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(&MediaBlockSize, sizeof(MediaBlockSize), NO_STREAM_CALLBACK);\r
- Endpoint_ClearIN();\r
- \r
- /* Succeed the command and update the bytes transferred counter */\r
- MSInterfaceInfo->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
- */\r
-static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
-{\r
- uint8_t ReturnByte;\r
-\r
- /* Check to see if the SELF TEST bit is not set */\r
- if (!(MSInterfaceInfo->CommandBlock.SCSICommandData[1] & (1 << 2)))\r
- {\r
- /* Only self-test supported - update SENSE key and fail the command */\r
- SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,\r
- SCSI_ASENSE_INVALID_FIELD_IN_CDB,\r
- SCSI_ASENSEQ_NO_QUALIFIER);\r
-\r
- return false;\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
- {\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
-\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->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
- */\r
-static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_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->CommandBlock.SCSICommandData[2];\r
- ((uint8_t*)&BlockAddress)[2] = MSInterfaceInfo->CommandBlock.SCSICommandData[3];\r
- ((uint8_t*)&BlockAddress)[1] = MSInterfaceInfo->CommandBlock.SCSICommandData[4];\r
- ((uint8_t*)&BlockAddress)[0] = MSInterfaceInfo->CommandBlock.SCSICommandData[5];\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->CommandBlock.SCSICommandData[7];\r
- ((uint8_t*)&TotalBlocks)[0] = MSInterfaceInfo->CommandBlock.SCSICommandData[8];\r
- \r
- /* Check if the block address is outside the maximum allowable value for the LUN */\r
- if (BlockAddress >= LUN_MEDIA_BLOCKS)\r
- {\r
- /* Block address is invalid, update SENSE key and return command fail */\r
- SCSI_SET_SENSE(SCSI_SENSE_KEY_ILLEGAL_REQUEST,\r
- SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE,\r
- SCSI_ASENSEQ_NO_QUALIFIER);\r
-\r
- return false;\r
- }\r
-\r
- #if (TOTAL_LUNS > 1)\r
- /* Adjust the given block address to the real media address based on the selected LUN */\r
- BlockAddress += ((uint32_t)MSInterfaceInfo->CommandBlock.LUN * LUN_MEDIA_BLOCKS);\r
- #endif\r
- \r
- /* Determine if the packet is a READ (10) or WRITE (10) command, call appropriate function */\r
- if (IsDataRead == DATA_READ)\r
- DataflashManager_ReadBlocks(MSInterfaceInfo, BlockAddress, TotalBlocks);\r
- else\r
- DataflashManager_WriteBlocks(MSInterfaceInfo, BlockAddress, TotalBlocks);\r
-\r
- /* Update the bytes transferred counter and succeed the command */\r
- MSInterfaceInfo->CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);\r
- \r
- return true;\r
-}\r
projects / pub / lufa.git / blobdiff