Endpoint.h 47.5 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
32
33
34
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

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

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, 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
 *
 *  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
35
 *  send/recieve functions for various data types.
36
 */
37
38
39
40
41
42
43
44
45
46
47
48
49

/** \ingroup Group_USB
 *  @defgroup Group_EndpointManagement Endpoint Management
 *
 *  Functions, macros, variables, enums and types related to the setup and management of endpoints while in USB Device mode.
 *
 *  @{
 */

/** @defgroup Group_EndpointRW Endpoint Data Reading and Writing
 *
 *  Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
 */
50
 
51
52
53
54
55
/** @defgroup Group_EndpointPacketManagement Endpoint Packet Management
 *
 *  Functions, macros, variables, enums and types related to packet management of endpoints.
 */

56
57
58
59
60
61
62
63
64
65
66
#ifndef __ENDPOINT_H__
#define __ENDPOINT_H__

	/* Includes: */
		#include <avr/io.h>
		#include <stdbool.h>

		#include "../../../Common/Common.h"
		#include "../HighLevel/USBTask.h"

		#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
67
			#include "../HighLevel/StreamCallbacks.h"
68
		#endif
69
		
70
71
72
73
74
75
76
77
78
79
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Public Interface - May be used in end-application: */
		/* Macros: */
			/** Endpoint data direction mask for Endpoint_ConfigureEndpoint(). This indicates that the endpoint
			 *  should be initialized in the OUT direction - i.e. data flows from host to device.
			 */
80
			#define ENDPOINT_DIR_OUT                      (0 << EPDIR)
81
82
83
84

			/** Endpoint data direction mask for Endpoint_ConfigureEndpoint(). This indicates that the endpoint
			 *  should be initialized in the IN direction - i.e. data flows from device to host.
			 */
85
			#define ENDPOINT_DIR_IN                       (1 << EPDIR)
86
87
88
89
90
91

			/** Mask for the bank mode selection for the 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.
			 */
92
			#define ENDPOINT_BANK_SINGLE                  (0 << EPBK0)
93
94
95
96
97
98

			/** Mask for the bank mode selection for the 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.
			 */
99
			#define ENDPOINT_BANK_DOUBLE                  (1 << EPBK0)
100
101
102
103
			
			/** 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.
			 */
104
			#define ENDPOINT_CONTROLEP                    0
105
106

			#if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
107
108
109
				/** Default size of the default control endpoint's bank, until altered by the Endpoint0Size value 
				 *  in the device descriptor. Not available if the FIXED_CONTROL_ENDPOINT_SIZE token is defined.
				 */
110
				#define ENDPOINT_CONTROLEP_DEFAULT_SIZE   8
111
112
113
114
115
			#endif
			
			/** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  numerical address in the device.
			 */
116
			#define ENDPOINT_EPNUM_MASK                   0x03
117
118
119
120

			/** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  bank size in the device.
			 */
121
			#define ENDPOINT_EPSIZE_MASK                  0x7FF
122
123
124
125
126
			
			/** Maximum size in bytes of a given endpoint.
			 *
			 *  \param n  Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
			 */				
127
			#define ENDPOINT_MAX_SIZE(n)                  _ENDPOINT_GET_MAXSIZE(n)
128
129
130
131
132

			/** Indicates if the given endpoint supports double banking.
			 *
			 *  \param n  Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
			 */				
133
			#define ENDPOINT_DOUBLEBANK_SUPPORTED(n)      _ENDPOINT_GET_DOUBLEBANK(n)
134
135
136
137
138
139

			#if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || 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.
				 */
140
				#define ENDPOINT_TOTAL_ENDPOINTS          7
141
			#else
142
				#define ENDPOINT_TOTAL_ENDPOINTS          5			
143
144
145
146
147
148
149
			#endif

			/** Interrupt definition for the endpoint SETUP interrupt (for CONTROL type endpoints). Should be
			 *  used with the USB_INT_* macros located in USBInterrupt.h.
			 *
			 *  This interrupt will fire if enabled on a CONTROL type endpoint if a new control packet is
			 *  received from the host.
150
151
152
153
154
			 *
			 *  \note This interrupt must be enabled and cleared on *each* endpoint which requires it (after the
			 *        endpoint is selected), and will fire the common endpoint interrupt vector.
			 *
			 *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.
155
			 */
156
			#define ENDPOINT_INT_SETUP                    UEIENX, (1 << RXSTPE), UEINTX, (1 << RXSTPI)
157
158
159
160
161
162
163

			/** Interrupt definition for the endpoint IN interrupt (for INTERRUPT type endpoints). Should be
			 *  used with the USB_INT_* macros located in USBInterrupt.h.
			 *
			 *  This interrupt will fire if enabled on an INTERRUPT type endpoint if a the endpoint interrupt
			 *  period has elapsed and the endpoint is ready for a new packet to be written to its FIFO buffer
			 *  (if required).
164
165
166
167
168
			 *
			 *  \note This interrupt must be enabled and cleared on *each* endpoint which requires it (after the
			 *        endpoint is selected), and will fire the common endpoint interrupt vector.
			 *
			 *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.
169
			 */
170
			#define ENDPOINT_INT_IN                       UEIENX, (1 << TXINE) , UEINTX, (1 << TXINI)
171
172
173
174
175
176
177

			/** Interrupt definition for the endpoint OUT interrupt (for INTERRUPT type endpoints). Should be
			 *  used with the USB_INT_* macros located in USBInterrupt.h.
			 *
			 *  This interrupt will fire if enabled on an INTERRUPT type endpoint if a the endpoint interrupt
			 *  period has elapsed and the endpoint is ready for a packet from the host to be read from its
			 *  FIFO buffer (if received).
178
179
180
181
182
			 *
			 *  \note This interrupt must be enabled and cleared on *each* endpoint which requires it (after the
			 *        endpoint is selected), and will fire the common endpoint interrupt vector.
			 *
			 *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.
183
			 */
184
			#define ENDPOINT_INT_OUT                      UEIENX, (1 << RXOUTE), UEINTX, (1 << RXOUTI)
185
			
186
187
188
189
190
191
192
193
194
195
196
197
		/* Psuedo-Function Macros: */
			#if defined(__DOXYGEN__)
				/** 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.
				 *
				 *  \ingroup Group_EndpointRW
				 *
				 *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer
				 */
				static inline uint16_t Endpoint_BytesInEndpoint(void);
198
			
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
				/** 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);
				
				/** Selects the given endpoint number. If the address from the device descriptors is used, the
				 *  value should be masked with the 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 EndpointNumber Endpoint number to select
				 */
				static inline void Endpoint_SelectEndpoint(uint8_t EndpointNumber);
				
				/** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
				 *  In and Out pointers to the bank's contents.
				 *
				 *  \param EndpointNumber Endpoint number whose FIFO buffers are to be reset
				 */
				static inline void Endpoint_ResetFIFO(uint8_t EndpointNumber);
				
				/** 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 rather than just being enabled via the
				 *        Endpoint_ConfigureEndpoint() macro, which calls Endpoint_EnableEndpoint() automatically.
				 */
				static inline void Endpoint_EnableEndpoint(void);
232

233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
				/** 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);
				
				/** Determines if the currently selected endpoint is enabled, but not necessarily configured.
				 *
				 * \return Boolean True if the currently selected endpoint is enabled, false otherwise
				 */
				static inline bool Endpoint_IsEnabled(void);
				
				/** 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.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 *
				 *  \return Boolean true if the currently selected endpoint may be read from or written to, depending on its direction
				 */
				static inline bool Endpoint_IsReadWriteAllowed(void);
				
				/** Determines if the currently selected endpoint is configured.
				 *
				 *  \return Boolean true if the currently selected endpoint has been configured, false otherwise
				 */
				static inline bool Endpoint_IsConfigured(void);
				
				/** 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
				 *  masking the return value against (1 << {Endpoint Number}).
				 *
				 *  \return Mask whose bits indicate which endpoints have interrupted
				 */
				static inline uint8_t Endpoint_GetEndpointInterrupts(void);
				
				/** Clears the endpoint interrupt flag. This clears the specified endpoint number's interrupt
				 *  mask in the endpoint interrupt flag register.
				 *
				 *  \param EndpointNumber  Index of the endpoint whose interrupt flag should be cleared
				 */
				static inline void Endpoint_ClearEndpointInterrupt(uint8_t EndpointNumber);
				
				/** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
				 *  endpoints).
				 *
				 *  \param EndpointNumber  Index of the endpoint whose interrupt flag should be tested
				 *
				 *  \return Boolean true if the specified endpoint has interrupted, false otherwise
				 */
				static inline bool Endpoint_HasEndpointInterrupted(uint8_t EndpointNumber);
				
				/** Determines if the selected IN endpoint is ready for a new packet.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 *
				 *  \return Boolean true if the current endpoint is ready for an IN packet, false otherwise.
				 */
				static inline bool Endpoint_IsINReady(void);
				
				/** Determines if the selected OUT endpoint has received new packet.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 *
				 *  \return Boolean true if current endpoint is has received an OUT packet, false otherwise.
				 */
				static inline bool Endpoint_IsOUTReceived(void);
				
				/** Determines if the current CONTROL type endpoint has received a SETUP packet.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 *
				 *  \return Boolean true if the selected endpoint has received a SETUP packet, false otherwise.
				 */
				static inline bool Endpoint_IsSETUPReceived(void);
				
				/** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
				 *  endpoint for the next packet.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 *
				 *  \note This is not applicable for non CONTROL type endpoints.			 
				 */
				static inline void Endpoint_ClearControlSETUP(void);
				
				/** Sends an IN packet to the host on the currently selected CONTROL type endpoint, freeing up the
				 *  endpoint for the next packet.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 *
				 *  \note For non CONTROL type endpoints, use Endpoint_ClearIN() instead.			 
				 */
				static inline void Endpoint_ClearControlIN(void);
				
				/** Acknowledges an OUT packet to the host on the currently selected CONTROL type endpoint, freeing
				 *  up the endpoint for the next packet.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 *
				 *  \note For non CONTROL type endpoints, use Endpoint_ClearOUT() instead.
				 */
				static inline void Endpoint_ClearControlOUT(void);
				
				/** Sends an IN packet to the host on the currently selected non CONTROL type endpoint, freeing
				 *  up the endpoint for the next packet and switching to the alternative endpoint bank if double banked.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 *
				 *  \note For CONTROL type endpoints, use Endpoint_ClearControlIN() instead.
				 */
				static inline void Endpoint_ClearIN(void);
				
				/** Acknowledges an OUT packet to the host on the currently selected non CONTROL type endpoint, freeing
				 *  up the endpoint for the next packet and switching to the alternative endpoint bank if double banked.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 *
				 *  \note For CONTROL type endpoints, use Endpoint_ClearControlOUT() instead.
				 */
				static inline void Endpoint_ClearOUT(void);
				
				/** 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 Endpoint_ClearStall() macro
				 *  is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
				 *  endpoint.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 */
				static inline void Endpoint_StallTransaction(void);
				
				/** Clears the STALL condition on the currently selected endpoint.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 */
				static inline void Endpoint_ClearStall(void);
				
				/** Determines if the currently selected endpoint is stalled, false otherwise.
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 *
				 *  \return Boolean true if the currently selected endpoint is stalled, false otherwise
				 */
				static inline bool Endpoint_IsStalled(void);
				
				/** Resets the data toggle of the currently selected endpoint. */
				static inline void Endpoint_ResetDataToggle(void);
				
				/** Determines the currently selected endpoint's direction.
				 *
				 *  \return The currently selected endpoint's direction, as a ENDPOINT_DIR_* mask.
				 */
				static inline uint8_t Endpoint_GetEndpointDirection(void);
			#else
				#if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)
					#define Endpoint_BytesInEndpoint()        UEBCX
				#else
					#define Endpoint_BytesInEndpoint()        UEBCLX
				#endif
				
				#define Endpoint_GetCurrentEndpoint()         (UENUM & ENDPOINT_EPNUM_MASK)
				
				#define Endpoint_SelectEndpoint(epnum)        MACROS{ UENUM = epnum; }MACROE
400

401
				#define Endpoint_ResetFIFO(epnum)             MACROS{ UERST = (1 << epnum); UERST = 0; }MACROE
402

403
				#define Endpoint_EnableEndpoint()             MACROS{ UECONX |= (1 << EPEN); }MACROE
404

405
				#define Endpoint_DisableEndpoint()            MACROS{ UECONX &= ~(1 << EPEN); }MACROE
406

407
				#define Endpoint_IsEnabled()                  ((UECONX & (1 << EPEN)) ? true : false)
408

409
				#define Endpoint_IsReadWriteAllowed()         ((UEINTX & (1 << RWAL)) ? true : false)
410

411
				#define Endpoint_IsConfigured()               ((UESTA0X & (1 << CFGOK)) ? true : false)
412

413
				#define Endpoint_GetEndpointInterrupts()      UEINT
414

415
				#define Endpoint_ClearEndpointInterrupt(n)    MACROS{ UEINT &= ~(1 << n); }MACROE
416

417
418
				#define Endpoint_HasEndpointInterrupted(n)    ((UEINT & (1 << n)) ? true : false)
				
419
				#define Endpoint_IsINReady()                  ((UEINTX & (1 << TXINI))  ? true : false)
420
				
421
				#define Endpoint_IsOUTReceived()              ((UEINTX & (1 << RXOUTI)) ? true : false)
422

423
				#define Endpoint_IsSETUPReceived()            ((UEINTX & (1 << RXSTPI)) ? true : false)
424

425
				#define Endpoint_ClearControlSETUP()          MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE
426

427
				#define Endpoint_ClearControlIN()             MACROS{ UEINTX &= ~(1 << TXINI); }MACROE
428

429
				#define Endpoint_ClearControlOUT()            MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE
430

431
432
				#define Endpoint_ClearIN()                    MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << TXINI)); \
				                                                      UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
433

434
435
				#define Endpoint_ClearOUT()                   MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << RXOUTI)); \
				                                                      UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
436

437
				#define Endpoint_StallTransaction()           MACROS{ UECONX |= (1 << STALLRQ); }MACROE
438

439
				#define Endpoint_ClearStall()                 MACROS{ UECONX |= (1 << STALLRQC); }MACROE
440

441
442
443
444
445
446
				#define Endpoint_IsStalled()                  ((UECONX & (1 << STALLRQ)) ? true : false)

				#define Endpoint_ResetDataToggle()            MACROS{ UECONX |= (1 << RSTDT); }MACROE
				
				#define Endpoint_GetEndpointDirection()       (UECFG0X & ENDPOINT_DIR_IN)
			#endif
447
448

		/* Enums: */
449
450
451
452
			/** Enum for the possible error return codes of the Endpoint_WaitUntilReady function.
			 *
			 *  \ingroup Group_EndpointRW
			 */
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
			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_Timeout                 = 3, /**< The host failed to accept or send the next packet
				                                                 *   within the software timeout period set by the
				                                                 *   USB_STREAM_TIMEOUT_MS macro.
				                                                 */
			};
		
468
469
470
471
			/** Enum for the possible error return codes of the Endpoint_*_Stream_* functions.
			 *
			 *  \ingroup Group_EndpointRW
			 */
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
			enum Endpoint_Stream_RW_ErrorCodes_t
			{
				ENDPOINT_RWSTREAM_ERROR_NoError            = 0, /**< Command completed successfully, no error. */
				ENDPOINT_RWSTREAM_ERROR_EndpointStalled    = 1, /**< The endpoint was stalled during the stream
				                                                 *   transfer by the host or device.
				                                                 */
				ENDPOINT_RWSTREAM_ERROR_DeviceDisconnected = 1, /**< Device was disconnected from the host during
				                                                 *   the transfer.
				                                                 */
				ENDPOINT_RWSTREAM_ERROR_Timeout            = 2, /**< The host failed to accept or send the next packet
				                                                 *   within the software timeout period set by the
				                                                 *   USB_STREAM_TIMEOUT_MS macro.
				                                                 */
				ENDPOINT_RWSTREAM_ERROR_CallbackAborted    = 3, /**< Indicates that the stream's callback function
			                                                     *   aborted the transfer early.
				                                                 */
			};
			
490
491
492
493
			/** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..
			 *
			 *  \ingroup Group_EndpointRW
			 */
494
495
496
497
498
499
500
			enum Endpoint_ControlStream_RW_ErrorCodes_t
			{
				ENDPOINT_RWCSTREAM_ERROR_NoError            = 0, /**< Command completed successfully, no error. */
				ENDPOINT_RWCSTREAM_ERROR_HostAborted        = 1, /**< The aborted the transfer prematurely. */
			};

		/* Inline Functions: */
501
502
503
504
505
506
			/** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
			 *  \ingroup Group_EndpointRW
			 *
			 *  \return Next byte in the currently selected endpoint's FIFO buffer
			 */
507
			static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
508
509
510
511
512
			static inline uint8_t Endpoint_Read_Byte(void)
			{
				return UEDATX;
			}

513
514
515
516
517
518
			/** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
			 *
			 *  \ingroup Group_EndpointRW
			 *
			 *  \param Byte  Next byte to write into the the currently selected endpoint's FIFO buffer
			 */
519
			static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
520
521
522
523
524
			static inline void Endpoint_Write_Byte(const uint8_t Byte)
			{
				UEDATX = Byte;
			}

525
526
527
528
			/** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
			 *  \ingroup Group_EndpointRW
			 */
529
			static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
530
531
532
533
534
535
536
537
538
			static inline void Endpoint_Discard_Byte(void)
			{
				uint8_t Dummy;
				
				Dummy = UEDATX;
			}
			
			/** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
			 *  direction endpoints.
539
540
541
542
			 *
			 *  \ingroup Group_EndpointRW
			 *
			 *  \return Next word in the currently selected endpoint's FIFO buffer
543
			 */
544
			static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
545
546
547
548
549
550
551
552
553
554
555
556
			static inline uint16_t Endpoint_Read_Word_LE(void)
			{
				uint16_t Data;
				
				Data  = UEDATX;
				Data |= (((uint16_t)UEDATX) << 8);
			
				return Data;
			}

			/** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
			 *  direction endpoints.
557
558
559
560
			 *
			 *  \ingroup Group_EndpointRW
			 *
			 *  \return Next word in the currently selected endpoint's FIFO buffer
561
			 */
562
			static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
563
564
565
566
567
568
569
570
571
572
573
574
			static inline uint16_t Endpoint_Read_Word_BE(void)
			{
				uint16_t Data;
				
				Data  = (((uint16_t)UEDATX) << 8);
				Data |= UEDATX;
			
				return Data;
			}

			/** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
			 *  direction endpoints.
575
576
577
578
			 *
			 *  \ingroup Group_EndpointRW
			 *
			 *  \param Word  Next word to write to the currently selected endpoint's FIFO buffer
579
			 */
580
			static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
581
582
583
584
585
586
587
588
			static inline void Endpoint_Write_Word_LE(const uint16_t Word)
			{
				UEDATX = (Word & 0xFF);
				UEDATX = (Word >> 8);
			}
			
			/** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
			 *  direction endpoints.
589
590
591
592
			 *
			 *  \ingroup Group_EndpointRW
			 *
			 *  \param Word  Next word to write to the currently selected endpoint's FIFO buffer
593
			 */
594
			static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
595
596
597
598
599
600
			static inline void Endpoint_Write_Word_BE(const uint16_t Word)
			{
				UEDATX = (Word >> 8);
				UEDATX = (Word & 0xFF);
			}

601
602
603
604
			/** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
			 *  \ingroup Group_EndpointRW
			 */
605
			static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
606
607
608
609
610
611
612
613
614
615
			static inline void Endpoint_Discard_Word(void)
			{
				uint8_t Dummy;
				
				Dummy = UEDATX;
				Dummy = UEDATX;
			}

			/** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
			 *  direction endpoints.
616
617
618
619
			 *
			 *  \ingroup Group_EndpointRW
			 *
			 *  \return Next double word in the currently selected endpoint's FIFO buffer
620
			 */
621
			static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
			static inline uint32_t Endpoint_Read_DWord_LE(void)
			{
				union
				{
					uint32_t DWord;
					uint8_t  Bytes[4];
				} Data;
				
				Data.Bytes[0] = UEDATX;
				Data.Bytes[1] = UEDATX;
				Data.Bytes[2] = UEDATX;
				Data.Bytes[3] = UEDATX;
			
				return Data.DWord;
			}

			/** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
			 *  direction endpoints.
640
641
642
643
			 *
			 *  \ingroup Group_EndpointRW
			 *
			 *  \return Next double word in the currently selected endpoint's FIFO buffer
644
			 */
645
			static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
			static inline uint32_t Endpoint_Read_DWord_BE(void)
			{
				union
				{
					uint32_t DWord;
					uint8_t  Bytes[4];
				} Data;
				
				Data.Bytes[3] = UEDATX;
				Data.Bytes[2] = UEDATX;
				Data.Bytes[1] = UEDATX;
				Data.Bytes[0] = UEDATX;
			
				return Data.DWord;
			}

			/** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
			 *  direction endpoints.
664
665
666
667
			 *
			 *  \ingroup Group_EndpointRW
			 *
			 *  \param DWord  Next double word to write to the currently selected endpoint's FIFO buffer
668
			 */
669
			static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
670
671
			static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
			{
672
673
674
675
				UEDATX = (DWord &  0xFF);
				UEDATX = (DWord >> 8);
				UEDATX = (DWord >> 16);
				UEDATX = (DWord >> 24);
676
677
678
679
			}
			
			/** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
			 *  direction endpoints.
680
681
682
683
			 *
			 *  \ingroup Group_EndpointRW
			 *
			 *  \param DWord  Next double word to write to the currently selected endpoint's FIFO buffer
684
			 */
685
			static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
686
687
			static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
			{
688
689
690
691
				UEDATX = (DWord >> 24);
				UEDATX = (DWord >> 16);
				UEDATX = (DWord >> 8);
				UEDATX = (DWord &  0xFF);
692
693
			}

694
695
696
697
			/** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.	
			 *
			 *  \ingroup Group_EndpointRW
			 */
698
			static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
			static inline void Endpoint_Discard_DWord(void)
			{
				uint8_t Dummy;
				
				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
			 *  endpoint size in the FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
			 *  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
			 *  FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the FIXED_CONTROL_ENDPOINT_SIZE token
			 *  be used in the descriptors to ensure this.
			 *
			 *  \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: */
			/** Configures the specified endpoint number with the given endpoint type, direction, bank size
			 *  and banking mode. Endpoints should be allocated in ascending order by their address in the
			 *  device (i.e. endpoint 1 should be configured before endpoint 2 and so on).
			 *
			 *  The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction
			 *  may be either ENDPOINT_DIR_OUT or ENDPOINT_DIR_IN.
			 *
			 *  The bank size must indicate the maximum packet size that the endpoint can handle. Different
			 *  endpoint numbers can handle different maximum packet sizes - refer to the chosen USB AVR's
			 *  datasheet to determine the maximum bank size for each endpoint.
			 *
			 *  The banking mode may be either ENDPOINT_BANK_SINGLE or ENDPOINT_BANK_DOUBLE.
			 *
			 *  The success of this routine can be determined via the Endpoint_IsConfigured() macro.
			 *
			 *  By default, the routine is entirely dynamic, and will accept both constant and variable inputs.
			 *  If dynamic configuration is unused, a small space savings can be made by defining the
			 *  STATIC_ENDPOINT_CONFIGURATION macro via the -D switch to the compiler, to optimize for constant
			 *  input values.
			 *
			 *  \note This routine will select the specified endpoint, and the endpoint will remain selected
			 *        once the routine completes regardless of if the endpoint configuration succeeds.
			 *
			 *  \return Boolean true if the configuration succeeded, false otherwise
			 */
			bool Endpoint_ConfigureEndpoint(const uint8_t  Number, const uint8_t Type, const uint8_t Direction,
			                                const uint16_t Size, const uint8_t Banks);

			/** Spinloops until the currently selected non-control endpoint is ready for the next packet of data
			 *  to be read or written to it.
			 *
			 *  \note This routine should not be called on CONTROL type endpoints.
			 *
765
766
			 *  \ingroup Group_EndpointRW
			 *
767
768
769
770
771
772
773
			 *  \return A value from the Endpoint_WaitUntilReady_ErrorCodes_t enum.
			 */
			uint8_t Endpoint_WaitUntilReady(void);

			/** Reads and discards the given number of bytes from the endpoint from the given buffer,
			 *  discarding fully read packets from the host as needed. The last packet is not automatically
			 *  discarded once the remaining bytes has been read; the user is responsible for manually
774
			 *  discarding the last packet from the host via the Endpoint_ClearOUT() macro. Between
775
776
777
778
779
			 *  each USB packet, the given stream callback function is executed repeatedly until the next
			 *  packet is ready, allowing for early aborts of stream transfers.
			 *
			 *	The callback routine should be created using the STREAM_CALLBACK() macro. If the token
			 *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
780
			 *  and this function has the Callback parameter omitted.
781
782
783
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
784
785
			 *  \ingroup Group_EndpointRW
			 *
786
			 *  \param Length    Number of bytes to send via the currently selected endpoint.
787
			 *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
788
789
790
791
792
793
794
795
796
797
798
799
			 *
			 *  \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
			uint8_t Endpoint_Discard_Stream(uint16_t Length
			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
			                                , uint8_t (* const Callback)(void)
			#endif
			                                );

			/** Writes the given number of bytes to the endpoint from the given buffer in little endian,
			 *  sending full packets to the host as needed. The last packet filled is not automatically sent;
			 *  the user is responsible for manually sending the last written packet to the host via the
800
			 *  Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
801
802
803
804
805
			 *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
			 *  aborts of stream transfers.
			 *
			 *	The callback routine should be created using the STREAM_CALLBACK() macro. If the token
			 *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
806
			 *  and this function has the Callback parameter omitted.
807
808
809
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
810
811
			 *  \ingroup Group_EndpointRW
			 *
812
813
			 *  \param Buffer    Pointer to the source data buffer to read from.
			 *  \param Length    Number of bytes to read for the currently selected endpoint into the buffer.
814
			 *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
815
816
817
818
819
820
821
822
823
824
825
826
			 *
			 *  \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
			uint8_t Endpoint_Write_Stream_LE(const void* Buffer, uint16_t Length
			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
			                                 , uint8_t (* const Callback)(void)
			#endif
			                                 ) ATTR_NON_NULL_PTR_ARG(1);

			/** Writes the given number of bytes to the endpoint from the given buffer in big endian,
			 *  sending full packets to the host as needed. The last packet filled is not automatically sent;
			 *  the user is responsible for manually sending the last written packet to the host via the
827
			 *  Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
828
829
830
831
832
			 *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
			 *  aborts of stream transfers.
			 *
			 *	The callback routine should be created using the STREAM_CALLBACK() macro. If the token
			 *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
833
			 *  and this function has the Callback parameter omitted.
834
835
836
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
837
838
			 *  \ingroup Group_EndpointRW
			 *
839
840
			 *  \param Buffer    Pointer to the source data buffer to read from.
			 *  \param Length    Number of bytes to read for the currently selected endpoint into the buffer.
841
			 *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
842
843
844
845
846
847
848
849
850
851
852
853
			 *
			 *  \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
			uint8_t Endpoint_Write_Stream_BE(const void* Buffer, uint16_t Length
			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
			                                 , uint8_t (* const Callback)(void)
			#endif
			                                 ) ATTR_NON_NULL_PTR_ARG(1);

			/** Reads the given number of bytes from the endpoint from the given buffer in little endian,
			 *  discarding fully read packets from the host as needed. The last packet is not automatically
			 *  discarded once the remaining bytes has been read; the user is responsible for manually
854
			 *  discarding the last packet from the host via the Endpoint_ClearOUT() macro. Between
855
856
857
858
859
			 *  each USB packet, the given stream callback function is executed repeatedly until the endpoint
			 *  is ready to accept the next packet, allowing for early aborts of stream transfers.
			 *
			 *	The callback routine should be created using the STREAM_CALLBACK() macro. If the token
			 *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
860
			 *  and this function has the Callback parameter omitted.
861
862
863
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
864
865
			 *  \ingroup Group_EndpointRW
			 *
866
867
			 *  \param Buffer    Pointer to the destination data buffer to write to.
			 *  \param Length    Number of bytes to send via the currently selected endpoint.
868
			 *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
869
870
871
872
873
874
875
876
877
878
879
880
			 *
			 *  \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
			uint8_t Endpoint_Read_Stream_LE(void* Buffer, uint16_t Length
			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
			                                , uint8_t (* const Callback)(void)
			#endif
			                                ) ATTR_NON_NULL_PTR_ARG(1);

			/** Reads the given number of bytes from the endpoint from the given buffer in big endian,
			 *  discarding fully read packets from the host as needed. The last packet is not automatically
			 *  discarded once the remaining bytes has been read; the user is responsible for manually
881
			 *  discarding the last packet from the host via the Endpoint_ClearOUT() macro. Between
882
883
884
885
886
			 *  each USB packet, the given stream callback function is executed repeatedly until the endpoint
			 *  is ready to accept the next packet, allowing for early aborts of stream transfers.
			 *
			 *	The callback routine should be created using the STREAM_CALLBACK() macro. If the token
			 *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
887
			 *  and this function has the Callback parameter omitted.
888
889
890
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
891
892
			 *  \ingroup Group_EndpointRW
			 *
893
894
			 *  \param Buffer    Pointer to the destination data buffer to write to.
			 *  \param Length    Number of bytes to send via the currently selected endpoint.
895
			 *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
896
897
898
899
900
901
902
903
904
905
			 *
			 *  \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
			uint8_t Endpoint_Read_Stream_BE(void* Buffer, uint16_t Length
			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
			                                , uint8_t (* const Callback)(void)
			#endif
			                                ) ATTR_NON_NULL_PTR_ARG(1);

			/** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
906
			 *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
907
			 *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
908
			 *  finalize the transfer via the Endpoint_ClearControlOUT() macro.
909
910
911
912
913
914
			 *
			 *  \note This routine should only be used on CONTROL type endpoints.
			 *
			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
			 *           together; i.e. the entire stream data must be read or written at the one time.
			 *
915
916
			 *  \ingroup Group_EndpointRW
			 *
917
918
919
920
921
922
923
924
			 *  \param Buffer  Pointer to the source data buffer to read from.
			 *  \param Length  Number of bytes to read for the currently selected endpoint into the buffer.
			 *
			 *  \return A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.
			 */
			uint8_t Endpoint_Write_Control_Stream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);

			/** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
925
			 *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
926
			 *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
927
			 *  finalize the transfer via the Endpoint_ClearControlOUT() macro.
928
929
930
931
932
933
			 *
			 *  \note This routine should only be used on CONTROL type endpoints.
			 *
			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
			 *           together; i.e. the entire stream data must be read or written at the one time.
			 *
934
935
			 *  \ingroup Group_EndpointRW
			 *
936
937
938
939
940
941
942
943
			 *  \param Buffer  Pointer to the source data buffer to read from.
			 *  \param Length  Number of bytes to read for the currently selected endpoint into the buffer.
			 *
			 *  \return A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.
			 */
			uint8_t Endpoint_Write_Control_Stream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);

			/** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
944
			 *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
945
			 *  automatically sent after success or failure states; the user is responsible for manually sending the
946
			 *  setup IN to finalize the transfer via the Endpoint_ClearControlIN() macro.
947
948
949
950
951
952
			 *
			 *  \note This routine should only be used on CONTROL type endpoints.
			 *
			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
			 *           together; i.e. the entire stream data must be read or written at the one time.
			 *
953
954
			 *  \ingroup Group_EndpointRW
			 *
955
956
957
958
959
960
961
962
			 *  \param Buffer  Pointer to the destination data buffer to write to.
			 *  \param Length  Number of bytes to send via the currently selected endpoint.
			 *
			 *  \return A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.
			 */
			uint8_t Endpoint_Read_Control_Stream_LE(void* Buffer, uint16_t Length)  ATTR_NON_NULL_PTR_ARG(1);

			/** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
963
			 *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
964
			 *  automatically sent after success or failure states; the user is responsible for manually sending the
965
			 *  setup IN to finalize the transfer via the Endpoint_ClearControlIN() macro.
966
967
968
969
970
971
			 *
			 *  \note This routine should only be used on CONTROL type endpoints.
			 *
			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
			 *           together; i.e. the entire stream data must be read or written at the one time.
			 *
972
973
			 *  \ingroup Group_EndpointRW
			 *
974
975
976
977
978
			 *  \param Buffer  Pointer to the destination data buffer to write to.
			 *  \param Length  Number of bytes to send via the currently selected endpoint.
			 *
			 *  \return A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.
			 */
979
			uint8_t Endpoint_Read_Control_Stream_BE(void* Buffer, uint16_t Length)  ATTR_NON_NULL_PTR_ARG(1);		
980
981
982
983
			
	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Macros: */
984
985
			#define Endpoint_AllocateMemory()              MACROS{ UECFG1X |=  (1 << ALLOC); }MACROE
			#define Endpoint_DeallocateMemory()            MACROS{ UECFG1X &= ~(1 << ALLOC); }MACROE
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
			
			#define _ENDPOINT_GET_MAXSIZE(n)               _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## n)
			#define _ENDPOINT_GET_MAXSIZE2(details)        _ENDPOINT_GET_MAXSIZE3(details)
			#define _ENDPOINT_GET_MAXSIZE3(maxsize, db)    maxsize

			#define _ENDPOINT_GET_DOUBLEBANK(n)            _ENDPOINT_GET_DOUBLEBANK2(ENDPOINT_DETAILS_EP ## n)
			#define _ENDPOINT_GET_DOUBLEBANK2(details)     _ENDPOINT_GET_DOUBLEBANK3(details)
			#define _ENDPOINT_GET_DOUBLEBANK3(maxsize, db) db
			
			#if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER)
				#define ENDPOINT_DETAILS_EP0               64,  true
				#define ENDPOINT_DETAILS_EP1               256, true
				#define ENDPOINT_DETAILS_EP2               64,  true
				#define ENDPOINT_DETAILS_EP3               64,  true
				#define ENDPOINT_DETAILS_EP4               64,  true