Endpoint.h 56.9 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

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

31
32
/** \ingroup Group_USB
 *  @defgroup Group_EndpointManagement Endpoint Management
33
34
35
 *
 *  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
36
 *  send/receive functions for various data types.
37
38
39
40
41
42
43
44
 *
 *  @{
 */

/** @defgroup Group_EndpointRW Endpoint Data Reading and Writing
 *
 *  Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
 */
45
 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/** \ingroup Group_EndpointRW  
 *  @defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types
 *
 *  Functions, macros, variables, enums and types related to data reading and writing of primitive data types
 *  from and to endpoints.
 */ 

/** \ingroup Group_EndpointRW  
 *  @defgroup Group_EndpointStreamRW Read/Write of Multi-Byte Streams
 *
 *  Functions, macros, variables, enums and types related to data reading and writing of data streams from
 *  and to endpoints.
 */ 

60
61
62
63
64
/** @defgroup Group_EndpointPacketManagement Endpoint Packet Management
 *
 *  Functions, macros, variables, enums and types related to packet management of endpoints.
 */

65
66
67
68
#ifndef __ENDPOINT_H__
#define __ENDPOINT_H__

	/* Includes: */
69
70
71
72
73
		#include <avr/io.h>
		#include <avr/pgmspace.h>
		#include <avr/eeprom.h>
		#include <stdbool.h>

74
75
76
77
		#include "../../../Common/Common.h"
		#include "../HighLevel/USBTask.h"

		#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
78
			#include "../HighLevel/StreamCallbacks.h"
79
		#endif
80
		
81
82
83
84
85
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

86
87
	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_USB_DRIVER)
88
			#error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
89
90
		#endif
		
91
92
	/* Public Interface - May be used in end-application: */
		/* Macros: */
93
94
95
96
			/** 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.
			 */
			#define ENDPOINT_DIR_OUT                      (0 << EPDIR)
97

98
99
100
101
			/** 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.
			 */
			#define ENDPOINT_DIR_IN                       (1 << EPDIR)
102

103
104
105
106
107
108
109
110
111
112
113
114
115
			/** 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.
			 */
			#define ENDPOINT_BANK_SINGLE                  (0 << EPBK0)

			/** 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.
			 */
			#define ENDPOINT_BANK_DOUBLE                  (1 << EPBK0)
116
117
118
119
			
			/** 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.
			 */
120
			#define ENDPOINT_CONTROLEP                    0
121
122

			#if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
123
124
125
				/** 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.
				 */
126
				#define ENDPOINT_CONTROLEP_DEFAULT_SIZE   8
127
128
129
130
131
			#endif
			
			/** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  numerical address in the device.
			 */
132
			#define ENDPOINT_EPNUM_MASK                   0x07
133

134
135
136
137
138
			/** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks.
			 */
			#define ENDPOINT_EPDIR_MASK                   0x80

139
140
141
			/** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  bank size in the device.
			 */
142
			#define ENDPOINT_EPSIZE_MASK                  0x7FF
143
144
145
			
			/** Maximum size in bytes of a given endpoint.
			 *
146
			 *  \param[in] n  Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
147
			 */				
148
			#define ENDPOINT_MAX_SIZE(n)                  _ENDPOINT_GET_MAXSIZE(n)
149
150
151

			/** Indicates if the given endpoint supports double banking.
			 *
152
			 *  \param[in] n  Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
153
			 */				
154
			#define ENDPOINT_DOUBLEBANK_SUPPORTED(n)      _ENDPOINT_GET_DOUBLEBANK(n)
155

156
			#if !defined(CONTROL_ONLY_DEVICE)
157
				#if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
158
159
160
161
					/** 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.
					 */
162
					#define ENDPOINT_TOTAL_ENDPOINTS          7
163
				#else
164
					#define ENDPOINT_TOTAL_ENDPOINTS          5			
165
				#endif
166
			#else
167
				#define ENDPOINT_TOTAL_ENDPOINTS              1
168
169
			#endif
			
170
		/* Pseudo-Function Macros: */
171
172
173
174
175
176
177
178
179
180
181
			#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);
182
			
183
184
185
186
187
188
189
190
191
				/** 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
192
				 *  value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
193
194
195
196
197
				 *  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.
				 *
198
				 *  \param[in] EndpointNumber Endpoint number to select
199
200
201
202
203
204
				 */
				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.
				 *
205
				 *  \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset
206
207
208
209
210
211
				 */
				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.
				 *
212
				 *  \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
213
214
				 */
				static inline void Endpoint_EnableEndpoint(void);
215

216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
				/** 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);
				
				/** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
				 *  endpoints).
				 *
256
				 *  \param[in] EndpointNumber  Index of the endpoint whose interrupt flag should be tested
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
				 *
				 *  \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.			 
				 */
293
				static inline void Endpoint_ClearSETUP(void);
294
				
295
296
				/** 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.
297
298
299
300
301
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 */
				static inline void Endpoint_ClearIN(void);
				
302
303
				/** 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.
304
305
306
307
308
309
310
311
312
313
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 */
				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.
				 *
314
				 *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
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
				 *  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);
344
345
346

				/** Sets the direction of the currently selected endpoint.
				 *
347
				 *  \param[in] DirectionMask  New endpoint direction, as a ENDPOINT_DIR_* mask.
348
349
				 */
				static inline void Endpoint_SetEndpointDirection(uint8_t DirectionMask);
350
			#else
351
				#if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
352
					#define Endpoint_BytesInEndpoint()        UEBCX
353
354
355
				#elif defined(USB_SERIES_4_AVR)
					#define Endpoint_BytesInEndpoint()        (((uint16_t)UEBCHX << 8) | UEBCLX)				
				#elif defined(USB_SERIES_2_AVR)
356
357
358
					#define Endpoint_BytesInEndpoint()        UEBCLX
				#endif
				
359
360
361
362
				#if !defined(CONTROL_ONLY_DEVICE)
					#define Endpoint_GetCurrentEndpoint()     (UENUM & ENDPOINT_EPNUM_MASK)
				#else
					#define Endpoint_GetCurrentEndpoint()     ENDPOINT_CONTROLEP
363
				#endif
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
				
				#if !defined(CONTROL_ONLY_DEVICE)
					#define Endpoint_SelectEndpoint(epnum)    MACROS{ UENUM = (epnum); }MACROE
				#else
					#define Endpoint_SelectEndpoint(epnum)    (void)(epnum)
				#endif

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

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

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

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

				#if !defined(CONTROL_ONLY_DEVICE)
					#define Endpoint_IsReadWriteAllowed()     ((UEINTX & (1 << RWAL)) ? true : false)
				#endif
				
				#define Endpoint_IsConfigured()               ((UESTA0X & (1 << CFGOK)) ? true : false)

				#define Endpoint_GetEndpointInterrupts()      UEINT

				#define Endpoint_HasEndpointInterrupted(n)    ((UEINT & (1 << (n))) ? true : false)
				
				#define Endpoint_IsINReady()                  ((UEINTX & (1 << TXINI))  ? true : false)
				
				#define Endpoint_IsOUTReceived()              ((UEINTX & (1 << RXOUTI)) ? true : false)

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

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

				#if !defined(CONTROL_ONLY_DEVICE)
					#define Endpoint_ClearIN()                MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << TXINI)); \
					                                                  UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
				#else
					#define Endpoint_ClearIN()                MACROS{ UEINTX &= ~(1 << TXINI); }MACROE
				#endif

				#if !defined(CONTROL_ONLY_DEVICE)
					#define Endpoint_ClearOUT()               MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << RXOUTI)); \
					                                                  UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
				#else
					#define Endpoint_ClearOUT()               MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE			
				#endif

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

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

				#define Endpoint_IsStalled()                  ((UECONX & (1 << STALLRQ)) ? true : false)

				#define Endpoint_ResetDataToggle()            MACROS{ UECONX |= (1 << RSTDT); }MACROE
				
				#define Endpoint_GetEndpointDirection()       (UECFG0X & ENDPOINT_DIR_IN)
				
				#define Endpoint_SetEndpointDirection(dir)    MACROS{ UECFG0X = ((UECFG0X & ~ENDPOINT_DIR_IN) | (dir)); }MACROE
422
			#endif
423
424

		/* Enums: */
425
			/** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
426
427
428
			 *
			 *  \ingroup Group_EndpointRW
			 */
429
430
431
432
433
434
435
436
437
438
439
			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
440
				                                                 *   \ref USB_STREAM_TIMEOUT_MS macro.
441
442
443
				                                                 */
			};
		
444
445
			/** Enum for the possible error return codes of the Endpoint_*_Stream_* functions.
			 *
446
			 *  \ingroup Group_EndpointStreamRW
447
			 */
448
449
			enum Endpoint_Stream_RW_ErrorCodes_t
			{
450
451
452
453
				ENDPOINT_RWSTREAM_NoError            = 0, /**< Command completed successfully, no error. */
				ENDPOINT_RWSTREAM_EndpointStalled    = 1, /**< The endpoint was stalled during the stream
				                                           *   transfer by the host or device.
				                                           */
454
				ENDPOINT_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
455
456
				                                           *   the transfer.
				                                           */
457
				ENDPOINT_RWSTREAM_Timeout            = 3, /**< The host failed to accept or send the next packet
458
459
460
				                                           *   within the software timeout period set by the
				                                           *   \ref USB_STREAM_TIMEOUT_MS macro.
				                                           */
461
				ENDPOINT_RWSTREAM_CallbackAborted    = 4, /**< Indicates that the stream's callback function
462
463
			                                               *   aborted the transfer early.
				                                           */
464
465
			};
			
466
467
			/** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..
			 *
468
			 *  \ingroup Group_EndpointStreamRW
469
			 */
470
471
			enum Endpoint_ControlStream_RW_ErrorCodes_t
			{
472
473
				ENDPOINT_RWCSTREAM_NoError            = 0, /**< Command completed successfully, no error. */
				ENDPOINT_RWCSTREAM_HostAborted        = 1, /**< The aborted the transfer prematurely. */
474
475
476
				ENDPOINT_RWCSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
				                                            *   the transfer.
				                                            */
477
478
479
			};

		/* Inline Functions: */
480
481
			/** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
482
			 *  \ingroup Group_EndpointPrimitiveRW
483
484
485
			 *
			 *  \return Next byte in the currently selected endpoint's FIFO buffer
			 */
486
			static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
487
488
489
490
491
			static inline uint8_t Endpoint_Read_Byte(void)
			{
				return UEDATX;
			}

492
493
			/** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
			 *
494
			 *  \ingroup Group_EndpointPrimitiveRW
495
			 *
496
			 *  \param[in] Byte  Next byte to write into the the currently selected endpoint's FIFO buffer
497
			 */
498
			static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
499
500
501
502
503
			static inline void Endpoint_Write_Byte(const uint8_t Byte)
			{
				UEDATX = Byte;
			}

504
505
			/** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
506
			 *  \ingroup Group_EndpointPrimitiveRW
507
			 */
508
			static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
509
510
511
512
513
514
515
516
517
			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.
518
			 *
519
			 *  \ingroup Group_EndpointPrimitiveRW
520
521
			 *
			 *  \return Next word in the currently selected endpoint's FIFO buffer
522
			 */
523
			static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
524
525
			static inline uint16_t Endpoint_Read_Word_LE(void)
			{
526
527
528
529
530
				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
531
				
532
533
				Data.Bytes[0] = UEDATX;
				Data.Bytes[1] = UEDATX;
534
			
535
				return Data.Word;
536
537
538
539
			}

			/** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
			 *  direction endpoints.
540
			 *
541
			 *  \ingroup Group_EndpointPrimitiveRW
542
543
			 *
			 *  \return Next word in the currently selected endpoint's FIFO buffer
544
			 */
545
			static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
546
547
			static inline uint16_t Endpoint_Read_Word_BE(void)
			{
548
549
550
551
552
				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
553
				
554
555
				Data.Bytes[1] = UEDATX;
				Data.Bytes[0] = UEDATX;
556
			
557
				return Data.Word;
558
559
560
561
			}

			/** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
			 *  direction endpoints.
562
			 *
563
			 *  \ingroup Group_EndpointPrimitiveRW
564
			 *
565
			 *  \param[in] Word  Next word to write to the currently selected endpoint's FIFO buffer
566
			 */
567
			static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
568
569
570
571
572
573
574
575
			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.
576
			 *
577
			 *  \ingroup Group_EndpointPrimitiveRW
578
			 *
579
			 *  \param[in] Word  Next word to write to the currently selected endpoint's FIFO buffer
580
			 */
581
			static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
582
583
584
585
586
587
			static inline void Endpoint_Write_Word_BE(const uint16_t Word)
			{
				UEDATX = (Word >> 8);
				UEDATX = (Word & 0xFF);
			}

588
589
			/** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
590
			 *  \ingroup Group_EndpointPrimitiveRW
591
			 */
592
			static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
593
594
595
596
597
598
599
600
601
602
			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.
603
			 *
604
			 *  \ingroup Group_EndpointPrimitiveRW
605
606
			 *
			 *  \return Next double word in the currently selected endpoint's FIFO buffer
607
			 */
608
			static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
			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.
627
			 *
628
			 *  \ingroup Group_EndpointPrimitiveRW
629
630
			 *
			 *  \return Next double word in the currently selected endpoint's FIFO buffer
631
			 */
632
			static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
			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.
651
			 *
652
			 *  \ingroup Group_EndpointPrimitiveRW
653
			 *
654
			 *  \param[in] DWord  Next double word to write to the currently selected endpoint's FIFO buffer
655
			 */
656
			static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
657
658
			static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
			{
659
660
661
662
				UEDATX = (DWord &  0xFF);
				UEDATX = (DWord >> 8);
				UEDATX = (DWord >> 16);
				UEDATX = (DWord >> 24);
663
664
665
666
			}
			
			/** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
			 *  direction endpoints.
667
			 *
668
			 *  \ingroup Group_EndpointPrimitiveRW
669
			 *
670
			 *  \param[in] DWord  Next double word to write to the currently selected endpoint's FIFO buffer
671
			 */
672
			static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
673
674
			static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
			{
675
676
677
678
				UEDATX = (DWord >> 24);
				UEDATX = (DWord >> 16);
				UEDATX = (DWord >> 8);
				UEDATX = (DWord &  0xFF);
679
680
			}

681
682
			/** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.	
			 *
683
			 *  \ingroup Group_EndpointPrimitiveRW
684
			 */
685
			static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
			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: */
719
			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
Dean Camera's avatar
Dean Camera committed
720
				#define __CALLBACK_PARAM     , StreamCallbackPtr_t Callback
721
			#else
Dean Camera's avatar
Dean Camera committed
722
				#define __CALLBACK_PARAM			
723
724
			#endif
		
725
726
			/** 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
727
728
			 *  device (i.e. endpoint 1 should be configured before endpoint 2 and so on) to prevent fragmentation
			 *  of the USB FIFO memory.
729
730
			 *
			 *  The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction
731
			 *  may be either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
732
733
734
735
736
			 *
			 *  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.
			 *
737
			 *  The banking mode may be either \ref ENDPOINT_BANK_SINGLE or \ref ENDPOINT_BANK_DOUBLE.
738
			 *
739
740
			 *  \note The default control endpoint does not have to be manually configured, as it is automatically
			 *  configured by the library internally.
741
742
743
744
745
746
			 *
			 *  \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
			 */
747
748
			bool Endpoint_ConfigureEndpoint(const uint8_t  Number, const uint8_t Type, const uint8_t Direction,
			                                const uint16_t Size, const uint8_t Banks);
749

750
			/** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
751
752
753
754
			 *  to be read or written to it.
			 *
			 *  \note This routine should not be called on CONTROL type endpoints.
			 *
755
756
			 *  \ingroup Group_EndpointRW
			 *
757
			 *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
758
759
			 */
			uint8_t Endpoint_WaitUntilReady(void);
760
761
762
763
764
765
			
			/** 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);
766
767
768
769

			/** 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
770
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
771
772
773
			 *  each USB packet, the given stream callback function is executed repeatedly until the next
			 *  packet is ready, allowing for early aborts of stream transfers.
			 *
774
775
776
			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.
			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
			 *  disabled and this function has the Callback parameter omitted.
777
778
779
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
780
			 *  \ingroup Group_EndpointStreamRW
781
			 *
782
783
			 *  \param[in] Length    Number of bytes to send via the currently selected endpoint.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
784
			 *
785
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
786
			 */
Dean Camera's avatar
Dean Camera committed
787
			uint8_t Endpoint_Discard_Stream(uint16_t Length __CALLBACK_PARAM);
788
789
790
791

			/** 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
792
			 *  \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
793
794
795
			 *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
			 *  aborts of stream transfers.
			 *
796
797
798
			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.
			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
			 *  disabled and this function has the Callback parameter omitted.
799
800
801
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
802
			 *  \ingroup Group_EndpointStreamRW
803
			 *
804
805
806
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
807
			 *
808
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
809
			 */
810
			uint8_t Endpoint_Write_Stream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
811

812
			/** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE().
813
814
815
816
817
818
819
820
821
			 *
			 *  \ingroup Group_EndpointStreamRW
			 *
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
			 *
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
822
			uint8_t Endpoint_Write_EStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
823

824
			/** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().
825
826
827
828
829
830
831
832
833
834
835
			 *
			 *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
			 *
			 *  \ingroup Group_EndpointStreamRW
			 *
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
			 *
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
836
			uint8_t Endpoint_Write_PStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
837
838
839
840

			/** 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
841
			 *  \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
842
843
844
			 *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
			 *  aborts of stream transfers.
			 *
845
846
847
			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.
			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
			 *  disabled and this function has the Callback parameter omitted.
848
849
850
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
851
			 *  \ingroup Group_EndpointStreamRW
852
			 *
853
854
855
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
856
			 *
857
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
858
			 */
859
			uint8_t Endpoint_Write_Stream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
860

861
			/** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE().
862
863
864
865
866
867
868
869
870
			 *
			 *  \ingroup Group_EndpointStreamRW
			 *
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
			 *
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
871
			uint8_t Endpoint_Write_EStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
872

873
			/** FLASH buffer source version of \ref Endpoint_Write_Stream_BE().
874
875
876
877
878
879
880
881
882
883
884
			 *
			 *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
			 *
			 *  \ingroup Group_EndpointStreamRW
			 *
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
			 *
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
885
			uint8_t Endpoint_Write_PStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
886
887
888
889

			/** 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
890
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
891
892
893
			 *  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.
			 *
894
895
896
			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.
			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
			 *  disabled and this function has the Callback parameter omitted.
897
898
899
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
900
			 *  \ingroup Group_EndpointStreamRW
901
			 *
902
			 *  \param[out] Buffer   Pointer to the destination data buffer to write to.
903
904
			 *  \param[in] Length    Number of bytes to send via the currently selected endpoint.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
905
			 *
906
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
907
			 */
Dean Camera's avatar
Dean Camera committed
908
			uint8_t Endpoint_Read_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
909

910
			/** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().
911
912
913
914
915
916
917
918
919
			 *
			 *  \ingroup Group_EndpointStreamRW
			 *
			 *  \param[out] Buffer   Pointer to the destination data buffer to write to, located in EEPROM memory space.
			 *  \param[in] Length    Number of bytes to send via the currently selected endpoint.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
			 *
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
Dean Camera's avatar
Dean Camera committed
920
			uint8_t Endpoint_Read_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
921
			
922
923
924
			/** 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
925
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
926
927
928
			 *  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.
			 *
929
930
931
			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.
			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
			 *  disabled and this function has the Callback parameter omitted.
932
933
934
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
935
			 *  \ingroup Group_EndpointStreamRW
936
			 *
937
938
939
			 *  \param[out] Buffer    Pointer to the destination data buffer to write to.
			 *  \param[in] Length    Number of bytes to send via the currently selected endpoint.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
940
			 *
941
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
942
			 */
Dean Camera's avatar
Dean Camera committed
943
			uint8_t Endpoint_Read_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
944

945
			/** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().
946
947
948
949
950
951
952
953
954
			 *
			 *  \ingroup Group_EndpointStreamRW
			 *
			 *  \param[out] Buffer   Pointer to the destination data buffer to write to, located in EEPROM memory space.
			 *  \param[in] Length    Number of bytes to send via the currently selected endpoint.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
			 *
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
Dean Camera's avatar
Dean Camera committed
955
			uint8_t Endpoint_Read_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
956

957
			/** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
958
			 *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
959
			 *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
960
			 *  finalize the transfer via the \ref Endpoint_ClearOUT() macro.
961
			 *
962
963
964
			 *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
			 *        to clear the status stage when using this routine in a control transaction.
			 *
965
966
967
968
969
			 *  \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.
			 *
970
			 *  \ingroup Group_EndpointStreamRW
971
			 *
972
973
			 *  \param[in] Buffer  Pointer to the source data buffer to read from.
			 *  \param[in] Length  Number of bytes to read for the currently selected endpoint into the buffer.
974
			 *
975
			 *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
976
			 */
977
			uint8_t Endpoint_Write_Control_Stream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
978
979

			/** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.
980
981
982
			 *
			 *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
			 *        to clear the status stage when using this routine in a control transaction.
983
984
985
986
987
988
989
990
991
992
993
994
995
			 *
			 *  \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.
			 *
			 *  \ingroup Group_EndpointStreamRW
			 *
			 *  \param[in] Buffer  Pointer to the source data buffer to read from.
			 *  \param[in] Length  Number of bytes to read for the currently selected endpoint into the buffer.
			 *
			 *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
			 */
996
			uint8_t Endpoint_Write_Control_EStream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
997

998
			/** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_LE().
999
1000
			 *
			 *  \note This function automatically clears the control transfer's status stage. Do not manually attempt