-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\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
- 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
- * Mass Storage Device commands, to issue MSD commands to the device for\r
- * reading device status, capacity, and other characteristics. This file\r
- * also contains block read and write functions, so that device blocks\r
- * can be read and written. In general, these functions would be chained\r
- * to a FAT library to give file-level access to an attached device's contents.\r
- *\r
- * \note Many Mass Storage devices on the market are non-compliant to the\r
- * specifications and thus can prove difficult to interface with. It\r
- * may be necessary to retry the functions in the module several times\r
- * after they have returned and error to successfully send the command\r
- * to the device. Some devices may also need to have the stream function\r
- * timeout period extended beyond 100ms (some badly designed devices exceeding\r
- * 1.5 seconds occasionally) by defining USB_STREAM_TIMEOUT_MS to a\r
- * larger value in the project makefile and passing it to the compiler\r
- * via the -D switch.\r
- */\r
- \r
-#define INCLUDE_FROM_MASSSTORE_COMMANDS_C\r
-#include "MassStoreCommands.h"\r
-\r
-/** Current Tag value used in issued CBWs to the device. This is automatically incremented\r
- * each time a command is sent, and is not externally accessible.\r
- */\r
-static uint32_t MassStore_Tag = 1;\r
-\r
-\r
-/** Routine to send the current CBW to the device, and increment the Tag value as needed.\r
- *\r
- * \param[in] SCSICommandBlock Pointer to a SCSI command block structure to send to the attached device\r
- * \param[in,out] BufferPtr Pointer to a buffer for the data to send or receive to/from the device, or NULL if no data\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum\r
- */\r
-static uint8_t MassStore_SendCommand(CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr)\r
-{\r
- uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
-\r
- /* Each transmission should have a unique tag value, increment before use */\r
- SCSICommandBlock->Tag = ++MassStore_Tag;\r
-\r
- /* Wrap Tag value when invalid - MS class defines tag values of 0 and 0xFFFFFFFF to be invalid */\r
- if (MassStore_Tag == 0xFFFFFFFF)\r
- MassStore_Tag = 1;\r
-\r
- /* Select the OUT data pipe for CBW transmission */\r
- Pipe_SelectPipe(MASS_STORE_DATA_OUT_PIPE);\r
- Pipe_Unfreeze();\r
-\r
- /* Write the CBW command to the OUT pipe */\r
- if ((ErrorCode = Pipe_Write_Stream_LE(SCSICommandBlock, sizeof(CommandBlockWrapper_t))) != PIPE_RWSTREAM_NoError)\r
- return ErrorCode;\r
-\r
- /* Send the data in the OUT pipe to the attached device */\r
- Pipe_ClearOUT();\r
- \r
- /* Wait until command has been sent */\r
- Pipe_WaitUntilReady();\r
-\r
- /* Freeze pipe after use */\r
- Pipe_Freeze();\r
- \r
- /* Send data if any */\r
- if ((BufferPtr != NULL) &&\r
- ((ErrorCode = MassStore_SendReceiveData(SCSICommandBlock, BufferPtr)) != PIPE_READYWAIT_NoError))\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
- \r
- return ErrorCode;\r
-}\r
-\r
-/** Waits until the attached device is ready to accept data following a CBW, checking\r
- * to ensure that the device has not stalled the transaction.\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum\r
- */\r
-static uint8_t MassStore_WaitForDataReceived(void)\r
-{\r
- uint16_t TimeoutMSRem = COMMAND_DATA_TIMEOUT_MS;\r
-\r
- /* Select the IN data pipe for data reception */\r
- Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);\r
- Pipe_Unfreeze();\r
-\r
- /* Wait until data received in the IN pipe */\r
- while (!(Pipe_IsINReceived()))\r
- {\r
- /* Check to see if a new frame has been issued (1ms elapsed) */\r
- if (USB_INT_HasOccurred(USB_INT_HSOFI))\r
- {\r
- /* Clear the flag and decrement the timeout period counter */\r
- USB_INT_Clear(USB_INT_HSOFI);\r
- TimeoutMSRem--;\r
-\r
- /* Check to see if the timeout period for the command has elapsed */\r
- if (!(TimeoutMSRem))\r
- return PIPE_RWSTREAM_Timeout;\r
- }\r
- \r
- Pipe_Freeze();\r
- Pipe_SelectPipe(MASS_STORE_DATA_OUT_PIPE);\r
- Pipe_Unfreeze();\r
-\r
- /* Check if pipe stalled (command failed by device) */\r
- if (Pipe_IsStalled())\r
- {\r
- /* Clear the stall condition on the OUT pipe */\r
- USB_Host_ClearPipeStall(MASS_STORE_DATA_OUT_PIPE);\r
-\r
- return PIPE_RWSTREAM_PipeStalled;\r
- }\r
- \r
- Pipe_Freeze();\r
- Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);\r
- Pipe_Unfreeze();\r
-\r
- /* Check if pipe stalled (command failed by device) */\r
- if (Pipe_IsStalled())\r
- {\r
- /* Clear the stall condition on the IN pipe */\r
- USB_Host_ClearPipeStall(MASS_STORE_DATA_IN_PIPE);\r
-\r
- return PIPE_RWSTREAM_PipeStalled;\r
- }\r
- \r
- /* Check to see if the device was disconnected, if so exit function */\r
- if (USB_HostState == HOST_STATE_Unattached)\r
- return PIPE_RWSTREAM_DeviceDisconnected;\r
- };\r
- \r
- Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);\r
- Pipe_Freeze();\r
- \r
- Pipe_SelectPipe(MASS_STORE_DATA_OUT_PIPE);\r
- Pipe_Freeze();\r
-\r
- return PIPE_RWSTREAM_NoError;\r
-}\r
-\r
-/** Sends or receives the transaction's data stage to or from the attached device, reading or\r
- * writing to the nominated buffer.\r
- *\r
- * \param[in] SCSICommandBlock Pointer to a SCSI command block structure being sent to the attached device\r
- * \param[in,out] BufferPtr Pointer to the data buffer to read from or write to\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum\r
- */\r
-static uint8_t MassStore_SendReceiveData(CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr)\r
-{\r
- uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
- uint16_t BytesRem = SCSICommandBlock->DataTransferLength;\r
-\r
- /* Check the direction of the SCSI command data stage */\r
- if (SCSICommandBlock->Flags & COMMAND_DIRECTION_DATA_IN)\r
- {\r
- /* Wait until the device has replied with some data */\r
- if ((ErrorCode = MassStore_WaitForDataReceived()) != PIPE_RWSTREAM_NoError)\r
- return ErrorCode;\r
- \r
- /* Select the IN data pipe for data reception */\r
- Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);\r
- Pipe_Unfreeze();\r
- \r
- /* Read in the block data from the pipe */\r
- if ((ErrorCode = Pipe_Read_Stream_LE(BufferPtr, BytesRem)) != PIPE_RWSTREAM_NoError)\r
- return ErrorCode;\r
-\r
- /* Acknowledge the packet */\r
- Pipe_ClearIN();\r
- }\r
- else\r
- {\r
- /* Select the OUT data pipe for data transmission */\r
- Pipe_SelectPipe(MASS_STORE_DATA_OUT_PIPE);\r
- Pipe_Unfreeze();\r
-\r
- /* Write the block data to the pipe */\r
- if ((ErrorCode = Pipe_Write_Stream_LE(BufferPtr, BytesRem)) != PIPE_RWSTREAM_NoError)\r
- return ErrorCode;\r
-\r
- /* Acknowledge the packet */\r
- Pipe_ClearOUT();\r
- \r
- while (!(Pipe_IsOUTReady()))\r
- {\r
- if (USB_HostState == HOST_STATE_Unattached)\r
- return PIPE_RWSTREAM_DeviceDisconnected;\r
- }\r
- }\r
- \r
- /* Freeze used pipe after use */\r
- Pipe_Freeze();\r
-\r
- return PIPE_RWSTREAM_NoError;\r
-}\r
-\r
-/** Routine to receive the current CSW from the device.\r
- *\r
- * \param[out] SCSICommandStatus Pointer to a destination where the returned status data should be stored\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails\r
- */\r
-static uint8_t MassStore_GetReturnedStatus(CommandStatusWrapper_t* SCSICommandStatus)\r
-{\r
- uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
-\r
- /* If an error in the command occurred, abort */\r
- if ((ErrorCode = MassStore_WaitForDataReceived()) != PIPE_RWSTREAM_NoError)\r
- return ErrorCode;\r
-\r
- /* Select the IN data pipe for data reception */\r
- Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);\r
- Pipe_Unfreeze();\r
- \r
- /* Load in the CSW from the attached device */\r
- if ((ErrorCode = Pipe_Read_Stream_LE(SCSICommandStatus, sizeof(CommandStatusWrapper_t))) != PIPE_RWSTREAM_NoError)\r
- return ErrorCode;\r
- \r
- /* Clear the data ready for next reception */\r
- Pipe_ClearIN();\r
- \r
- /* Freeze the IN pipe after use */\r
- Pipe_Freeze();\r
- \r
- /* Check to see if command failed */\r
- if (SCSICommandStatus->Status != Command_Pass)\r
- ErrorCode = MASS_STORE_SCSI_COMMAND_FAILED;\r
- \r
- return ErrorCode;\r
-}\r
-\r
-/** Issues a Mass Storage class specific request to reset the attached device's Mass Storage interface,\r
- * readying the device for the next CBW.\r
- *\r
- * \return A value from the USB_Host_SendControlErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails\r
- */\r
-uint8_t MassStore_MassStorageReset(void)\r
-{\r
- USB_ControlRequest = (USB_Request_Header_t)\r
- {\r
- .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
- .bRequest = REQ_MassStorageReset,\r
- .wValue = 0,\r
- .wIndex = 0,\r
- .wLength = 0,\r
- };\r
- \r
- /* Select the control pipe for the request transfer */\r
- Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
- return USB_Host_SendControlRequest(NULL);\r
-}\r
-\r
-/** Issues a Mass Storage class specific request to determine the index of the highest numbered Logical\r
- * Unit in the attached device.\r
- *\r
- * \note Some devices do not support this request, and will STALL it when issued. To get around this,\r
- * on unsupported devices the max LUN index will be reported as zero and no error will be returned\r
- * if the device STALLs the request.\r
- *\r
- * \param[out] MaxLUNIndex Pointer to the location that the maximum LUN index value should be stored\r
- *\r
- * \return A value from the USB_Host_SendControlErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails\r
- */\r
-uint8_t MassStore_GetMaxLUN(uint8_t* const MaxLUNIndex)\r
-{\r
- uint8_t ErrorCode = HOST_SENDCONTROL_Successful;\r
-\r
- USB_ControlRequest = (USB_Request_Header_t)\r
- {\r
- .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r
- .bRequest = REQ_GetMaxLUN,\r
- .wValue = 0,\r
- .wIndex = 0,\r
- .wLength = 1,\r
- };\r
- \r
- /* Select the control pipe for the request transfer */\r
- Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
- if ((ErrorCode = USB_Host_SendControlRequest(MaxLUNIndex)) == HOST_SENDCONTROL_SetupStalled)\r
- {\r
- /* Clear the pipe stall */\r
- Pipe_ClearStall();\r
- \r
- /* Some faulty Mass Storage devices don't implement the GET_MAX_LUN request, so assume a single LUN */\r
- *MaxLUNIndex = 0;\r
- \r
- /* Clear the error, and pretend the request executed correctly if the device STALLed it */\r
- ErrorCode = HOST_SENDCONTROL_Successful;\r
- }\r
- \r
- return ErrorCode;\r
-}\r
-\r
-/** Issues a SCSI Inquiry command to the attached device, to determine the device's information. This\r
- * gives information on the device's capabilities.\r
- *\r
- * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to\r
- * \param[out] InquiryPtr Pointer to the inquiry data structure where the inquiry data from the device is to be stored\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails\r
- */\r
-uint8_t MassStore_Inquiry(const uint8_t LUNIndex, SCSI_Inquiry_Response_t* const InquiryPtr)\r
-{\r
- uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
-\r
- /* Create a CBW with a SCSI command to issue INQUIRY command */\r
- CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)\r
- {\r
- .Signature = CBW_SIGNATURE,\r
- .DataTransferLength = sizeof(SCSI_Inquiry_Response_t),\r
- .Flags = COMMAND_DIRECTION_DATA_IN,\r
- .LUN = LUNIndex,\r
- .SCSICommandLength = 6,\r
- .SCSICommandData =\r
- {\r
- SCSI_CMD_INQUIRY,\r
- 0x00, // Reserved\r
- 0x00, // Reserved\r
- 0x00, // Reserved\r
- sizeof(SCSI_Inquiry_Response_t), // Allocation Length\r
- 0x00 // Unused (control)\r
- }\r
- };\r
- \r
- CommandStatusWrapper_t SCSICommandStatus;\r
-\r
- /* Send the command and any data to the attached device */\r
- if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, InquiryPtr)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
- \r
- /* Retrieve status information from the attached device */\r
- if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
-\r
- return ErrorCode;\r
-}\r
-\r
-/** Issues a SCSI Request Sense command to the attached device, to determine the current SCSI sense information. This\r
- * gives error codes for the last issued SCSI command to the device.\r
- *\r
- * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to\r
- * \param[out] SensePtr Pointer to the sense data structure where the sense data from the device is to be stored\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails\r
- */\r
-uint8_t MassStore_RequestSense(const uint8_t LUNIndex, SCSI_Request_Sense_Response_t* const SensePtr)\r
-{\r
- uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
-\r
- /* Create a CBW with a SCSI command to issue REQUEST SENSE command */\r
- CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)\r
- {\r
- .Signature = CBW_SIGNATURE,\r
- .DataTransferLength = sizeof(SCSI_Request_Sense_Response_t),\r
- .Flags = COMMAND_DIRECTION_DATA_IN,\r
- .LUN = LUNIndex,\r
- .SCSICommandLength = 6,\r
- .SCSICommandData =\r
- {\r
- SCSI_CMD_REQUEST_SENSE,\r
- 0x00, // Reserved\r
- 0x00, // Reserved\r
- 0x00, // Reserved\r
- sizeof(SCSI_Request_Sense_Response_t), // Allocation Length\r
- 0x00 // Unused (control)\r
- }\r
- };\r
- \r
- CommandStatusWrapper_t SCSICommandStatus;\r
-\r
- /* Send the command and any data to the attached device */\r
- if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, SensePtr)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
- \r
- /* Retrieve status information from the attached device */\r
- if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
-\r
- return ErrorCode;\r
-}\r
-\r
-/** Issues a SCSI Device Block Read command to the attached device, to read in one or more data blocks from the\r
- * storage medium into a buffer.\r
- *\r
- * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to\r
- * \param[in] BlockAddress Start block address to read from\r
- * \param[in] Blocks Number of blocks to read from the device\r
- * \param[in] BlockSize Size in bytes of each block to read\r
- * \param[out] BufferPtr Pointer to the buffer where the read data is to be written to\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails\r
- */\r
-uint8_t MassStore_ReadDeviceBlock(const uint8_t LUNIndex, const uint32_t BlockAddress,\r
- const uint8_t Blocks, const uint16_t BlockSize, void* BufferPtr)\r
-{\r
- uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
-\r
- /* Create a CBW with a SCSI command to read in the given blocks from the device */\r
- CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)\r
- {\r
- .Signature = CBW_SIGNATURE,\r
- .DataTransferLength = ((uint32_t)Blocks * BlockSize),\r
- .Flags = COMMAND_DIRECTION_DATA_IN,\r
- .LUN = LUNIndex,\r
- .SCSICommandLength = 10,\r
- .SCSICommandData =\r
- {\r
- SCSI_CMD_READ_10,\r
- 0x00, // Unused (control bits, all off)\r
- (BlockAddress >> 24), // MSB of Block Address\r
- (BlockAddress >> 16),\r
- (BlockAddress >> 8),\r
- (BlockAddress & 0xFF), // LSB of Block Address\r
- 0x00, // Unused (reserved)\r
- 0x00, // MSB of Total Blocks to Read\r
- Blocks, // LSB of Total Blocks to Read\r
- 0x00 // Unused (control)\r
- }\r
- };\r
- \r
- CommandStatusWrapper_t SCSICommandStatus;\r
-\r
- /* Send the command and any data to the attached device */\r
- if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, BufferPtr)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
- \r
- /* Retrieve status information from the attached device */\r
- if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
-\r
- return ErrorCode;\r
-}\r
-\r
-/** Issues a SCSI Device Block Write command to the attached device, to write one or more data blocks to the\r
- * storage medium from a buffer.\r
- *\r
- * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to\r
- * \param[in] BlockAddress Start block address to write to\r
- * \param[in] Blocks Number of blocks to write to in the device\r
- * \param[in] BlockSize Size in bytes of each block to write\r
- * \param[in] BufferPtr Pointer to the buffer where the write data is to be sourced from\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails\r
- */\r
-uint8_t MassStore_WriteDeviceBlock(const uint8_t LUNIndex, const uint32_t BlockAddress,\r
- const uint8_t Blocks, const uint16_t BlockSize, void* BufferPtr)\r
-{\r
- uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
-\r
- /* Create a CBW with a SCSI command to write the given blocks to the device */\r
- CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)\r
- {\r
- .Signature = CBW_SIGNATURE,\r
- .DataTransferLength = ((uint32_t)Blocks * BlockSize),\r
- .Flags = COMMAND_DIRECTION_DATA_OUT,\r
- .LUN = LUNIndex,\r
- .SCSICommandLength = 10,\r
- .SCSICommandData =\r
- {\r
- SCSI_CMD_WRITE_10,\r
- 0x00, // Unused (control bits, all off)\r
- (BlockAddress >> 24), // MSB of Block Address\r
- (BlockAddress >> 16),\r
- (BlockAddress >> 8),\r
- (BlockAddress & 0xFF), // LSB of Block Address\r
- 0x00, // Unused (reserved)\r
- 0x00, // MSB of Total Blocks to Write\r
- Blocks, // LSB of Total Blocks to Write\r
- 0x00 // Unused (control)\r
- }\r
- };\r
- \r
- CommandStatusWrapper_t SCSICommandStatus;\r
-\r
- /* Send the command and any data to the attached device */\r
- if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, BufferPtr)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
- \r
- /* Retrieve status information from the attached device */\r
- if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
-\r
- return ErrorCode;\r
-}\r
-\r
-/** Issues a SCSI Device Test Unit Ready command to the attached device, to determine if the device is ready to accept\r
- * other commands.\r
- *\r
- * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails\r
- */\r
-uint8_t MassStore_TestUnitReady(const uint8_t LUNIndex)\r
-{\r
- uint8_t ErrorCode = PIPE_RWSTREAM_NoError; \r
-\r
- /* Create a CBW with a SCSI command to issue TEST UNIT READY command */\r
- CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)\r
- {\r
- .Signature = CBW_SIGNATURE,\r
- .DataTransferLength = 0,\r
- .Flags = COMMAND_DIRECTION_DATA_IN,\r
- .LUN = LUNIndex,\r
- .SCSICommandLength = 6,\r
- .SCSICommandData =\r
- {\r
- SCSI_CMD_TEST_UNIT_READY,\r
- 0x00, // Reserved\r
- 0x00, // Reserved\r
- 0x00, // Reserved\r
- 0x00, // Reserved\r
- 0x00 // Unused (control)\r
- }\r
- };\r
- \r
- CommandStatusWrapper_t SCSICommandStatus;\r
-\r
- /* Send the command and any data to the attached device */\r
- if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, NULL)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
- \r
- /* Retrieve status information from the attached device */\r
- if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
-\r
- return ErrorCode;\r
-}\r
-\r
-/** Issues a SCSI Device Read Capacity command to the attached device, to determine the capacity of the\r
- * given Logical Unit within the device.\r
- *\r
- * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to\r
- * \param[out] CapacityPtr Device capacity structure where the capacity data is to be stored\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails\r
- */\r
-uint8_t MassStore_ReadCapacity(const uint8_t LUNIndex, SCSI_Capacity_t* const CapacityPtr)\r
-{\r
- uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
-\r
- /* Create a CBW with a SCSI command to issue READ CAPACITY command */\r
- CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)\r
- {\r
- .Signature = CBW_SIGNATURE,\r
- .DataTransferLength = sizeof(SCSI_Capacity_t),\r
- .Flags = COMMAND_DIRECTION_DATA_IN,\r
- .LUN = LUNIndex,\r
- .SCSICommandLength = 10,\r
- .SCSICommandData =\r
- {\r
- SCSI_CMD_READ_CAPACITY_10,\r
- 0x00, // Reserved\r
- 0x00, // MSB of Logical block address\r
- 0x00,\r
- 0x00,\r
- 0x00, // LSB of Logical block address\r
- 0x00, // Reserved\r
- 0x00, // Reserved\r
- 0x00, // Partial Medium Indicator\r
- 0x00 // Unused (control)\r
- }\r
- };\r
- \r
- CommandStatusWrapper_t SCSICommandStatus;\r
-\r
- /* Send the command and any data to the attached device */\r
- if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, CapacityPtr)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
- \r
- /* Endian-correct the read data */\r
- CapacityPtr->Blocks = SwapEndian_32(CapacityPtr->Blocks);\r
- CapacityPtr->BlockSize = SwapEndian_32(CapacityPtr->BlockSize);\r
- \r
- /* Retrieve status information from the attached device */\r
- if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
-\r
- return ErrorCode;\r
-}\r
-\r
-/** Issues a SCSI Device Prevent/Allow Medium Removal command to the attached device, to lock the physical media from\r
- * being removed. This is a legacy command for SCSI disks with removable storage (such as ZIP disks), but should still\r
- * be issued before the first read or write command is sent.\r
- *\r
- * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to\r
- * \param[in] PreventRemoval Whether or not the LUN media should be locked to prevent removal or not\r
- *\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails\r
- */\r
-uint8_t MassStore_PreventAllowMediumRemoval(const uint8_t LUNIndex, const bool PreventRemoval)\r
-{\r
- uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
-\r
- /* Create a CBW with a SCSI command to issue PREVENT ALLOW MEDIUM REMOVAL command */\r
- CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)\r
- {\r
- .Signature = CBW_SIGNATURE,\r
- .DataTransferLength = 0,\r
- .Flags = COMMAND_DIRECTION_DATA_OUT,\r
- .LUN = LUNIndex,\r
- .SCSICommandLength = 6,\r
- .SCSICommandData =\r
- {\r
- SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL,\r
- 0x00, // Reserved\r
- 0x00, // Reserved\r
- PreventRemoval, // Prevent flag\r
- 0x00, // Reserved\r
- 0x00 // Unused (control)\r
- }\r
- };\r
- \r
- CommandStatusWrapper_t SCSICommandStatus;\r
-\r
- /* Send the command and any data to the attached device */\r
- if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, NULL)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
- \r
- /* Retrieve status information from the attached device */\r
- if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)\r
- {\r
- Pipe_Freeze();\r
- return ErrorCode;\r
- }\r
-\r
- return ErrorCode;\r
-}\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2010.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.fourwalledcubicle.com
+*/
+
+/*
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ 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
+ software without specific, written prior permission.
+
+ The author disclaim 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
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ *
+ * Mass Storage Device commands, to issue MSD commands to the device for
+ * reading device status, capacity, and other characteristics. This file
+ * also contains block read and write functions, so that device blocks
+ * can be read and written. In general, these functions would be chained
+ * to a FAT library to give file-level access to an attached device's contents.
+ *
+ * \note Many Mass Storage devices on the market are non-compliant to the
+ * specifications and thus can prove difficult to interface with. It
+ * may be necessary to retry the functions in the module several times
+ * after they have returned and error to successfully send the command
+ * to the device. Some devices may also need to have the stream function
+ * timeout period extended beyond 100ms (some badly designed devices exceeding
+ * 1.5 seconds occasionally) by defining USB_STREAM_TIMEOUT_MS to a
+ * larger value in the project makefile and passing it to the compiler
+ * via the -D switch.
+ */
+
+#define INCLUDE_FROM_MASSSTORE_COMMANDS_C
+#include "MassStoreCommands.h"
+
+/** Current Tag value used in issued CBWs to the device. This is automatically incremented
+ * each time a command is sent, and is not externally accessible.
+ */
+static uint32_t MassStore_Tag = 1;
+
+
+/** Routine to send the current CBW to the device, and increment the Tag value as needed.
+ *
+ * \param[in] SCSICommandBlock Pointer to a SCSI command block structure to send to the attached device
+ * \param[in,out] BufferPtr Pointer to a buffer for the data to send or receive to/from the device, or NULL if no data
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ */
+static uint8_t MassStore_SendCommand(CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr)
+{
+ uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
+
+ /* Each transmission should have a unique tag value, increment before use */
+ SCSICommandBlock->Tag = ++MassStore_Tag;
+
+ /* Wrap Tag value when invalid - MS class defines tag values of 0 and 0xFFFFFFFF to be invalid */
+ if (MassStore_Tag == 0xFFFFFFFF)
+ MassStore_Tag = 1;
+
+ /* Select the OUT data pipe for CBW transmission */
+ Pipe_SelectPipe(MASS_STORE_DATA_OUT_PIPE);
+ Pipe_Unfreeze();
+
+ /* Write the CBW command to the OUT pipe */
+ if ((ErrorCode = Pipe_Write_Stream_LE(SCSICommandBlock, sizeof(CommandBlockWrapper_t))) != PIPE_RWSTREAM_NoError)
+ return ErrorCode;
+
+ /* Send the data in the OUT pipe to the attached device */
+ Pipe_ClearOUT();
+
+ /* Wait until command has been sent */
+ Pipe_WaitUntilReady();
+
+ /* Freeze pipe after use */
+ Pipe_Freeze();
+
+ /* Send data if any */
+ if ((BufferPtr != NULL) &&
+ ((ErrorCode = MassStore_SendReceiveData(SCSICommandBlock, BufferPtr)) != PIPE_READYWAIT_NoError))
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ return ErrorCode;
+}
+
+/** Waits until the attached device is ready to accept data following a CBW, checking
+ * to ensure that the device has not stalled the transaction.
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ */
+static uint8_t MassStore_WaitForDataReceived(void)
+{
+ uint16_t TimeoutMSRem = COMMAND_DATA_TIMEOUT_MS;
+
+ /* Select the IN data pipe for data reception */
+ Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);
+ Pipe_Unfreeze();
+
+ /* Wait until data received in the IN pipe */
+ while (!(Pipe_IsINReceived()))
+ {
+ /* Check to see if a new frame has been issued (1ms elapsed) */
+ if (USB_INT_HasOccurred(USB_INT_HSOFI))
+ {
+ /* Clear the flag and decrement the timeout period counter */
+ USB_INT_Clear(USB_INT_HSOFI);
+ TimeoutMSRem--;
+
+ /* Check to see if the timeout period for the command has elapsed */
+ if (!(TimeoutMSRem))
+ return PIPE_RWSTREAM_Timeout;
+ }
+
+ Pipe_Freeze();
+ Pipe_SelectPipe(MASS_STORE_DATA_OUT_PIPE);
+ Pipe_Unfreeze();
+
+ /* Check if pipe stalled (command failed by device) */
+ if (Pipe_IsStalled())
+ {
+ /* Clear the stall condition on the OUT pipe */
+ USB_Host_ClearPipeStall(MASS_STORE_DATA_OUT_PIPE);
+
+ return PIPE_RWSTREAM_PipeStalled;
+ }
+
+ Pipe_Freeze();
+ Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);
+ Pipe_Unfreeze();
+
+ /* Check if pipe stalled (command failed by device) */
+ if (Pipe_IsStalled())
+ {
+ /* Clear the stall condition on the IN pipe */
+ USB_Host_ClearPipeStall(MASS_STORE_DATA_IN_PIPE);
+
+ return PIPE_RWSTREAM_PipeStalled;
+ }
+
+ /* Check to see if the device was disconnected, if so exit function */
+ if (USB_HostState == HOST_STATE_Unattached)
+ return PIPE_RWSTREAM_DeviceDisconnected;
+ };
+
+ Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);
+ Pipe_Freeze();
+
+ Pipe_SelectPipe(MASS_STORE_DATA_OUT_PIPE);
+ Pipe_Freeze();
+
+ return PIPE_RWSTREAM_NoError;
+}
+
+/** Sends or receives the transaction's data stage to or from the attached device, reading or
+ * writing to the nominated buffer.
+ *
+ * \param[in] SCSICommandBlock Pointer to a SCSI command block structure being sent to the attached device
+ * \param[in,out] BufferPtr Pointer to the data buffer to read from or write to
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ */
+static uint8_t MassStore_SendReceiveData(CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr)
+{
+ uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
+ uint16_t BytesRem = SCSICommandBlock->DataTransferLength;
+
+ /* Check the direction of the SCSI command data stage */
+ if (SCSICommandBlock->Flags & COMMAND_DIRECTION_DATA_IN)
+ {
+ /* Wait until the device has replied with some data */
+ if ((ErrorCode = MassStore_WaitForDataReceived()) != PIPE_RWSTREAM_NoError)
+ return ErrorCode;
+
+ /* Select the IN data pipe for data reception */
+ Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);
+ Pipe_Unfreeze();
+
+ /* Read in the block data from the pipe */
+ if ((ErrorCode = Pipe_Read_Stream_LE(BufferPtr, BytesRem)) != PIPE_RWSTREAM_NoError)
+ return ErrorCode;
+
+ /* Acknowledge the packet */
+ Pipe_ClearIN();
+ }
+ else
+ {
+ /* Select the OUT data pipe for data transmission */
+ Pipe_SelectPipe(MASS_STORE_DATA_OUT_PIPE);
+ Pipe_Unfreeze();
+
+ /* Write the block data to the pipe */
+ if ((ErrorCode = Pipe_Write_Stream_LE(BufferPtr, BytesRem)) != PIPE_RWSTREAM_NoError)
+ return ErrorCode;
+
+ /* Acknowledge the packet */
+ Pipe_ClearOUT();
+
+ while (!(Pipe_IsOUTReady()))
+ {
+ if (USB_HostState == HOST_STATE_Unattached)
+ return PIPE_RWSTREAM_DeviceDisconnected;
+ }
+ }
+
+ /* Freeze used pipe after use */
+ Pipe_Freeze();
+
+ return PIPE_RWSTREAM_NoError;
+}
+
+/** Routine to receive the current CSW from the device.
+ *
+ * \param[out] SCSICommandStatus Pointer to a destination where the returned status data should be stored
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
+ */
+static uint8_t MassStore_GetReturnedStatus(CommandStatusWrapper_t* SCSICommandStatus)
+{
+ uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
+
+ /* If an error in the command occurred, abort */
+ if ((ErrorCode = MassStore_WaitForDataReceived()) != PIPE_RWSTREAM_NoError)
+ return ErrorCode;
+
+ /* Select the IN data pipe for data reception */
+ Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);
+ Pipe_Unfreeze();
+
+ /* Load in the CSW from the attached device */
+ if ((ErrorCode = Pipe_Read_Stream_LE(SCSICommandStatus, sizeof(CommandStatusWrapper_t))) != PIPE_RWSTREAM_NoError)
+ return ErrorCode;
+
+ /* Clear the data ready for next reception */
+ Pipe_ClearIN();
+
+ /* Freeze the IN pipe after use */
+ Pipe_Freeze();
+
+ /* Check to see if command failed */
+ if (SCSICommandStatus->Status != Command_Pass)
+ ErrorCode = MASS_STORE_SCSI_COMMAND_FAILED;
+
+ return ErrorCode;
+}
+
+/** Issues a Mass Storage class specific request to reset the attached device's Mass Storage interface,
+ * readying the device for the next CBW.
+ *
+ * \return A value from the USB_Host_SendControlErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
+ */
+uint8_t MassStore_MassStorageReset(void)
+{
+ USB_ControlRequest = (USB_Request_Header_t)
+ {
+ .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
+ .bRequest = REQ_MassStorageReset,
+ .wValue = 0,
+ .wIndex = 0,
+ .wLength = 0,
+ };
+
+ /* Select the control pipe for the request transfer */
+ Pipe_SelectPipe(PIPE_CONTROLPIPE);
+
+ return USB_Host_SendControlRequest(NULL);
+}
+
+/** Issues a Mass Storage class specific request to determine the index of the highest numbered Logical
+ * Unit in the attached device.
+ *
+ * \note Some devices do not support this request, and will STALL it when issued. To get around this,
+ * on unsupported devices the max LUN index will be reported as zero and no error will be returned
+ * if the device STALLs the request.
+ *
+ * \param[out] MaxLUNIndex Pointer to the location that the maximum LUN index value should be stored
+ *
+ * \return A value from the USB_Host_SendControlErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
+ */
+uint8_t MassStore_GetMaxLUN(uint8_t* const MaxLUNIndex)
+{
+ uint8_t ErrorCode = HOST_SENDCONTROL_Successful;
+
+ USB_ControlRequest = (USB_Request_Header_t)
+ {
+ .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),
+ .bRequest = REQ_GetMaxLUN,
+ .wValue = 0,
+ .wIndex = 0,
+ .wLength = 1,
+ };
+
+ /* Select the control pipe for the request transfer */
+ Pipe_SelectPipe(PIPE_CONTROLPIPE);
+
+ if ((ErrorCode = USB_Host_SendControlRequest(MaxLUNIndex)) == HOST_SENDCONTROL_SetupStalled)
+ {
+ /* Clear the pipe stall */
+ Pipe_ClearStall();
+
+ /* Some faulty Mass Storage devices don't implement the GET_MAX_LUN request, so assume a single LUN */
+ *MaxLUNIndex = 0;
+
+ /* Clear the error, and pretend the request executed correctly if the device STALLed it */
+ ErrorCode = HOST_SENDCONTROL_Successful;
+ }
+
+ return ErrorCode;
+}
+
+/** Issues a SCSI Inquiry command to the attached device, to determine the device's information. This
+ * gives information on the device's capabilities.
+ *
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[out] InquiryPtr Pointer to the inquiry data structure where the inquiry data from the device is to be stored
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
+ */
+uint8_t MassStore_Inquiry(const uint8_t LUNIndex, SCSI_Inquiry_Response_t* const InquiryPtr)
+{
+ uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
+
+ /* Create a CBW with a SCSI command to issue INQUIRY command */
+ CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)
+ {
+ .Signature = CBW_SIGNATURE,
+ .DataTransferLength = sizeof(SCSI_Inquiry_Response_t),
+ .Flags = COMMAND_DIRECTION_DATA_IN,
+ .LUN = LUNIndex,
+ .SCSICommandLength = 6,
+ .SCSICommandData =
+ {
+ SCSI_CMD_INQUIRY,
+ 0x00, // Reserved
+ 0x00, // Reserved
+ 0x00, // Reserved
+ sizeof(SCSI_Inquiry_Response_t), // Allocation Length
+ 0x00 // Unused (control)
+ }
+ };
+
+ CommandStatusWrapper_t SCSICommandStatus;
+
+ /* Send the command and any data to the attached device */
+ if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, InquiryPtr)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ /* Retrieve status information from the attached device */
+ if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ return ErrorCode;
+}
+
+/** Issues a SCSI Request Sense command to the attached device, to determine the current SCSI sense information. This
+ * gives error codes for the last issued SCSI command to the device.
+ *
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[out] SensePtr Pointer to the sense data structure where the sense data from the device is to be stored
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
+ */
+uint8_t MassStore_RequestSense(const uint8_t LUNIndex, SCSI_Request_Sense_Response_t* const SensePtr)
+{
+ uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
+
+ /* Create a CBW with a SCSI command to issue REQUEST SENSE command */
+ CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)
+ {
+ .Signature = CBW_SIGNATURE,
+ .DataTransferLength = sizeof(SCSI_Request_Sense_Response_t),
+ .Flags = COMMAND_DIRECTION_DATA_IN,
+ .LUN = LUNIndex,
+ .SCSICommandLength = 6,
+ .SCSICommandData =
+ {
+ SCSI_CMD_REQUEST_SENSE,
+ 0x00, // Reserved
+ 0x00, // Reserved
+ 0x00, // Reserved
+ sizeof(SCSI_Request_Sense_Response_t), // Allocation Length
+ 0x00 // Unused (control)
+ }
+ };
+
+ CommandStatusWrapper_t SCSICommandStatus;
+
+ /* Send the command and any data to the attached device */
+ if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, SensePtr)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ /* Retrieve status information from the attached device */
+ if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ return ErrorCode;
+}
+
+/** Issues a SCSI Device Block Read command to the attached device, to read in one or more data blocks from the
+ * storage medium into a buffer.
+ *
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[in] BlockAddress Start block address to read from
+ * \param[in] Blocks Number of blocks to read from the device
+ * \param[in] BlockSize Size in bytes of each block to read
+ * \param[out] BufferPtr Pointer to the buffer where the read data is to be written to
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
+ */
+uint8_t MassStore_ReadDeviceBlock(const uint8_t LUNIndex, const uint32_t BlockAddress,
+ const uint8_t Blocks, const uint16_t BlockSize, void* BufferPtr)
+{
+ uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
+
+ /* Create a CBW with a SCSI command to read in the given blocks from the device */
+ CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)
+ {
+ .Signature = CBW_SIGNATURE,
+ .DataTransferLength = ((uint32_t)Blocks * BlockSize),
+ .Flags = COMMAND_DIRECTION_DATA_IN,
+ .LUN = LUNIndex,
+ .SCSICommandLength = 10,
+ .SCSICommandData =
+ {
+ SCSI_CMD_READ_10,
+ 0x00, // Unused (control bits, all off)
+ (BlockAddress >> 24), // MSB of Block Address
+ (BlockAddress >> 16),
+ (BlockAddress >> 8),
+ (BlockAddress & 0xFF), // LSB of Block Address
+ 0x00, // Unused (reserved)
+ 0x00, // MSB of Total Blocks to Read
+ Blocks, // LSB of Total Blocks to Read
+ 0x00 // Unused (control)
+ }
+ };
+
+ CommandStatusWrapper_t SCSICommandStatus;
+
+ /* Send the command and any data to the attached device */
+ if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, BufferPtr)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ /* Retrieve status information from the attached device */
+ if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ return ErrorCode;
+}
+
+/** Issues a SCSI Device Block Write command to the attached device, to write one or more data blocks to the
+ * storage medium from a buffer.
+ *
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[in] BlockAddress Start block address to write to
+ * \param[in] Blocks Number of blocks to write to in the device
+ * \param[in] BlockSize Size in bytes of each block to write
+ * \param[in] BufferPtr Pointer to the buffer where the write data is to be sourced from
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
+ */
+uint8_t MassStore_WriteDeviceBlock(const uint8_t LUNIndex, const uint32_t BlockAddress,
+ const uint8_t Blocks, const uint16_t BlockSize, void* BufferPtr)
+{
+ uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
+
+ /* Create a CBW with a SCSI command to write the given blocks to the device */
+ CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)
+ {
+ .Signature = CBW_SIGNATURE,
+ .DataTransferLength = ((uint32_t)Blocks * BlockSize),
+ .Flags = COMMAND_DIRECTION_DATA_OUT,
+ .LUN = LUNIndex,
+ .SCSICommandLength = 10,
+ .SCSICommandData =
+ {
+ SCSI_CMD_WRITE_10,
+ 0x00, // Unused (control bits, all off)
+ (BlockAddress >> 24), // MSB of Block Address
+ (BlockAddress >> 16),
+ (BlockAddress >> 8),
+ (BlockAddress & 0xFF), // LSB of Block Address
+ 0x00, // Unused (reserved)
+ 0x00, // MSB of Total Blocks to Write
+ Blocks, // LSB of Total Blocks to Write
+ 0x00 // Unused (control)
+ }
+ };
+
+ CommandStatusWrapper_t SCSICommandStatus;
+
+ /* Send the command and any data to the attached device */
+ if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, BufferPtr)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ /* Retrieve status information from the attached device */
+ if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ return ErrorCode;
+}
+
+/** Issues a SCSI Device Test Unit Ready command to the attached device, to determine if the device is ready to accept
+ * other commands.
+ *
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
+ */
+uint8_t MassStore_TestUnitReady(const uint8_t LUNIndex)
+{
+ uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
+
+ /* Create a CBW with a SCSI command to issue TEST UNIT READY command */
+ CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)
+ {
+ .Signature = CBW_SIGNATURE,
+ .DataTransferLength = 0,
+ .Flags = COMMAND_DIRECTION_DATA_IN,
+ .LUN = LUNIndex,
+ .SCSICommandLength = 6,
+ .SCSICommandData =
+ {
+ SCSI_CMD_TEST_UNIT_READY,
+ 0x00, // Reserved
+ 0x00, // Reserved
+ 0x00, // Reserved
+ 0x00, // Reserved
+ 0x00 // Unused (control)
+ }
+ };
+
+ CommandStatusWrapper_t SCSICommandStatus;
+
+ /* Send the command and any data to the attached device */
+ if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, NULL)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ /* Retrieve status information from the attached device */
+ if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ return ErrorCode;
+}
+
+/** Issues a SCSI Device Read Capacity command to the attached device, to determine the capacity of the
+ * given Logical Unit within the device.
+ *
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[out] CapacityPtr Device capacity structure where the capacity data is to be stored
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
+ */
+uint8_t MassStore_ReadCapacity(const uint8_t LUNIndex, SCSI_Capacity_t* const CapacityPtr)
+{
+ uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
+
+ /* Create a CBW with a SCSI command to issue READ CAPACITY command */
+ CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)
+ {
+ .Signature = CBW_SIGNATURE,
+ .DataTransferLength = sizeof(SCSI_Capacity_t),
+ .Flags = COMMAND_DIRECTION_DATA_IN,
+ .LUN = LUNIndex,
+ .SCSICommandLength = 10,
+ .SCSICommandData =
+ {
+ SCSI_CMD_READ_CAPACITY_10,
+ 0x00, // Reserved
+ 0x00, // MSB of Logical block address
+ 0x00,
+ 0x00,
+ 0x00, // LSB of Logical block address
+ 0x00, // Reserved
+ 0x00, // Reserved
+ 0x00, // Partial Medium Indicator
+ 0x00 // Unused (control)
+ }
+ };
+
+ CommandStatusWrapper_t SCSICommandStatus;
+
+ /* Send the command and any data to the attached device */
+ if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, CapacityPtr)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ /* Endian-correct the read data */
+ CapacityPtr->Blocks = SwapEndian_32(CapacityPtr->Blocks);
+ CapacityPtr->BlockSize = SwapEndian_32(CapacityPtr->BlockSize);
+
+ /* Retrieve status information from the attached device */
+ if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ return ErrorCode;
+}
+
+/** Issues a SCSI Device Prevent/Allow Medium Removal command to the attached device, to lock the physical media from
+ * being removed. This is a legacy command for SCSI disks with removable storage (such as ZIP disks), but should still
+ * be issued before the first read or write command is sent.
+ *
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[in] PreventRemoval Whether or not the LUN media should be locked to prevent removal or not
+ *
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum, or MASS_STORE_SCSI_COMMAND_FAILED if the SCSI command fails
+ */
+uint8_t MassStore_PreventAllowMediumRemoval(const uint8_t LUNIndex, const bool PreventRemoval)
+{
+ uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
+
+ /* Create a CBW with a SCSI command to issue PREVENT ALLOW MEDIUM REMOVAL command */
+ CommandBlockWrapper_t SCSICommandBlock = (CommandBlockWrapper_t)
+ {
+ .Signature = CBW_SIGNATURE,
+ .DataTransferLength = 0,
+ .Flags = COMMAND_DIRECTION_DATA_OUT,
+ .LUN = LUNIndex,
+ .SCSICommandLength = 6,
+ .SCSICommandData =
+ {
+ SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL,
+ 0x00, // Reserved
+ 0x00, // Reserved
+ PreventRemoval, // Prevent flag
+ 0x00, // Reserved
+ 0x00 // Unused (control)
+ }
+ };
+
+ CommandStatusWrapper_t SCSICommandStatus;
+
+ /* Send the command and any data to the attached device */
+ if ((ErrorCode = MassStore_SendCommand(&SCSICommandBlock, NULL)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ /* Retrieve status information from the attached device */
+ if ((ErrorCode = MassStore_GetReturnedStatus(&SCSICommandStatus)) != PIPE_RWSTREAM_NoError)
+ {
+ Pipe_Freeze();
+ return ErrorCode;
+ }
+
+ return ErrorCode;
+}
projects / pub / USBasp.git / blobdiff