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

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

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

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
17
18
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
19
20
21
22
23
24
25
26
27
28
29
  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.
*/
30

31
/** \file
32
33
 *  \brief USB Pipe definitions for the AVR8 microcontrollers.
 *  \copydetails Group_PipeManagement_AVR8
34
35
36
 *
 *  \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.
37
 */
38

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

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

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

61
62
/** \ingroup Group_PipeControlReq
 *  \defgroup Group_PipeControlReq_AVR8 Pipe Control Request Management (AVR8)
63
 *  \brief Pipe control request management definitions for the Atmel AVR8 architecture.
64
65
66
67
68
 *
 *  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.
69
 */
70

71
72
/** \ingroup Group_PipeManagement
 *  \defgroup Group_PipeManagement_AVR8 Pipe Management (AVR8)
73
 *  \brief Pipe management definitions for the Atmel AVR8 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_AVR8_H__
#define __PIPE_AVR8_H__
84
85

	/* Includes: */
86
87
		#include "../../../../Common/Common.h"
		#include "../USBTask.h"
88

89
90
91
92
93
94
95
96
97
	/* 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
98

99
100
	/* Public Interface - May be used in end-application: */
		/* Macros: */
101
102
			/** \name Pipe Error Flag Masks */
			//@{
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
			/** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */
			#define PIPE_ERRORFLAG_OVERFLOW         (1 << 6)

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that an underflow error occurred in the pipe on the received data. */
			#define PIPE_ERRORFLAG_UNDERFLOW        (1 << 5)

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */
			#define PIPE_ERRORFLAG_CRC16            (1 << 4)

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */
			#define PIPE_ERRORFLAG_TIMEOUT          (1 << 3)

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */
			#define PIPE_ERRORFLAG_PID              (1 << 2)

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

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */
			#define PIPE_ERRORFLAG_DATATGL          (1 << 0)
123
			//@}
124

125
126
			/** \name Pipe Token Masks */
			//@{
127
128
129
130
131
132
133
134
135
136
137
138
139
140
			/** 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.
			 */
			#define PIPE_TOKEN_SETUP                (0 << PTOKEN0)

			/** 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.
			 */
			#define PIPE_TOKEN_IN                   (1 << PTOKEN0)

			/** 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.
			 */
			#define PIPE_TOKEN_OUT                  (2 << PTOKEN0)
141
142
143
144
			//@}
			
			/** \name Pipe Bank Mode Masks */
			//@{
145
146
147
148
149
150
151
152
153
154
155
156
			/** 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.
			 */
			#define PIPE_BANK_SINGLE                (0 << EPBK0)

			/** 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.
			 */
			#define PIPE_BANK_DOUBLE                (1 << EPBK0)
157
			//@}
158

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

164
165
166
167
168
169
170
171
172
173
174
175
176
177
			/** Total number of pipes (including the default control pipe at address 0) which may be used in
			 *  the device. Different USB AVR models support different amounts of pipes, this value reflects
			 *  the maximum number of pipes for the currently selected AVR model.
			 */
			#define PIPE_TOTAL_PIPES                7

			/** 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
			 *  currently selected USB AVR model.
			 */
			#define PIPE_MAX_SIZE                   256

		/* Enums: */
178
			/** Enum for the possible error return codes of the \ref Pipe_WaitUntilReady() function.
179
			 *
180
			 *  \ingroup Group_PipeRW_AVR8
181
182
183
			 */
			enum Pipe_WaitUntilReady_ErrorCodes_t
			{
184
				PIPE_READYWAIT_NoError                 = 0, /**< Pipe ready for next packet, no error. */
185
				PIPE_READYWAIT_PipeStalled             = 1,	/**< The device stalled the pipe while waiting. */
186
187
188
189
190
191
192
193
				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: */
194
195
196
197
198
			/** 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.
			 *
199
			 *  \ingroup Group_PipeRW_AVR8
200
			 *
201
			 *  \return Total number of bytes in the currently selected pipe's FIFO buffer.
202
203
204
205
206
207
			 */
			static inline uint16_t Pipe_BytesInPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint16_t Pipe_BytesInPipe(void)
			{
				return UPBCX;
			}
208

209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
			/** 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)
			{
				return (UPNUM & PIPE_PIPENUM_MASK);
			}

			/** 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)
			{
				UPNUM = PipeNumber;
			}
230

231
232
233
234
235
236
237
238
239
240
			/** 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)
			{
				UPRST = (1 << PipeNumber);
				UPRST = 0;
			}
241

242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
			/** 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)
			{
				UPCONX |= (1 << PEN);
			}

			/** 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)
			{
				UPCONX &= ~(1 << PEN);
			}

			/** Determines if the currently selected pipe is enabled, but not necessarily configured.
			 *
264
			 * \return Boolean \c true if the currently selected pipe is enabled, \c false otherwise.
265
266
267
268
269
270
			 */
			static inline bool Pipe_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsEnabled(void)
			{
				return ((UPCONX & (1 << PEN)) ? true : false);
			}
271

272
273
			/** Gets the current pipe token, indicating the pipe's data direction and type.
			 *
274
			 *  \return The current pipe token, as a \c PIPE_TOKEN_* mask.
275
			 */
276
			static inline uint8_t Pipe_GetPipeToken(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
277
278
279
280
			static inline uint8_t Pipe_GetPipeToken(void)
			{
				return (UPCFG0X & (0x03 << PTOKEN0));
			}
281

282
			/** Sets the token for the currently selected pipe to one of the tokens specified by the \c PIPE_TOKEN_*
283
284
285
286
			 *  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.
			 *
287
			 *  \param[in] Token  New pipe token to set the selected pipe to, as a \c PIPE_TOKEN_* mask.
288
289
290
291
292
293
			 */
			static inline void Pipe_SetPipeToken(const uint8_t Token) ATTR_ALWAYS_INLINE;
			static inline void Pipe_SetPipeToken(const uint8_t Token)
			{
				UPCFG0X = ((UPCFG0X & ~(0x03 << PTOKEN0)) | Token);
			}
294

295
296
297
298
299
300
			/** 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)
			{
				UPCONX |= (1 << INMODE);
			}
301

302
303
304
305
306
307
308
309
310
311
312
313
314
315
			/** 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)
			{
				UPCONX &= ~(1 << INMODE);
				UPINRQX = TotalINRequests;
			}

			/** Determines if the currently selected pipe is configured.
			 *
316
			 *  \return Boolean \c true if the selected pipe is configured, \c false otherwise.
317
318
319
320
321
322
			 */
			static inline bool Pipe_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsConfigured(void)
			{
				return ((UPSTAX & (1 << CFGOK)) ? true : false);
			}
323

324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
			/** 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)
			{
				return ((UPCFG0X >> PEPNUM0) & PIPE_EPNUM_MASK);
			}

			/** 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)
			{
				UPCFG2X = Milliseconds;
			}
344

345
346
347
348
349
350
351
352
353
354
			/** 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)
			{
				return UPINT;
			}
355

356
357
358
359
360
			/** 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.
			 *
361
			 *  \return Boolean \c true if the specified pipe has interrupted, \c false otherwise.
362
363
364
365
366
367
			 */
			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)
			{
				return ((UPINT & (1 << PipeNumber)) ? true : false);
			}
368

369
370
371
372
373
374
			/** 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)
			{
				UPCONX &= ~(1 << PFREEZE);
			}
375

376
377
378
379
380
381
382
383
384
			/** 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)
			{
				UPCONX |= (1 << PFREEZE);
			}

			/** Determines if the currently selected pipe is frozen, and not able to accept data.
			 *
385
			 *  \return Boolean \c true if the currently selected pipe is frozen, \c false otherwise.
386
387
388
389
390
391
			 */
			static inline bool Pipe_IsFrozen(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsFrozen(void)
			{
				return ((UPCONX & (1 << PFREEZE)) ? true : false);
			}
392

393
			/** Clears the error flags for the currently selected pipe. */
394
395
396
			static inline void Pipe_ClearError(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearError(void)
			{
397
				UPERRX = 0;
398
399
				UPINTX &= ~(1 << PERRI);
			}
400

401
402
403
404
405
			/** 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.
			 *
406
			 *  \return Boolean \c true if an error has occurred on the selected pipe, \c false otherwise.
407
408
409
410
411
412
			 */
			static inline bool Pipe_IsError(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsError(void)
			{
				return ((UPINTX & (1 << PERRI)) ? true : false);
			}
413

414
			/** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This
415
			 *  value can then be masked against the \c PIPE_ERRORFLAG_* masks to determine what error has occurred.
416
			 *
417
			 *  \return  Mask comprising of \c PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe.
418
419
420
421
422
423
424
425
426
			 */
			static inline uint8_t Pipe_GetErrorFlags(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Pipe_GetErrorFlags(void)
			{
				return ((UPERRX & (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT |
				                   PIPE_ERRORFLAG_PID   | PIPE_ERRORFLAG_DATAPID |
				                   PIPE_ERRORFLAG_DATATGL)) |
				        (UPSTAX & (PIPE_ERRORFLAG_OVERFLOW | PIPE_ERRORFLAG_UNDERFLOW)));
			}
427
428
429
430
431
			
			/** 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.
			 *
432
			 *  \ingroup Group_PipePacketManagement_AVR8
433
434
435
			 *
			 *  \return Total number of busy banks in the selected pipe.
			 */
436
			static inline uint8_t Pipe_GetBusyBanks(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
437
438
			static inline uint8_t Pipe_GetBusyBanks(void)
			{
439
				return (UPSTAX & (0x03 << NBUSYBK0));
440
			}
441

442
443
444
445
446
447
448
449
			/** 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.
			 *
450
			 *  \ingroup Group_PipePacketManagement_AVR8
451
			 *
452
453
			 *  \return Boolean \c true if the currently selected pipe may be read from or written to, depending
			 *          on its direction.
454
455
456
457
458
459
			 */
			static inline bool Pipe_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsReadWriteAllowed(void)
			{
				return ((UPINTX & (1 << RWAL)) ? true : false);
			}
460

461
			/** Determines if a packet has been received on the currently selected IN pipe from the attached device.
462
			 *
463
			 *  \ingroup Group_PipePacketManagement_AVR8
464
			 *
465
			 *  \return Boolean \c true if the current pipe has received an IN packet, \c false otherwise.
466
467
468
469
470
471
			 */
			static inline bool Pipe_IsINReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsINReceived(void)
			{
				return ((UPINTX & (1 << RXINI)) ? true : false);
			}
472

473
			/** Determines if the currently selected OUT pipe is ready to send an OUT packet to the attached device.
474
			 *
475
			 *  \ingroup Group_PipePacketManagement_AVR8
476
			 *
477
			 *  \return Boolean \c true if the current pipe is ready for an OUT packet, \c false otherwise.
478
479
480
481
482
483
484
485
486
487
			 */
			static inline bool Pipe_IsOUTReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsOUTReady(void)
			{
				return ((UPINTX & (1 << TXOUTI)) ? true : false);
			}

			/** Determines if no SETUP request is currently being sent to the attached device on the selected
			 *  CONTROL type pipe.
			 *
488
			 *  \ingroup Group_PipePacketManagement_AVR8
489
			 *
490
			 *  \return Boolean \c true if the current pipe is ready for a SETUP packet, \c false otherwise.
491
492
493
494
495
496
			 */
			static inline bool Pipe_IsSETUPSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsSETUPSent(void)
			{
				return ((UPINTX & (1 << TXSTPI)) ? true : false);
			}
497

498
499
			/** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.
			 *
500
			 *  \ingroup Group_PipePacketManagement_AVR8
501
502
503
504
505
506
507
508
509
510
			 */
			static inline void Pipe_ClearSETUP(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearSETUP(void)
			{
				UPINTX &= ~((1 << TXSTPI) | (1 << FIFOCON));
			}

			/** 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.
			 *
511
			 *  \ingroup Group_PipePacketManagement_AVR8
512
513
514
515
516
517
518
519
520
521
			 */
			static inline void Pipe_ClearIN(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearIN(void)
			{
				UPINTX &= ~((1 << RXINI) | (1 << FIFOCON));
			}

			/** 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.
			 *
522
			 *  \ingroup Group_PipePacketManagement_AVR8
523
524
525
526
527
528
529
530
531
532
533
534
535
			 */
			static inline void Pipe_ClearOUT(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearOUT(void)
			{
				UPINTX &= ~((1 << TXOUTI) | (1 << FIFOCON));
			}

			/** 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.
			 *
536
			 *  \ingroup Group_PipePacketManagement_AVR8
537
			 *
538
			 *  \return Boolean \c true if an NAK has been received on the current pipe, \c false otherwise.
539
540
541
542
543
544
545
546
547
			 */
			static inline bool Pipe_IsNAKReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsNAKReceived(void)
			{
				return ((UPINTX & (1 << NAKEDI)) ? true : false);
			}

			/** Clears the NAK condition on the currently selected pipe.
			 *
548
			 *  \ingroup Group_PipePacketManagement_AVR8
549
550
551
552
553
554
555
556
			 *
			 *  \see \ref Pipe_IsNAKReceived() for more details.
			 */
			static inline void Pipe_ClearNAKReceived(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearNAKReceived(void)
			{
				UPINTX &= ~(1 << NAKEDI);
			}
557

558
559
			/** Determines if the currently selected pipe has had the STALL condition set by the attached device.
			 *
560
			 *  \ingroup Group_PipePacketManagement_AVR8
561
			 *
562
			 *  \return Boolean \c true if the current pipe has been stalled by the attached device, \c false otherwise.
563
564
565
566
567
568
			 */
			static inline bool Pipe_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Pipe_IsStalled(void)
			{
				return ((UPINTX & (1 << RXSTALLI)) ? true : false);
			}
569

570
571
572
			/** 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).
			 *
573
			 *  \ingroup Group_PipePacketManagement_AVR8
574
575
576
577
578
579
580
			 */
			static inline void Pipe_ClearStall(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_ClearStall(void)
			{
				UPINTX &= ~(1 << RXSTALLI);
			}

581
582
			/** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.
			 *
583
			 *  \ingroup Group_PipePrimitiveRW_AVR8
584
			 *
585
			 *  \return Next byte in the currently selected pipe's FIFO buffer.
586
			 */
587
588
			static inline uint8_t Pipe_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Pipe_Read_8(void)
589
590
591
592
593
594
			{
				return UPDATX;
			}

			/** Writes one byte from the currently selected pipe's bank, for IN direction pipes.
			 *
595
			 *  \ingroup Group_PipePrimitiveRW_AVR8
596
			 *
597
			 *  \param[in] Data  Data to write into the the currently selected pipe's FIFO buffer.
598
			 */
599
600
			static inline void Pipe_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Write_8(const uint8_t Data)
601
			{
602
				UPDATX = Data;
603
604
605
606
			}

			/** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.
			 *
607
			 *  \ingroup Group_PipePrimitiveRW_AVR8
608
			 */
609
610
			static inline void Pipe_Discard_8(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Discard_8(void)
611
612
			{
				uint8_t Dummy;
613

614
615
				Dummy = UPDATX;
			}
616

617
618
619
			/** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT
			 *  direction pipes.
			 *
620
			 *  \ingroup Group_PipePrimitiveRW_AVR8
621
			 *
622
			 *  \return Next two bytes in the currently selected pipe's FIFO buffer.
623
			 */
624
625
			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)
626
627
628
			{
				union
				{
629
					uint16_t Value;
630
631
					uint8_t  Bytes[2];
				} Data;
632

633
634
				Data.Bytes[0] = UPDATX;
				Data.Bytes[1] = UPDATX;
635

636
				return Data.Value;
637
638
639
640
641
			}

			/** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT
			 *  direction pipes.
			 *
642
			 *  \ingroup Group_PipePrimitiveRW_AVR8
643
			 *
644
			 *  \return Next two bytes in the currently selected pipe's FIFO buffer.
645
			 */
646
647
			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)
648
649
650
			{
				union
				{
651
					uint16_t Value;
652
653
					uint8_t  Bytes[2];
				} Data;
654

655
656
				Data.Bytes[1] = UPDATX;
				Data.Bytes[0] = UPDATX;
657

658
				return Data.Value;
659
			}
660

661
662
663
			/** Writes two bytes to the currently selected pipe's bank in little endian format, for IN
			 *  direction pipes.
			 *
664
			 *  \ingroup Group_PipePrimitiveRW_AVR8
665
			 *
666
			 *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
667
			 */
668
669
			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)
670
			{
671
672
				UPDATX = (Data & 0xFF);
				UPDATX = (Data >> 8);
673
			}
674

675
676
677
			/** Writes two bytes to the currently selected pipe's bank in big endian format, for IN
			 *  direction pipes.
			 *
678
			 *  \ingroup Group_PipePrimitiveRW_AVR8
679
			 *
680
			 *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
681
			 */
682
683
			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)
684
			{
685
686
				UPDATX = (Data >> 8);
				UPDATX = (Data & 0xFF);
687
688
689
690
			}

			/** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.
			 *
691
			 *  \ingroup Group_PipePrimitiveRW_AVR8
692
			 */
693
694
			static inline void Pipe_Discard_16(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Discard_16(void)
695
696
			{
				uint8_t Dummy;
697

698
699
700
701
702
703
704
				Dummy = UPDATX;
				Dummy = UPDATX;
			}

			/** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT
			 *  direction pipes.
			 *
705
			 *  \ingroup Group_PipePrimitiveRW_AVR8
706
			 *
707
			 *  \return Next four bytes in the currently selected pipe's FIFO buffer.
708
			 */
709
710
			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)
711
712
713
			{
				union
				{
714
					uint32_t Value;
715
716
					uint8_t  Bytes[4];
				} Data;
717

718
719
720
721
				Data.Bytes[0] = UPDATX;
				Data.Bytes[1] = UPDATX;
				Data.Bytes[2] = UPDATX;
				Data.Bytes[3] = UPDATX;
722

723
				return Data.Value;
724
725
726
727
728
			}

			/** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT
			 *  direction pipes.
			 *
729
			 *  \ingroup Group_PipePrimitiveRW_AVR8
730
			 *
731
			 *  \return Next four bytes in the currently selected pipe's FIFO buffer.
732
			 */
733
734
			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)
735
736
737
738
739
740
			{
				union
				{
					uint32_t DWord;
					uint8_t  Bytes[4];
				} Data;
741

742
743
744
745
				Data.Bytes[3] = UPDATX;
				Data.Bytes[2] = UPDATX;
				Data.Bytes[1] = UPDATX;
				Data.Bytes[0] = UPDATX;
746

747
748
749
750
751
752
				return Data.DWord;
			}

			/** Writes four bytes to the currently selected pipe's bank in little endian format, for IN
			 *  direction pipes.
			 *
753
			 *  \ingroup Group_PipePrimitiveRW_AVR8
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
				UPDATX = (Data &  0xFF);
				UPDATX = (Data >> 8);
				UPDATX = (Data >> 16);
				UPDATX = (Data >> 24);
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_AVR8
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
				UPDATX = (Data >> 24);
				UPDATX = (Data >> 16);
				UPDATX = (Data >> 8);
				UPDATX = (Data &  0xFF);
780
781
782
			}

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

791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
				Dummy = UPDATX;
				Dummy = UPDATX;
				Dummy = UPDATX;
				Dummy = UPDATX;
			}

		/* 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
810
			 *  attached device, bank size and banking mode.
811
812
813
814
815
816
817
			 *
			 *  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().
			 *
818
819
			 *  \param[in] Number          Pipe number to configure. This must be more than 0 and less than \ref PIPE_TOTAL_PIPES.
			 *
820
			 *  \param[in] Type            Type of pipe to configure, an \c EP_TYPE_* mask. Not all pipe types are available on Low
821
822
823
			 *                             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.
824
			 *                             All pipes (except Control type) are unidirectional - data may only be read from or
825
826
827
828
829
			 *                             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
830
831
			 *                             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
832
833
			 *                             the pipe can handle.
			 *
834
			 *  \param[in] Banks           Number of banks to use for the pipe being configured, a \c PIPE_BANK_* mask. More banks
835
836
837
			 *                             uses more USB DPRAM, but offers better performance. Isochronous type pipes <b>must</b>
			 *                             have at least two banks.
			 *
838
			 *  \note When the \c ORDERED_EP_CONFIG compile time option is used, Pipes <b>must</b> be configured in ascending order,
839
			 *        or bank corruption will occur.
840
841
			 *        \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
			 *        \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.
848
849
			 *        \n\n
			 *
850
851
			 *  \note This routine will automatically select the specified pipe upon success. Upon failure, the pipe which
			 *        failed to reconfigure correctly will be selected.
852
			 *
853
			 *  \return Boolean \c true if the configuration succeeded, \c false otherwise.
854
			 */
855
			bool Pipe_ConfigurePipe(const uint8_t Number,
856
857
858
859
860
			                        const uint8_t Type,
			                        const uint8_t Token,
			                        const uint8_t EndpointNumber,
			                        const uint16_t Size,
			                        const uint8_t Banks);
861

862
			/** Spin-loops until the currently selected non-control pipe is ready for the next packed of data to be read
863
864
			 *  or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).
			 *
865
			 *  \ingroup Group_PipeRW_AVR8
866
			 *
867
			 *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
868
869
			 */
			uint8_t Pipe_WaitUntilReady(void);
870

871
872
873
			/** 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.
			 *
874
			 *  \param[in] EndpointAddress Address and direction mask of the endpoint within the attached device to check.
875
			 *
876
877
			 *  \return Boolean \c true if a pipe bound to the given endpoint address of the specified direction is found,
			 *          \c false otherwise.
878
879
880
881
			 */
			bool Pipe_IsEndpointBound(const uint8_t EndpointAddress);

	/* Private Interface - For use in library only: */
882
883
884
885
886
	#if !defined(__DOXYGEN__)
		/* Macros: */
			#if !defined(ENDPOINT_CONTROLEP)
				#define ENDPOINT_CONTROLEP          0
			#endif
887

888
		/* Inline Functions: */
889
890
			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)
891
			{
892
893
				uint8_t  MaskVal    = 0;
				uint16_t CheckBytes = 8;
894

895
896
897
898
899
				while ((CheckBytes < Bytes) && (CheckBytes < PIPE_MAX_SIZE))
				{
					MaskVal++;
					CheckBytes <<= 1;
				}
900

901
				return (MaskVal << EPSIZE0);
902
903
			}

904
905
		/* Function Prototypes: */
			void Pipe_ClearPipes(void);
906
907
908
909
910
911
	#endif

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

913
914
915
#endif

/** @} */
916