Endpoint.h 35.3 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
30
31
  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 Endpoint definitions for the AVR8 microcontrollers.
 *  \copydetails Group_EndpointManagement_AVR8
34
35
36
37
38
 *
 *  \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.
 */

39
40
/** \ingroup Group_EndpointRW
 *  \defgroup Group_EndpointRW_AVR8 Endpoint Data Reading and Writing (AVR8)
41
 *  \brief Endpoint 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 endpoints.
 */
45

46
47
/** \ingroup Group_EndpointPrimitiveRW
 *  \defgroup Group_EndpointPrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8)
48
 *  \brief Endpoint primative 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 endpoints.
52
 */
53

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

61
62
/** \ingroup Group_EndpointManagement
 *  \defgroup Group_EndpointManagement_AVR8 Endpoint Management (AVR8)
63
 *  \brief Endpoint management definitions for the Atmel AVR8 architecture.
64
 *
65
66
67
68
69
 *  Functions, macros and enums related to endpoint management when in USB Device mode. This
 *  module contains the endpoint management macros, as well as endpoint interrupt and data
 *  send/receive functions for various data types.
 *
 *  @{
70
71
 */

72
73
#ifndef __ENDPOINT_AVR8_H__
#define __ENDPOINT_AVR8_H__
74
75

	/* Includes: */
76
77
78
		#include "../../../../Common/Common.h"
		#include "../USBTask.h"
		#include "../USBInterrupt.h"
79

80
81
82
83
84
85
86
87
88
	/* 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
89
90
91
92
93
94

	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Macros: */
			#define _ENDPOINT_GET_MAXSIZE(EPIndex)         _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## EPIndex)
			#define _ENDPOINT_GET_MAXSIZE2(EPDetails)      _ENDPOINT_GET_MAXSIZE3(EPDetails)
95
			#define _ENDPOINT_GET_MAXSIZE3(MaxSize, Banks) (MaxSize)
96

97
98
99
			#define _ENDPOINT_GET_BANKS(EPIndex)           _ENDPOINT_GET_BANKS2(ENDPOINT_DETAILS_EP ## EPIndex)
			#define _ENDPOINT_GET_BANKS2(EPDetails)        _ENDPOINT_GET_BANKS3(EPDetails)
			#define _ENDPOINT_GET_BANKS3(MaxSize, Banks)   (Banks)
100

101
			#if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
102
				#define ENDPOINT_DETAILS_MAXEP             7
103

104
105
106
107
108
109
110
				#define ENDPOINT_DETAILS_EP0               64,  2
				#define ENDPOINT_DETAILS_EP1               256, 2
				#define ENDPOINT_DETAILS_EP2               64,  2
				#define ENDPOINT_DETAILS_EP3               64,  2
				#define ENDPOINT_DETAILS_EP4               64,  2
				#define ENDPOINT_DETAILS_EP5               64,  2
				#define ENDPOINT_DETAILS_EP6               64,  2
111
			#else
112
113
				#define ENDPOINT_DETAILS_MAXEP             5

114
115
116
117
118
				#define ENDPOINT_DETAILS_EP0               64,  2
				#define ENDPOINT_DETAILS_EP1               64,  1
				#define ENDPOINT_DETAILS_EP2               64,  1
				#define ENDPOINT_DETAILS_EP3               64,  2
				#define ENDPOINT_DETAILS_EP4               64,  2
119
120
121
122
123
124
125
126
127
			#endif

		/* Inline Functions: */
			static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST
			                                                                       ATTR_ALWAYS_INLINE;
			static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
			{
				uint8_t  MaskVal    = 0;
				uint16_t CheckBytes = 8;
128

129
130
131
132
133
				while (CheckBytes < Bytes)
				{
					MaskVal++;
					CheckBytes <<= 1;
				}
134

135
136
137
138
139
140
141
142
143
144
				return (MaskVal << EPSIZE0);
			}

		/* Function Prototypes: */
			void Endpoint_ClearEndpoints(void);
			bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,
			                                    const uint8_t UECFG0XData,
			                                    const uint8_t UECFG1XData);

	#endif
145

146
147
	/* Public Interface - May be used in end-application: */
		/* Macros: */
148
149
			/** \name Endpoint Direction Masks */
			//@{
150
151
152
			/** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
			 *  should be initialized in the OUT direction - i.e. data flows from host to device.
			 */
153
			#define ENDPOINT_DIR_OUT                        (0 << EPDIR)
154
155
156
157

			/** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
			 *  should be initialized in the IN direction - i.e. data flows from device to host.
			 */
158
			#define ENDPOINT_DIR_IN                         (1 << EPDIR)
159
160
161
162
			//@}
			
			/** \name Endpoint Bank Mode Masks */
			//@{
163
164
165
166
167
			/** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
			 *  that the endpoint 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 host) can access the endpoint's
			 *  bank at the one time.
			 */
168
			#define ENDPOINT_BANK_SINGLE                    (0 << EPBK0)
169
170
171
172
173
174

			/** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
			 *  that the endpoint should have two banks, which requires more USB FIFO memory but results
			 *  in faster transfers as one USB device (the AVR or the host) can access one bank while the other
			 *  accesses the second bank.
			 */
175
			#define ENDPOINT_BANK_DOUBLE                    (1 << EPBK0)
176
177
			//@}
			
178
179
180
			/** Endpoint address for the default control endpoint, which always resides in address 0. This is
			 *  defined for convenience to give more readable code when used with the endpoint macros.
			 */
181
			#define ENDPOINT_CONTROLEP                      0
182
183

			#if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
184
				/** Default size of the default control endpoint's bank, until altered by the control endpoint bank size
185
				 *  value in the device descriptor. Not available if the \c FIXED_CONTROL_ENDPOINT_SIZE token is defined.
186
				 */
187
				#define ENDPOINT_CONTROLEP_DEFAULT_SIZE     8
188
			#endif
189

190
191
192
			/** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  numerical address in the device.
			 */
193
			#define ENDPOINT_EPNUM_MASK                     0x07
194
195

			/** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's
196
			 *  direction for comparing with the \c ENDPOINT_DESCRIPTOR_DIR_* masks.
197
			 */
198
			#define ENDPOINT_EPDIR_MASK                     0x80
199
200
201
202

			/** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  bank size in the device.
			 */
203
			#define ENDPOINT_EPSIZE_MASK                    0x7F
204

205
206
207
208
			/** Retrives the maximum bank size in bytes of a given endpoint.
			 *
			 *  \note This macro will only work correctly on endpoint indexes that are compile-time constants
			 *        defined by the preprocessor.
209
			 *
210
			 *  \param[in] EPIndex  Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
211
			 */
212
			#define ENDPOINT_MAX_SIZE(EPIndex)              _ENDPOINT_GET_MAXSIZE(EPIndex)
213

214
215
216
217
			/** Retrieves the total number of banks supported by the given endpoint.
			 *
			 *  \note This macro will only work correctly on endpoint indexes that are compile-time constants
			 *        defined by the preprocessor.
218
			 *
219
			 *  \param[in] EPIndex  Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
220
			 */
221
			#define ENDPOINT_BANKS_SUPPORTED(EPIndex)       _ENDPOINT_GET_BANKS(EPIndex)
222
223
224
225
226
227
228

			#if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)
				/** Total number of endpoints (including the default control endpoint at address 0) which may
				 *  be used in the device. Different USB AVR models support different amounts of endpoints,
				 *  this value reflects the maximum number of endpoints for the currently selected AVR model.
				 */
				#define ENDPOINT_TOTAL_ENDPOINTS            ENDPOINT_DETAILS_MAXEP
229
			#else
230
				#define ENDPOINT_TOTAL_ENDPOINTS            1
231
232
233
234
235
			#endif

		/* Enums: */
			/** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
			 *
236
			 *  \ingroup Group_EndpointRW_AVR8
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
			 */
			enum Endpoint_WaitUntilReady_ErrorCodes_t
			{
				ENDPOINT_READYWAIT_NoError                 = 0, /**< Endpoint is ready for next packet, no error. */
				ENDPOINT_READYWAIT_EndpointStalled         = 1, /**< The endpoint was stalled during the stream
				                                                 *   transfer by the host or device.
				                                                 */
				ENDPOINT_READYWAIT_DeviceDisconnected      = 2,	/**< Device was disconnected from the host while
				                                                 *   waiting for the endpoint to become ready.
				                                                 */
				ENDPOINT_READYWAIT_BusSuspended            = 3, /**< The USB bus has been suspended by the host and
				                                                 *   no USB endpoint traffic can occur until the bus
				                                                 *   has resumed.
				                                                 */
				ENDPOINT_READYWAIT_Timeout                 = 4, /**< The host failed to accept or send the next packet
				                                                 *   within the software timeout period set by the
				                                                 *   \ref USB_STREAM_TIMEOUT_MS macro.
				                                                 */
			};

257
		/* Inline Functions: */
258
			/** Configures the specified endpoint number with the given endpoint type, direction, bank size
259
260
			 *  and banking mode. Once configured, the endpoint may be read from or written to, depending
			 *  on its direction.
261
			 *
262
263
			 *  \param[in] Number     Endpoint number to configure. This must be more than 0 and less than
			 *                        \ref ENDPOINT_TOTAL_ENDPOINTS.
264
			 *
265
			 *  \param[in] Type       Type of endpoint to configure, a \c EP_TYPE_* mask. Not all endpoint types
266
			 *                        are available on Low Speed USB devices - refer to the USB 2.0 specification.
267
			 *
268
269
270
271
272
273
274
275
276
			 *  \param[in] Direction  Endpoint data direction, either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
			 *                        All endpoints (except Control type) are unidirectional - data may only be read
			 *                        from or written to the endpoint bank based on its direction, not both.
			 *
			 *  \param[in] Size       Size of the endpoint's bank, where packets are stored before they are transmitted
			 *                        to the USB host, or after they have been received from the USB host (depending on
			 *                        the endpoint's data direction). The bank size must indicate the maximum packet size
			 *                        that the endpoint can handle.
			 *
277
			 *  \param[in] Banks      Number of banks to use for the endpoint being configured, an \c ENDPOINT_BANK_* mask.
278
279
280
			 *                        More banks uses more USB DPRAM, but offers better performance. Isochronous type
			 *                        endpoints <b>must</b> have at least two banks.
			 *
281
282
			 *  \note When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in
			 *        ascending order, or bank corruption will occur.
283
284
			 *        \n\n
			 *
285
286
287
			 *  \note Certain models of USB AVR's endpoints may have different maximum packet sizes based on the endpoint's
			 *        index - refer to the chosen USB AVR's datasheet to determine the maximum bank size for each endpoint.
			 *        \n\n
288
			 *
289
			 *  \note The default control endpoint should not be manually configured by the user application, as
290
291
292
			 *        it is automatically configured by the library internally.
			 *        \n\n
			 *
293
294
			 *  \note This routine will automatically select the specified endpoint upon success. Upon failure, the endpoint
			 *        which failed to reconfigure correctly will be selected.
295
			 *
296
			 *  \return Boolean \c true if the configuration succeeded, \c false otherwise.
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
			 */
			static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
			                                              const uint8_t Type,
			                                              const uint8_t Direction,
			                                              const uint16_t Size,
			                                              const uint8_t Banks) ATTR_ALWAYS_INLINE;
			static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
			                                              const uint8_t Type,
			                                              const uint8_t Direction,
			                                              const uint16_t Size,
			                                              const uint8_t Banks)
			{
				return Endpoint_ConfigureEndpoint_Prv(Number, (((Type) << EPTYPE0) | (Direction)),
				                                      ((1 << ALLOC) | Banks | Endpoint_BytesToEPSizeMask(Size)));
			}

313
314
315
316
317
			/** Indicates the number of bytes currently stored in the current endpoint's selected bank.
			 *
			 *  \note The return width of this function may differ, depending on the maximum endpoint bank size
			 *        of the selected AVR model.
			 *
318
			 *  \ingroup Group_EndpointRW_AVR8
319
320
321
322
323
324
325
326
327
328
329
330
331
332
			 *
			 *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
			 */
			static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint16_t Endpoint_BytesInEndpoint(void)
			{
				#if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
					return UEBCX;
				#elif defined(USB_SERIES_4_AVR)
					return (((uint16_t)UEBCHX << 8) | UEBCLX);
				#elif defined(USB_SERIES_2_AVR)
					return UEBCLX;
				#endif
			}
333

334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
			/** Get the endpoint address of the currently selected endpoint. This is typically used to save
			 *  the currently selected endpoint number so that it can be restored after another endpoint has
			 *  been manipulated.
			 *
			 *  \return Index of the currently selected endpoint.
			 */
			static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Endpoint_GetCurrentEndpoint(void)
			{
				#if !defined(CONTROL_ONLY_DEVICE)
					return (UENUM & ENDPOINT_EPNUM_MASK);
				#else
					return ENDPOINT_CONTROLEP;
				#endif
			}
349

350
351
352
353
354
355
356
357
358
359
360
361
362
363
			/** Selects the given endpoint number. If the address from the device descriptors is used, the
			 *  value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
			 *  number (and discarding the endpoint direction bit).
			 *
			 *  Any endpoint operations which do not require the endpoint number to be indicated will operate on
			 *  the currently selected endpoint.
			 *
			 *  \param[in] EndpointNumber Endpoint number to select.
			 */
			static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber)
			{
				#if !defined(CONTROL_ONLY_DEVICE)
					UENUM = EndpointNumber;
364
				#endif
365
			}
366

367
			/** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
368
			 *  data In and Out pointers to the bank's contents.
369
370
371
372
373
374
375
376
377
			 *
			 *  \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset.
			 */
			static inline void Endpoint_ResetFIFO(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_ResetFIFO(const uint8_t EndpointNumber)
			{
				UERST = (1 << EndpointNumber);
				UERST = 0;
			}
378

379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
			/** Enables the currently selected endpoint so that data can be sent and received through it to
			 *  and from a host.
			 *
			 *  \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
			 */
			static inline void Endpoint_EnableEndpoint(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_EnableEndpoint(void)
			{
				UECONX |= (1 << EPEN);
			}

			/** Disables the currently selected endpoint so that data cannot be sent and received through it
			 *  to and from a host.
			 */
			static inline void Endpoint_DisableEndpoint(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_DisableEndpoint(void)
			{
				UECONX &= ~(1 << EPEN);
			}
398

399
400
			/** Determines if the currently selected endpoint is enabled, but not necessarily configured.
			 *
401
			 * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.
402
403
404
405
406
407
			 */
			static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Endpoint_IsEnabled(void)
			{
				return ((UECONX & (1 << EPEN)) ? true : false);
			}
408

409
410
411
412
413
			/** Aborts all pending IN transactions on the currently selected endpoint, once the bank
			 *  has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
			 *  will terminate all queued transactions, resetting the endpoint banks ready for a new
			 *  packet.
			 *
414
			 *  \ingroup Group_EndpointPacketManagement_AVR8
415
416
417
			 */
			static inline void Endpoint_AbortPendingIN(void)
			{
418
				while (UESTA0X & (0x03 << NBUSYBK0))
419
420
421
422
423
424
425
426
427
428
				{
					UEINTX |= (1 << RXOUTI);
					while (UEINTX & (1 << RXOUTI));
				}
			}
			
			/** Retrieves the number of busy banks in the currently selected endpoint, which have been queued for
			 *  transmission via the \ref Endpoint_ClearIN() command, or are awaiting acknowledgement via the
			 *  \ref Endpoint_ClearOUT() command.
			 *
429
			 *  \ingroup Group_EndpointPacketManagement_AVR8
430
431
432
433
434
			 *
			 *  \return Total number of busy banks in the selected endpoint.
			 */
			static inline uint8_t Endpoint_GetBusyBanks(void)
			{
435
				return (UESTA0X & (0x03 << NBUSYBK0));
436
437
			}

438
439
440
441
442
443
			/** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
			 *  bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
			 *  direction). This function will return false if an error has occurred in the endpoint, if the endpoint
			 *  is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
			 *  direction and the endpoint bank is full.
			 *
444
			 *  \ingroup Group_EndpointPacketManagement_AVR8
445
			 *
446
447
			 *  \return Boolean \c true if the currently selected endpoint may be read from or written to, depending
			 *          on its direction.
448
449
450
451
452
453
			 */
			static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Endpoint_IsReadWriteAllowed(void)
			{
				return ((UEINTX & (1 << RWAL)) ? true : false);
			}
454

455
456
			/** Determines if the currently selected endpoint is configured.
			 *
457
			 *  \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.
458
459
460
461
462
463
			 */
			static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Endpoint_IsConfigured(void)
			{
				return ((UESTA0X & (1 << CFGOK)) ? true : false);
			}
464

465
466
			/** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
			 *  interrupt duration has elapsed. Which endpoints have interrupted can be determined by
467
			 *  masking the return value against <tt>(1 << <i>{Endpoint Number}</i>)</tt>.
468
469
470
471
472
473
474
475
			 *
			 *  \return Mask whose bits indicate which endpoints have interrupted.
			 */
			static inline uint8_t Endpoint_GetEndpointInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Endpoint_GetEndpointInterrupts(void)
			{
				return UEINT;
			}
476

477
478
479
480
481
			/** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
			 *  endpoints).
			 *
			 *  \param[in] EndpointNumber  Index of the endpoint whose interrupt flag should be tested.
			 *
482
			 *  \return Boolean \c true if the specified endpoint has interrupted, \c false otherwise.
483
484
485
486
487
488
			 */
			static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber)
			{
				return ((UEINT & (1 << EndpointNumber)) ? true : false);
			}
489

490
			/** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
491
			 *
492
			 *  \ingroup Group_EndpointPacketManagement_AVR8
493
			 *
494
			 *  \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.
495
496
497
498
			 */
			static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Endpoint_IsINReady(void)
			{
499
				return ((UEINTX & (1 << TXINI)) ? true : false);
500
			}
501

502
			/** Determines if the selected OUT endpoint has received new packet from the host.
503
			 *
504
			 *  \ingroup Group_EndpointPacketManagement_AVR8
505
			 *
506
			 *  \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.
507
508
509
510
511
512
			 */
			static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Endpoint_IsOUTReceived(void)
			{
				return ((UEINTX & (1 << RXOUTI)) ? true : false);
			}
513

514
515
			/** Determines if the current CONTROL type endpoint has received a SETUP packet.
			 *
516
			 *  \ingroup Group_EndpointPacketManagement_AVR8
517
			 *
518
			 *  \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.
519
520
521
522
523
524
			 */
			static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Endpoint_IsSETUPReceived(void)
			{
				return ((UEINTX & (1 << RXSTPI)) ? true : false);
			}
525

526
527
528
			/** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
			 *  endpoint for the next packet.
			 *
529
			 *  \ingroup Group_EndpointPacketManagement_AVR8
530
			 *
531
			 *  \note This is not applicable for non CONTROL type endpoints.
532
533
534
535
536
537
			 */
			static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_ClearSETUP(void)
			{
				UEINTX &= ~(1 << RXSTPI);
			}
538

539
540
541
			/** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
			 *  next packet and switching to the alternative endpoint bank if double banked.
			 *
542
			 *  \ingroup Group_EndpointPacketManagement_AVR8
543
544
545
546
547
548
549
550
551
552
			 */
			static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_ClearIN(void)
			{
				#if !defined(CONTROL_ONLY_DEVICE)
					UEINTX &= ~((1 << TXINI) | (1 << FIFOCON));
				#else
					UEINTX &= ~(1 << TXINI);
				#endif
			}
553

554
555
556
			/** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
			 *  for the next packet and switching to the alternative endpoint bank if double banked.
			 *
557
			 *  \ingroup Group_EndpointPacketManagement_AVR8
558
559
560
561
562
563
564
			 */
			static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_ClearOUT(void)
			{
				#if !defined(CONTROL_ONLY_DEVICE)
					UEINTX &= ~((1 << RXOUTI) | (1 << FIFOCON));
				#else
565
					UEINTX &= ~(1 << RXOUTI);
566
567
				#endif
			}
568

569
570
571
572
573
574
575
576
577
			/** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
			 *  indicated endpoint and that the current transfer sequence should be aborted. This provides a
			 *  way for devices to indicate invalid commands to the host so that the current transfer can be
			 *  aborted and the host can begin its own recovery sequence.
			 *
			 *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
			 *  is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
			 *  endpoint.
			 *
578
			 *  \ingroup Group_EndpointPacketManagement_AVR8
579
580
581
582
583
584
			 */
			static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_StallTransaction(void)
			{
				UECONX |= (1 << STALLRQ);
			}
585

586
587
			/** Clears the STALL condition on the currently selected endpoint.
			 *
588
			 *  \ingroup Group_EndpointPacketManagement_AVR8
589
590
591
592
593
594
			 */
			static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_ClearStall(void)
			{
				UECONX |= (1 << STALLRQC);
			}
595

596
597
			/** Determines if the currently selected endpoint is stalled, false otherwise.
			 *
598
			 *  \ingroup Group_EndpointPacketManagement_AVR8
599
			 *
600
			 *  \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.
601
602
603
604
605
606
			 */
			static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline bool Endpoint_IsStalled(void)
			{
				return ((UECONX & (1 << STALLRQ)) ? true : false);
			}
607

608
609
610
611
612
613
			/** Resets the data toggle of the currently selected endpoint. */
			static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_ResetDataToggle(void)
			{
				UECONX |= (1 << RSTDT);
			}
614

615
616
			/** Determines the currently selected endpoint's direction.
			 *
617
			 *  \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.
618
619
620
621
622
623
624
625
626
			 */
			static inline uint8_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Endpoint_GetEndpointDirection(void)
			{
				return (UECFG0X & ENDPOINT_DIR_IN);
			}

			/** Sets the direction of the currently selected endpoint.
			 *
627
			 *  \param[in] DirectionMask  New endpoint direction, as a \c ENDPOINT_DIR_* mask.
628
629
630
631
632
633
634
			 */
			static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask)
			{
				UECFG0X = ((UECFG0X & ~ENDPOINT_DIR_IN) | DirectionMask);
			}

635
636
			/** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
637
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
638
			 *
639
			 *  \return Next byte in the currently selected endpoint's FIFO buffer.
640
641
642
643
644
645
646
647
648
			 */
			static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint8_t Endpoint_Read_Byte(void)
			{
				return UEDATX;
			}

			/** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
			 *
649
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
650
			 *
651
			 *  \param[in] Byte  Next byte to write into the the currently selected endpoint's FIFO buffer.
652
653
654
655
656
657
658
659
660
			 */
			static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_Write_Byte(const uint8_t Byte)
			{
				UEDATX = Byte;
			}

			/** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
661
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
662
663
664
665
666
			 */
			static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_Discard_Byte(void)
			{
				uint8_t Dummy;
667

668
669
				Dummy = UEDATX;
			}
670

671
672
673
			/** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
			 *  direction endpoints.
			 *
674
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
675
			 *
676
			 *  \return Next word in the currently selected endpoint's FIFO buffer.
677
678
679
680
681
682
683
684
685
			 */
			static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint16_t Endpoint_Read_Word_LE(void)
			{
				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
686

687
688
				Data.Bytes[0] = UEDATX;
				Data.Bytes[1] = UEDATX;
689

690
691
692
693
694
695
				return Data.Word;
			}

			/** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
			 *  direction endpoints.
			 *
696
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
697
			 *
698
			 *  \return Next word in the currently selected endpoint's FIFO buffer.
699
700
701
702
703
704
705
706
707
			 */
			static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint16_t Endpoint_Read_Word_BE(void)
			{
				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
708

709
710
				Data.Bytes[1] = UEDATX;
				Data.Bytes[0] = UEDATX;
711

712
713
714
715
716
717
				return Data.Word;
			}

			/** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
			 *  direction endpoints.
			 *
718
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
719
			 *
720
			 *  \param[in] Word  Next word to write to the currently selected endpoint's FIFO buffer.
721
722
723
724
725
726
727
			 */
			static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_Write_Word_LE(const uint16_t Word)
			{
				UEDATX = (Word & 0xFF);
				UEDATX = (Word >> 8);
			}
728

729
730
731
			/** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
			 *  direction endpoints.
			 *
732
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
733
			 *
734
			 *  \param[in] Word  Next word to write to the currently selected endpoint's FIFO buffer.
735
736
737
738
739
740
741
742
743
744
			 */
			static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_Write_Word_BE(const uint16_t Word)
			{
				UEDATX = (Word >> 8);
				UEDATX = (Word & 0xFF);
			}

			/** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
745
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
746
747
748
749
750
			 */
			static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_Discard_Word(void)
			{
				uint8_t Dummy;
751

752
753
754
755
756
757
758
				Dummy = UEDATX;
				Dummy = UEDATX;
			}

			/** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
			 *  direction endpoints.
			 *
759
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
760
			 *
761
			 *  \return Next double word in the currently selected endpoint's FIFO buffer.
762
763
764
765
766
767
768
769
770
			 */
			static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint32_t Endpoint_Read_DWord_LE(void)
			{
				union
				{
					uint32_t DWord;
					uint8_t  Bytes[4];
				} Data;
771

772
773
774
775
				Data.Bytes[0] = UEDATX;
				Data.Bytes[1] = UEDATX;
				Data.Bytes[2] = UEDATX;
				Data.Bytes[3] = UEDATX;
776

777
778
779
780
781
782
				return Data.DWord;
			}

			/** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
			 *  direction endpoints.
			 *
783
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
784
			 *
785
			 *  \return Next double word in the currently selected endpoint's FIFO buffer.
786
787
788
789
790
791
792
793
794
			 */
			static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
			static inline uint32_t Endpoint_Read_DWord_BE(void)
			{
				union
				{
					uint32_t DWord;
					uint8_t  Bytes[4];
				} Data;
795

796
797
798
799
				Data.Bytes[3] = UEDATX;
				Data.Bytes[2] = UEDATX;
				Data.Bytes[1] = UEDATX;
				Data.Bytes[0] = UEDATX;
800

801
802
803
804
805
806
				return Data.DWord;
			}

			/** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
			 *  direction endpoints.
			 *
807
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
808
			 *
809
			 *  \param[in] DWord  Next double word to write to the currently selected endpoint's FIFO buffer.
810
811
812
813
814
815
816
817
818
			 */
			static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
			{
				UEDATX = (DWord &  0xFF);
				UEDATX = (DWord >> 8);
				UEDATX = (DWord >> 16);
				UEDATX = (DWord >> 24);
			}
819

820
821
822
			/** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
			 *  direction endpoints.
			 *
823
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
824
			 *
825
			 *  \param[in] DWord  Next double word to write to the currently selected endpoint's FIFO buffer.
826
827
828
829
830
831
832
833
834
835
			 */
			static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
			{
				UEDATX = (DWord >> 24);
				UEDATX = (DWord >> 16);
				UEDATX = (DWord >> 8);
				UEDATX = (DWord &  0xFF);
			}

836
			/** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
837
			 *
838
			 *  \ingroup Group_EndpointPrimitiveRW_AVR8
839
840
841
842
843
			 */
			static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
			static inline void Endpoint_Discard_DWord(void)
			{
				uint8_t Dummy;
844

845
846
847
848
849
850
851
852
853
854
855
856
				Dummy = UEDATX;
				Dummy = UEDATX;
				Dummy = UEDATX;
				Dummy = UEDATX;
			}

		/* External Variables: */
			/** Global indicating the maximum packet size of the default control endpoint located at address
			 *  0 in the device. This value is set to the value indicated in the device descriptor in the user
			 *  project once the USB interface is initialized into device mode.
			 *
			 *  If space is an issue, it is possible to fix this to a static value by defining the control
857
			 *  endpoint size in the \c FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
858
859
860
			 *  via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
			 *  read from the descriptors at runtime and instead fixed to the given value. When used, it is
			 *  important that the descriptor control endpoint size value matches the size given as the
861
862
			 *  \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
			 *  be used in the device descriptors to ensure this.
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
			 *
			 *  \note This variable should be treated as read-only in the user application, and never manually
			 *        changed in value.
			 */
			#if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
				extern uint8_t USB_ControlEndpointSize;
			#else
				#define USB_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
			#endif

		/* Function Prototypes: */
			/** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
			 *  with respect to the data direction. This is a convenience function which can be used to
			 *  simplify user control request handling.
			 */
			void Endpoint_ClearStatusStage(void);

880
881
			/** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
			 *  to be read or written to it.
882
			 *
883
			 *  \note This routine should not be called on CONTROL type endpoints.
884
			 *
885
			 *  \ingroup Group_EndpointRW_AVR8
886
			 *
887
			 *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
888
			 */
889
			uint8_t Endpoint_WaitUntilReady(void);
890
891
892
893
894

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

896
897
898
#endif

/** @} */
899