projects / pub / USBasp.git / blob
? search:


8868c951569002edee085e2f830e1a3c16da6992
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / MassStorage.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2010.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2010 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 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
20
21 The author disclaim all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
28 this software.
29 */
30
31 /** \file
32 * \brief Host mode driver for the library USB Mass Storage Class driver.
33 *
34 * \note This file should not be included directly. It is automatically included as needed by the class driver
35 * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.
36 */
37
38 /** \ingroup Group_USBClassMS
39 * @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver
40 *
41 * \section Sec_Dependencies Module Source Dependencies
42 * The following files must be built with any user project that uses this module:
43 * - LUFA/Drivers/USB/Class/Host/MassStorage.c
44 *
45 * \section Module Description
46 * Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
47 *
48 * @{
49 */
50
51 #ifndef __MS_CLASS_HOST_H__
52 #define __MS_CLASS_HOST_H__
53
54 /* Includes: */
55 #include "../../USB.h"
56 #include "../Common/MassStorage.h"
57
58 /* Enable C linkage for C++ Compilers: */
59 #if defined(__cplusplus)
60 extern "C" {
61 #endif
62
63 /* Preprocessor Checks: */
64 #if !defined(__INCLUDE_FROM_MS_DRIVER)
65 #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
66 #endif
67
68 /* Public Interface - May be used in end-application: */
69 /* Macros: */
70 /** Error code for some Mass Storage Host functions, indicating a logical (and not hardware) error */
71 #define MS_ERROR_LOGICAL_CMD_FAILED 0x80
72
73 /* Type Defines: */
74 /** Class state structure. An instance of this structure should be made within the user application,
75 * and passed to each of the Mass Storage class driver functions as the MSInterfaceInfo parameter. This
76 * stores each Mass Storage interface's configuration and state information.
77 */
78 typedef struct
79 {
80 const struct
81 {
82 uint8_t DataINPipeNumber; /**< Pipe number of the Mass Storage interface's IN data pipe */
83 bool DataINPipeDoubleBank; /** Indicates if the Mass Storage interface's IN data pipe should use double banking */
84
85 uint8_t DataOUTPipeNumber; /**< Pipe number of the Mass Storage interface's OUT data pipe */
86 bool DataOUTPipeDoubleBank; /** Indicates if the Mass Storage interface's OUT data pipe should use double banking */
87 } Config; /**< Config data for the USB class interface within the device. All elements in this section
88 * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
89 */
90 struct
91 {
92 bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
93 * after \ref MS_Host_ConfigurePipes() is called and the Host state machine is in the
94 * Configured state
95 */
96 uint8_t InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device */
97
98 uint16_t DataINPipeSize; /**< Size in bytes of the Mass Storage interface's IN data pipe */
99 uint16_t DataOUTPipeSize; /**< Size in bytes of the Mass Storage interface's OUT data pipe */
100
101 uint32_t TransactionTag; /**< Current transaction tag for data synchronizing of packets */
102 } State; /**< State data for the USB class interface within the device. All elements in this section
103 * <b>may</b> be set to initial values, but may also be ignored to default to sane values when
104 * the interface is enumerated.
105 */
106 } USB_ClassInfo_MS_Host_t;
107
108 /** SCSI capacity structure, to hold the total capacity of the device in both the number
109 * of blocks in the current LUN, and the size of each block. This structure is filled by
110 * the device when the MassStore_ReadCapacity() function is called.
111 */
112 typedef struct
113 {
114 uint32_t Blocks; /**< Number of blocks in the addressed LUN of the device */
115 uint32_t BlockSize; /**< Number of bytes in each block in the addressed LUN */
116 } SCSI_Capacity_t;
117
118 /* Enums: */
119 enum MSHost_EnumerationFailure_ErrorCodes_t
120 {
121 MS_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */
122 MS_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */
123 MS_ENUMERROR_NoMSInterfaceFound = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */
124 MS_ENUMERROR_EndpointsNotFound = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */
125 };
126
127 /* Function Prototypes: */
128 /** Host interface configuration routine, to configure a given Mass Storage host interface instance using the
129 * Configuration Descriptor read from an attached USB device. This function automatically updates the given Mass
130 * Storage Host instance's state values and configures the pipes required to communicate with the interface if it
131 * is found within the device. This should be called once after the stack has enumerated the attached device, while
132 * the host state machine is in the Addressed state.
133 *
134 * \param[in,out] MSInterfaceInfo Pointer to a structure containing an MS Class host configuration and state
135 * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor
136 * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
137 *
138 * \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum
139 */
140 uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint16_t ConfigDescriptorSize,
141 void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
142
143 /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
144 * and readying it for the next Mass Storage command.
145 *
146 * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
147 *
148 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
149 */
150 uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
151
152 /** Sends a GET MAX LUN control request to the attached device, retrieving the index of the highest LUN (Logical
153 * UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage
154 * Host mode Class driver to address a specific LUN within the device.
155 *
156 * \note Some devices do not support this request, and will STALL it when issued. To get around this,
157 * on unsupported devices the max LUN index will be reported as zero and no error will be returned
158 * if the device STALLs the request.
159 *
160 * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
161 * \param[out] MaxLUNIndex Pointer to a location where the highest LUN index value should be stored
162 *
163 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
164 */
165 uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint8_t* const MaxLUNIndex)
166 ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
167
168 /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
169 * properties.
170 *
171 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
172 * call will fail.
173 *
174 * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
175 * \param[in] LUNIndex LUN index within the device the command is being issued to
176 * \param[out] InquiryData Location where the read inquiry data should be stored
177 *
178 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED
179 */
180 uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
181 SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1)
182 ATTR_NON_NULL_PTR_ARG(3);
183
184 /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.
185 *
186 * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
187 * \param[in] LUNIndex LUN index within the device the command is being issued to
188 *
189 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
190 */
191 uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex)
192 ATTR_NON_NULL_PTR_ARG(1);
193
194 /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.
195 *
196 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
197 * call will fail.
198 *
199 * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
200 * \param[in] LUNIndex LUN index within the device the command is being issued to
201 * \param[out] DeviceCapacity Pointer to the location where the capacity information should be stored
202 *
203 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
204 */
205 uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
206 SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1)
207 ATTR_NON_NULL_PTR_ARG(3);
208
209 /** Retrieves the device sense data, indicating the current device state and error codes for the previously
210 * issued command.
211 *
212 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
213 * call will fail.
214 *
215 * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
216 * \param[in] LUNIndex LUN index within the device the command is being issued to
217 * \param[out] SenseData Pointer to the location where the sense information should be stored
218 *
219 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
220 */
221 uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
222 SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1)
223 ATTR_NON_NULL_PTR_ARG(3);
224
225 /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock
226 * the device from removal so that blocks of data on the medium can be read or altered.
227 *
228 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
229 * call will fail.
230 *
231 * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
232 * \param[in] LUNIndex LUN index within the device the command is being issued to
233 * \param[in] PreventRemoval Boolean true if the device should be locked from removal, false otherwise
234 *
235 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
236 */
237 uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
238 const bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);
239
240 /** Reads blocks of data from the attached Mass Storage device's medium.
241 *
242 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
243 * call will fail.
244 *
245 * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
246 * \param[in] LUNIndex LUN index within the device the command is being issued to
247 * \param[in] BlockAddress Starting block address within the device to read from
248 * \param[in] Blocks Total number of blocks to read
249 * \param[in] BlockSize Size in bytes of each block within the device
250 * \param[out] BlockBuffer Pointer to where the read data from the device should be stored
251 *
252 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
253 */
254 uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
255 const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
256 void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
257
258 /** Writes blocks of data to the attached Mass Storage device's medium.
259 *
260 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
261 * call will fail.
262 *
263 * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
264 * \param[in] LUNIndex LUN index within the device the command is being issued to
265 * \param[in] BlockAddress Starting block address within the device to write to
266 * \param[in] Blocks Total number of blocks to read
267 * \param[in] BlockSize Size in bytes of each block within the device
268 * \param[in] BlockBuffer Pointer to where the data to write should be sourced from
269 *
270 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
271 */
272 uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
273 const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
274 void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
275
276 /* Inline Functions: */
277 /** General management task for a given Mass Storage host class interface, required for the correct operation of
278 * the interface. This should be called frequently in the main program loop, before the master USB management task
279 * \ref USB_USBTask().
280 *
281 * \param[in,out] MSInterfaceInfo Pointer to a structure containing an MS Class host configuration and state
282 */
283 static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);
284 static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo)
285 {
286 (void)MSInterfaceInfo;
287 }
288
289 /* Private Interface - For use in library only: */
290 #if !defined(__DOXYGEN__)
291 /* Macros: */
292 #define MASS_STORE_CLASS 0x08
293 #define MASS_STORE_SUBCLASS 0x06
294 #define MASS_STORE_PROTOCOL 0x50
295
296 #define REQ_MassStorageReset 0xFF
297 #define REQ_GetMaxLUN 0xFE
298
299 #define CBW_SIGNATURE 0x43425355UL
300 #define CSW_SIGNATURE 0x53425355UL
301
302 #define COMMAND_DIRECTION_DATA_OUT (0 << 7)
303 #define COMMAND_DIRECTION_DATA_IN (1 << 7)
304
305 #define COMMAND_DATA_TIMEOUT_MS 10000
306
307 #define MS_FOUND_DATAPIPE_IN (1 << 0)
308 #define MS_FOUND_DATAPIPE_OUT (1 << 1)
309
310 /* Function Prototypes: */
311 #if defined(__INCLUDE_FROM_MS_CLASS_HOST_C)
312 static uint8_t DComp_NextMSInterface(void* const CurrentDescriptor);
313 static uint8_t DComp_NextMSInterfaceEndpoint(void* const CurrentDescriptor);
314
315 static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
316 MS_CommandBlockWrapper_t* const SCSICommandBlock,
317 void* BufferPtr);
318 static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);
319 static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
320 MS_CommandBlockWrapper_t* const SCSICommandBlock, void* BufferPtr);
321 static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
322 MS_CommandStatusWrapper_t* const SCSICommandStatus);
323 #endif
324 #endif
325
326 /* Disable C linkage for C++ Compilers: */
327 #if defined(__cplusplus)
328 }
329 #endif
330
331 #endif
332
333 /** @} */
USB isp AVR programmer