forked from mfulz_github/qmk_firmware
a233109909
Updated MS_Host_ResetMSInterface() to now perform a full Mass Storage reset sequence to prevent data corruption in the event of a device lock up or timeout (thanks to David Lyons). Add parenthesis around the library Endianness macros that do nothing on a particular architecture to prevent operator precedence issues depending on usage. Minor documentation corrections.
742 lines
25 KiB
C
742 lines
25 KiB
C
/*
|
|
LUFA Library
|
|
Copyright (C) Dean Camera, 2011.
|
|
|
|
dean [at] fourwalledcubicle [dot] com
|
|
www.lufa-lib.org
|
|
*/
|
|
|
|
/*
|
|
Copyright 2011 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(MS_CommandBlockWrapper_t* const SCSICommandBlock,
|
|
void* BufferPtr)
|
|
{
|
|
uint8_t ErrorCode = PIPE_RWSTREAM_NoError;
|
|
|
|
/* Wrap Tag value when invalid - MS class defines tag values of 0 and 0xFFFFFFFF to be invalid */
|
|
if (++MassStore_Tag == 0xFFFFFFFF)
|
|
MassStore_Tag = 1;
|
|
|
|
/* Each transmission should have a unique tag value, increment before use */
|
|
SCSICommandBlock->Tag = MassStore_Tag;
|
|
|
|
/* 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(MS_CommandBlockWrapper_t), NULL)) !=
|
|
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 has been given */
|
|
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;
|
|
uint16_t PreviousFrameNumber = USB_Host_GetFrameNumber();
|
|
|
|
/* 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()))
|
|
{
|
|
uint16_t CurrentFrameNumber = USB_Host_GetFrameNumber();
|
|
|
|
/* Check to see if a new frame has been issued (1ms elapsed) */
|
|
if (CurrentFrameNumber != PreviousFrameNumber)
|
|
{
|
|
/* Save the new frame number and decrement the timeout period */
|
|
PreviousFrameNumber = CurrentFrameNumber;
|
|
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_ClearEndpointStall(Pipe_GetBoundEndpointAddress());
|
|
|
|
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_ClearEndpointStall(Pipe_GetBoundEndpointAddress());
|
|
|
|
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(MS_CommandBlockWrapper_t* const 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 & MS_COMMAND_DIR_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, NULL)) != 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, NULL)) != 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(MS_CommandStatusWrapper_t* const 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(MS_CommandStatusWrapper_t), NULL)) !=
|
|
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 != MS_SCSI_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. The Data endpoints are cleared of any STALL condition once this
|
|
* command completes sucessfuly.
|
|
*
|
|
* \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)
|
|
{
|
|
uint8_t ErrorCode;
|
|
|
|
USB_ControlRequest = (USB_Request_Header_t)
|
|
{
|
|
.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
|
|
.bRequest = MS_REQ_MassStorageReset,
|
|
.wValue = 0,
|
|
.wIndex = 0,
|
|
.wLength = 0,
|
|
};
|
|
|
|
/* Select the control pipe for the request transfer */
|
|
Pipe_SelectPipe(PIPE_CONTROLPIPE);
|
|
|
|
if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
|
|
return ErrorCode;
|
|
|
|
/* Select first data pipe to clear STALL condition if one exists */
|
|
Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);
|
|
|
|
if ((ErrorCode = USB_Host_ClearEndpointStall(Pipe_GetBoundEndpointAddress())) != HOST_SENDCONTROL_Successful)
|
|
return ErrorCode;
|
|
|
|
/* Select second data pipe to clear STALL condition if one exists */
|
|
Pipe_SelectPipe(MASS_STORE_DATA_OUT_PIPE);
|
|
|
|
if ((ErrorCode = USB_Host_ClearEndpointStall(Pipe_GetBoundEndpointAddress())) != HOST_SENDCONTROL_Successful)
|
|
return ErrorCode;
|
|
|
|
return HOST_SENDCONTROL_Successful;
|
|
}
|
|
|
|
/** 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 = MS_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 */
|
|
MS_CommandBlockWrapper_t SCSICommandBlock = (MS_CommandBlockWrapper_t)
|
|
{
|
|
.Signature = MS_CBW_SIGNATURE,
|
|
.DataTransferLength = sizeof(SCSI_Inquiry_Response_t),
|
|
.Flags = MS_COMMAND_DIR_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)
|
|
}
|
|
};
|
|
|
|
MS_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 */
|
|
MS_CommandBlockWrapper_t SCSICommandBlock = (MS_CommandBlockWrapper_t)
|
|
{
|
|
.Signature = MS_CBW_SIGNATURE,
|
|
.DataTransferLength = sizeof(SCSI_Request_Sense_Response_t),
|
|
.Flags = MS_COMMAND_DIR_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)
|
|
}
|
|
};
|
|
|
|
MS_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 */
|
|
MS_CommandBlockWrapper_t SCSICommandBlock = (MS_CommandBlockWrapper_t)
|
|
{
|
|
.Signature = MS_CBW_SIGNATURE,
|
|
.DataTransferLength = ((uint32_t)Blocks * BlockSize),
|
|
.Flags = MS_COMMAND_DIR_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, // Reserved
|
|
0x00, // MSB of Total Blocks to Read
|
|
Blocks, // LSB of Total Blocks to Read
|
|
0x00 // Unused (control)
|
|
}
|
|
};
|
|
|
|
MS_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 */
|
|
MS_CommandBlockWrapper_t SCSICommandBlock = (MS_CommandBlockWrapper_t)
|
|
{
|
|
.Signature = MS_CBW_SIGNATURE,
|
|
.DataTransferLength = ((uint32_t)Blocks * BlockSize),
|
|
.Flags = MS_COMMAND_DIR_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)
|
|
}
|
|
};
|
|
|
|
MS_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 */
|
|
MS_CommandBlockWrapper_t SCSICommandBlock = (MS_CommandBlockWrapper_t)
|
|
{
|
|
.Signature = MS_CBW_SIGNATURE,
|
|
.DataTransferLength = 0,
|
|
.Flags = MS_COMMAND_DIR_DATA_IN,
|
|
.LUN = LUNIndex,
|
|
.SCSICommandLength = 6,
|
|
.SCSICommandData =
|
|
{
|
|
SCSI_CMD_TEST_UNIT_READY,
|
|
0x00, // Reserved
|
|
0x00, // Reserved
|
|
0x00, // Reserved
|
|
0x00, // Reserved
|
|
0x00 // Unused (control)
|
|
}
|
|
};
|
|
|
|
MS_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 */
|
|
MS_CommandBlockWrapper_t SCSICommandBlock = (MS_CommandBlockWrapper_t)
|
|
{
|
|
.Signature = MS_CBW_SIGNATURE,
|
|
.DataTransferLength = sizeof(SCSI_Capacity_t),
|
|
.Flags = MS_COMMAND_DIR_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)
|
|
}
|
|
};
|
|
|
|
MS_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 */
|
|
MS_CommandBlockWrapper_t SCSICommandBlock = (MS_CommandBlockWrapper_t)
|
|
{
|
|
.Signature = MS_CBW_SIGNATURE,
|
|
.DataTransferLength = 0,
|
|
.Flags = MS_COMMAND_DIR_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)
|
|
}
|
|
};
|
|
|
|
MS_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;
|
|
}
|
|
|