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

	/* Includes: */
69
70
71
72
73
74
75
76
77
78
79
		#if defined(__AVR32__)
			#include <avr32/io.h>
			#include <stdint.h>
			#include <stdbool.h>
		#elif defined(__AVR__)
			#include <avr/io.h>
			#include <avr/pgmspace.h>
			#include <avr/eeprom.h>
			#include <stdbool.h>
		#endif
		
80
		#include "../../../Common/Common.h"
81
		#include "LowLevel.h"
82
83
84
		#include "../HighLevel/USBTask.h"

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

93
94
	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_USB_DRIVER)
95
			#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
96
97
		#endif
		
Dean Camera's avatar
Dean Camera committed
98
99
100
101
		#if defined(__AVR32__) && !defined(__AVR32_EPREG_X)
			#define __AVR32_EPREG_X(x) ((volatile uint32_t*)AVR32_USBB_ ## x)[USB_SelectedEPNumber]			
		#endif

102
103
	/* Public Interface - May be used in end-application: */
		/* Macros: */
104
105
106
107
108
			#if defined(__AVR32__) || defined(__DOXYGEN__)
				/** 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
109

110
111
112
113
				/** 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                   AVR32_USBB_EPDIR_IN
114

115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
				/** 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              AVR32_USBB_EPBK_SINGLE
				
				/** 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              AVR32_USBB_EPBK_DOUBLE
			#elif defined(__AVR__)
				#define ENDPOINT_DIR_OUT                  (0 << EPDIR)
				#define ENDPOINT_DIR_IN                   (1 << EPDIR)
				#define ENDPOINT_BANK_SINGLE              (0 << EPBK0)
				#define ENDPOINT_BANK_DOUBLE              (1 << EPBK0)			
			#endif
134
135
136
137
			
			/** 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.
			 */
138
			#define ENDPOINT_CONTROLEP                    0
139
140

			#if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
141
142
143
				/** 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.
				 */
144
				#define ENDPOINT_CONTROLEP_DEFAULT_SIZE   8
145
146
147
148
149
			#endif
			
			/** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  numerical address in the device.
			 */
150
			#define ENDPOINT_EPNUM_MASK                   0x07
151

152
153
154
155
156
			/** 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

157
158
159
			/** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  bank size in the device.
			 */
160
			#define ENDPOINT_EPSIZE_MASK                  0x7FF
161
162
163
			
			/** Maximum size in bytes of a given endpoint.
			 *
164
			 *  \param[in] n  Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
165
			 */				
166
			#define ENDPOINT_MAX_SIZE(n)                  _ENDPOINT_GET_MAXSIZE(n)
167
168
169

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

174
			#if !defined(CONTROL_ONLY_DEVICE)
175
176
				#if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || \
				     defined(USB_SERIES_UC3B_AVR) || defined(__DOXYGEN__))
177
178
179
180
					/** 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.
					 */
181
					#define ENDPOINT_TOTAL_ENDPOINTS      7
182
				#else
183
					#define ENDPOINT_TOTAL_ENDPOINTS      5			
184
				#endif
185
			#else
186
				#define ENDPOINT_TOTAL_ENDPOINTS          1
187
188
			#endif
			
189
		/* Pseudo-Function Macros: */
190
191
192
193
194
195
196
197
198
199
200
			#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);
201
			
202
203
204
205
206
207
208
209
210
				/** 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
211
				 *  value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
212
213
214
215
216
				 *  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.
				 *
217
				 *  \param[in] EndpointNumber Endpoint number to select
218
219
220
221
222
223
				 */
				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.
				 *
224
				 *  \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset
225
226
227
228
229
230
				 */
				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.
				 *
231
				 *  \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
232
233
				 */
				static inline void Endpoint_EnableEndpoint(void);
234

235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
				/** 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).
				 *
275
				 *  \param[in] EndpointNumber  Index of the endpoint whose interrupt flag should be tested
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
				 *
				 *  \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.			 
				 */
312
				static inline void Endpoint_ClearSETUP(void);
313
				
314
315
				/** 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.
316
317
318
319
320
				 *
				 *  \ingroup Group_EndpointPacketManagement
				 */
				static inline void Endpoint_ClearIN(void);
				
321
322
				/** 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.
323
324
325
326
327
328
329
330
331
332
				 *
				 *  \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.
				 *
333
				 *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
				 *  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);
363
364
365

				/** Sets the direction of the currently selected endpoint.
				 *
366
				 *  \param[in] DirectionMask  New endpoint direction, as a ENDPOINT_DIR_* mask.
367
368
				 */
				static inline void Endpoint_SetEndpointDirection(uint8_t DirectionMask);
369
			#else
370
				#if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
371
					#define Endpoint_BytesInEndpoint()        UEBCX
372
373
374
				#elif defined(USB_SERIES_4_AVR)
					#define Endpoint_BytesInEndpoint()        (((uint16_t)UEBCHX << 8) | UEBCLX)				
				#elif defined(USB_SERIES_2_AVR)
375
					#define Endpoint_BytesInEndpoint()        UEBCLX
376
377
				#elif defined(USB_SERIES_UC3B_AVR)
					#define Endpoint_BytesInEndpoint()        ((__AVR32_EPREG_X(UESTA0) & AVR32_USBB_BYCT_MASK) >> AVR32_USBB_BYCT)
378
379
				#endif
				
380
381
382
383
				#if defined(__AVR32__)
					#if !defined(CONTROL_ONLY_DEVICE)
						#define Endpoint_GetCurrentEndpoint()     USB_SelectedEPNumber
						#define Endpoint_SelectEndpoint(epnum)    MACROS{ USB_SelectedEPNumber = (epnum); }MACROE					
Dean Camera's avatar
Dean Camera committed
384
						#define Endpoint_IsReadWriteAllowed()     (__AVR32_EPREG_X(UESTA0) & AVR32_USBB_RWALL_MASK)
385
386
387
388
389
					#else
						#define Endpoint_GetCurrentEndpoint()     ENDPOINT_CONTROLEP
						#define Endpoint_SelectEndpoint(epnum)    (void)(epnum)
					#endif

Dean Camera's avatar
Dean Camera committed
390
391
392
393
394
					#define Endpoint_ResetFIFO(epnum)             MACROS{ AVR32_USBB.uerst |=  (AVR32_USBB_EPRST0_MASK << (epnum)); \
					                                                      AVR32_USBB.uerst &= ~(AVR32_USBB_EPRST0_MASK << (epnum));     }MACROE
					#define Endpoint_EnableEndpoint()             MACROS{ AVR32_USBB.uerst |=  (AVR32_USBB_UERST_EPEN0_MASK << USB_SelectedEPNumber); }MACROE
					#define Endpoint_DisableEndpoint()            MACROS{ AVR32_USBB.uerst &= ~(AVR32_USBB_UERST_EPEN0_MASK << USB_SelectedEPNumber); }MACROE
					#define Endpoint_IsEnabled()                        ((AVR32_USBB.uerst & (AVR32_USBB_UERST_EPEN0_MASK << USB_SelectedEPNumber)) ? true : false)
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
					
					#define Endpoint_IsConfigured()                     ((__AVR32_EPREG_X(UESTA0) & AVR32_USBB_UESTA0_CFGOK_MASK) ? true : false)
					#define Endpoint_GetEndpointInterrupts()             (AVR32_USBB.UDINT >> AVR32_USBB_EP0INT)
					#define Endpoint_HasEndpointInterrupted(n)          ((AVR32_USBB.UDINT & (AVR32_USBB_EP0INT << (n))) ? true : false)
					#define Endpoint_IsINReady()                        ((__AVR32_EPREG_X(UESTA0) & AVR32_USBB_TXINI)  ? true : false)
					#define Endpoint_IsOUTReceived()                    ((__AVR32_EPREG_X(UESTA0) & AVR32_USBB_RXOUTI) ? true : false)
					#define Endpoint_IsSETUPReceived()                  ((__AVR32_EPREG_X(UESTA0) & AVR32_USBB_RXSTPI) ? true : false)
					#define Endpoint_ClearSETUP()                 MACROS{ __AVR32_EPREG_X(UESTA0CLR) = AVR32_USBB_RXSTPIC;  }MACROE
					#define Endpoint_ClearIN()                    MACROS{ __AVR32_EPREG_X(UESTA0CLR) = AVR32_USBB_TXINIC; \
																		  __AVR32_EPREG_X(UECON0CLR) = AVR32_USBB_FIFOCONC; }MACROE
					#define Endpoint_ClearOUT()                   MACROS{ __AVR32_EPREG_X(UESTA0CLR) = AVR32_USBB_RXOUTI; \
																		  __AVR32_EPREG_X(UECON0CLR) = AVR32_USBB_FIFOCONC; }MACROE
					#define Endpoint_StallTransaction()           MACROS{ __AVR32_EPREG_X(UECON0SET) = AVR32_USBB_STALLRQS; }MACROE
					#define Endpoint_ClearStall()                 MACROS{ __AVR32_EPREG_X(UECON0CLR) = AVR32_USBB_STALLRQC; }MACROE
					#define Endpoint_IsStalled()                        ((__AVR32_EPREG_X(UECON0) & AVR32_USBB_STALLRQ) ? true : false)
					#define Endpoint_ResetDataToggle()            MACROS{ __AVR32_EPREG_X(UECON0CLR) = AVR32_USBB_RSTDTS;   }MACROE
					#define Endpoint_GetEndpointDirection()       ((__AVR32_EPREG_X(UECFG0) & ENDPOINT_DIR_IN) ? true : false)
					#define Endpoint_SetEndpointDirection(dir)    MACROS{ __AVR32_EPREG_X(UECFG0) = \
					                                                      ((__AVR32_EPREG_X(UECFG0) & ENDPOINT_DIR_IN) | (dir)); }MACROE
				#elif defined(__AVR__)
					#if !defined(CONTROL_ONLY_DEVICE)
						#define Endpoint_GetCurrentEndpoint()     (UENUM & ENDPOINT_EPNUM_MASK)
						#define Endpoint_SelectEndpoint(epnum)    MACROS{ UENUM = (epnum); }MACROE
						#define Endpoint_IsReadWriteAllowed()     ((UEINTX & (1 << RWAL)) ? true : false)
					#else
						#define Endpoint_GetCurrentEndpoint()     ENDPOINT_CONTROLEP
						#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)
					
					#define Endpoint_IsConfigured()               ((UESTA0X & (1 << CFGOK)) ? true : false)
					#define Endpoint_GetEndpointInterrupts()      UEINT
					#define Endpoint_HasEndpointInterrupted(n)    ((UEINT & (1 << (n))) ? true : false)
					#define Endpoint_IsINReady()                  ((UEINTX & (1 << TXINI))  ? true : false)
					#define Endpoint_IsOUTReceived()              ((UEINTX & (1 << RXOUTI)) ? true : false)
					#define Endpoint_IsSETUPReceived()            ((UEINTX & (1 << RXSTPI)) ? true : false)
					#define Endpoint_ClearSETUP()                 MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE

					#if !defined(CONTROL_ONLY_DEVICE)
						#define Endpoint_ClearIN()                MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << TXINI)); \
																		  UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
						#define Endpoint_ClearOUT()               MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << RXOUTI)); \
																		  UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
					#else
						#define Endpoint_ClearIN()                MACROS{ UEINTX &= ~(1 << TXINI); }MACROE
						#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				
453
				#endif
454
			#endif
455
456

		/* Enums: */
457
			/** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
458
459
460
			 *
			 *  \ingroup Group_EndpointRW
			 */
461
462
463
464
465
466
467
468
469
470
471
			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
472
				                                                 *   \ref USB_STREAM_TIMEOUT_MS macro.
473
474
475
				                                                 */
			};
		
476
477
			/** Enum for the possible error return codes of the Endpoint_*_Stream_* functions.
			 *
478
			 *  \ingroup Group_EndpointStreamRW
479
			 */
480
481
			enum Endpoint_Stream_RW_ErrorCodes_t
			{
482
483
484
485
				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.
				                                           */
486
				ENDPOINT_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
487
488
				                                           *   the transfer.
				                                           */
489
				ENDPOINT_RWSTREAM_Timeout            = 3, /**< The host failed to accept or send the next packet
490
491
492
				                                           *   within the software timeout period set by the
				                                           *   \ref USB_STREAM_TIMEOUT_MS macro.
				                                           */
493
				ENDPOINT_RWSTREAM_CallbackAborted    = 4, /**< Indicates that the stream's callback function
494
495
			                                               *   aborted the transfer early.
				                                           */
496
497
			};
			
498
499
			/** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..
			 *
500
			 *  \ingroup Group_EndpointStreamRW
501
			 */
502
503
			enum Endpoint_ControlStream_RW_ErrorCodes_t
			{
504
505
				ENDPOINT_RWCSTREAM_NoError            = 0, /**< Command completed successfully, no error. */
				ENDPOINT_RWCSTREAM_HostAborted        = 1, /**< The aborted the transfer prematurely. */
506
507
508
				ENDPOINT_RWCSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
				                                            *   the transfer.
				                                            */
509
510
511
			};

		/* Inline Functions: */
512
513
			/** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
514
			 *  \ingroup Group_EndpointPrimitiveRW
515
516
517
			 *
			 *  \return Next byte in the currently selected endpoint's FIFO buffer
			 */
518
			static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
519
520
			static inline uint8_t Endpoint_Read_Byte(void)
			{
521
				#if defined(__AVR32__)
522
				return __AVR32_EPREG_X(UEDAT0);
523
				#elif defined(__AVR__)
524
				return UEDATX;
525
				#endif
526
527
			}

528
529
			/** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
			 *
530
			 *  \ingroup Group_EndpointPrimitiveRW
531
			 *
532
			 *  \param[in] Byte  Next byte to write into the the currently selected endpoint's FIFO buffer
533
			 */
534
			static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
535
536
			static inline void Endpoint_Write_Byte(const uint8_t Byte)
			{
537
				#if defined(__AVR32__)
538
				__AVR32_EPREG_X(UEDAT0) = Byte;
539
				#elif defined(__AVR__)
540
				UEDATX = Byte;
541
				#endif
542
543
			}

544
545
			/** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
546
			 *  \ingroup Group_EndpointPrimitiveRW
547
			 */
548
			static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
549
550
551
552
			static inline void Endpoint_Discard_Byte(void)
			{
				uint8_t Dummy;
				
553
				#if defined(__AVR32__)
554
				Dummy = __AVR32_EPREG_X(UEDAT0);
555
				#elif defined(__AVR__)
556
				Dummy = UEDATX;
557
				#endif
558
559
560
561
			}
			
			/** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
			 *  direction endpoints.
562
			 *
563
			 *  \ingroup Group_EndpointPrimitiveRW
564
565
			 *
			 *  \return Next word in the currently selected endpoint's FIFO buffer
566
			 */
567
			static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
568
569
			static inline uint16_t Endpoint_Read_Word_LE(void)
			{
570
571
572
573
574
				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
575
				
576
				#if defined(__AVR32__)
577
578
				Data.Bytes[0] = __AVR32_EPREG_X(UEDAT0);
				Data.Bytes[1] = __AVR32_EPREG_X(UEDAT0);
579
				#elif defined(__AVR__)
580
581
				Data.Bytes[0] = UEDATX;
				Data.Bytes[1] = UEDATX;
582
				#endif
583
			
584
				return Data.Word;
585
586
587
588
			}

			/** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
			 *  direction endpoints.
589
			 *
590
			 *  \ingroup Group_EndpointPrimitiveRW
591
592
			 *
			 *  \return Next word in the currently selected endpoint's FIFO buffer
593
			 */
594
			static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
595
596
			static inline uint16_t Endpoint_Read_Word_BE(void)
			{
597
598
599
600
601
				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
602
				
603
				#if defined(__AVR32__)
604
605
				Data.Bytes[1] = __AVR32_EPREG_X(UEDAT0);
				Data.Bytes[0] = __AVR32_EPREG_X(UEDAT0);
606
				#elif defined(__AVR__)
607
608
				Data.Bytes[1] = UEDATX;
				Data.Bytes[0] = UEDATX;
609
				#endif
610
			
611
				return Data.Word;
612
613
614
615
			}

			/** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
			 *  direction endpoints.
616
			 *
617
			 *  \ingroup Group_EndpointPrimitiveRW
618
			 *
619
			 *  \param[in] Word  Next word to write to the currently selected endpoint's FIFO buffer
620
			 */
621
			static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
622
623
			static inline void Endpoint_Write_Word_LE(const uint16_t Word)
			{
624
				#if defined(__AVR32__)
625
626
				__AVR32_EPREG_X(UEDAT0) = (Word & 0xFF);
				__AVR32_EPREG_X(UEDAT0) = (Word >> 8);
627
				#elif defined(__AVR__)
628
629
				UEDATX = (Word & 0xFF);
				UEDATX = (Word >> 8);
630
				#endif
631
632
633
634
			}
			
			/** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
			 *  direction endpoints.
635
			 *
636
			 *  \ingroup Group_EndpointPrimitiveRW
637
			 *
638
			 *  \param[in] Word  Next word to write to the currently selected endpoint's FIFO buffer
639
			 */
640
			static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
641
642
			static inline void Endpoint_Write_Word_BE(const uint16_t Word)
			{
643
				#if defined(__AVR32__)
644
645
				__AVR32_EPREG_X(UEDAT0) = (Word >> 8);
				__AVR32_EPREG_X(UEDAT0) = (Word & 0xFF);
646
				#elif defined(__AVR__)
647
648
				UEDATX = (Word >> 8);
				UEDATX = (Word & 0xFF);
649
				#endif
650
651
			}

652
653
			/** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
			 *
654
			 *  \ingroup Group_EndpointPrimitiveRW
655
			 */
656
			static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
657
658
659
660
			static inline void Endpoint_Discard_Word(void)
			{
				uint8_t Dummy;
				
661
				#if defined(__AVR32__)
662
663
				Dummy = __AVR32_EPREG_X(UEDAT0);
				Dummy = __AVR32_EPREG_X(UEDAT0);
664
				#elif defined(__AVR__)
665
666
				Dummy = UEDATX;
				Dummy = UEDATX;
667
				#endif
668
669
670
671
			}

			/** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
			 *  direction endpoints.
672
			 *
673
			 *  \ingroup Group_EndpointPrimitiveRW
674
675
			 *
			 *  \return Next double word in the currently selected endpoint's FIFO buffer
676
			 */
677
			static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
678
679
680
681
682
683
684
685
			static inline uint32_t Endpoint_Read_DWord_LE(void)
			{
				union
				{
					uint32_t DWord;
					uint8_t  Bytes[4];
				} Data;
				
686
				#if defined(__AVR32__)
687
688
689
690
				Data.Bytes[0] = __AVR32_EPREG_X(UEDAT0);
				Data.Bytes[1] = __AVR32_EPREG_X(UEDAT0);
				Data.Bytes[2] = __AVR32_EPREG_X(UEDAT0);
				Data.Bytes[3] = __AVR32_EPREG_X(UEDAT0);
691
				#elif defined(__AVR__)
692
693
694
695
				Data.Bytes[0] = UEDATX;
				Data.Bytes[1] = UEDATX;
				Data.Bytes[2] = UEDATX;
				Data.Bytes[3] = UEDATX;
696
				#endif
697
698
699
700
701
702
			
				return Data.DWord;
			}

			/** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
			 *  direction endpoints.
703
			 *
704
			 *  \ingroup Group_EndpointPrimitiveRW
705
706
			 *
			 *  \return Next double word in the currently selected endpoint's FIFO buffer
707
			 */
708
			static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
709
710
711
712
713
714
715
716
			static inline uint32_t Endpoint_Read_DWord_BE(void)
			{
				union
				{
					uint32_t DWord;
					uint8_t  Bytes[4];
				} Data;
				
717
				#if defined(__AVR32__)
718
719
720
721
				Data.Bytes[3] = __AVR32_EPREG_X(UEDAT0);
				Data.Bytes[2] = __AVR32_EPREG_X(UEDAT0);
				Data.Bytes[1] = __AVR32_EPREG_X(UEDAT0);
				Data.Bytes[0] = __AVR32_EPREG_X(UEDAT0);
722
				#elif defined(__AVR__)
723
724
725
726
				Data.Bytes[3] = UEDATX;
				Data.Bytes[2] = UEDATX;
				Data.Bytes[1] = UEDATX;
				Data.Bytes[0] = UEDATX;
727
				#endif
728
729
730
731
732
733
			
				return Data.DWord;
			}

			/** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
			 *  direction endpoints.
734
			 *
735
			 *  \ingroup Group_EndpointPrimitiveRW
736
			 *
737
			 *  \param[in] DWord  Next double word to write to the currently selected endpoint's FIFO buffer
738
			 */
739
			static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
740
741
			static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
			{
742
				#if defined(__AVR32__)
743
744
745
746
				__AVR32_EPREG_X(UEDAT0) = (DWord &  0xFF);
				__AVR32_EPREG_X(UEDAT0) = (DWord >> 8);
				__AVR32_EPREG_X(UEDAT0) = (DWord >> 16);
				__AVR32_EPREG_X(UEDAT0) = (DWord >> 24);
747
				#elif defined(__AVR__)
748
749
750
751
				UEDATX = (DWord &  0xFF);
				UEDATX = (DWord >> 8);
				UEDATX = (DWord >> 16);
				UEDATX = (DWord >> 24);
752
				#endif
753
754
755
756
			}
			
			/** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
			 *  direction endpoints.
757
			 *
758
			 *  \ingroup Group_EndpointPrimitiveRW
759
			 *
760
			 *  \param[in] DWord  Next double word to write to the currently selected endpoint's FIFO buffer
761
			 */
762
			static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
763
764
			static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
			{
765
				#if defined(__AVR32__)
766
767
768
769
				__AVR32_EPREG_X(UEDAT0) = (DWord >> 24);
				__AVR32_EPREG_X(UEDAT0) = (DWord >> 16);
				__AVR32_EPREG_X(UEDAT0) = (DWord >> 8);
				__AVR32_EPREG_X(UEDAT0) = (DWord &  0xFF);
770
				#elif defined(__AVR__)
771
772
773
774
				UEDATX = (DWord >> 24);
				UEDATX = (DWord >> 16);
				UEDATX = (DWord >> 8);
				UEDATX = (DWord &  0xFF);
775
				#endif
776
777
			}

778
779
			/** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.	
			 *
780
			 *  \ingroup Group_EndpointPrimitiveRW
781
			 */
782
			static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
783
784
785
786
			static inline void Endpoint_Discard_DWord(void)
			{
				uint8_t Dummy;
				
787
				#if defined(__AVR32__)
788
789
790
791
				Dummy = __AVR32_EPREG_X(UEDAT0);
				Dummy = __AVR32_EPREG_X(UEDAT0);
				Dummy = __AVR32_EPREG_X(UEDAT0);
				Dummy = __AVR32_EPREG_X(UEDAT0);
792
				#elif defined(__AVR__)
793
794
795
796
				Dummy = UEDATX;
				Dummy = UEDATX;
				Dummy = UEDATX;
				Dummy = UEDATX;
797
				#endif
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
			}

		/* 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: */
823
			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
Dean Camera's avatar
Dean Camera committed
824
				#define __CALLBACK_PARAM     , StreamCallbackPtr_t Callback
825
			#else
Dean Camera's avatar
Dean Camera committed
826
				#define __CALLBACK_PARAM			
827
828
			#endif
		
829
830
			/** 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
831
832
			 *  device (i.e. endpoint 1 should be configured before endpoint 2 and so on) to prevent fragmentation
			 *  of the USB FIFO memory.
833
834
			 *
			 *  The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction
835
			 *  may be either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
836
837
838
839
840
			 *
			 *  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.
			 *
841
			 *  The banking mode must be a ENDPOINT_BANK_* mask.
842
			 *
843
844
			 *  \note The default control endpoint does not have to be manually configured, as it is automatically
			 *  configured by the library internally.
845
846
847
848
849
850
			 *
			 *  \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
			 */
851
852
			bool Endpoint_ConfigureEndpoint(const uintN_t  Number, const uintN_t Type, const uintN_t Direction,
			                                const uint16_t Size, const uintN_t Banks);
853

854
			/** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
855
856
857
858
			 *  to be read or written to it.
			 *
			 *  \note This routine should not be called on CONTROL type endpoints.
			 *
859
860
			 *  \ingroup Group_EndpointRW
			 *
861
			 *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
862
863
			 */
			uint8_t Endpoint_WaitUntilReady(void);
864
865
866
867
868
869
			
			/** 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);
870
871
872
873

			/** 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
874
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
875
876
877
			 *  each USB packet, the given stream callback function is executed repeatedly until the next
			 *  packet is ready, allowing for early aborts of stream transfers.
			 *
878
879
880
			 *	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.
881
882
883
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
884
			 *  \ingroup Group_EndpointStreamRW
885
			 *
886
887
			 *  \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
888
			 *
889
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
890
			 */
Dean Camera's avatar
Dean Camera committed
891
			uint8_t Endpoint_Discard_Stream(uint16_t Length __CALLBACK_PARAM);
892
893
894
895

			/** 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
896
			 *  \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
897
898
899
			 *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
			 *  aborts of stream transfers.
			 *
900
901
902
			 *	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.
903
904
905
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
906
			 *  \ingroup Group_EndpointStreamRW
907
			 *
908
909
910
			 *  \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
911
			 *
912
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
913
			 */
914
			uint8_t Endpoint_Write_Stream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
915

916
			/** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE().
917
918
919
920
921
922
923
			 *
			 *  \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
			 *
924
925
			 *  \note Not available on AVR32 UC3B targets.
			 *
926
927
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
928
			uint8_t Endpoint_Write_EStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
929

930
			/** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().
931
932
933
934
935
936
937
938
939
940
941
			 *
			 *  \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.
			 */
942
			uint8_t Endpoint_Write_PStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
943
944
945
946

			/** 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
947
			 *  \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
948
949
950
			 *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
			 *  aborts of stream transfers.
			 *
951
952
953
			 *	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.
954
955
956
			 *
			 *  \note This routine should not be used on CONTROL type endpoints.
			 *
957
			 *  \ingroup Group_EndpointStreamRW
958
			 *
959
960
961
			 *  \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
962
			 *
963
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
964
			 */
965
			uint8_t Endpoint_Write_Stream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
966

967
			/** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE().
968
969
970
971
972
973
974
			 *
			 *  \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
			 *
975
976
			 *  \note Not available on AVR32 UC3B targets.
			 *
977
978
			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
			 */
979
			uint8_t Endpoint_Write_EStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
980

981
			/** FLASH buffer source version of \ref Endpoint_Write_Stream_BE().
982
983
984
985
986
987
988
989
990
991
992
			 *
			 *  \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.
			 */
993
			uint8_t Endpoint_Write_PStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
994
995
996
997

			/** 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
998
			 *  discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
999
1000
			 *  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.