Moved out each demos' functionality library files (e.g. Ring Buffer library) to ...
[pub/lufa.git] / Demos / Host / MassStorageHost / MassStoreCommands.c
diff --git a/Demos/Host/MassStorageHost/MassStoreCommands.c b/Demos/Host/MassStorageHost/MassStoreCommands.c
deleted file mode 100644 (file)
index 95aafca..0000000
+++ /dev/null
@@ -1,685 +0,0 @@
-/*\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
- *  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
-/* Globals: */\r
-/** Current CBW to send to the device. This is automatically filled by the routines\r
- *  in this file and is not externally accessible.\r
- */\r
-static CommandBlockWrapper_t  SCSICommandBlock;\r
-\r
-/** Current CSW received from the device. This is automatically filled by the routines\r
- *  in this file and is externally accessible so that the return codes may be checked.\r
- */\r
-CommandStatusWrapper_t        SCSICommandStatus;\r
-\r
-/** Current Tag value used in issued CBWs to the device. This is automatically incremented\r
- *  by the routines in this file, 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
- *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum\r
- */\r
-static uint8_t MassStore_SendCommand(void)\r
-{\r
-       uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
-\r
-       /* Each transmission should have a unique tag value, excluding values 0 and 0xFFFFFFFF */\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
-       while(!(Pipe_IsOUTReady()));\r
-\r
-       /* Freeze pipe after use */\r
-       Pipe_Freeze();\r
-       \r
-       return PIPE_RWSTREAM_NoError;\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
-       /* Unfreeze the OUT pipe so that it can be checked */\r
-       Pipe_SelectPipe(MASS_STORE_DATA_OUT_PIPE);\r
-       Pipe_Unfreeze();\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_SelectPipe(MASS_STORE_DATA_OUT_PIPE);\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
-                       MassStore_ClearPipeStall(MASS_STORE_DATA_OUT_PIPE);\r
-\r
-                       return PIPE_RWSTREAM_PipeStalled;\r
-               }\r
-\r
-               Pipe_SelectPipe(MASS_STORE_DATA_IN_PIPE);\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
-                       MassStore_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_IsConnected))\r
-                 return PIPE_RWSTREAM_DeviceDisconnected;\r
-       };\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  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(void* BufferPtr)\r
-{\r
-       uint8_t  ErrorCode = PIPE_RWSTREAM_NoError;\r
-       uint16_t BytesRem  = SCSICommandBlock.Header.DataTransferLength;\r
-\r
-       /* Check the direction of the SCSI command data stage */\r
-       if (SCSICommandBlock.Header.Flags & COMMAND_DIRECTION_DATA_IN)\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
-       \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
- *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum\r
- */\r
-static uint8_t MassStore_GetReturnedStatus(void)\r
-{\r
-       uint8_t ErrorCode = PIPE_RWSTREAM_NoError;\r
-\r
-       /* If an error in the command ocurred, 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
-       return PIPE_RWSTREAM_NoError;\r
-}\r
-\r
-/** Clears the stall condition in the attached device on the nominated endpoint number.\r
- *\r
- *  \param EndpointNum  Endpoint number in the attached device whose stall condition is to be cleared\r
- *\r
- *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
- */\r
-uint8_t MassStore_ClearPipeStall(const uint8_t EndpointNum)\r
-{\r
-       USB_ControlRequest = (USB_Request_Header_t)\r
-               {\r
-                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_ENDPOINT),\r
-                       .bRequest      = REQ_ClearFeature,\r
-                       .wValue        = FEATURE_ENDPOINT_HALT,\r
-                       .wIndex        = EndpointNum,\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 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\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
- *  \param 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\r
- */\r
-uint8_t MassStore_GetMaxLUN(uint8_t* const MaxLUNIndex)\r
-{\r
-       uint8_t ErrorCode;\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
-       \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 LUNIndex  Index of the LUN inside the device the command is being addressed to\r
- *  \param 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\r
- */\r
-uint8_t MassStore_RequestSense(const uint8_t LUNIndex, const SCSI_Request_Sense_Response_t* const SensePtr)\r
-{\r
-       uint8_t ReturnCode = PIPE_RWSTREAM_NoError;\r
-\r
-       /* Create a CBW with a SCSI command to issue REQUEST SENSE command */\r
-       SCSICommandBlock = (CommandBlockWrapper_t)\r
-               {\r
-                       .Header =\r
-                               {\r
-                                       .Signature          = CBW_SIGNATURE,\r
-                                       .Tag                = MassStore_Tag,\r
-                                       .DataTransferLength = sizeof(SCSI_Request_Sense_Response_t),\r
-                                       .Flags              = COMMAND_DIRECTION_DATA_IN,\r
-                                       .LUN                = LUNIndex,\r
-                                       .SCSICommandLength  = 6\r
-                               },\r
-                                       \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
-       /* Send SCSI command to the attached device */\r
-       MassStore_SendCommand();\r
-\r
-       /* Wait until data received from the device */\r
-       if ((ReturnCode = MassStore_WaitForDataReceived()) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }\r
-\r
-       /* Read the returned sense data into the buffer */\r
-       if ((ReturnCode = MassStore_SendReceiveData((uint8_t*)SensePtr)) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }       \r
-       \r
-       /* Read in the returned CSW from the device */\r
-       if ((ReturnCode = MassStore_GetReturnedStatus()) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }\r
-       \r
-       return PIPE_RWSTREAM_NoError;\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 LUNIndex      Index of the LUN inside the device the command is being addressed to\r
- *  \param BlockAddress  Start block address to read from\r
- *  \param Blocks        Number of blocks to read from the device\r
- *  \param BlockSize     Size in bytes of each block to read\r
- *  \param 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\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 ReturnCode = PIPE_RWSTREAM_NoError;\r
-\r
-       /* Create a CBW with a SCSI command to read in the given blocks from the device */\r
-       SCSICommandBlock = (CommandBlockWrapper_t)\r
-               {\r
-                       .Header =\r
-                               {\r
-                                       .Signature          = CBW_SIGNATURE,\r
-                                       .Tag                = MassStore_Tag,\r
-                                       .DataTransferLength = ((uint32_t)Blocks * BlockSize),\r
-                                       .Flags              = COMMAND_DIRECTION_DATA_IN,\r
-                                       .LUN                = LUNIndex,\r
-                                       .SCSICommandLength  = 10\r
-                               },\r
-                                       \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
-       /* Send SCSI command to the attached device */\r
-       MassStore_SendCommand();\r
-\r
-       /* Wait until data received from the device */\r
-       if ((ReturnCode = MassStore_WaitForDataReceived()) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }\r
-\r
-       /* Read the returned block data into the buffer */\r
-       if ((ReturnCode = MassStore_SendReceiveData(BufferPtr)) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }       \r
-       \r
-       /* Read in the returned CSW from the device */\r
-       if ((ReturnCode = MassStore_GetReturnedStatus()) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }\r
-       \r
-       return PIPE_RWSTREAM_NoError;\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 LUNIndex      Index of the LUN inside the device the command is being addressed to\r
- *  \param BlockAddress  Start block address to write to\r
- *  \param Blocks        Number of blocks to write to in the device\r
- *  \param BlockSize     Size in bytes of each block to write\r
- *  \param 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\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 ReturnCode = PIPE_RWSTREAM_NoError;\r
-\r
-       /* Create a CBW with a SCSI command to write the given blocks to the device */\r
-       SCSICommandBlock = (CommandBlockWrapper_t)\r
-               {\r
-                       .Header =\r
-                               {\r
-                                       .Signature          = CBW_SIGNATURE,\r
-                                       .Tag                = MassStore_Tag,\r
-                                       .DataTransferLength = ((uint32_t)Blocks * BlockSize),\r
-                                       .Flags              = COMMAND_DIRECTION_DATA_OUT,\r
-                                       .LUN                = LUNIndex,\r
-                                       .SCSICommandLength  = 10\r
-                               },\r
-                                       \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
-       /* Send SCSI command to the attached device */\r
-       MassStore_SendCommand();\r
-\r
-       /* Write the data to the device from the buffer */\r
-       if ((ReturnCode = MassStore_SendReceiveData(BufferPtr)) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }       \r
-       \r
-       /* Read in the returned CSW from the device */\r
-       if ((ReturnCode = MassStore_GetReturnedStatus()) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }\r
-       \r
-       return PIPE_RWSTREAM_NoError;\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 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\r
- */\r
-uint8_t MassStore_TestUnitReady(const uint8_t LUNIndex)\r
-{\r
-       uint8_t ReturnCode = PIPE_RWSTREAM_NoError;     \r
-\r
-       /* Create a CBW with a SCSI command to issue TEST UNIT READY command */\r
-       SCSICommandBlock = (CommandBlockWrapper_t)\r
-               {\r
-                       .Header =\r
-                               {\r
-                                       .Signature          = CBW_SIGNATURE,\r
-                                       .Tag                = MassStore_Tag,\r
-                                       .DataTransferLength = 0,\r
-                                       .Flags              = COMMAND_DIRECTION_DATA_IN,\r
-                                       .LUN                = LUNIndex,\r
-                                       .SCSICommandLength  = 6\r
-                               },\r
-                                       \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
-       /* Send SCSI command to the attached device */\r
-       MassStore_SendCommand();\r
-\r
-       /* Read in the returned CSW from the device */\r
-       if ((ReturnCode = MassStore_GetReturnedStatus()) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }\r
-       \r
-       return PIPE_RWSTREAM_NoError;\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 LUNIndex     Index of the LUN inside the device the command is being addressed to\r
- *  \param 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\r
- */\r
-uint8_t MassStore_ReadCapacity(const uint8_t LUNIndex, SCSI_Capacity_t* const CapacityPtr)\r
-{\r
-       uint8_t ReturnCode = PIPE_RWSTREAM_NoError;\r
-\r
-       /* Create a CBW with a SCSI command to issue READ CAPACITY command */\r
-       SCSICommandBlock = (CommandBlockWrapper_t)\r
-               {\r
-                       .Header =\r
-                               {\r
-                                       .Signature          = CBW_SIGNATURE,\r
-                                       .Tag                = MassStore_Tag,\r
-                                       .DataTransferLength = sizeof(SCSI_Capacity_t),\r
-                                       .Flags              = COMMAND_DIRECTION_DATA_IN,\r
-                                       .LUN                = LUNIndex,\r
-                                       .SCSICommandLength  = 10\r
-                               },\r
-                                       \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
-       /* Send SCSI command to the attached device */\r
-       MassStore_SendCommand();\r
-\r
-       /* Wait until data received from the device */\r
-       if ((ReturnCode = MassStore_WaitForDataReceived()) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }\r
-\r
-       /* Read the returned capacity data into the buffer */\r
-       if ((ReturnCode = MassStore_SendReceiveData(CapacityPtr)) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }\r
-         \r
-       /* Endian-correct the read data */\r
-       CapacityPtr->Blocks    = SwapEndian_32(CapacityPtr->Blocks);\r
-       CapacityPtr->BlockSize = SwapEndian_32(CapacityPtr->BlockSize);\r
-       \r
-       /* Read in the returned CSW from the device */\r
-       if ((ReturnCode = MassStore_GetReturnedStatus()) != PIPE_RWSTREAM_NoError)\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }\r
-       \r
-       return PIPE_RWSTREAM_NoError;\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 LUNIndex        Index of the LUN inside the device the command is being addressed to\r
- *  \param 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\r
- */\r
-uint8_t MassStore_PreventAllowMediumRemoval(const uint8_t LUNIndex, const bool PreventRemoval)\r
-{\r
-       uint8_t ReturnCode = PIPE_RWSTREAM_NoError;\r
-\r
-       /* Create a CBW with a SCSI command to issue PREVENT ALLOW MEDIUM REMOVAL command */\r
-       SCSICommandBlock = (CommandBlockWrapper_t)\r
-               {\r
-                       .Header =\r
-                               {\r
-                                       .Signature          = CBW_SIGNATURE,\r
-                                       .Tag                = MassStore_Tag,\r
-                                       .DataTransferLength = 0,\r
-                                       .Flags              = COMMAND_DIRECTION_DATA_OUT,\r
-                                       .LUN                = LUNIndex,\r
-                                       .SCSICommandLength  = 6\r
-                               },\r
-                                       \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
-       /* Send SCSI command to the attached device */\r
-       MassStore_SendCommand();\r
-\r
-       /* Read in the returned CSW from the device */\r
-       if ((ReturnCode = MassStore_GetReturnedStatus()))\r
-       {\r
-               Pipe_Freeze();\r
-               return ReturnCode;\r
-       }\r
-       \r
-       return PIPE_RWSTREAM_NoError;\r
-}\r