Pipe.h 45.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

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

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, provided that the above copyright notice appear in all
  copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/
 
31
32
33
/** \ingroup Group_USB
 *  @defgroup Group_PipeManagement Pipe Management
 *
34
 *  This module contains functions, macros and enums related to pipe management when in USB Host mode. This
35
 *  module contains the pipe management macros, as well as pipe interrupt and data send/receive functions
36
 *  for various data types.
37
38
39
40
41
42
43
44
45
 *
 *  @{
 */

/** @defgroup Group_PipeRW Pipe Data Reading and Writing
 *
 *  Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
 */
 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/** \ingroup Group_PipeRW  
 *  @defgroup Group_PipePrimitiveRW 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 pipes.
 */ 

/** \ingroup Group_PipeRW  
 *  @defgroup Group_PipeStreamRW Read/Write of Multi-Byte Streams
 *
 *  Functions, macros, variables, enums and types related to data reading and writing of data streams from
 *  and to pipes.
 */ 
 
60
61
62
63
64
65
66
/** @defgroup Group_PipePacketManagement Pipe Packet Management
 *
 *  Functions, macros, variables, enums and types related to packet management of pipes.
 */
 
/** @defgroup Group_PipeControlReq Pipe Control Request Management
 *
67
68
69
70
71
 *  Module for host mode request processing. This module allows for the transmission of standard, class and
 *  vendor control requests to the default control endpoint of an attached device while in host mode.
 *
 *  \see Chapter 9 of the USB 2.0 specification.
 */ 
72

73
74
75
76
77
#ifndef __PIPE_H__
#define __PIPE_H__

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

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

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

	/* Public Interface - May be used in end-application: */
		/* Macros: */
96
97
98
99
100
101
			/** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */
			#define PIPE_ERRORFLAG_OVERFLOW         (1 << 6)

			/** Mask for \ref Pipe_GetErrorFlags(), indicating that an underflow error occurred in the pipe on the received data. */
			#define PIPE_ERRORFLAG_UNDERFLOW        (1 << 5)

102
			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */
103
			#define PIPE_ERRORFLAG_CRC16            (1 << 4)
104

105
			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */
106
			#define PIPE_ERRORFLAG_TIMEOUT          (1 << 3)
107

108
			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */
109
			#define PIPE_ERRORFLAG_PID              (1 << 2)
110

111
			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */
112
			#define PIPE_ERRORFLAG_DATAPID          (1 << 1)
113

114
			/** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */
115
			#define PIPE_ERRORFLAG_DATATGL          (1 << 0)
116

117
			/** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes),
118
119
			 *  which will trigger a control request on the attached device when data is written to the pipe.
			 */
120
			#define PIPE_TOKEN_SETUP                (0 << PTOKEN0)
121

122
			/** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),
123
124
			 *  indicating that the pipe data will flow from device to host.
			 */
125
			#define PIPE_TOKEN_IN                   (1 << PTOKEN0)
126

127
			/** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a OUT token (for non-CONTROL type pipes),
128
129
			 *  indicating that the pipe data will flow from host to device.
			 */
130
			#define PIPE_TOKEN_OUT                  (2 << PTOKEN0)
131

132
			/** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe
133
134
135
			 *  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 attached device) can access the pipe's bank at the one time.
			 */
136
			#define PIPE_BANK_SINGLE                (0 << EPBK0)
137

138
			/** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe
139
140
141
142
			 *  should have two banks, which requires more USB FIFO memory but results in faster transfers as one
			 *  USB device (the AVR or the attached device) can access one bank while the other accesses the second
			 *  bank.
			 */
143
			#define PIPE_BANK_DOUBLE                (1 << EPBK0)
144
145
146
147
			
			/** Pipe address for the default control pipe, which always resides in address 0. This is
			 *  defined for convenience to give more readable code when used with the pipe macros.
			 */
148
			#define PIPE_CONTROLPIPE                0
149
150
151
152

			/** Default size of the default control pipe's bank, until altered by the Endpoint0Size value 
			 *  in the device descriptor of the attached device.
			 */
153
			#define PIPE_CONTROLPIPE_DEFAULT_SIZE   64
154
155
156
157
			
			/** Pipe number mask, for masking against pipe addresses to retrieve the pipe's numerical address
			 *  in the device.
			 */
158
			#define PIPE_PIPENUM_MASK               0x07
159
160
161
162
163

			/** Total number of pipes (including the default control pipe at address 0) which may be used in
			 *  the device. Different USB AVR models support different amounts of pipes, this value reflects
			 *  the maximum number of pipes for the currently selected AVR model.
			 */
164
			#define PIPE_TOTAL_PIPES                7
165
166
167
168
169
170

			/** Size in bytes of the largest pipe bank size possible in the device. Not all banks on each AVR
			 *  model supports the largest bank size possible on the device; different pipe numbers support
			 *  different maximum bank sizes. This value reflects the largest possible bank of any pipe on the
			 *  currently selected USB AVR model.
			 */
171
			#define PIPE_MAX_SIZE                   256
172
173
174
175

			/** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
			 *  numerical address in the attached device.
			 */
176
			#define PIPE_EPNUM_MASK                 0x0F
177

178
		/* Pseudo-Function Macros: */
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
			#if defined(__DOXYGEN__)
				/** Indicates the number of bytes currently stored in the current pipes's selected bank.
				 *
				 *  \note The return width of this function may differ, depending on the maximum pipe bank size
				 *        of the selected AVR model.
				 *
				 *  \ingroup Group_PipeRW
				 *
				 *  \return Total number of bytes in the currently selected Pipe's FIFO buffer
				 */
				static inline uint16_t Pipe_BytesInPipe(void);
				
				/** Returns the pipe address of the currently selected pipe. This is typically used to save the
				 *  currently selected pipe number so that it can be restored after another pipe has been manipulated.
				 *
				 *  \return Index of the currently selected pipe
				 */
				static inline uint8_t Pipe_GetCurrentPipe(void);

				/** Selects the given pipe number. Any pipe operations which do not require the pipe number to be
				 *  indicated will operate on the currently selected pipe.
				 *
201
				 *  \param[in] PipeNumber  Index of the pipe to select
202
203
204
205
206
				 */
				static inline void Pipe_SelectPipe(uint8_t PipeNumber);
				
				/** Resets the desired pipe, including the pipe banks and flags.
				 *
207
				 *  \param[in] PipeNumber  Index of the pipe to reset
208
209
210
211
212
213
				 */
				static inline void Pipe_ResetPipe(uint8_t PipeNumber);
				
				/** Enables the currently selected pipe so that data can be sent and received through it to and from
				 *  an attached device.
				 *
214
				 *  \note Pipes must first be configured properly via \ref Pipe_ConfigurePipe().
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
				 */
				static inline void Pipe_EnablePipe(void);

				/** Disables the currently selected pipe so that data cannot be sent and received through it to and
				 *  from an attached device.
				 */
				static inline void Pipe_DisablePipe(void);

				/** Determines if the currently selected pipe is enabled, but not necessarily configured.
				 *
				 * \return Boolean True if the currently selected pipe is enabled, false otherwise
				 */
				static inline bool Pipe_IsEnabled(void);
				
				/** Gets the current pipe token, indicating the pipe's data direction and type.
				 *
				 *  \return The current pipe token, as a PIPE_TOKEN_* mask
				 */
233
				static inline uint8_t Pipe_GetPipeToken(void);
234
235
236
237
238
239
				
				/** Sets the token for the currently selected pipe to one of the tokens specified by the PIPE_TOKEN_*
				 *  masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during
				 *  control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices
				 *  which have two endpoints of opposite direction sharing the same endpoint address within the device.
				 *
240
				 *  \param[in] Token  New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask
241
242
243
244
245
246
247
248
249
				 */
				static inline void Pipe_SetPipeToken(uint8_t Token);
				
				/** Configures the currently selected pipe to allow for an unlimited number of IN requests. */
				static inline void Pipe_SetInfiniteINRequests(void);
				
				/** Configures the currently selected pipe to only allow the specified number of IN requests to be
				 *  accepted by the pipe before it is automatically frozen.
				 *
250
				 *  \param[in] TotalINRequests  Total number of IN requests that the pipe may receive before freezing
251
252
253
254
255
256
257
258
259
				 */
				static inline void Pipe_SetFiniteINRequests(uint8_t TotalINRequests);

				/** Determines if the currently selected pipe is configured.
				 *
				 *  \return Boolean true if the selected pipe is configured, false otherwise
				 */
				static inline bool Pipe_IsConfigured(void);
				
260
261
262
263
264
265
266
				/** Retrieves the endpoint number of the endpoint within the attached device that the currently selected
				 *  pipe is bound to.
				 *
				 *  \return Endpoint number the currently selected pipe is bound to
				 */
				static inline uint8_t Pipe_BoundEndpointNumber(void);

267
268
				/** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.
				 *
269
				 *  \param[in] Milliseconds  Number of milliseconds between each pipe poll
270
271
272
273
274
275
276
277
278
279
280
281
282
				 */
				static inline void Pipe_SetInterruptPeriod(uint8_t Milliseconds);
				
				/** Returns a mask indicating which pipe's interrupt periods have elapsed, indicating that the pipe should
				 *  be serviced.
				 *
				 *  \return Mask whose bits indicate which pipes have interrupted
				 */
				static inline uint8_t Pipe_GetPipeInterrupts(void);
				
				/** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type
				 *  pipes).
				 *
283
				 *  \param[in] PipeNumber  Index of the pipe whose interrupt flag should be tested
284
285
286
287
288
289
290
291
292
293
				 *
				 *  \return Boolean true if the specified pipe has interrupted, false otherwise
				 */
				static inline bool Pipe_HasPipeInterrupted(uint8_t PipeNumber);
				
				/** Unfreezes the selected pipe, allowing it to communicate with an attached device. */
				static inline void Pipe_Unfreeze(void);
				
				/** Freezes the selected pipe, preventing it from communicating with an attached device. */
				static inline void Pipe_Freeze(void);
294

295
296
297
298
299
300
				/** Determines if the currently selected pipe is frozen, and not able to accept data.
				 *
				 *  \return Boolean true if the currently selected pipe is frozen, false otherwise
				 */
				static inline bool Pipe_IsFrozen(void);
				
301
302
303
304
305
306
				/** Clears the master pipe error flag. */
				static inline void Pipe_ClearError(void);
				
				/** Determines if the master pipe error flag is set for the currently selected pipe, indicating that
				 *  some sort of hardware error has occurred on the pipe.
				 *
307
				 *  \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.
308
				 *
309
				 *  \return Boolean true if an error has occurred on the selected pipe, false otherwise
310
311
312
313
314
315
316
317
318
319
320
				 */
				static inline bool Pipe_IsError(void);
				
				/** Clears all the currently selected pipe's hardware error flags, but does not clear the master error
				 *  flag for the pipe.
				 */
				static inline void Pipe_ClearErrorFlags(void);
				
				/** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This
				 *  value can then be masked against the PIPE_ERRORFLAG_* masks to determine what error has occurred.
				 *
321
				 *  \return  Mask comprising of PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe
322
323
324
325
326
327
328
329
330
				 */
				static inline uint8_t Pipe_GetErrorFlags(void);
				
				/** Determines if the currently selected pipe may be read from (if data is waiting in the pipe
				 *  bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT
				 *  direction). This function will return false if an error has occurred in the pipe, or if the pipe
				 *  is an IN direction and no packet (or an empty packet) has been received, or if the pipe is an OUT
				 *  direction and the pipe bank is full.
				 *
331
332
				 *  \note This function is not valid on CONTROL type pipes.
				 *
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
				 *  \ingroup Group_PipePacketManagement
				 *  
				 *  \return Boolean true if the currently selected pipe may be read from or written to, depending on its direction
				 */
				static inline bool Pipe_IsReadWriteAllowed(void);
				
				/** Determines if an IN request has been received on the currently selected pipe.
				 *
				 *  \ingroup Group_PipePacketManagement
				 *
				 *  \return Boolean true if the current pipe has received an IN packet, false otherwise.
				 */
				static inline bool Pipe_IsINReceived(void);
				
				/** Determines if the currently selected pipe is ready to send an OUT request.
				 *
				 *  \ingroup Group_PipePacketManagement
				 *
				 *  \return Boolean true if the current pipe is ready for an OUT packet, false otherwise.
				 */
				static inline bool Pipe_IsOUTReady(void);

				/** Determines if no SETUP request is currently being sent to the attached device on the selected
				 *  CONTROL type pipe.
				 *
				 *  \ingroup Group_PipePacketManagement
				 *
				 *  \return Boolean true if the current pipe is ready for a SETUP packet, false otherwise.
				 */
				static inline bool Pipe_IsSETUPSent(void);
				
				/** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.
				 *
366
				 *  \ingroup Group_PipePacketManagement		
367
				 */
368
				static inline void Pipe_ClearSETUP(void);
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386

				/** Acknowledges the reception of a setup IN request from the attached device on the currently selected
				 *  pipe, freeing the bank ready for the next packet.
				 *
				 *  \ingroup Group_PipePacketManagement
				 */
				static inline void Pipe_ClearIN(void);

				/** Sends the currently selected pipe's contents to the device as an OUT packet on the selected pipe, freeing
				 *  the bank ready for the next packet.
				 *
				 *  \ingroup Group_PipePacketManagement
				 */
				static inline void Pipe_ClearOUT(void);

				/** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on
				 *  the currently selected pipe. This occurs when the host sends a packet to the device, but the device
				 *  is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been
387
				 *  received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet
388
389
390
391
392
393
394
395
396
397
398
399
				 *  can be re-sent.
				 *
				 *  \ingroup Group_PipePacketManagement
				 *
				 *  \return Boolean true if an NAK has been received on the current pipe, false otherwise
				 */
				static inline bool Pipe_IsNAKReceived(void);

				/** Clears the NAK condition on the currently selected pipe.
				 *
				 *  \ingroup Group_PipePacketManagement
				 *
400
				 *  \see \ref Pipe_IsNAKReceived() for more details.
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
				 */
				static inline void Pipe_ClearNAKReceived(void);
				 
				/** Determines if the currently selected pipe has had the STALL condition set by the attached device.
				 *
				 *  \ingroup Group_PipePacketManagement
				 *
				 *  \return Boolean true if the current pipe has been stalled by the attached device, false otherwise
				*/
				static inline bool Pipe_IsStalled(void);
				
				/** Clears the STALL condition detection flag on the currently selected pipe, but does not clear the
				 *  STALL condition itself (this must be done via a ClearFeature control request to the device).
				 *
				 *  \ingroup Group_PipePacketManagement
				 */
				static inline void Pipe_ClearStall(void);
			#else
				#define Pipe_BytesInPipe()             UPBCX
420

421
				#define Pipe_GetCurrentPipe()          (UPNUM & PIPE_PIPENUM_MASK)
422

423
424
425
				#define Pipe_SelectPipe(pipenum)       MACROS{ UPNUM = pipenum; }MACROE
				
				#define Pipe_ResetPipe(pipenum)        MACROS{ UPRST = (1 << pipenum); UPRST = 0; }MACROE
426

427
				#define Pipe_EnablePipe()              MACROS{ UPCONX |= (1 << PEN); }MACROE
428

429
				#define Pipe_DisablePipe()             MACROS{ UPCONX &= ~(1 << PEN); }MACROE
430

431
				#define Pipe_IsEnabled()               ((UPCONX & (1 << PEN)) ? true : false)
432

433
				#define Pipe_GetPipeToken()            (UPCFG0X & PIPE_TOKEN_MASK)
434

435
436
437
				#define Pipe_SetToken(token)           MACROS{ UPCFG0X = ((UPCFG0X & ~PIPE_TOKEN_MASK) | token); }MACROE
				
				#define Pipe_SetInfiniteINRequests()   MACROS{ UPCONX |= (1 << INMODE); }MACROE
438

439
				#define Pipe_SetFiniteINRequests(n)    MACROS{ UPCONX &= ~(1 << INMODE); UPINRQX = n; }MACROE
440

441
				#define Pipe_IsConfigured()            ((UPSTAX  & (1 << CFGOK)) ? true : false)
442

443
444
				#define Pipe_BoundEndpointNumber()     ((UPCFG0X >> PEPNUM0) & PIPE_EPNUM_MASK)
				
445
				#define Pipe_SetInterruptPeriod(ms)    MACROS{ UPCFG2X = ms; }MACROE
446

447
				#define Pipe_GetPipeInterrupts()       UPINT
448

449
				#define Pipe_HasPipeInterrupted(n)     ((UPINT & (1 << n)) ? true : false)
450

451
				#define Pipe_Unfreeze()                MACROS{ UPCONX &= ~(1 << PFREEZE); }MACROE
452

453
				#define Pipe_Freeze()                  MACROS{ UPCONX |= (1 << PFREEZE); }MACROE
454
455
				
				#define Pipe_IsFrozen()                ((UPCONX & (1 << PFREEZE)) ? true : false)
456

457
				#define Pipe_ClearError()              MACROS{ UPINTX &= ~(1 << PERRI); }MACROE
458

459
460
461
				#define Pipe_IsError()                 ((UPINTX & (1 << PERRI)) ? true : false)
				
				#define Pipe_ClearErrorFlags()         MACROS{ UPERRX = 0; }MACROE
462

463
464
465
466
				#define Pipe_GetErrorFlags()           ((UPERRX & (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT | \
				                                                   PIPE_ERRORFLAG_PID   | PIPE_ERRORFLAG_DATAPID | \
				                                                   PIPE_ERRORFLAG_DATATGL))                      | \
				                                        (UPSTAX & PIPE_ERRORFLAG_OVERFLOW | PIPE_ERRORFLAG_UNDERFLOW))
467

468
				#define Pipe_IsReadWriteAllowed()      ((UPINTX & (1 << RWAL)) ? true : false)
469

470
				#define Pipe_IsINReceived()            ((UPINTX & (1 << RXINI)) ? true : false)
471

472
				#define Pipe_IsOUTReady()              ((UPINTX & (1 << TXOUTI)) ? true : false)
473

474
				#define Pipe_IsSETUPSent()             ((UPINTX & (1 << TXSTPI)) ? true : false)
475

476
477
				#define Pipe_ClearIN()                 MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << RXINI)); \
				                                               UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE
478

479
480
				#define Pipe_ClearOUT()                MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << TXOUTI)); \
				                                               UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE
481
				
482
				#define Pipe_ClearSETUP()              MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << TXSTPI)); \
483
				                                               UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE
484

485
486
487
488
489
490
491
492
				#define Pipe_IsNAKReceived()           ((UPINTX & (1 << NAKEDI)) ? true : false)

				#define Pipe_ClearNAKReceived()        MACROS{ UPINTX &= ~(1 << NAKEDI); }MACROE

				#define Pipe_IsStalled()               ((UPINTX & (1 << RXSTALLI)) ? true : false)

				#define Pipe_ClearStall()              MACROS{ UPINTX &= ~(1 << RXSTALLI); }MACROE
			#endif
493
494

		/* Enums: */
495
496
497
498
			/** Enum for the possible error return codes of the Pipe_WaitUntilReady function
			 *
			 *  \ingroup Group_PipeRW
			 */
499
500
501
502
503
504
505
			enum Pipe_WaitUntilReady_ErrorCodes_t
			{
				PIPE_READYWAIT_NoError                 = 0, /**< Pipe ready for next packet, no error */
				PIPE_READYWAIT_PipeStalled             = 1,	/**< The device stalled the pipe while waiting. */			
				PIPE_READYWAIT_DeviceDisconnected      = 2,	/**< Device was disconnected from the host while waiting. */
				PIPE_READYWAIT_Timeout                 = 3, /**< The device failed to accept or send the next packet
				                                             *   within the software timeout period set by the
506
				                                             *   \ref USB_STREAM_TIMEOUT_MS macro.
507
508
509
				                                             */
			};

510
511
512
513
			/** Enum for the possible error return codes of the Pipe_*_Stream_* functions.
			 *
			 *  \ingroup Group_PipeRW
			 */
514
515
			enum Pipe_Stream_RW_ErrorCodes_t
			{
516
517
518
519
520
521
522
523
524
525
526
527
				PIPE_RWSTREAM_NoError            = 0, /**< Command completed successfully, no error. */
				PIPE_RWSTREAM_PipeStalled        = 1, /**< The device stalled the pipe during the transfer. */		
				PIPE_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
			                                           *   the transfer.
			                                           */		
				PIPE_RWSTREAM_Timeout            = 3, /**< The device failed to accept or send the next packet
				                                       *   within the software timeout period set by the
				                                       *   \ref USB_STREAM_TIMEOUT_MS macro.
				                                       */
				PIPE_RWSTREAM_CallbackAborted    = 4, /**< Indicates that the stream's callback function aborted
			                                           *   the transfer early.
				                                       */
528
529
530
			};

		/* Inline Functions: */
531
532
			/** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.
			 *
533
			 *  \ingroup Group_PipePrimitiveRW
534
535
536
			 *
			 *  \return Next byte in the currently selected pipe's FIFO buffer
			 */
537
			static inline uint8_t Pipe_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
538
539
540
541
542
			static inline uint8_t Pipe_Read_Byte(void)
			{
				return UPDATX;
			}

543
544
			/** Writes one byte from the currently selected pipe's bank, for IN direction pipes.
			 *
545
			 *  \ingroup Group_PipePrimitiveRW
546
			 *
547
			 *  \param[in] Byte  Next byte to write into the the currently selected pipe's FIFO buffer
548
			 */
549
			static inline void Pipe_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
550
551
552
553
554
			static inline void Pipe_Write_Byte(const uint8_t Byte)
			{
				UPDATX = Byte;
			}

555
556
			/** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.
			 *
557
			 *  \ingroup Group_PipePrimitiveRW
558
			 */
559
			static inline void Pipe_Discard_Byte(void) ATTR_ALWAYS_INLINE;
560
561
562
563
564
565
566
567
568
			static inline void Pipe_Discard_Byte(void)
			{
				uint8_t Dummy;
				
				Dummy = UPDATX;
			}
			
			/** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT
			 *  direction pipes.
569
			 *
570
			 *  \ingroup Group_PipePrimitiveRW
571
572
			 *
			 *  \return Next word in the currently selected pipe's FIFO buffer
573
			 */
574
			static inline uint16_t Pipe_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
575
576
			static inline uint16_t Pipe_Read_Word_LE(void)
			{
577
578
579
580
581
				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
582
				
583
584
				Data.Bytes[0] = UPDATX;
				Data.Bytes[1] = UPDATX;
585
			
586
				return Data.Word;
587
588
589
590
			}

			/** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT
			 *  direction pipes.
591
			 *
592
			 *  \ingroup Group_PipePrimitiveRW
593
594
			 *
			 *  \return Next word in the currently selected pipe's FIFO buffer
595
			 */
596
			static inline uint16_t Pipe_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
597
598
			static inline uint16_t Pipe_Read_Word_BE(void)
			{
599
600
601
602
603
				union
				{
					uint16_t Word;
					uint8_t  Bytes[2];
				} Data;
604
				
605
606
				Data.Bytes[1] = UPDATX;
				Data.Bytes[0] = UPDATX;
607
			
608
				return Data.Word;
609
610
611
612
			}
			
			/** Writes two bytes to the currently selected pipe's bank in little endian format, for IN
			 *  direction pipes.
613
			 *
614
			 *  \ingroup Group_PipePrimitiveRW
615
			 *
616
			 *  \param[in] Word  Next word to write to the currently selected pipe's FIFO buffer
617
			 */
618
			static inline void Pipe_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
619
620
621
622
623
624
625
626
			static inline void Pipe_Write_Word_LE(const uint16_t Word)
			{
				UPDATX = (Word & 0xFF);
				UPDATX = (Word >> 8);
			}
			
			/** Writes two bytes to the currently selected pipe's bank in big endian format, for IN
			 *  direction pipes.
627
			 *
628
			 *  \ingroup Group_PipePrimitiveRW
629
			 *
630
			 *  \param[in] Word  Next word to write to the currently selected pipe's FIFO buffer
631
			 */
632
			static inline void Pipe_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
633
634
635
636
637
638
			static inline void Pipe_Write_Word_BE(const uint16_t Word)
			{
				UPDATX = (Word >> 8);
				UPDATX = (Word & 0xFF);
			}

639
640
			/** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.
			 *
641
			 *  \ingroup Group_PipePrimitiveRW
642
643
644
			 */
			static inline void Pipe_Discard_Word(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Discard_Word(void)
645
646
647
648
649
650
651
652
653
			{
				uint8_t Dummy;
				
				Dummy = UPDATX;
				Dummy = UPDATX;
			}

			/** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT
			 *  direction pipes.
654
			 *
655
			 *  \ingroup Group_PipePrimitiveRW
656
657
			 *
			 *  \return Next double word in the currently selected pipe's FIFO buffer
658
			 */
659
			static inline uint32_t Pipe_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
			static inline uint32_t Pipe_Read_DWord_LE(void)
			{
				union
				{
					uint32_t DWord;
					uint8_t  Bytes[4];
				} Data;
				
				Data.Bytes[0] = UPDATX;
				Data.Bytes[1] = UPDATX;
				Data.Bytes[2] = UPDATX;
				Data.Bytes[3] = UPDATX;
			
				return Data.DWord;
			}

			/** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT
			 *  direction pipes.
678
			 *
679
			 *  \ingroup Group_PipePrimitiveRW
680
681
			 *
			 *  \return Next double word in the currently selected pipe's FIFO buffer
682
			 */
683
			static inline uint32_t Pipe_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
			static inline uint32_t Pipe_Read_DWord_BE(void)
			{
				union
				{
					uint32_t DWord;
					uint8_t  Bytes[4];
				} Data;
				
				Data.Bytes[3] = UPDATX;
				Data.Bytes[2] = UPDATX;
				Data.Bytes[1] = UPDATX;
				Data.Bytes[0] = UPDATX;
			
				return Data.DWord;
			}

			/** Writes four bytes to the currently selected pipe's bank in little endian format, for IN
			 *  direction pipes.
702
			 *
703
			 *  \ingroup Group_PipePrimitiveRW
704
			 *
705
			 *  \param[in] DWord  Next double word to write to the currently selected pipe's FIFO buffer
706
			 */
707
			static inline void Pipe_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
708
709
			static inline void Pipe_Write_DWord_LE(const uint32_t DWord)
			{
710
711
712
713
				UPDATX = (DWord &  0xFF);
				UPDATX = (DWord >> 8);
				UPDATX = (DWord >> 16);
				UPDATX = (DWord >> 24);
714
715
716
717
			}
			
			/** Writes four bytes to the currently selected pipe's bank in big endian format, for IN
			 *  direction pipes.
718
			 *
719
			 *  \ingroup Group_PipePrimitiveRW
720
			 *
721
			 *  \param[in] DWord  Next double word to write to the currently selected pipe's FIFO buffer
722
723
			 */
			static inline void Pipe_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
724
725
			static inline void Pipe_Write_DWord_BE(const uint32_t DWord)
			{
726
727
728
729
				UPDATX = (DWord >> 24);
				UPDATX = (DWord >> 16);
				UPDATX = (DWord >> 8);
				UPDATX = (DWord &  0xFF);
730
731
			}			
			
732
733
			/** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.	
			 *
734
			 *  \ingroup Group_PipePrimitiveRW
735
			 */
736
737
			static inline void Pipe_Discard_DWord(void) ATTR_ALWAYS_INLINE;
			static inline void Pipe_Discard_DWord(void)
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
			{
				uint8_t Dummy;
				
				Dummy = UPDATX;
				Dummy = UPDATX;
				Dummy = UPDATX;
				Dummy = UPDATX;
			}

		/* External Variables: */
			/** Global indicating the maximum packet size of the default control pipe located at address
			 *  0 in the device. This value is set to the value indicated in the attached device's device
		     *  descriptor once the USB interface is initialized into host mode and a device is attached
			 *  to the USB bus.
			 *
			 *  \note This variable should be treated as read-only in the user application, and never manually
			 *        changed in value.
			 */
			extern uint8_t USB_ControlPipeSize;

		/* Function Prototypes: */
759
			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
Dean Camera's avatar
Dean Camera committed
760
				#define __CALLBACK_PARAM     , StreamCallbackPtr_t Callback
761
			#else
Dean Camera's avatar
Dean Camera committed
762
				#define __CALLBACK_PARAM			
763
764
			#endif

765
766
			/** Configures the specified pipe number with the given pipe type, token, target endpoint number in the
			 *  attached device, bank size and banking mode. Pipes should be allocated in ascending order by their
767
768
			 *  address in the device (i.e. pipe 1 should be configured before pipe 2 and so on) to prevent fragmentation
			 *  of the USB FIFO memory.
769
770
771
772
773
774
775
776
			 *
			 *  The pipe type may be one of the EP_TYPE_* macros listed in LowLevel.h, the token may be one of the
			 *  PIPE_TOKEN_* masks.
			 *
			 *  The bank size must indicate the maximum packet size that the pipe can handle. Different pipe
			 *  numbers can handle different maximum packet sizes - refer to the chosen USB AVR's datasheet to
			 *  determine the maximum bank size for each pipe.
			 *
777
			 *  The banking mode may be either \ref PIPE_BANK_SINGLE or \ref PIPE_BANK_DOUBLE.
778
			 *
779
780
			 *  A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()
			 *  before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or
781
782
783
			 *  sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite
			 *  numbers of IN requests without automatic freezing - this can be overridden by a call to
			 *  \ref Pipe_SetFiniteINRequests().
784
			 *
785
786
787
			 *  \note The default control pipe does not have to be manually configured, as it is automatically
			 *  configured by the library internally.
			 *
788
789
790
791
792
793
794
795
			 *  \note This routine will select the specified pipe, and the pipe will remain selected once the
			 *        routine completes regardless of if the pipe configuration succeeds.
			 *
			 *  \return Boolean true if the configuration is successful, false otherwise
			 */
			bool Pipe_ConfigurePipe(const uint8_t  Number, const uint8_t Type, const uint8_t Token, const uint8_t EndpointNumber,
			                        const uint16_t Size, const uint8_t Banks);

796
797
			/** Spinloops until the currently selected non-control pipe is ready for the next packed of data to be read 
			 *  or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).
798
			 *
799
800
			 *  \ingroup Group_PipeRW
			 *
801
802
			 *  \return A value from the Pipe_WaitUntilReady_ErrorCodes_t enum.
			 */
803
804
805
806
807
			uint8_t Pipe_WaitUntilReady(void);
			
			/** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given
			 *  endpoint is found, it is automatically selected.
			 *
808
			 *  \param[in] EndpointAddress Address of the endpoint within the attached device to check
809
810
811
			 *
			 *  \return Boolean true if a pipe bound to the given endpoint address is found, false otherwise
			 */
812
			bool Pipe_IsEndpointBound(const uint8_t EndpointAddress);
813
		
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
			/** Reads and discards the given number of bytes from the pipe, 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 discarding the last packet from the device via the \ref Pipe_ClearIN() macro.
			 *  Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,
			 *  allowing for early aborts of stream transfers.
			 *
			 *	The callback routine should be created 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.
			 *
			 *  The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
			 *  having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
			 *
			 *  \ingroup Group_PipeStreamRW
			 *
			 *  \param[in] Length  Number of bytes to send via the currently selected pipe.
			 *  \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 Pipe_Stream_RW_ErrorCodes_t enum.
			 */
Dean Camera's avatar
Dean Camera committed
834
			uint8_t Pipe_Discard_Stream(uint16_t Length __CALLBACK_PARAM);
835

836
837
838
			/** Writes the given number of bytes to the pipe from the given buffer in little endian,
			 *  sending full packets to the device 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
839
			 *  \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is
840
841
			 *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
			 *
842
843
844
			 *	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.
845
			 *
846
847
848
			 *  The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
			 *  having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
			 *
849
			 *  \ingroup Group_PipeStreamRW
850
			 *
851
852
853
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected pipe into the buffer.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
854
			 *
855
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
856
			 */
Dean Camera's avatar
Dean Camera committed
857
			uint8_t Pipe_Write_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);				
858

859
			/** EEPROM buffer source version of \ref Pipe_Write_Stream_LE().
860
861
862
863
864
865
866
867
868
			 *
			 *  \ingroup Group_PipeStreamRW
			 *
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.
			 */
Dean Camera's avatar
Dean Camera committed
869
			uint8_t Pipe_Write_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
870
			
871
			/** FLASH buffer source version of \ref Pipe_Write_Stream_LE().
872
873
874
875
876
877
878
879
880
881
882
			 *
			 *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
			 *
			 *  \ingroup Group_PipeStreamRW
			 *
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.
			 */
Dean Camera's avatar
Dean Camera committed
883
			uint8_t Pipe_Write_PStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
884
						
885
886
887
			/** Writes the given number of bytes to the pipe from the given buffer in big endian,
			 *  sending full packets to the device 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
888
			 *  \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is
889
890
			 *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
			 *
891
892
893
			 *	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.
894
			 *
895
896
897
			 *  The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
			 *  having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
			 *
898
			 *  \ingroup Group_PipeStreamRW
899
			 *
900
901
902
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected pipe into the buffer.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
903
			 *
904
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
905
			 */
Dean Camera's avatar
Dean Camera committed
906
			uint8_t Pipe_Write_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
907

908
			/** EEPROM buffer source version of \ref Pipe_Write_Stream_BE().
909
			 *
910
			 *  \ingroup Group_PipeStreamRW
911
			 *
912
913
914
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected pipe into the buffer.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
915
			 *
916
917
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
			 */
Dean Camera's avatar
Dean Camera committed
918
			uint8_t Pipe_Write_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
919
			
920
			/** FLASH buffer source version of \ref Pipe_Write_Stream_BE().
921
			 *
922
923
924
925
926
927
			 *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
			 *
			 *  \ingroup Group_PipeStreamRW
			 *
			 *  \param[in] Buffer    Pointer to the source data buffer to read from.
			 *  \param[in] Length    Number of bytes to read for the currently selected pipe into the buffer.
928
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
929
			 *
930
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
931
			 */
Dean Camera's avatar
Dean Camera committed
932
			uint8_t Pipe_Write_PStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
933
934
935
936

			/** Reads the given number of bytes from the pipe into the given buffer in little endian,
			 *  sending full packets to the device 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
937
			 *  \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is
938
939
			 *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
			 *
940
941
942
			 *	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.
943
			 *
944
945
946
			 *  The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
			 *  having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
			 *
947
			 *  \ingroup Group_PipeStreamRW
948
			 *
949
			 *  \param[out] Buffer   Pointer to the source data buffer to write to.
950
951
			 *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
952
			 *
953
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
954
			 */
Dean Camera's avatar
Dean Camera committed
955
			uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
956

957
			/** EEPROM buffer source version of \ref Pipe_Read_Stream_LE().
958
959
960
			 *
			 *  \ingroup Group_PipeStreamRW
			 *
961
			 *  \param[out] Buffer   Pointer to the source data buffer to write to.
962
963
964
965
966
			 *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
			 *  \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 Pipe_Stream_RW_ErrorCodes_t enum.
			 */
Dean Camera's avatar
Dean Camera committed
967
			uint8_t Pipe_Read_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
968
969
970
971

			/** Reads the given number of bytes from the pipe into the given buffer in big endian,
			 *  sending full packets to the device 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
972
			 *  \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is
973
974
			 *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
			 *
975
976
977
			 *	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.
978
			 *
979
980
981
			 *  The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
			 *  having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
			 *
982
			 *  \ingroup Group_PipeStreamRW
983
			 *
984
			 *  \param[out] Buffer   Pointer to the source data buffer to write to.
985
986
			 *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
987
			 *
988
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
989
			 */
Dean Camera's avatar
Dean Camera committed
990
			uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
991
			
992
			/** EEPROM buffer source version of \ref Pipe_Read_Stream_BE().
993
994
995
			 *
			 *  \ingroup Group_PipeStreamRW
			 *
996
			 *  \param[out] Buffer   Pointer to the source data buffer to write to.
997
998
999
1000
1001
			 *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
			 *  \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 Pipe_Stream_RW_ErrorCodes_t enum.
			 */
Dean Camera's avatar
Dean Camera committed
1002
			uint8_t Pipe_Read_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
1003

1004
1005
1006
	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Macros: */
1007
			#define PIPE_TOKEN_MASK                (0x03 << PTOKEN0)
1008

1009
1010
1011
1012
			#if !defined(ENDPOINT_CONTROLEP)
				#define ENDPOINT_CONTROLEP         0
			#endif
			
1013
1014
			#define Pipe_AllocateMemory()          MACROS{ UPCFG1X |=  (1 << ALLOC); }MACROE
			#define Pipe_DeallocateMemory()        MACROS{ UPCFG1X &= ~(1 << ALLOC); }MACROE
1015
1016
1017
1018
1019

		/* Function Prototypes: */
			void Pipe_ClearPipes(void);

		/* Inline Functions: */
1020
			static inline uint8_t Pipe_BytesToEPSizeMask(uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
			static inline uint8_t Pipe_BytesToEPSizeMask(uint16_t Bytes)
			{
				if (Bytes <= 8)
				  return (0 << EPSIZE0);
				else if (Bytes <= 16)
				  return (1 << EPSIZE0);
				else if (Bytes <= 32)
				  return (2 << EPSIZE0);
				else if (Bytes <= 64)
				  return (3 << EPSIZE0);
1031
				else if (Bytes <= 128)
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
				  return (4 << EPSIZE0);
				else
				  return (5 << EPSIZE0);
			};

	#endif

	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
1043
	
1044
#endif
1045
1046

/** @} */