Endpoint.h 58.3 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
33
34
35
36
37
38
39
40
/** \file
 *  \brief USB device endpoint management definitions.
 *
 *  This file contains structures, function prototypes and macros related to the management of the device's
 *  data endpoints when the library is initialized in USB device mode.
 *
 *  \note This file should not be included directly. It is automatically included as needed by the USB driver
 *        dispatch header located in LUFA/Drivers/USB/USB.h.
 */

41
42
/** \ingroup Group_USB
 *  @defgroup Group_EndpointManagement Endpoint Management
43
44
45
 *
 *  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
46
 *  send/receive functions for various data types.
47
48
49
50
51
52
53
54
 *
 *  @{
 */

/** @defgroup Group_EndpointRW Endpoint Data Reading and Writing
 *
 *  Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
 */
55
 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/** \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.
 */ 

70
71
72
73
74
/** @defgroup Group_EndpointPacketManagement Endpoint Packet Management
 *
 *  Functions, macros, variables, enums and types related to packet management of endpoints.
 */

75
76
77
78
#ifndef __ENDPOINT_H__
#define __ENDPOINT_H__

	/* Includes: */
79
80
81
82
83
		#include <avr/io.h>
		#include <avr/pgmspace.h>
		#include <avr/eeprom.h>
		#include <stdbool.h>

84
85
86
87
		#include "../../../Common/Common.h"
		#include "../HighLevel/USBTask.h"

		#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
88
			#include "../HighLevel/StreamCallbacks.h"
89
		#endif
90
		
91
92
93
94
95
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

96
97
	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_USB_DRIVER)
98
			#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
99
100
		#endif
		
101
102
	/* Public Interface - May be used in end-application: */
		/* Macros: */
103
104
105
106
			/** 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)
107

108
109
110
111
			/** 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)
112

113
114
115
116
117
118
119
120
121
122
123
124
125
			/** 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)
126
127
128
129
			
			/** 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.
			 */
130
			#define ENDPOINT_CONTROLEP                    0
131
132

			#if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
133
134
135
				/** 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.
				 */
136
				#define ENDPOINT_CONTROLEP_DEFAULT_SIZE   8
137
138
139
140
141
			#endif
			
			/** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  numerical address in the device.
			 */
142
			#define ENDPOINT_EPNUM_MASK                   0x07
143

144
145
146
147
148
			/** 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

149
150
151
			/** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  bank size in the device.
			 */
152
			#define ENDPOINT_EPSIZE_MASK                  0x7FF
153
154
155
			
			/** Maximum size in bytes of a given endpoint.
			 *
156
			 *  \param[in] n  Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
157
			 */				
158
			#define ENDPOINT_MAX_SIZE(n)                  _ENDPOINT_GET_MAXSIZE(n)
159
160
161

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

166
			#if !defined(CONTROL_ONLY_DEVICE)
167
				#if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
168
169
170
171
					/** 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.
					 */
172
					#define ENDPOINT_TOTAL_ENDPOINTS          7
173
				#else
174
					#define ENDPOINT_TOTAL_ENDPOINTS          5			
175
				#endif
176
			#else
177
				#define ENDPOINT_TOTAL_ENDPOINTS              1
178
179
			#endif
			
180
		/* Pseudo-Function Macros: */
181
182
183
184
185
186
187
188
189
190
191
			#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);
192
			
193
194
195
196
197
198
199
200
201
				/** 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
202
				 *  value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
203
204
205
206
207
				 *  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.
				 *
208
				 *  \param[in] EndpointNumber Endpoint number to select
209
210
211
212
213
214
				 */
				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.
				 *
215
				 *  \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset
216
217
218
219
220
221
				 */
				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.
				 *
222
				 *  \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
223
224
				 */
				static inline void Endpoint_EnableEndpoint(void);
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
256
257
258
259
260
261
262
263
264
265
				/** 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).
				 *
266
				 *  \param[in] EndpointNumber  Index of the endpoint whose interrupt flag should be tested
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
				 *
				 *  \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.			 
				 */
303
				static inline void Endpoint_ClearSETUP(void);
304
				
305
306
				/** 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.
307
308
309
310
311
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 */
				static inline void Endpoint_ClearIN(void);
				
312
313
				/** 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.
314
315
316
317
318
319
320
321
322
323
				 *
				 *  \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.
				 *
324
				 *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
				 *  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);
354
355
356

				/** Sets the direction of the currently selected endpoint.
				 *
357
				 *  \param[in] DirectionMask  New endpoint direction, as a ENDPOINT_DIR_* mask.
358
359
				 */
				static inline void Endpoint_SetEndpointDirection(uint8_t DirectionMask);
360
			#else
361
				#if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
362
					#define Endpoint_BytesInEndpoint()        UEBCX
363
364
365
				#elif defined(USB_SERIES_4_AVR)
					#define Endpoint_BytesInEndpoint()        (((uint16_t)UEBCHX << 8) | UEBCLX)				
				#elif defined(USB_SERIES_2_AVR)
366
367
368
					#define Endpoint_BytesInEndpoint()        UEBCLX
				#endif
				
369
370
371
372
				#if !defined(CONTROL_ONLY_DEVICE)
					#define Endpoint_GetCurrentEndpoint()     (UENUM & ENDPOINT_EPNUM_MASK)
				#else
					#define Endpoint_GetCurrentEndpoint()     ENDPOINT_CONTROLEP
373
				#endif
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
				
				#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)
408
					#define Endpoint_ClearIN()                MACROS{ UEINTX &= ~((1 << TXINI) | (1 << FIFOCON)); }MACROE
409
410
411
412
413
				#else
					#define Endpoint_ClearIN()                MACROS{ UEINTX &= ~(1 << TXINI); }MACROE
				#endif

				#if !defined(CONTROL_ONLY_DEVICE)
414
					#define Endpoint_ClearOUT()               MACROS{ UEINTX &= ~((1 << RXOUTI) | (1 << FIFOCON)); }MACROE
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
				#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
430
			#endif
431
432

		/* Enums: */
433
			/** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
434
435
436
			 *
			 *  \ingroup Group_EndpointRW
			 */
437
438
439
440
441
442
443
444
			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.
445
446
447
448
449
450
				                                                 */
				ENDPOINT_READYWAIT_BusSuspended            = 3, /**< The USB bus has been suspended by the host and
				                                                 *   no USB endpoint traffic can occur until the bus
				                                                 *   has resumed.
				                                                 */
				ENDPOINT_READYWAIT_Timeout                 = 4, /**< The host failed to accept or send the next packet
451
				                                                 *   within the software timeout period set by the
452
				                                                 *   \ref USB_STREAM_TIMEOUT_MS macro.
453
454
455
				                                                 */
			};
		
456
457
			/** Enum for the possible error return codes of the Endpoint_*_Stream_* functions.
			 *
458
			 *  \ingroup Group_EndpointStreamRW
459
			 */
460
461
			enum Endpoint_Stream_RW_ErrorCodes_t
			{
462
463
464
465
				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.
				                                           */
466
				ENDPOINT_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
467
468
				                                           *   the transfer.
				                                           */
469
470
471
472
473
				ENDPOINT_RWSTREAM_BusSuspended       = 3, /**< The USB bus has been suspended by the host and
				                                           *   no USB endpoint traffic can occur until the bus
				                                           *   has resumed.
				                                           */
				ENDPOINT_RWSTREAM_Timeout            = 4, /**< The host failed to accept or send the next packet
474
475
476
				                                           *   within the software timeout period set by the
				                                           *   \ref USB_STREAM_TIMEOUT_MS macro.
				                                           */
477
				ENDPOINT_RWSTREAM_CallbackAborted    = 5, /**< Indicates that the stream's callback function
478
479
			                                               *   aborted the transfer early.
				                                           */
480
481
			};
			
482
483
			/** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..
			 *
484
			 *  \ingroup Group_EndpointStreamRW
485
			 */
486
487
			enum Endpoint_ControlStream_RW_ErrorCodes_t
			{
488
489
				ENDPOINT_RWCSTREAM_NoError            = 0, /**< Command completed successfully, no error. */
				ENDPOINT_RWCSTREAM_HostAborted        = 1, /**< The aborted the transfer prematurely. */
490
491
492
				ENDPOINT_RWCSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
				                                            *   the transfer.
				                                            */
493
494
495
496
				ENDPOINT_RWCSTREAM_BusSuspended       = 3, /**< The USB bus has been suspended by the host and
				                                            *   no USB endpoint traffic can occur until the bus
				                                            *   has resumed.
				                                            */
497
498
499
			};

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

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

524
525
			/** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
526
			 *  \ingroup Group_EndpointPrimitiveRW
527
			 */
528
			static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
529
530
531
532
533
534
535
536
537
			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.
538
			 *
539
			 *  \ingroup Group_EndpointPrimitiveRW
540
541
			 *
			 *  \return Next word in the currently selected endpoint's FIFO buffer
542
			 */
543
			static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
544
545
			static inline uint16_t Endpoint_Read_Word_LE(void)
			{
546
547
548
549
550
				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
551
				
552
553
				Data.Bytes[0] = UEDATX;
				Data.Bytes[1] = UEDATX;
554
			
555
				return Data.Word;
556
557
558
559
			}

			/** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
			 *  direction endpoints.
560
			 *
561
			 *  \ingroup Group_EndpointPrimitiveRW
562
563
			 *
			 *  \return Next word in the currently selected endpoint's FIFO buffer
564
			 */
565
			static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
566
567
			static inline uint16_t Endpoint_Read_Word_BE(void)
			{
568
569
570
571
572
				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
573
				
574
575
				Data.Bytes[1] = UEDATX;
				Data.Bytes[0] = UEDATX;
576
			
577
				return Data.Word;
578
579
580
581
			}

			/** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
			 *  direction endpoints.
582
			 *
583
			 *  \ingroup Group_EndpointPrimitiveRW
584
			 *
585
			 *  \param[in] Word  Next word to write to the currently selected endpoint's FIFO buffer
586
			 */
587
			static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
588
589
590
591
592
593
594
595
			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.
596
			 *
597
			 *  \ingroup Group_EndpointPrimitiveRW
598
			 *
599
			 *  \param[in] Word  Next word to write to the currently selected endpoint's FIFO buffer
600
			 */
601
			static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
602
603
604
605
606
607
			static inline void Endpoint_Write_Word_BE(const uint16_t Word)
			{
				UEDATX = (Word >> 8);
				UEDATX = (Word & 0xFF);
			}

608
609
			/** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
610
			 *  \ingroup Group_EndpointPrimitiveRW
611
			 */
612
			static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
613
614
615
616
617
618
619
620
621
622
			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.
623
			 *
624
			 *  \ingroup Group_EndpointPrimitiveRW
625
626
			 *
			 *  \return Next double word in the currently selected endpoint's FIFO buffer
627
			 */
628
			static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
			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.
647
			 *
648
			 *  \ingroup Group_EndpointPrimitiveRW
649
650
			 *
			 *  \return Next double word in the currently selected endpoint's FIFO buffer
651
			 */
652
			static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
			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.
671
			 *
672
			 *  \ingroup Group_EndpointPrimitiveRW
673
			 *
674
			 *  \param[in] DWord  Next double word to write to the currently selected endpoint's FIFO buffer
675
			 */
676
			static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
677
678
			static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
			{
679
680
681
682
				UEDATX = (DWord &  0xFF);
				UEDATX = (DWord >> 8);
				UEDATX = (DWord >> 16);
				UEDATX = (DWord >> 24);
683
684
685
686
			}
			
			/** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
			 *  direction endpoints.
687
			 *
688
			 *  \ingroup Group_EndpointPrimitiveRW
689
			 *
690
			 *  \param[in] DWord  Next double word to write to the currently selected endpoint's FIFO buffer
691
			 */
692
			static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
693
694
			static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
			{
695
696
697
698
				UEDATX = (DWord >> 24);
				UEDATX = (DWord >> 16);
				UEDATX = (DWord >> 8);
				UEDATX = (DWord &  0xFF);
699
700
			}

701
702
			/** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.	
			 *
703
			 *  \ingroup Group_EndpointPrimitiveRW
704
			 */
705
			static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
			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: */
739
			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
Dean Camera's avatar
Dean Camera committed
740
				#define __CALLBACK_PARAM     , StreamCallbackPtr_t Callback
741
			#else
Dean Camera's avatar
Dean Camera committed
742
				#define __CALLBACK_PARAM			
743
744
			#endif
		
745
746
			/** 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
747
748
			 *  device (i.e. endpoint 1 should be configured before endpoint 2 and so on) to prevent fragmentation
			 *  of the USB FIFO memory.
749
750
			 *
			 *  The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction
751
			 *  may be either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
752
753
754
755
756
			 *
			 *  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.
			 *
757
			 *  The banking mode may be either \ref ENDPOINT_BANK_SINGLE or \ref ENDPOINT_BANK_DOUBLE.
758
			 *
759
			 *  \note The default control endpoint does not have to be manually configured, as it is automatically
760
761
			 *        configured by the library internally.
			 *        \n\n
762
763
764
765
766
767
			 *
			 *  \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
			 */
768
769
			bool Endpoint_ConfigureEndpoint(const uint8_t  Number, const uint8_t Type, const uint8_t Direction,
			                                const uint16_t Size, const uint8_t Banks);
770

771
			/** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
772
773
774
775
			 *  to be read or written to it.
			 *
			 *  \note This routine should not be called on CONTROL type endpoints.
			 *
776
777
			 *  \ingroup Group_EndpointRW
			 *
778
			 *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
779
780
			 */
			uint8_t Endpoint_WaitUntilReady(void);
781
782
783
784
785
786
			
			/** 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);
787
788
789
790

			/** 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
791
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
792
793
794
			 *  each USB packet, the given stream callback function is executed repeatedly until the next
			 *  packet is ready, allowing for early aborts of stream transfers.
			 *
795
796
797
			 *	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.
798
799
800
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
801
			 *  \ingroup Group_EndpointStreamRW
802
			 *
803
804
			 *  \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
805
			 *
806
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
807
			 */
Dean Camera's avatar
Dean Camera committed
808
			uint8_t Endpoint_Discard_Stream(uint16_t Length __CALLBACK_PARAM);
809
810
811
812

			/** 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
813
			 *  \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
814
815
816
			 *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
			 *  aborts of stream transfers.
			 *
817
818
819
			 *	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.
820
821
822
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
823
			 *  \ingroup Group_EndpointStreamRW
824
			 *
825
826
827
			 *  \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
828
			 *
829
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
830
			 */
831
			uint8_t Endpoint_Write_Stream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
832

833
			/** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE().
834
835
836
837
838
839
840
841
842
			 *
			 *  \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.
			 */
843
			uint8_t Endpoint_Write_EStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
844

845
			/** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().
846
847
848
849
850
851
852
853
854
855
856
			 *
			 *  \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.
			 */
857
			uint8_t Endpoint_Write_PStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
858
859
860
861

			/** 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
862
			 *  \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
863
864
865
			 *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
			 *  aborts of stream transfers.
			 *
866
867
868
			 *	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.
869
870
871
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
872
			 *  \ingroup Group_EndpointStreamRW
873
			 *
874
875
876
			 *  \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
877
			 *
878
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
879
			 */
880
			uint8_t Endpoint_Write_Stream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
881

882
			/** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE().
883
884
885
886
887
888
889
890
891
			 *
			 *  \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.
			 */
892
			uint8_t Endpoint_Write_EStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
893

894
			/** FLASH buffer source version of \ref Endpoint_Write_Stream_BE().
895
896
897
898
899
900
901
902
903
904
905
			 *
			 *  \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.
			 */
906
			uint8_t Endpoint_Write_PStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
907
908
909
910

			/** 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
911
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
912
913
914
			 *  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.
			 *
915
916
917
			 *	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.
918
919
920
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
921
			 *  \ingroup Group_EndpointStreamRW
922
			 *
923
			 *  \param[out] Buffer   Pointer to the destination data buffer to write to.
924
925
			 *  \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
926
			 *
927
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
928
			 */
Dean Camera's avatar
Dean Camera committed
929
			uint8_t Endpoint_Read_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
930

931
			/** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().
932
933
934
935
936
937
938
939
940
			 *
			 *  \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
941
			uint8_t Endpoint_Read_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
942
			
943
944
945
			/** 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
946
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
947
948
949
			 *  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.
			 *
950
951
952
			 *	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.
953
954
955
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
956
			 *  \ingroup Group_EndpointStreamRW
957
			 *
958
959
960
			 *  \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
961
			 *
962
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
963
			 */
Dean Camera's avatar
Dean Camera committed
964
			uint8_t Endpoint_Read_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
965

966
			/** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().
967
968
969
970
971
972
973
974
975
			 *
			 *  \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
976
			uint8_t Endpoint_Read_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
977

978
			/** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
979
			 *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
980
			 *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
981
			 *  finalize the transfer via the \ref Endpoint_ClearOUT() macro.
982
			 *
983
984
			 *  \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.
985
			 *        \n\n
986
			 *
987
988
989
990
991
			 *  \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.
			 *
992
			 *  \ingroup Group_EndpointStreamRW
993
			 *
994
995
			 *  \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.
996
			 *
997
			 *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
998
			 */
999
			uint8_t Endpoint_Write_Control_Stream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1000