Endpoint.h 56.7 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
69
#ifndef __ENDPOINT_H__
#define __ENDPOINT_H__

	/* Includes: */
		#include <avr/io.h>
70
71
		#include <avr/pgmspace.h>
		#include <avr/eeprom.h>
72
73
74
75
76
77
		#include <stdbool.h>

		#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
86
87
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Public Interface - May be used in end-application: */
		/* Macros: */
88
			/** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
89
90
			 *  should be initialized in the OUT direction - i.e. data flows from host to device.
			 */
91
			#define ENDPOINT_DIR_OUT                      (0 << EPDIR)
92

93
			/** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
94
95
			 *  should be initialized in the IN direction - i.e. data flows from device to host.
			 */
96
			#define ENDPOINT_DIR_IN                       (1 << EPDIR)
97

98
			/** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
99
100
101
102
			 *  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.
			 */
103
			#define ENDPOINT_BANK_SINGLE                  (0 << EPBK0)
104

105
			/** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
106
107
108
109
			 *  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.
			 */
110
			#define ENDPOINT_BANK_DOUBLE                  (1 << EPBK0)
111
112
113
114
			
			/** 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.
			 */
115
			#define ENDPOINT_CONTROLEP                    0
116
117

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

129
130
131
132
133
			/** 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

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

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

151
			#if !defined(CONTROL_ONLY_DEVICE)
152
				#if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
153
154
155
156
157
158
159
160
					/** Total number of endpoints (including the default control endpoint at address 0) which may
					 *  be used in the device. Different USB AVR models support different amounts of endpoints,
					 *  this value reflects the maximum number of endpoints for the currently selected AVR model.
					 */
					#define ENDPOINT_TOTAL_ENDPOINTS          7
				#else
					#define ENDPOINT_TOTAL_ENDPOINTS          5			
				#endif
161
			#else
162
				#define ENDPOINT_TOTAL_ENDPOINTS              1
163
164
			#endif
			
165
		/* Pseudo-Function Macros: */
166
167
168
169
170
171
172
173
174
175
176
			#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);
177
			
178
179
180
181
182
183
184
185
186
				/** 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
187
				 *  value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
188
189
190
191
192
				 *  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.
				 *
193
				 *  \param[in] EndpointNumber Endpoint number to select
194
195
196
197
198
199
				 */
				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.
				 *
200
				 *  \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset
201
202
203
204
205
206
				 */
				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.
				 *
207
				 *  \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
208
209
				 */
				static inline void Endpoint_EnableEndpoint(void);
210

211
212
213
214
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
				/** 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).
				 *
251
				 *  \param[in] EndpointNumber  Index of the endpoint whose interrupt flag should be tested
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
				 *
				 *  \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.			 
				 */
288
				static inline void Endpoint_ClearSETUP(void);
289
				
290
291
				/** 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.
292
293
294
295
296
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 */
				static inline void Endpoint_ClearIN(void);
				
297
298
				/** 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.
299
300
301
302
303
304
305
306
307
308
				 *
				 *  \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.
				 *
309
				 *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
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
				 *  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);
339
340
341

				/** Sets the direction of the currently selected endpoint.
				 *
342
				 *  \param[in] DirectionMask  New endpoint direction, as a ENDPOINT_DIR_* mask.
343
344
				 */
				static inline void Endpoint_SetEndpointDirection(uint8_t DirectionMask);
345
			#else
346
				#if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
347
					#define Endpoint_BytesInEndpoint()        UEBCX
348
349
350
				#elif defined(USB_SERIES_4_AVR)
					#define Endpoint_BytesInEndpoint()        (((uint16_t)UEBCHX << 8) | UEBCLX)				
				#elif defined(USB_SERIES_2_AVR)
351
352
353
					#define Endpoint_BytesInEndpoint()        UEBCLX
				#endif
				
354
355
356
357
358
				#if !defined(CONTROL_ONLY_DEVICE)
					#define Endpoint_GetCurrentEndpoint()     (UENUM & ENDPOINT_EPNUM_MASK)
				#else
					#define Endpoint_GetCurrentEndpoint()     ENDPOINT_CONTROLEP
				#endif
359
				
360
				#if !defined(CONTROL_ONLY_DEVICE)
361
					#define Endpoint_SelectEndpoint(epnum)    MACROS{ UENUM = (epnum); }MACROE
362
				#else
363
					#define Endpoint_SelectEndpoint(epnum)    (void)(epnum)
364
				#endif
365

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

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

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

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

374
375
376
377
				#if !defined(CONTROL_ONLY_DEVICE)
					#define Endpoint_IsReadWriteAllowed()     ((UEINTX & (1 << RWAL)) ? true : false)
				#endif
				
378
				#define Endpoint_IsConfigured()               ((UESTA0X & (1 << CFGOK)) ? true : false)
379

380
				#define Endpoint_GetEndpointInterrupts()      UEINT
381

382
				#define Endpoint_HasEndpointInterrupted(n)    ((UEINT & (1 << (n))) ? true : false)
383
				
384
				#define Endpoint_IsINReady()                  ((UEINTX & (1 << TXINI))  ? true : false)
385
				
386
				#define Endpoint_IsOUTReceived()              ((UEINTX & (1 << RXOUTI)) ? true : false)
387

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

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

392
393
394
395
396
397
				#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
398

399
400
401
402
403
404
				#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
405

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

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

410
411
412
413
414
				#define Endpoint_IsStalled()                  ((UECONX & (1 << STALLRQ)) ? true : false)

				#define Endpoint_ResetDataToggle()            MACROS{ UECONX |= (1 << RSTDT); }MACROE
				
				#define Endpoint_GetEndpointDirection()       (UECFG0X & ENDPOINT_DIR_IN)
415
				
416
				#define Endpoint_SetEndpointDirection(dir)    MACROS{ UECFG0X = ((UECFG0X & ~ENDPOINT_DIR_IN) | (dir)); }MACROE
417
			#endif
418
419

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

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

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

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

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

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

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

676
677
			/** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.	
			 *
678
			 *  \ingroup Group_EndpointPrimitiveRW
679
			 */
680
			static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
681
682
683
684
685
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
			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: */
714
			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
Dean Camera's avatar
Dean Camera committed
715
				#define __CALLBACK_PARAM     , StreamCallbackPtr_t Callback
716
			#else
Dean Camera's avatar
Dean Camera committed
717
				#define __CALLBACK_PARAM			
718
719
			#endif
		
720
721
			/** 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
722
723
			 *  device (i.e. endpoint 1 should be configured before endpoint 2 and so on) to prevent fragmentation
			 *  of the USB FIFO memory.
724
725
			 *
			 *  The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction
726
			 *  may be either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
727
728
729
730
731
			 *
			 *  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.
			 *
732
			 *  The banking mode may be either \ref ENDPOINT_BANK_SINGLE or \ref ENDPOINT_BANK_DOUBLE.
733
			 *
734
735
			 *  \note The default control endpoint does not have to be manually configured, as it is automatically
			 *  configured by the library internally.
736
737
738
739
740
741
742
743
744
			 *
			 *  \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);

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

			/** 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
765
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
766
767
768
			 *  each USB packet, the given stream callback function is executed repeatedly until the next
			 *  packet is ready, allowing for early aborts of stream transfers.
			 *
769
770
771
			 *	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.
772
773
774
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
775
			 *  \ingroup Group_EndpointStreamRW
776
			 *
777
778
			 *  \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
779
			 *
780
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
781
			 */
Dean Camera's avatar
Dean Camera committed
782
			uint8_t Endpoint_Discard_Stream(uint16_t Length __CALLBACK_PARAM);
783
784
785
786

			/** 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
787
			 *  \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
788
789
790
			 *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
			 *  aborts of stream transfers.
			 *
791
792
793
			 *	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.
794
795
796
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
797
			 *  \ingroup Group_EndpointStreamRW
798
			 *
799
800
801
			 *  \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
802
			 *
803
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
804
			 */
805
			uint8_t Endpoint_Write_Stream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
806

807
			/** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE().
808
809
810
811
812
813
814
815
816
			 *
			 *  \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.
			 */
817
			uint8_t Endpoint_Write_EStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
818

819
			/** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().
820
821
822
823
824
825
826
827
828
829
830
			 *
			 *  \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.
			 */
831
			uint8_t Endpoint_Write_PStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
832
833
834
835

			/** 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
836
			 *  \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
837
838
839
			 *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
			 *  aborts of stream transfers.
			 *
840
841
842
			 *	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.
843
844
845
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
846
			 *  \ingroup Group_EndpointStreamRW
847
			 *
848
849
850
			 *  \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
851
			 *
852
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
853
			 */
854
			uint8_t Endpoint_Write_Stream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
855

856
			/** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE().
857
858
859
860
861
862
863
864
865
			 *
			 *  \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.
			 */
866
			uint8_t Endpoint_Write_EStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
867

868
			/** FLASH buffer source version of \ref Endpoint_Write_Stream_BE().
869
870
871
872
873
874
875
876
877
878
879
			 *
			 *  \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.
			 */
880
			uint8_t Endpoint_Write_PStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
881
882
883
884

			/** 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
885
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
886
887
888
			 *  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.
			 *
889
890
891
			 *	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.
892
893
894
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
895
			 *  \ingroup Group_EndpointStreamRW
896
			 *
897
			 *  \param[out] Buffer   Pointer to the destination data buffer to write to.
898
899
			 *  \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
900
			 *
901
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
902
			 */
Dean Camera's avatar
Dean Camera committed
903
			uint8_t Endpoint_Read_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
904

905
			/** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().
906
907
908
909
910
911
912
913
914
			 *
			 *  \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
915
			uint8_t Endpoint_Read_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
916
			
917
918
919
			/** 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
920
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
921
922
923
			 *  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.
			 *
924
925
926
			 *	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.
927
928
929
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
930
			 *  \ingroup Group_EndpointStreamRW
931
			 *
932
933
934
			 *  \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
935
			 *
936
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
937
			 */
Dean Camera's avatar
Dean Camera committed
938
			uint8_t Endpoint_Read_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
939

940
			/** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().
941
942
943
944
945
946
947
948
949
			 *
			 *  \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
950
			uint8_t Endpoint_Read_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
951

952
			/** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
953
			 *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
954
			 *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
955
			 *  finalize the transfer via the \ref Endpoint_ClearOUT() macro.
956
			 *
957
958
959
			 *  \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.
			 *
960
961
962
963
964
			 *  \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.
			 *
965
			 *  \ingroup Group_EndpointStreamRW
966
			 *
967
968
			 *  \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.
969
			 *
970
			 *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
971
			 */
972
			uint8_t Endpoint_Write_Control_Stream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
973
974

			/** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.
975
976
977
			 *
			 *  \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.
978
979
980
981
982
983
984
985
986
987
988
989
990
			 *
			 *  \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.
			 */
991
			uint8_t Endpoint_Write_Control_EStream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
992

993
			/** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_LE().
994
995
996
			 *
			 *  \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.
997
998
999
1000
			 *
			 *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
			 *
			 *  \note This routine should only be used on CONTROL type endpoints.