MassStorage.h 18.5 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
10
  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
17
18
  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
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
  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
 *  \brief Host mode driver for the library USB Mass Storage Class driver.
 *
 *  Host mode driver for the library USB Mass Storage Class driver.
 *
36
37
 *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
 *        dispatch header located in LUFA/Drivers/USB.h.
38
39
40
 */

/** \ingroup Group_USBClassMS
41
 *  \defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver
42
43
44
 *
 *  \section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
45
 *    - LUFA/Drivers/USB/Class/Host/MassStorage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
46
 *
47
 *  \section Sec_ModDescription Module Description
48
49
50
51
52
53
54
55
56
57
58
 *  Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
 *
 *  @{
 */

#ifndef __MS_CLASS_HOST_H__
#define __MS_CLASS_HOST_H__

	/* Includes: */
		#include "../../USB.h"
		#include "../Common/MassStorage.h"
59

60
61
62
63
64
65
66
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_MS_DRIVER)
67
68
69
			#error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
		#endif

70
71
	/* Public Interface - May be used in end-application: */
		/* Macros: */
Dean Camera's avatar
Dean Camera committed
72
			/** Error code for some Mass Storage Host functions, indicating a logical (and not hardware) error. */
73
			#define MS_ERROR_LOGICAL_CMD_FAILED              0x80
74

75
76
77
78
		/* Type Defines: */
			/** \brief Mass Storage Class Host Mode Configuration and State Structure.
			 *
			 *  Class state structure. An instance of this structure should be made within the user application,
79
			 *  and passed to each of the Mass Storage class driver functions as the \c MSInterfaceInfo parameter. This
80
81
82
83
84
85
			 *  stores each Mass Storage interface's configuration and state information.
			 */
			typedef struct
			{
				const struct
				{
86
87
					uint8_t  DataINPipeNumber; /**< Pipe number of the Mass Storage interface's IN data pipe. */
					bool     DataINPipeDoubleBank; /**< Indicates if the Mass Storage interface's IN data pipe should use double banking. */
88

89
90
					uint8_t  DataOUTPipeNumber; /**< Pipe number of the Mass Storage interface's OUT data pipe. */
					bool     DataOUTPipeDoubleBank; /**< Indicates if the Mass Storage interface's OUT data pipe should use double banking. */
91
92
93
94
95
				} Config; /**< Config data for the USB class interface within the device. All elements in this section
				           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
				           */
				struct
				{
96
97
98
99
100
					bool     IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
					                    *   after \ref MS_Host_ConfigurePipes() is called and the Host state machine is in the
					                    *   Configured state.
					                    */
					uint8_t  InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device. */
101

102
103
					uint16_t DataINPipeSize; /**< Size in bytes of the Mass Storage interface's IN data pipe. */
					uint16_t DataOUTPipeSize;  /**< Size in bytes of the Mass Storage interface's OUT data pipe. */
104

105
					uint32_t TransactionTag; /**< Current transaction tag for data synchronizing of packets. */
106
107
108
109
110
				} State; /**< State data for the USB class interface within the device. All elements in this section
						  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
						  *   the interface is enumerated.
						  */
			} USB_ClassInfo_MS_Host_t;
111

112
113
114
115
			/** \brief SCSI Device LUN Capacity Structure.
			 *
			 *  SCSI capacity structure, to hold the total capacity of the device in both the number
			 *  of blocks in the current LUN, and the size of each block. This structure is filled by
116
			 *  the device when the \ref MS_Host_ReadDeviceCapacity() function is called.
117
118
119
			 */
			typedef struct
			{
120
121
				uint32_t Blocks; /**< Number of blocks in the addressed LUN of the device. */
				uint32_t BlockSize; /**< Number of bytes in each block in the addressed LUN. */
122
123
124
			} SCSI_Capacity_t;

		/* Enums: */
125
			enum MS_Host_EnumerationFailure_ErrorCodes_t
126
			{
127
128
				MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
				MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
129
				MS_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor. */
130
				MS_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
131
			};
132

133
134
135
136
137
138
139
		/* Function Prototypes: */
			/** Host interface configuration routine, to configure a given Mass Storage host interface instance using the
			 *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Mass
			 *  Storage Host instance's state values and configures the pipes required to communicate with the interface if it
			 *  is found within the device. This should be called once after the stack has enumerated the attached device, while
			 *  the host state machine is in the Addressed state.
			 *
140
141
142
			 *  \param[in,out] MSInterfaceInfo       Pointer to a structure containing an MS Class host configuration and state.
			 *  \param[in]     ConfigDescriptorSize  Length of the attached device's Configuration Descriptor.
			 *  \param[in]     ConfigDescriptorData  Pointer to a buffer containing the attached device's Configuration Descriptor.
143
			 *
144
			 *  \return A value from the \ref MS_Host_EnumerationFailure_ErrorCodes_t enum.
145
			 */
146
147
			uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
			                               uint16_t ConfigDescriptorSize,
148
			                               void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
149
150

			/** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
151
152
			 *  and readying it for the next Mass Storage command. This should be called after a failed SCSI request to 
			 *  ensure the attached Mass Storage device is ready to receive the next command.
153
			 *
154
			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
155
			 *
156
			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
157
158
159
160
161
162
163
164
165
166
167
			 */
			uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

			/** Sends a GET MAX LUN control request to the attached device, retrieving the index of the highest LUN (Logical
			 *  UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage
			 *  Host mode Class driver to address a specific LUN within the 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.
			 *
168
169
			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
			 *  \param[out]    MaxLUNIndex      Pointer to a location where the highest LUN index value should be stored.
170
			 *
171
			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
172
			 */
173
174
			uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
			                          uint8_t* const MaxLUNIndex) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
175
176
177
178

			/** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
			 *  properties.
			 *
179
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
180
			 *       call will fail.
181
			 *
182
183
184
			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
			 *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
			 *  \param[out]    InquiryData      Location where the read inquiry data should be stored.
185
			 *
186
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED.
187
			 */
188
189
			uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
			                               const uint8_t LUNIndex,
190
191
192
193
194
			                               SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1)
			                               ATTR_NON_NULL_PTR_ARG(3);

			/** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.
			 *
195
196
			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
			 *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
197
			 *
198
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
199
			 */
200
201
			uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
			                              const uint8_t LUNIndex) ATTR_NON_NULL_PTR_ARG(1);
202
203
204

			/** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.
			 *
205
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
206
			 *       call will fail.
207
			 *
208
209
210
			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
			 *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
			 *  \param[out]    DeviceCapacity   Pointer to the location where the capacity information should be stored.
211
			 *
212
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
213
			 */
214
215
			uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
			                                   const uint8_t LUNIndex,
216
217
			                                   SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1)
			                                   ATTR_NON_NULL_PTR_ARG(3);
218

219
220
221
			/** Retrieves the device sense data, indicating the current device state and error codes for the previously
			 *  issued command.
			 *
222
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
223
			 *       call will fail.
224
			 *
225
226
227
			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
			 *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
			 *  \param[out]    SenseData        Pointer to the location where the sense information should be stored.
228
			 *
229
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
230
			 */
231
232
			uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
			                             const uint8_t LUNIndex,
233
234
			                             SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1)
			                             ATTR_NON_NULL_PTR_ARG(3);
235

236
237
238
			/** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock
			 *  the device from removal so that blocks of data on the medium can be read or altered.
			 *
239
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
240
			 *       call will fail.
241
			 *
242
243
			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
			 *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
244
			 *  \param[in]     PreventRemoval   Boolean \c true if the device should be locked from removal, \c false otherwise.
245
			 *
246
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
247
			 */
248
249
			uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
			                                          const uint8_t LUNIndex,
250
			                                          const bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);
251

252
253
			/** Reads blocks of data from the attached Mass Storage device's medium.
			 *
254
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
255
			 *       call will fail.
256
			 *
257
258
259
260
261
262
			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
			 *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
			 *  \param[in]     BlockAddress     Starting block address within the device to read from.
			 *  \param[in]     Blocks           Total number of blocks to read.
			 *  \param[in]     BlockSize        Size in bytes of each block within the device.
			 *  \param[out]    BlockBuffer      Pointer to where the read data from the device should be stored.
263
			 *
264
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
265
			 */
266
267
268
269
270
			uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
			                                 const uint8_t LUNIndex,
			                                 const uint32_t BlockAddress,
			                                 const uint8_t Blocks,
			                                 const uint16_t BlockSize,
271
			                                 void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
272

273
274
			/** Writes blocks of data to the attached Mass Storage device's medium.
			 *
275
			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
276
			 *       call will fail.
277
			 *
278
279
280
281
282
283
			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
			 *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
			 *  \param[in]     BlockAddress     Starting block address within the device to write to.
			 *  \param[in]     Blocks           Total number of blocks to read.
			 *  \param[in]     BlockSize        Size in bytes of each block within the device.
			 *  \param[in]     BlockBuffer      Pointer to where the data to write should be sourced from.
284
			 *
285
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
286
			 */
287
288
289
290
291
			uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
			                                  const uint8_t LUNIndex,
			                                  const uint32_t BlockAddress,
			                                  const uint8_t Blocks,
			                                  const uint16_t BlockSize,
292
293
294
295
296
297
298
			                                  const void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);

		/* Inline Functions: */
			/** General management task for a given Mass Storage host class interface, required for the correct operation of
			 *  the interface. This should be called frequently in the main program loop, before the master USB management task
			 *  \ref USB_USBTask().
			 *
299
			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an Mass Storage Class host configuration and state.
300
			 */
Dean Camera's avatar
Dean Camera committed
301
			static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
302
303
304
305
306
307
308
309
			static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo)
			{
				(void)MSInterfaceInfo;
			}

	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Macros: */
310
			#define MS_COMMAND_DATA_TIMEOUT_MS        10000
311

312
		/* Function Prototypes: */
313
			#if defined(__INCLUDE_FROM_MASSSTORAGE_HOST_C)
314
315
				static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
				                                   MS_CommandBlockWrapper_t* const SCSICommandBlock,
316
317
				                                   const void* const BufferPtr) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
				static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
318
				static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
319
				                                       MS_CommandBlockWrapper_t* const SCSICommandBlock,
Dean Camera's avatar
Dean Camera committed
320
				                                       void* BufferPtr) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
321
				static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
322
323
				                                         MS_CommandStatusWrapper_t* const SCSICommandStatus)
				                                         ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
Dean Camera's avatar
Dean Camera committed
324
325
326
327
328

				static uint8_t DCOMP_MS_Host_NextMSInterface(void* const CurrentDescriptor)
				                                             ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
				static uint8_t DCOMP_MS_Host_NextMSInterfaceEndpoint(void* const CurrentDescriptor)
				                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
329
330
			#endif
	#endif
331

332
333
334
335
336
337
338
339
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif

#endif

/** @} */
340