Pipe_UC3.h 38.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/*
             LUFA Library
     Copyright (C) Dean Camera, 2011.

  dean [at] fourwalledcubicle [dot] com
           www.lufa-lib.org
*/

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

  Permission to use, copy, modify, distribute, and sell this
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in
  all copies and that both that the copyright notice and this
  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
  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
32
33
 *  \brief USB Pipe definitions for the AVR32 UC3 microcontrollers.
 *  \copydetails Group_PipeManagement_UC3
34
35
36
37
38
39
 *
 *  \note This file should not be included directly. It is automatically included as needed by the USB driver
 *        dispatch header located in LUFA/Drivers/USB/USB.h.
 */

/** \ingroup Group_PipeRW
40
41
 *  \defgroup Group_PipeRW_UC3 Pipe Data Reading and Writing (UC3)
 *  \brief Pipe data read/write definitions for the Atmel AVR32 UC3 architecture.
42
43
44
45
46
 *
 *  Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
 */

/** \ingroup Group_PipePrimitiveRW
47
48
 *  \defgroup Group_PipePrimitiveRW_UC3 Read/Write of Primitive Data Types (UC3)
 *  \brief Pipe primative data read/write definitions for the Atmel AVR32 UC3 architecture.
49
50
51
52
53
54
 *
 *  Functions, macros, variables, enums and types related to data reading and writing of primitive data types
 *  from and to pipes.
 */

/** \ingroup Group_PipePacketManagement
55
56
 *  \defgroup Group_PipePacketManagement_UC3 Pipe Packet Management (UC3)
 *  \brief Pipe packet management definitions for the Atmel AVR32 UC3 architecture.
57
58
59
60
61
 *
 *  Functions, macros, variables, enums and types related to packet management of pipes.
 */

/** \ingroup Group_PipeControlReq
62
63
 *  \defgroup Group_PipeControlReq_UC3 Pipe Control Request Management (UC3)
 *  \brief Pipe control request management definitions for the Atmel AVR32 UC3 architecture.
64
65
66
67
68
69
70
71
 *
 *  Module for host mode request processing. This module allows for the transmission of standard, class and
 *  vendor control requests to the default control endpoint of an attached device while in host mode.
 *
 *  \see Chapter 9 of the USB 2.0 specification.
 */

/** \ingroup Group_PipeManagement
72
73
 *  \defgroup Group_PipeManagement_UC3 Pipe Management (UC3)
 *  \brief Pipe management definitions for the Atmel AVR32 UC3 architecture.
74
75
76
77
78
79
80
81
 *
 *  This module contains functions, macros and enums related to pipe management when in USB Host mode. This
 *  module contains the pipe management macros, as well as pipe interrupt and data send/receive functions
 *  for various data types.
 *
 *  @{
 */

82
83
#ifndef __PIPE_UC3_H__
#define __PIPE_UC3_H__
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

	/* Includes: */
		#include "../../../../Common/Common.h"
		#include "../USBTask.h"

	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

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

99
100
	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
101
		/* Macros: */
102
			#define PIPE_HSB_ADDRESS_SPACE_SIZE     (64 * 1024UL)
103
	
104
		/* External Variables: */
105
			extern volatile uint32_t USB_SelectedPipe;
106
			extern volatile uint8_t* USB_PipeFIFOPos[];
107
108
	#endif

109
110
111
112
113
	/* Public Interface - May be used in end-application: */
		/* Macros: */
			/** \name Pipe Error Flag Masks */
			//@{
			/** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */
114
			#define PIPE_ERRORFLAG_OVERFLOW         (AVR32_USBB_UPSTA0_OVERFI_MASK << 8)
115
116

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */
117
			#define PIPE_ERRORFLAG_CRC16            AVR32_USBB_UPERR0_CRC16_MASK
118
119

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */
120
			#define PIPE_ERRORFLAG_TIMEOUT          AVR32_USBB_UPERR0_TIMEOUT_MASK
121
122

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */
123
			#define PIPE_ERRORFLAG_PID              AVR32_USBB_UPERR0_PID_MASK
124
125

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */
126
			#define PIPE_ERRORFLAG_DATAPID          AVR32_USBB_UPERR0_DATAPID_MASK
127
128

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */
129
			#define PIPE_ERRORFLAG_DATATGL          AVR32_USBB_UPERR0_DATATGL_MASK
130
131
132
133
134
135
136
			//@}

			/** \name Pipe Token Masks */
			//@{
			/** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes),
			 *  which will trigger a control request on the attached device when data is written to the pipe.
			 */
137
			#define PIPE_TOKEN_SETUP                AVR32_USBB_UPCFG0_PTOKEN_SETUP
138
139
140
141

			/** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),
			 *  indicating that the pipe data will flow from device to host.
			 */
142
			#define PIPE_TOKEN_IN                   AVR32_USBB_UPCFG0_PTOKEN_IN
143
144
145
146

			/** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a OUT token (for non-CONTROL type pipes),
			 *  indicating that the pipe data will flow from host to device.
			 */
147
			#define PIPE_TOKEN_OUT                  AVR32_USBB_UPCFG0_PTOKEN_OUT
148
149
150
151
152
153
154
155
			//@}
			
			/** \name Pipe Bank Mode Masks */
			//@{
			/** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe
			 *  should have one single bank, which requires less USB FIFO memory but results in slower transfers as
			 *  only one USB device (the AVR or the attached device) can access the pipe's bank at the one time.
			 */
156
			#define PIPE_BANK_SINGLE                AVR32_USBB_UPCFG0_PBK_SINGLE
157
158
159
160
161
162

			/** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe
			 *  should have two banks, which requires more USB FIFO memory but results in faster transfers as one
			 *  USB device (the AVR or the attached device) can access one bank while the other accesses the second
			 *  bank.
			 */
163
			#define PIPE_BANK_DOUBLE                AVR32_USBB_UPCFG0_PBK_DOUBLE
164
165
166
167
168
169
170
			//@}

			/** Default size of the default control pipe's bank, until altered by the Endpoint0Size value
			 *  in the device descriptor of the attached device.
			 */
			#define PIPE_CONTROLPIPE_DEFAULT_SIZE   64

171
172
173
174
175
176
177
178
			#if defined(USB_SERIES_UC3A3_AVR) || defined(USB_SERIES_UC3A4_AVR) || defined(__DOXYGEN__)
				/** Total number of pipes (including the default control pipe at address 0) which may be used in
				 *  the device.
				 */
				#define PIPE_TOTAL_PIPES            8
			#else
				#define PIPE_TOTAL_PIPES            7			
			#endif
179
180
181
182

			/** Size in bytes of the largest pipe bank size possible in the device. Not all banks on each AVR
			 *  model supports the largest bank size possible on the device; different pipe numbers support
			 *  different maximum bank sizes. This value reflects the largest possible bank of any pipe on the
183
			 *  currently selected UC3 AVR model.
184
185
186
187
188
189
			 */
			#define PIPE_MAX_SIZE                   256

		/* Enums: */
			/** Enum for the possible error return codes of the \ref Pipe_WaitUntilReady() function.
			 *
190
			 *  \ingroup Group_PipeRW_UC3
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
			 */
			enum Pipe_WaitUntilReady_ErrorCodes_t
			{
				PIPE_READYWAIT_NoError                 = 0, /**< Pipe ready for next packet, no error. */
				PIPE_READYWAIT_PipeStalled             = 1,	/**< The device stalled the pipe while waiting. */
				PIPE_READYWAIT_DeviceDisconnected      = 2,	/**< Device was disconnected from the host while waiting. */
				PIPE_READYWAIT_Timeout                 = 3, /**< The device failed to accept or send the next packet
				                                             *   within the software timeout period set by the
				                                             *   \ref USB_STREAM_TIMEOUT_MS macro.
				                                             */
			};

		/* Inline Functions: */
			/** Indicates the number of bytes currently stored in the current pipes's selected bank.
			 *
			 *  \note The return width of this function may differ, depending on the maximum pipe bank size
			 *        of the selected AVR model.
			 *
209
			 *  \ingroup Group_PipeRW_UC3
210
211
212
213
214
215
			 *
			 *  \return Total number of bytes in the currently selected pipe's FIFO buffer.
			 */
			static inline uint16_t Pipe_BytesInPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint16_t Pipe_BytesInPipe(void)
			{
216
				return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].pbyct;
217
218
219
220
221
222
223
224
225
226
			}

			/** Returns the pipe address of the currently selected pipe. This is typically used to save the
			 *  currently selected pipe number so that it can be restored after another pipe has been manipulated.
			 *
			 *  \return Index of the currently selected pipe.
			 */
			static inline uint8_t Pipe_GetCurrentPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Pipe_GetCurrentPipe(void)
			{
227
				return USB_SelectedPipe;
228
229
230
231
232
233
234
235
236
237
			}

			/** Selects the given pipe number. Any pipe operations which do not require the pipe number to be
			 *  indicated will operate on the currently selected pipe.
			 *
			 *  \param[in] PipeNumber  Index of the pipe to select.
			 */
			static inline void Pipe_SelectPipe(const uint8_t PipeNumber) ATTR_ALWAYS_INLINE;
			static inline void Pipe_SelectPipe(const uint8_t PipeNumber)
			{
238
				USB_SelectedPipe = PipeNumber;
239
240
241
242
243
244
245
246
247
			}

			/** Resets the desired pipe, including the pipe banks and flags.
			 *
			 *  \param[in] PipeNumber  Index of the pipe to reset.
			 */
			static inline void Pipe_ResetPipe(const uint8_t PipeNumber) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ResetPipe(const uint8_t PipeNumber)
			{
248
249
				AVR32_USBB.uprst |=  (AVR32_USBB_PRST0_MASK << PipeNumber);
				AVR32_USBB.uprst &= ~(AVR32_USBB_PRST0_MASK << PipeNumber);
250
				USB_PipeFIFOPos[USB_SelectedPipe] = &AVR32_USBB_SLAVE[USB_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
251
252
253
254
255
256
257
258
259
260
			}

			/** Enables the currently selected pipe so that data can be sent and received through it to and from
			 *  an attached device.
			 *
			 *  \pre The currently selected pipe must first be configured properly via \ref Pipe_ConfigurePipe().
			 */
			static inline void Pipe_EnablePipe(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_EnablePipe(void)
			{
261
				AVR32_USBB.uprst |=  (AVR32_USBB_PEN0_MASK << USB_SelectedPipe);
262
263
264
265
266
267
268
269
			}

			/** Disables the currently selected pipe so that data cannot be sent and received through it to and
			 *  from an attached device.
			 */
			static inline void Pipe_DisablePipe(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_DisablePipe(void)
			{
270
				AVR32_USBB.uprst &= ~(AVR32_USBB_PEN0_MASK << USB_SelectedPipe);
271
272
273
274
275
276
277
278
279
			}

			/** Determines if the currently selected pipe is enabled, but not necessarily configured.
			 *
			 * \return Boolean \c true if the currently selected pipe is enabled, \c false otherwise.
			 */
			static inline bool Pipe_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsEnabled(void)
			{
280
				return ((AVR32_USBB.uprst & (AVR32_USBB_PEN0_MASK << USB_SelectedPipe)) ? true : false);
281
282
283
284
285
286
			}

			/** Gets the current pipe token, indicating the pipe's data direction and type.
			 *
			 *  \return The current pipe token, as a \c PIPE_TOKEN_* mask.
			 */
287
			static inline uint8_t Pipe_GetPipeToken(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
288
289
			static inline uint8_t Pipe_GetPipeToken(void)
			{
290
				return (&AVR32_USBB.UPCFG0)[USB_SelectedPipe].ptoken;
291
292
293
294
295
296
297
298
299
300
301
302
			}

			/** Sets the token for the currently selected pipe to one of the tokens specified by the \c PIPE_TOKEN_*
			 *  masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during
			 *  control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices
			 *  which have two endpoints of opposite direction sharing the same endpoint address within the device.
			 *
			 *  \param[in] Token  New pipe token to set the selected pipe to, as a \c PIPE_TOKEN_* mask.
			 */
			static inline void Pipe_SetPipeToken(const uint8_t Token) ATTR_ALWAYS_INLINE;
			static inline void Pipe_SetPipeToken(const uint8_t Token)
			{
303
				(&AVR32_USBB.UPCFG0)[USB_SelectedPipe].ptoken = Token;
304
305
306
307
308
309
			}

			/** Configures the currently selected pipe to allow for an unlimited number of IN requests. */
			static inline void Pipe_SetInfiniteINRequests(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_SetInfiniteINRequests(void)
			{
310
				(&AVR32_USBB.UPINRQ0)[USB_SelectedPipe].inmode = true;
311
312
313
314
315
316
317
318
319
320
			}

			/** Configures the currently selected pipe to only allow the specified number of IN requests to be
			 *  accepted by the pipe before it is automatically frozen.
			 *
			 *  \param[in] TotalINRequests  Total number of IN requests that the pipe may receive before freezing.
			 */
			static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests) ATTR_ALWAYS_INLINE;
			static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests)
			{
321
322
				(&AVR32_USBB.UPINRQ0)[USB_SelectedPipe].inmode = false;
				(&AVR32_USBB.UPINRQ0)[USB_SelectedPipe].inrq   = TotalINRequests;
323
324
325
326
327
328
329
330
331
			}

			/** Determines if the currently selected pipe is configured.
			 *
			 *  \return Boolean \c true if the selected pipe is configured, \c false otherwise.
			 */
			static inline bool Pipe_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsConfigured(void)
			{
332
				return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].cfgok;
333
334
335
336
337
338
339
340
341
342
			}

			/** Retrieves the endpoint number of the endpoint within the attached device that the currently selected
			 *  pipe is bound to.
			 *
			 *  \return Endpoint number the currently selected pipe is bound to.
			 */
			static inline uint8_t Pipe_BoundEndpointNumber(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Pipe_BoundEndpointNumber(void)
			{
343
				return (&AVR32_USBB.UPCFG0)[USB_SelectedPipe].pepnum;
344
345
346
347
348
349
350
351
352
			}

			/** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.
			 *
			 *  \param[in] Milliseconds  Number of milliseconds between each pipe poll.
			 */
			static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds) ATTR_ALWAYS_INLINE;
			static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds)
			{
353
				(&AVR32_USBB.UPCFG0)[USB_SelectedPipe].intfrq = Milliseconds;
354
355
356
357
358
359
360
361
362
363
			}

			/** Returns a mask indicating which pipe's interrupt periods have elapsed, indicating that the pipe should
			 *  be serviced.
			 *
			 *  \return Mask whose bits indicate which pipes have interrupted.
			 */
			static inline uint8_t Pipe_GetPipeInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Pipe_GetPipeInterrupts(void)
			{
364
365
366
367
				return ((AVR32_USBB.uhint & (AVR32_USBB_P6INT_MASK | AVR32_USBB_P5INT_MASK |
				                             AVR32_USBB_P4INT_MASK | AVR32_USBB_P3INT_MASK |
				                             AVR32_USBB_P2INT_MASK | AVR32_USBB_P1INT_MASK |
				                             AVR32_USBB_P0INT_MASK)) >> AVR32_USBB_P0INT_OFFSET);
368
369
370
371
372
373
374
375
376
377
378
379
			}

			/** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type
			 *  pipes).
			 *
			 *  \param[in] PipeNumber  Index of the pipe whose interrupt flag should be tested.
			 *
			 *  \return Boolean \c true if the specified pipe has interrupted, \c false otherwise.
			 */
			static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber)
			{
380
				return ((AVR32_USBB.uhint & (AVR32_USBB_P0INTES_MASK << USB_SelectedPipe)) ? true : false);
381
382
383
384
385
386
			}

			/** Unfreezes the selected pipe, allowing it to communicate with an attached device. */
			static inline void Pipe_Unfreeze(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Unfreeze(void)
			{
387
				(&AVR32_USBB.UPCON0CLR)[USB_SelectedPipe].pfreezec = true;
388
389
390
391
392
393
			}

			/** Freezes the selected pipe, preventing it from communicating with an attached device. */
			static inline void Pipe_Freeze(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Freeze(void)
			{
394
				(&AVR32_USBB.UPCON0SET)[USB_SelectedPipe].pfreezes = true;
395
396
397
398
399
400
401
402
403
			}

			/** Determines if the currently selected pipe is frozen, and not able to accept data.
			 *
			 *  \return Boolean \c true if the currently selected pipe is frozen, \c false otherwise.
			 */
			static inline bool Pipe_IsFrozen(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsFrozen(void)
			{
404
				return (((&AVR32_USBB.UPCON0)[USB_SelectedPipe].pfreeze) ? true : false);
405
406
			}

407
			/** Clears the error flags for the currently selected pipe. */
408
409
410
			static inline void Pipe_ClearError(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearError(void)
			{
411
412
				(&AVR32_USBB.uperr0)[USB_SelectedPipe] = 0;
				(&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].overfic  = true;
413
414
415
416
417
418
419
420
421
422
423
424
			}

			/** Determines if the master pipe error flag is set for the currently selected pipe, indicating that
			 *  some sort of hardware error has occurred on the pipe.
			 *
			 *  \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.
			 *
			 *  \return Boolean \c true if an error has occurred on the selected pipe, \c false otherwise.
			 */
			static inline bool Pipe_IsError(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsError(void)
			{
425
				return (((&AVR32_USBB.upsta0)[USB_SelectedPipe] &
426
				        (AVR32_USBB_PERRI_MASK | AVR32_USBB_OVERFI_MASK)) ? true : false);
427
428
429
430
431
432
433
434
435
436
			}

			/** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This
			 *  value can then be masked against the \c PIPE_ERRORFLAG_* masks to determine what error has occurred.
			 *
			 *  \return  Mask comprising of \c PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe.
			 */
			static inline uint8_t Pipe_GetErrorFlags(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Pipe_GetErrorFlags(void)
			{
437
				
438
				return (((&AVR32_USBB.uperr0)[USB_SelectedPipe] &
439
440
441
				        (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT |
				         PIPE_ERRORFLAG_PID   | PIPE_ERRORFLAG_DATAPID |
				         PIPE_ERRORFLAG_DATATGL)) |
442
				        (((&AVR32_USBB.upsta0)[USB_SelectedPipe] << 8) &
443
						 PIPE_ERRORFLAG_OVERFLOW));
444
445
446
447
448
449
			}
			
			/** Retrieves the number of busy banks in the currently selected pipe, which have been queued for
			 *  transmission via the \ref Pipe_ClearOUT() command, or are awaiting acknowledgement via the
			 *  \ref Pipe_ClearIN() command.
			 *
450
			 *  \ingroup Group_PipePacketManagement_UC3
451
452
453
			 *
			 *  \return Total number of busy banks in the selected pipe.
			 */
454
			static inline uint8_t Pipe_GetBusyBanks(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
455
456
			static inline uint8_t Pipe_GetBusyBanks(void)
			{
457
				return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].nbusybk;
458
459
460
461
462
463
464
465
466
467
			}

			/** Determines if the currently selected pipe may be read from (if data is waiting in the pipe
			 *  bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT
			 *  direction). This function will return false if an error has occurred in the pipe, or if the pipe
			 *  is an IN direction and no packet (or an empty packet) has been received, or if the pipe is an OUT
			 *  direction and the pipe bank is full.
			 *
			 *  \note This function is not valid on CONTROL type pipes.
			 *
468
			 *  \ingroup Group_PipePacketManagement_UC3
469
470
471
472
473
474
475
			 *
			 *  \return Boolean \c true if the currently selected pipe may be read from or written to, depending
			 *          on its direction.
			 */
			static inline bool Pipe_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsReadWriteAllowed(void)
			{
476
				return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].rwall;
477
478
479
480
			}

			/** Determines if a packet has been received on the currently selected IN pipe from the attached device.
			 *
481
			 *  \ingroup Group_PipePacketManagement_UC3
482
483
484
485
486
487
			 *
			 *  \return Boolean \c true if the current pipe has received an IN packet, \c false otherwise.
			 */
			static inline bool Pipe_IsINReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsINReceived(void)
			{
488
				return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].rxini;
489
490
491
492
			}

			/** Determines if the currently selected OUT pipe is ready to send an OUT packet to the attached device.
			 *
493
			 *  \ingroup Group_PipePacketManagement_UC3
494
495
496
497
498
499
			 *
			 *  \return Boolean \c true if the current pipe is ready for an OUT packet, \c false otherwise.
			 */
			static inline bool Pipe_IsOUTReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsOUTReady(void)
			{
500
				return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].txouti;
501
502
503
504
505
			}

			/** Determines if no SETUP request is currently being sent to the attached device on the selected
			 *  CONTROL type pipe.
			 *
506
			 *  \ingroup Group_PipePacketManagement_UC3
507
508
509
510
511
512
			 *
			 *  \return Boolean \c true if the current pipe is ready for a SETUP packet, \c false otherwise.
			 */
			static inline bool Pipe_IsSETUPSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsSETUPSent(void)
			{
513
				return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].txstpi;
514
515
516
517
			}

			/** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.
			 *
518
			 *  \ingroup Group_PipePacketManagement_UC3
519
520
521
522
			 */
			static inline void Pipe_ClearSETUP(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearSETUP(void)
			{
523
				(&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].txstpic = true;
524
				USB_PipeFIFOPos[USB_SelectedPipe] = &AVR32_USBB_SLAVE[USB_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
525
526
527
528
529
			}

			/** Acknowledges the reception of a setup IN request from the attached device on the currently selected
			 *  pipe, freeing the bank ready for the next packet.
			 *
530
			 *  \ingroup Group_PipePacketManagement_UC3
531
532
533
534
			 */
			static inline void Pipe_ClearIN(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearIN(void)
			{
535
536
				(&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].rxinic   = true;
				(&AVR32_USBB.UPCON0CLR)[USB_SelectedPipe].fifoconc = true;
537
				USB_PipeFIFOPos[USB_SelectedPipe] = &AVR32_USBB_SLAVE[USB_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
538
539
540
541
542
			}

			/** Sends the currently selected pipe's contents to the device as an OUT packet on the selected pipe, freeing
			 *  the bank ready for the next packet.
			 *
543
			 *  \ingroup Group_PipePacketManagement_UC3
544
545
546
547
			 */
			static inline void Pipe_ClearOUT(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearOUT(void)
			{
548
549
				(&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].txoutic  = true;
				(&AVR32_USBB.UPCON0CLR)[USB_SelectedPipe].fifoconc = true;
550
				USB_PipeFIFOPos[USB_SelectedPipe] = &AVR32_USBB_SLAVE[USB_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
551
552
553
554
555
556
557
558
			}

			/** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on
			 *  the currently selected pipe. This occurs when the host sends a packet to the device, but the device
			 *  is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been
			 *  received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet
			 *  can be re-sent.
			 *
559
			 *  \ingroup Group_PipePacketManagement_UC3
560
561
562
563
564
565
			 *
			 *  \return Boolean \c true if an NAK has been received on the current pipe, \c false otherwise.
			 */
			static inline bool Pipe_IsNAKReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsNAKReceived(void)
			{
566
				return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].nakedi;
567
568
569
570
			}

			/** Clears the NAK condition on the currently selected pipe.
			 *
571
			 *  \ingroup Group_PipePacketManagement_UC3
572
573
574
575
576
577
			 *
			 *  \see \ref Pipe_IsNAKReceived() for more details.
			 */
			static inline void Pipe_ClearNAKReceived(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearNAKReceived(void)
			{
578
				(&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].nakedic = true;
579
580
581
582
			}

			/** Determines if the currently selected pipe has had the STALL condition set by the attached device.
			 *
583
			 *  \ingroup Group_PipePacketManagement_UC3
584
585
586
587
588
589
			 *
			 *  \return Boolean \c true if the current pipe has been stalled by the attached device, \c false otherwise.
			 */
			static inline bool Pipe_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsStalled(void)
			{
590
				return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].rxstalldi;
591
592
593
594
595
			}

			/** Clears the STALL condition detection flag on the currently selected pipe, but does not clear the
			 *  STALL condition itself (this must be done via a ClearFeature control request to the device).
			 *
596
			 *  \ingroup Group_PipePacketManagement_UC3
597
598
599
600
			 */
			static inline void Pipe_ClearStall(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearStall(void)
			{
601
				(&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].rxstalldic = true;
602
				USB_PipeFIFOPos[USB_SelectedPipe] = &AVR32_USBB_SLAVE[USB_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
603
604
605
606
			}

			/** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.
			 *
607
			 *  \ingroup Group_PipePrimitiveRW_UC3
608
609
610
			 *
			 *  \return Next byte in the currently selected pipe's FIFO buffer.
			 */
611
612
			static inline uint8_t Pipe_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Pipe_Read_8(void)
613
			{
614
				return *(USB_PipeFIFOPos[USB_SelectedPipe]++);
615
616
617
618
			}

			/** Writes one byte from the currently selected pipe's bank, for IN direction pipes.
			 *
619
			 *  \ingroup Group_PipePrimitiveRW_UC3
620
			 *
621
			 *  \param[in] Data  Data to write into the the currently selected pipe's FIFO buffer.
622
			 */
623
624
			static inline void Pipe_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Write_8(const uint8_t Data)
625
			{
626
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = Data;
627
628
629
630
			}

			/** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.
			 *
631
			 *  \ingroup Group_PipePrimitiveRW_UC3
632
			 */
633
634
			static inline void Pipe_Discard_8(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Discard_8(void)
635
636
637
			{
				uint8_t Dummy;

638
				Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
639
640
641
642
643
			}

			/** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT
			 *  direction pipes.
			 *
644
			 *  \ingroup Group_PipePrimitiveRW_UC3
645
			 *
646
			 *  \return Next two bytes in the currently selected pipe's FIFO buffer.
647
			 */
648
649
			static inline uint16_t Pipe_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint16_t Pipe_Read_16_LE(void)
650
			{
651
652
				uint16_t Byte1 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				uint16_t Byte0 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
653

654
				return ((Byte0 << 8) | Byte1);
655
656
657
658
659
			}

			/** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT
			 *  direction pipes.
			 *
660
			 *  \ingroup Group_PipePrimitiveRW_UC3
661
			 *
662
			 *  \return Next two bytes in the currently selected pipe's FIFO buffer.
663
			 */
664
665
			static inline uint16_t Pipe_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint16_t Pipe_Read_16_BE(void)
666
			{
667
668
				uint16_t Byte0 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				uint16_t Byte1 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
669

670
				return ((Byte0 << 8) | Byte1);
671
672
673
674
675
			}

			/** Writes two bytes to the currently selected pipe's bank in little endian format, for IN
			 *  direction pipes.
			 *
676
			 *  \ingroup Group_PipePrimitiveRW_UC3
677
			 *
678
			 *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
679
			 */
680
681
			static inline void Pipe_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Write_16_LE(const uint16_t Data)
682
			{
683
684
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 8);
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data & 0xFF);
685
686
687
688
689
			}

			/** Writes two bytes to the currently selected pipe's bank in big endian format, for IN
			 *  direction pipes.
			 *
690
			 *  \ingroup Group_PipePrimitiveRW_UC3
691
			 *
692
			 *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
693
			 */
694
695
			static inline void Pipe_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Write_16_BE(const uint16_t Data)
696
			{
697
698
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data & 0xFF);
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 8);
699
700
701
702
			}

			/** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.
			 *
703
			 *  \ingroup Group_PipePrimitiveRW_UC3
704
			 */
705
706
			static inline void Pipe_Discard_16(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Discard_16(void)
707
708
709
			{
				uint8_t Dummy;

710
711
				Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
712
713
714
715
716
			}

			/** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT
			 *  direction pipes.
			 *
717
			 *  \ingroup Group_PipePrimitiveRW_UC3
718
			 *
719
			 *  \return Next four bytes in the currently selected pipe's FIFO buffer.
720
			 */
721
722
			static inline uint32_t Pipe_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint32_t Pipe_Read_32_LE(void)
723
			{
724
725
726
727
				uint32_t Byte3 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				uint32_t Byte2 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				uint32_t Byte1 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				uint32_t Byte0 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
728

729
				return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
730
731
732
733
734
			}

			/** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT
			 *  direction pipes.
			 *
735
			 *  \ingroup Group_PipePrimitiveRW_UC3
736
			 *
737
			 *  \return Next four bytes in the currently selected pipe's FIFO buffer.
738
			 */
739
740
			static inline uint32_t Pipe_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint32_t Pipe_Read_32_BE(void)
741
			{
742
743
744
745
				uint32_t Byte0 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				uint32_t Byte1 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				uint32_t Byte2 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				uint32_t Byte3 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
746

747
				return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
748
749
750
751
752
			}

			/** Writes four bytes to the currently selected pipe's bank in little endian format, for IN
			 *  direction pipes.
			 *
753
			 *  \ingroup Group_PipePrimitiveRW_UC3
754
			 *
755
			 *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
756
			 */
757
758
			static inline void Pipe_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Write_32_LE(const uint32_t Data)
759
			{
760
761
762
763
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 24);
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 16);
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 8);
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data &  0xFF);
764
765
766
767
768
			}

			/** Writes four bytes to the currently selected pipe's bank in big endian format, for IN
			 *  direction pipes.
			 *
769
			 *  \ingroup Group_PipePrimitiveRW_UC3
770
			 *
771
			 *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
772
			 */
773
774
			static inline void Pipe_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Write_32_BE(const uint32_t Data)
775
			{
776
777
778
779
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data &  0xFF);
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 8);
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 16);
				*(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 24);
780
781
782
783
			}

			/** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.
			 *
784
			 *  \ingroup Group_PipePrimitiveRW_UC3
785
			 */
786
787
			static inline void Pipe_Discard_32(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Discard_32(void)
788
789
790
			{
				uint8_t Dummy;

791
792
793
794
				Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
				Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
			}

		/* External Variables: */
			/** Global indicating the maximum packet size of the default control pipe located at address
			 *  0 in the device. This value is set to the value indicated in the attached device's device
		     *  descriptor once the USB interface is initialized into host mode and a device is attached
			 *  to the USB bus.
			 *
			 *  \note This variable should be treated as read-only in the user application, and never manually
			 *        changed in value.
			 */
			extern uint8_t USB_ControlPipeSize;

		/* Function Prototypes: */
			/** Configures the specified pipe number with the given pipe type, token, target endpoint number in the
			 *  attached device, bank size and banking mode.
			 *
			 *  A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()
			 *  before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or
			 *  sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite
			 *  numbers of IN requests without automatic freezing - this can be overridden by a call to
			 *  \ref Pipe_SetFiniteINRequests().
			 *
			 *  \param[in] Number          Pipe number to configure. This must be more than 0 and less than \ref PIPE_TOTAL_PIPES.
			 *
			 *  \param[in] Type            Type of pipe to configure, an \c EP_TYPE_* mask. Not all pipe types are available on Low
			 *                             Speed USB devices - refer to the USB 2.0 specification.
			 *
			 *  \param[in] Token           Pipe data token, either \ref PIPE_TOKEN_SETUP, \ref PIPE_TOKEN_OUT or \ref PIPE_TOKEN_IN.
			 *                             All pipes (except Control type) are unidirectional - data may only be read from or
			 *                             written to the pipe bank based on its direction, not both.
			 *
			 *  \param[in] EndpointNumber  Endpoint index within the attached device that the pipe should interface to.
			 *
			 *  \param[in] Size            Size of the pipe's bank, where packets are stored before they are transmitted to
			 *                             the USB device, or after they have been received from the USB device (depending on
			 *                             the pipe's data direction). The bank size must indicate the maximum packet size that
			 *                             the pipe can handle.
			 *
			 *  \param[in] Banks           Number of banks to use for the pipe being configured, a \c PIPE_BANK_* mask. More banks
			 *                             uses more USB DPRAM, but offers better performance. Isochronous type pipes <b>must</b>
			 *                             have at least two banks.
			 *
			 *  \note When the \c ORDERED_EP_CONFIG compile time option is used, Pipes <b>must</b> be configured in ascending order,
			 *        or bank corruption will occur.
			 *        \n\n
			 *
842
843
			 *  \note Certain microcontroller model's pipes may have different maximum packet sizes based on the pipe's
			 *        index - refer to the chosen microcontroller's datasheet to determine the maximum bank size for each pipe.
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
			 *        \n\n
			 *
			 *  \note The default control pipe should not be manually configured by the user application, as it is
			 *        automatically configured by the library internally.
			 *        \n\n
			 *
			 *  \note This routine will automatically select the specified pipe upon success. Upon failure, the pipe which
			 *        failed to reconfigure correctly will be selected.
			 *
			 *  \return Boolean \c true if the configuration succeeded, \c false otherwise.
			 */
			bool Pipe_ConfigurePipe(const uint8_t Number,
			                        const uint8_t Type,
			                        const uint8_t Token,
			                        const uint8_t EndpointNumber,
			                        const uint16_t Size,
			                        const uint8_t Banks);

			/** Spin-loops until the currently selected non-control pipe is ready for the next packed of data to be read
			 *  or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).
			 *
865
			 *  \ingroup Group_PipeRW_UC3
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
			 *
			 *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
			 */
			uint8_t Pipe_WaitUntilReady(void);

			/** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given
			 *  endpoint is found, it is automatically selected.
			 *
			 *  \param[in] EndpointAddress Address and direction mask of the endpoint within the attached device to check.
			 *
			 *  \return Boolean \c true if a pipe bound to the given endpoint address of the specified direction is found,
			 *          \c false otherwise.
			 */
			bool Pipe_IsEndpointBound(const uint8_t EndpointAddress);

	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Macros: */
			#if !defined(ENDPOINT_CONTROLEP)
				#define ENDPOINT_CONTROLEP          0
			#endif
887
			
888
889
890
891
892
893
894
895
896
897
898
899
900
		/* Inline Functions: */
			static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
			static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes)
			{
				uint8_t  MaskVal    = 0;
				uint16_t CheckBytes = 8;

				while ((CheckBytes < Bytes) && (CheckBytes < PIPE_MAX_SIZE))
				{
					MaskVal++;
					CheckBytes <<= 1;
				}

901
				return (MaskVal << AVR32_USBB_PSIZE_OFFSET);
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
			}

		/* Function Prototypes: */
			void Pipe_ClearPipes(void);
	#endif

	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif

#endif

/** @} */