1 /**
2 \defgroup   usbh_interface_gr USB Host Interface
3 \ingroup    usb_interface_gr
4 \brief      Driver API for USB Host Peripheral (%Driver_USBH.h)
5 @{
6 */
7 
8 /**
9 \struct     ARM_DRIVER_USBH
10 \details
11 The functions of the USB Host driver are accessed by function pointers. Refer to \ref DriverFunctions for
12 overview information.
13 
14 Each instance of an USBH provides such an access struct. The instance is indicated by
15 a postfix in the symbol name of the access struct, for example:
16  - \b Driver_USBH0 is the name of the access struct of the first instance (no. 0).
17  - \b Driver_USBH1 is the name of the access struct of the second instance (no. 1).
18 
19 
20 A configuration setting in the middleware allows connecting the middleware to a specific driver instance <b>Driver_USBH<i>n</i></b>.
21 The default is \token{0}, which connects a middleware to the first instance of a driver.
22 
23 \note    The struct must remain unchanged.
24 *****************************************************************************************************************/
25 
26 /**
27 \struct     ARM_USBH_CAPABILITIES
28 \details
29 A USB Host driver can be implemented with different capabilities.
30 The data fields of this structure encode the capabilities implemented by this driver.
31 
32 <b>Returned by:</b>
33   - \ref ARM_USBH_GetCapabilities
34 
35 \note    The struct must remain unchanged.
36 *****************************************************************************************************************/
37 
38 /**
39 \struct     ARM_USBH_PORT_STATE
40 \details
41 This structure stores information about the state of the USB Host Port. The data fields encode whether a device
42 is connected to the port, if port overcurrent is detected, and the port speed.
43 
44 <b>Returned by:</b>
45   - \ref ARM_USBH_PortGetState
46 *****************************************************************************************************************/
47 
48 /**
49 \typedef    uint32_t ARM_USBH_PIPE_HANDLE
50 \details
51 Each pipe is identified through a unique number, which is created by the function \ref ARM_USBH_PipeCreate.
52 
53 <b>Parameter for:</b>
54  - \ref ARM_USBH_PipeModify,
55    \ref ARM_USBH_PipeDelete,
56    \ref ARM_USBH_PipeReset,
57    \ref ARM_USBH_PipeTransfer,
58    \ref ARM_USBH_PipeTransferGetResult,
59    \ref ARM_USBH_PipeTransferAbort,
60    \ref ARM_USBH_SignalPipeEvent
61 
62 <b>Retruned by:</b>
63  - \ref ARM_USBH_PipeCreate
64 *****************************************************************************************************************/
65 
66 /**
67 \typedef    ARM_USBH_SignalPortEvent_t
68 \details
69 Provides the typedef for the callback function \ref ARM_USBH_SignalPortEvent.
70 
71 <b>Parameter for:</b>
72   - \ref ARM_USBH_Initialize
73 *******************************************************************************************************************/
74 
75 /**
76 \typedef    ARM_USBH_SignalPipeEvent_t
77 \details
78 Provides the typedef for the callback function \ref ARM_USBH_SignalPipeEvent.
79 
80 <b>Parameter for:</b>
81   - \ref ARM_USBH_Initialize
82 *******************************************************************************************************************/
83 
84 /**
85 \defgroup USBH_port_events USBH Port Events
86 \ingroup usbh_host_gr
87 \brief The USB Host driver generates Port call back events that are notified via the function \ref ARM_USBH_SignalPortEvent.
88 \details
89 This section provides the event values for the \ref ARM_USBH_SignalPortEvent callback function.
90 
91 The following call back notification events are generated:
92 @{
93 \def  ARM_USBH_EVENT_CONNECT
94 \def  ARM_USBH_EVENT_DISCONNECT
95 \def  ARM_USBH_EVENT_OVERCURRENT
96 \def  ARM_USBH_EVENT_RESET
97 \def  ARM_USBH_EVENT_SUSPEND
98 \def  ARM_USBH_EVENT_RESUME
99 \def  ARM_USBH_EVENT_REMOTE_WAKEUP
100 @}
101 */
102 
103 /**
104 \defgroup USBH_pipe_events USBH Pipe Events
105 \ingroup usbh_host_gr
106 \brief The USB Host driver generates Pipe call back events that are notified via the function \ref ARM_USBH_SignalPipeEvent.
107 \details
108 This section provides the event values for the \ref ARM_USBH_SignalPipeEvent callback function.
109 
110 The following call back notification events are generated:
111 @{
112 \def  ARM_USBH_EVENT_TRANSFER_COMPLETE
113 \def  ARM_USBH_EVENT_HANDSHAKE_NAK
114 \def  ARM_USBH_EVENT_HANDSHAKE_NYET
115 \def  ARM_USBH_EVENT_HANDSHAKE_MDATA
116 \def  ARM_USBH_EVENT_HANDSHAKE_STALL
117 \def  ARM_USBH_EVENT_HANDSHAKE_ERR
118 \def  ARM_USBH_EVENT_BUS_ERROR
119 @}
120 */
121 
122 /**
123 \defgroup USBH_packets USBH Packet Information
124 \ingroup usbh_host_gr
125 \brief Specify USB packet information used by the function \ref ARM_USBH_PipeTransfer
126 \details
127 This section provides the packet information values (parameter \em packet) for the \ref ARM_USBH_PipeTransfer function.
128 
129 The following values are defined:
130 @{
131 \def  ARM_USBH_PACKET_SETUP
132 Generate SETUP transaction.
133 \def  ARM_USBH_PACKET_OUT
134 Generate OUT transaction.
135 \def  ARM_USBH_PACKET_IN
136 Generate IN transaction.
137 \def  ARM_USBH_PACKET_PING
138 Generate PING transaction (no data packet).
139 \def  ARM_USBH_PACKET_DATA0
140 Force DATA0 PID (Packet Identifier) for the initial data packet. When not specified than the driver provides the initial value according to the current state.
141 \def  ARM_USBH_PACKET_DATA1
142 Force DATA1 PID (Packet Identifier) for the initial data packet. When not specified than the driver provides the initial value according to the current state.
143 \def  ARM_USBH_PACKET_SSPLIT
144 Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet.
145 For isochronous OUT it indicates that the High-speed data is in the middle of the Full-speed data payload.
146 \def  ARM_USBH_PACKET_SSPLIT_S
147 Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet.
148 Valid only for isochronous OUT and indicates that the High-speed data is the start of the Full-speed data payload.
149 \def  ARM_USBH_PACKET_SSPLIT_E
150 Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet.
151 Valid only for isochronous OUT and indicates that the High-speed data is the end of the Full-speed data payload.
152 \def  ARM_USBH_PACKET_SSPLIT_S_E
153 Used when driver does not support automatic handling of SPLIT packets and indicates Start-Split packet.
154 Valid only for isochronous OUT and indicates that the High-speed data is all of the Full-speed data payload.
155 \def  ARM_USBH_PACKET_CSPLIT
156 Used when driver does not support automatic handling of SPLIT packets and indicates Complete-Split packet.
157 \def  ARM_USBH_PACKET_PRE
158 Generate PRE (Preamble) for low-speed devices within a full/low-speed signaling environment.
159 @}
160 */
161 
162 
163 //
164 // Functions
165 //
166 
ARM_USBH_GetVersion(void)167 ARM_DRIVER_VERSION ARM_USBH_GetVersion (void)  {
168   return { 0, 0 };
169 }
170 /**
171 \fn     ARM_DRIVER_VERSION ARM_USBH_GetVersion (void)
172 \details
173 The function \b ARM_USBH_GetVersion returns version information of the driver implementation in \ref ARM_DRIVER_VERSION
174  - API version is the version of the CMSIS-Driver specification used to implement this driver.
175  - Driver version is source code version of the actual driver implementation.
176 
177 Example:
178 \code
179 extern ARM_DRIVER_USBH Driver_USBH0;
180 ARM_DRIVER_USBH *drv_info;
181 
182 void setup_usbh (void)  {
183   ARM_DRIVER_VERSION  version;
184 
185   drv_info = &Driver_USBH0;
186   version = drv_info->GetVersion ();
187   if (version.api < 0x10A)   {      // requires at minimum API version 1.10 or higher
188     // error handling
189     return;
190   }
191 }
192 \endcode
193 *****************************************************************************************************************/
194 
ARM_USBH_GetCapabilities(void)195 ARM_USBH_CAPABILITIES ARM_USBH_GetCapabilities (void)  {
196   return { 0 };
197 }
198 /**
199 \fn       ARM_USBH_CAPABILITIES ARM_USBH_GetCapabilities (void)
200 \details
201 The function \b ARM_USBH_GetCapabilities returns information about capabilities in this driver implementation.
202 The data fields of the structure \ref ARM_USBH_CAPABILITIES encode various capabilities, for example
203 available HUB ports or if the hardware can generate signal events using the \ref ARM_USBH_SignalPortEvent
204 callback function.
205 
206 Example:
207 \code
208 extern ARM_DRIVER_USBH Driver_USBH0;
209 ARM_DRIVER_USBH *drv_info;
210 
211 void read_capabilities (void)  {
212   ARM_USBH_CAPABILITIES drv_capabilities;
213 
214   drv_info = &Driver_USBH0;
215   drv_capabilities = drv_info->GetCapabilities ();
216   // interrogate capabilities
217 
218 }
219 \endcode
220 *****************************************************************************************************************/
221 
ARM_USBH_Initialize(ARM_USBH_SignalPortEvent_t cb_port_event,ARM_USBH_SignalPipeEvent_t cb_pipe_event)222 int32_t ARM_USBH_Initialize (ARM_USBH_SignalPortEvent_t cb_port_event,
223                              ARM_USBH_SignalPipeEvent_t cb_pipe_event)  {
224   return ARM_DRIVER_OK;
225 }
226 /**
227 \fn       int32_t ARM_USBH_Initialize (ARM_USBH_SignalPortEvent_t cb_port_event, ARM_USBH_SignalPipeEvent_t cb_pipe_event)
228 \details
229 The function \b ARM_USBH_Initialize initializes the USB Host interface.
230 It is called when the middleware component starts operation.
231 
232 The function performs the following operations:
233   - Initializes the resources needed for the USBH interface.
234   - Registers the \ref ARM_USBH_SignalPortEvent callback function.
235   - Registers the \ref ARM_USBH_SignalPipeEvent callback function.
236 
237 The parameter \em cb_port_event is a pointer to the \ref ARM_USBH_SignalPortEvent callback function; use a NULL pointer
238 when no port callback signals are required.
239 
240 The parameter \em cb_pipe_event is a pointer to the \ref ARM_USBH_SignalPipeEvent callback function.
241 
242 \b Example:
243  - see \ref usbh_interface_gr - Driver Functions
244 
245 *****************************************************************************************************************/
246 
ARM_USBH_Uninitialize(void)247 int32_t ARM_USBH_Uninitialize (void) {
248   return ARM_DRIVER_OK;
249 }
250 /**
251 \fn       int32_t ARM_USBH_Uninitialize (void)
252 \details
253 The function \b ARM_USBH_Uninitialize de-initializes the resources of USB Host interface.
254 
255 It is called when the middleware component stops operation and releases the software resources used by the interface.
256 *****************************************************************************************************************/
257 
ARM_USBH_PowerControl(ARM_POWER_STATE state)258 int32_t ARM_USBH_PowerControl (ARM_POWER_STATE state)  {
259   return ARM_DRIVER_OK;
260 }
261 /**
262 \fn int32_t ARM_USBH_PowerControl (ARM_POWER_STATE state)
263 \details
264 The function \b ARM_USBH_PowerControl operates the power modes of the USB Host interface.
265 
266 The parameter \em state sets the operation and can have the following values:
267   - \ref ARM_POWER_FULL : set-up peripheral for data transfers, enable interrupts (NVIC) and optionally DMA.
268                           Can be called multiple times. If the peripheral is already in this mode the function performs
269 						  no operation and returns with \ref ARM_DRIVER_OK.
270   - \ref ARM_POWER_LOW : may use power saving. Returns \ref ARM_DRIVER_ERROR_UNSUPPORTED when not implemented.
271   - \ref ARM_POWER_OFF : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.
272 
273 Refer to \ref CallSequence for more information.
274 *****************************************************************************************************************/
275 
ARM_USBH_PortVbusOnOff(uint8_t port,bool vbus)276 int32_t ARM_USBH_PortVbusOnOff (uint8_t port, bool vbus)  {
277   return ARM_DRIVER_OK;
278 }
279 /**
280 \fn int32_t ARM_USBH_PortVbusOnOff (uint8_t port, bool vbus)
281 \details
282 The function \b ARM_USBH_PortVbusOnOff controls the VBUS signal of the specified port.
283 *****************************************************************************************************************/
284 
ARM_USBH_PortReset(uint8_t port)285 int32_t ARM_USBH_PortReset (uint8_t port)  {
286   return ARM_DRIVER_OK;
287 }
288 /**
289 \fn int32_t ARM_USBH_PortReset (uint8_t port)
290 \details
291 Executes reset signalling on the specified port.
292 *****************************************************************************************************************/
293 
ARM_USBH_PortSuspend(uint8_t port)294 int32_t ARM_USBH_PortSuspend (uint8_t port)  {
295   return ARM_DRIVER_OK;
296 }
297 /**
298 \fn int32_t ARM_USBH_PortSuspend (uint8_t port)
299 \details
300 The function \b ARM_USBH_PortSuspend auspends USB signaling on the specified port.
301 *****************************************************************************************************************/
302 
ARM_USBH_PortResume(uint8_t port)303 int32_t ARM_USBH_PortResume (uint8_t port)  {
304   return ARM_DRIVER_OK;
305 }
306 /**
307 \fn int32_t ARM_USBH_PortResume (uint8_t port)
308 \details
309 The function \b ARM_USBH_PortResume resumes USB signaling on the specified port.
310 *****************************************************************************************************************/
311 
ARM_USBH_PortGetState(uint8_t port)312 ARM_USBH_PORT_STATE ARM_USBH_PortGetState (uint8_t port)  {
313   return 0;
314 }
315 /**
316 \fn ARM_USBH_PORT_STATE ARM_USBH_PortGetState (uint8_t port)
317 \details
318 The function \b ARM_USBH_PortGetState returns the current state of the specified port.
319 *****************************************************************************************************************/
320 
ARM_USBH_PipeCreate(uint8_t dev_addr,uint8_t dev_speed,uint8_t hub_addr,uint8_t hub_port,uint8_t ep_addr,uint8_t ep_type,uint16_t ep_max_packet_size,uint8_t ep_interval)321 ARM_USBH_PIPE_HANDLE ARM_USBH_PipeCreate (uint8_t  dev_addr,
322                                           uint8_t  dev_speed,
323                                           uint8_t  hub_addr,
324                                           uint8_t  hub_port,
325                                           uint8_t  ep_addr,
326                                           uint8_t  ep_type,
327                                           uint16_t ep_max_packet_size,
328                                           uint8_t  ep_interval)  {
329   return 0;
330 }
331 /**
332 \fn ARM_USBH_PIPE_HANDLE ARM_USBH_PipeCreate (uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval)
333 \details
334 The function \b ARM_USBH_PipeCreate creates a pipe for transfers (allocates required resources and configures the pipe).
335 
336 The parameters specify pipe information (connection between host and device endpoint):
337  - device: address and speed
338  - hub (optional): hub address and number of the hub port to which the device is connected
339  - endpoint: address, type, maximum packet size and polling interval
340 
341 The function returns an pipe handle that is used for all subsequent operations on that pipe.
342 In case of errors an invalid handle (\em NULL) is returned.
343 *****************************************************************************************************************/
344 
ARM_USBH_PipeModify(ARM_USBH_PIPE_HANDLE pipe_hndl,uint8_t dev_addr,uint8_t dev_speed,uint8_t hub_addr,uint8_t hub_port,uint16_t ep_max_packet_size)345 int32_t ARM_USBH_PipeModify (ARM_USBH_PIPE_HANDLE pipe_hndl,
346                              uint8_t              dev_addr,
347                              uint8_t              dev_speed,
348                              uint8_t              hub_addr,
349                              uint8_t              hub_port,
350                              uint16_t             ep_max_packet_size)  {
351   return ARM_DRIVER_OK;
352 }
353 /**
354 \fn int32_t ARM_USBH_PipeModify (ARM_USBH_PIPE_HANDLE pipe_hndl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size)
355 \details
356 The function \b ARM_USBH_PipeModify modifies a pipe configuration that was created with \ref ARM_USBH_PipeCreate.
357 *****************************************************************************************************************/
358 
ARM_USBH_PipeDelete(ARM_USBH_PIPE_HANDLE pipe_hndl)359 int32_t ARM_USBH_PipeDelete (ARM_USBH_PIPE_HANDLE pipe_hndl)  {
360   return ARM_DRIVER_OK;
361 }
362 /**
363 \fn int32_t ARM_USBH_PipeDelete (ARM_USBH_PIPE_HANDLE pipe_hndl)
364 \details
365 The function \b ARM_USBH_PipeDelete deletes a pipe that was created with \ref ARM_USBH_PipeCreate (deactivates the pipe and releases used resources).
366 *****************************************************************************************************************/
367 
ARM_USBH_PipeReset(ARM_USBH_PIPE_HANDLE pipe_hndl)368 int32_t ARM_USBH_PipeReset (ARM_USBH_PIPE_HANDLE pipe_hndl)  {
369   return ARM_DRIVER_OK;
370 }
371 /**
372 \fn int32_t ARM_USBH_PipeReset (ARM_USBH_PIPE_HANDLE pipe_hndl)
373 \details
374 The function \b ARM_USBH_PipeReset clears Halt condition and resets data toggle on the specified pipe.
375 *****************************************************************************************************************/
376 
ARM_USBH_PipeTransfer(ARM_USBH_PIPE_HANDLE pipe_hndl,uint32_t packet,uint8_t * data,uint32_t num)377 int32_t ARM_USBH_PipeTransfer (ARM_USBH_PIPE_HANDLE pipe_hndl,
378                                uint32_t packet,
379                                uint8_t *data,
380                                uint32_t num)  {
381   return ARM_DRIVER_OK;
382 }
383 /**
384 \fn int32_t ARM_USBH_PipeTransfer (ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t packet, uint8_t *data, uint32_t num)
385 \details
386 The function \b ARM_USBH_PipeTransfer generates packets for sending or receiving data from an USB Endpoint.
387 
388 The function specifies the buffer with data to send or for data to receive and the number of bytes to transfer (must be multiple of device endpoint maximum packet size for receive).
389 It also specifies \ref USBH_packets with parameter \em packet.
390 
391 The function is non-blocking and returns as soon as the driver starts the operation on the specified pipe. During the operation it is not allowed to call this function again on the same pipe. Also the data buffer must stay allocated and the contents of data must not be modified.
392 
393 Operation is completed when the the requested number of data bytes have been transferred and is indicated with \ref ARM_USBH_EVENT_TRANSFER_COMPLETE event.
394 It can also finish earlier on reception of different handshake tokens which are also indicated through \ref USBH_pipe_events.
395 
396 Transfer operation can be aborted by calling \ref ARM_USBH_PipeTransferAbort.
397 *****************************************************************************************************************/
398 
ARM_USBH_PipeTransferGetResult(ARM_USBH_PIPE_HANDLE pipe_hndl)399 uint32_t ARM_USBH_PipeTransferGetResult (ARM_USBH_PIPE_HANDLE pipe_hndl)  {
400   return 0;
401 }
402 /**
403 \fn uint32_t ARM_USBH_PipeTransferGetResult (ARM_USBH_PIPE_HANDLE pipe_hndl)
404 \details
405 The function \b ARM_USBH_PipeTransferGetResult returns the number of successfully transferred data bytes started by \ref ARM_USBH_PipeTransfer operation.
406 *****************************************************************************************************************/
407 
ARM_USBH_PipeTransferAbort(ARM_USBH_PIPE_HANDLE pipe_hndl)408 int32_t ARM_USBH_PipeTransferAbort (ARM_USBH_PIPE_HANDLE pipe_hndl)  {
409   return ARM_DRIVER_OK;
410 }
411 /**
412 \fn int32_t ARM_USBH_PipeTransferAbort (ARM_USBH_PIPE_HANDLE pipe_hndl)
413 \details
414 
415 The function \b ARM_USBH_PipeTransferAbort aborts an active pipe transfer started by \ref ARM_USBH_PipeTransfer.
416 *****************************************************************************************************************/
417 
ARM_USBH_GetFrameNumber(void)418 uint16_t ARM_USBH_GetFrameNumber (void)  {
419   return 0;
420 }
421 /**
422 \fn uint16_t ARM_USBH_GetFrameNumber (void)
423 \details
424 The function \b ARM_USBH_GetFrameNumber returns the sequential 11-bit frame number of the last Start of Frame (SOF) packet.
425 *****************************************************************************************************************/
426 
ARM_USBH_SignalPortEvent(uint8_t port,uint32_t event)427 void ARM_USBH_SignalPortEvent (uint8_t port, uint32_t event)  {
428   // function body
429 }
430 /**
431 \fn void ARM_USBH_SignalPortEvent (uint8_t port, uint32_t event)
432 \details
433 The function \b ARM_USBH_SignalPortEvent is a callback function registered by the function \ref ARM_USBH_Initialize.
434 
435 The parameter \em port specifies the root hub port number. \n
436 The parameter \em event indicates one or more events that occurred during driver operation.
437 Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.
438 
439 Not every event is necessarily generated by the driver. This depends on the implemented capabilities stored in the
440 data fields of the structure \ref ARM_USBH_CAPABILITIES, which can be retrieved with the function \ref ARM_USBH_GetCapabilities.
441 
442 The following events can be generated:
443 
444 Parameter \em event               | Bit | Description                                                                | supported when ARM_USBH_CAPABILITIES
445 :---------------------------------|:---:|:---------------------------------------------------------------------------|---------------------------------------
446 \ref ARM_USBH_EVENT_CONNECT       |  0  | Occurs when USB Device connects to the Host.                               | data field \em event_connect=\token{1}
447 \ref ARM_USBH_EVENT_DISCONNECT    |  1  | Occurs when USB Device disconnects from the Host.                          | data field \em event_disconnect=\token{1}
448 \ref ARM_USBH_EVENT_OVERCURRENT   |  2  | Occurs when USB Overcurrent it detected.                                   | data field \em event_overcurrent=\token{1}
449 \ref ARM_USBH_EVENT_RESET         |  3  | Occurs when USB Reset is completed after calling \ref ARM_USBH_PortReset.  | <i>always supported</i>
450 \ref ARM_USBH_EVENT_SUSPEND       |  4  | Occurs when USB Suspend is detected.                                       | <i>always supported</i>
451 \ref ARM_USBH_EVENT_RESUME        |  5  | Occurs when USB Resume is detected.                                        | <i>always supported</i>
452 \ref ARM_USBH_EVENT_REMOTE_WAKEUP |  6  | Occurs when USB Remote wakeup is detected.                                 | <i>always supported</i>
453 *****************************************************************************************************************/
454 
ARM_USBH_SignalPipeEvent(ARM_USBH_PIPE_HANDLE pipe_hndl,uint32_t event)455 void ARM_USBH_SignalPipeEvent (ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t event)  {
456   // function body
457 }
458 /**
459 \fn void ARM_USBH_SignalPipeEvent (ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t event)
460 \details
461 The function \b ARM_USBH_SignalPipeEvent is a callback function registered by the function \ref ARM_USBH_Initialize.
462 
463 The parameter \em pipe_hndl specifies the pipe handle. \n
464 The parameter \em event indicates one or more events that occurred during driver operation.
465 Each event is encoded in a separate bit and therefore it is possible to signal multiple events within the same call.
466 
467 The following events can be generated:
468 
469 Parameter \em event                       | Bit| Description
470 :-----------------------------------------|---:|:-----------
471 \ref ARM_USBH_EVENT_TRANSFER_COMPLETE     | 0  | Occurs after all the data has been transferred without errors.
472 \ref ARM_USBH_EVENT_HANDSHAKE_NAK         | 1  | Occurs when NAK Handshake is received before all the data is transferred.
473 \ref ARM_USBH_EVENT_HANDSHAKE_NYET        | 2  | Occurs when NYET Handshake is received before all the data is transferred.
474 \ref ARM_USBH_EVENT_HANDSHAKE_MDATA       | 3  | Occurs when MDATA Handshake is received before all the data is transferred.
475 \ref ARM_USBH_EVENT_HANDSHAKE_STALL       | 4  | Occurs when STALL Handshake is received before all the data is transferred.
476 \ref ARM_USBH_EVENT_HANDSHAKE_ERR         | 5  | Occurs when ERR Handshake is received before all the data is transferred.
477 \ref ARM_USBH_EVENT_BUS_ERROR             | 6  | Occurs when bus error is detected before all the data is transferred.
478 
479 <b>See also:</b>
480  - ARM_USBH_PipeCreate
481 *****************************************************************************************************************/
482 
483 /**
484 @}
485 */
486 // End USBH Interface
487