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


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