projects / pub / USBasp.git / blob
? search:


0b07cbb25a826f218aface7943d02ee6bd98d2a0
[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Pipe.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2010.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, distribute, and sell this
13 software and its documentation for any purpose is hereby granted
14 without fee, provided that the above copyright notice appear in
15 all copies and that both that the copyright notice and this
16 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
20
21 The author disclaim all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
28 this software.
29 */
30
31 /** \file
32 * \brief USB host pipe management definitions.
33 *
34 * This file contains structures, function prototypes and macros related to the management of the device's
35 * data pipes when the library is initialized in USB host mode.
36 *
37 * \note This file should not be included directly. It is automatically included as needed by the USB driver
38 * dispatch header located in LUFA/Drivers/USB/USB.h.
39 */
40
41 /** \ingroup Group_USB
42 * @defgroup Group_PipeManagement Pipe Management
43 *
44 * This module contains functions, macros and enums related to pipe management when in USB Host mode. This
45 * module contains the pipe management macros, as well as pipe interrupt and data send/receive functions
46 * for various data types.
47 *
48 * @{
49 */
50
51 /** @defgroup Group_PipeRW Pipe Data Reading and Writing
52 *
53 * Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
54 */
55
56 /** \ingroup Group_PipeRW
57 * @defgroup Group_PipePrimitiveRW Read/Write of Primitive Data Types
58 *
59 * Functions, macros, variables, enums and types related to data reading and writing of primitive data types
60 * from and to pipes.
61 */
62
63 /** \ingroup Group_PipeRW
64 * @defgroup Group_PipeStreamRW Read/Write of Multi-Byte Streams
65 *
66 * Functions, macros, variables, enums and types related to data reading and writing of data streams from
67 * and to pipes.
68 */
69
70 /** @defgroup Group_PipePacketManagement Pipe Packet Management
71 *
72 * Functions, macros, variables, enums and types related to packet management of pipes.
73 */
74
75 /** @defgroup Group_PipeControlReq Pipe Control Request Management
76 *
77 * Module for host mode request processing. This module allows for the transmission of standard, class and
78 * vendor control requests to the default control endpoint of an attached device while in host mode.
79 *
80 * \see Chapter 9 of the USB 2.0 specification.
81 */
82
83 #ifndef __PIPE_H__
84 #define __PIPE_H__
85
86 /* Includes: */
87 #include <avr/io.h>
88 #include <avr/pgmspace.h>
89 #include <avr/eeprom.h>
90 #include <stdbool.h>
91
92 #include "../../../Common/Common.h"
93 #include "../HighLevel/USBTask.h"
94
95 #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
96 #include "../HighLevel/StreamCallbacks.h"
97 #endif
98
99 /* Enable C linkage for C++ Compilers: */
100 #if defined(__cplusplus)
101 extern "C" {
102 #endif
103
104 /* Preprocessor Checks: */
105 #if !defined(__INCLUDE_FROM_USB_DRIVER)
106 #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
107 #endif
108
109 /* Private Interface - For use in library only: */
110 #if !defined(__DOXYGEN__)
111 /* Macros: */
112 #if !defined(ENDPOINT_CONTROLEP) && !defined(__DOXYGEN__)
113 #define ENDPOINT_CONTROLEP 0
114 #endif
115 #endif
116
117 /* Public Interface - May be used in end-application: */
118 /* Macros: */
119 /** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */
120 #define PIPE_ERRORFLAG_OVERFLOW (1 << 6)
121
122 /** Mask for \ref Pipe_GetErrorFlags(), indicating that an underflow error occurred in the pipe on the received data. */
123 #define PIPE_ERRORFLAG_UNDERFLOW (1 << 5)
124
125 /** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */
126 #define PIPE_ERRORFLAG_CRC16 (1 << 4)
127
128 /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */
129 #define PIPE_ERRORFLAG_TIMEOUT (1 << 3)
130
131 /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */
132 #define PIPE_ERRORFLAG_PID (1 << 2)
133
134 /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */
135 #define PIPE_ERRORFLAG_DATAPID (1 << 1)
136
137 /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */
138 #define PIPE_ERRORFLAG_DATATGL (1 << 0)
139
140 /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes),
141 * which will trigger a control request on the attached device when data is written to the pipe.
142 */
143 #define PIPE_TOKEN_SETUP (0 << PTOKEN0)
144
145 /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),
146 * indicating that the pipe data will flow from device to host.
147 */
148 #define PIPE_TOKEN_IN (1 << PTOKEN0)
149
150 /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a OUT token (for non-CONTROL type pipes),
151 * indicating that the pipe data will flow from host to device.
152 */
153 #define PIPE_TOKEN_OUT (2 << PTOKEN0)
154
155 /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe
156 * should have one single bank, which requires less USB FIFO memory but results in slower transfers as
157 * only one USB device (the AVR or the attached device) can access the pipe's bank at the one time.
158 */
159 #define PIPE_BANK_SINGLE (0 << EPBK0)
160
161 /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe
162 * should have two banks, which requires more USB FIFO memory but results in faster transfers as one
163 * USB device (the AVR or the attached device) can access one bank while the other accesses the second
164 * bank.
165 */
166 #define PIPE_BANK_DOUBLE (1 << EPBK0)
167
168 /** Pipe address for the default control pipe, which always resides in address 0. This is
169 * defined for convenience to give more readable code when used with the pipe macros.
170 */
171 #define PIPE_CONTROLPIPE 0
172
173 /** Default size of the default control pipe's bank, until altered by the Endpoint0Size value
174 * in the device descriptor of the attached device.
175 */
176 #define PIPE_CONTROLPIPE_DEFAULT_SIZE 64
177
178 /** Pipe number mask, for masking against pipe addresses to retrieve the pipe's numerical address
179 * in the device.
180 */
181 #define PIPE_PIPENUM_MASK 0x07
182
183 /** Total number of pipes (including the default control pipe at address 0) which may be used in
184 * the device. Different USB AVR models support different amounts of pipes, this value reflects
185 * the maximum number of pipes for the currently selected AVR model.
186 */
187 #define PIPE_TOTAL_PIPES 7
188
189 /** Size in bytes of the largest pipe bank size possible in the device. Not all banks on each AVR
190 * model supports the largest bank size possible on the device; different pipe numbers support
191 * different maximum bank sizes. This value reflects the largest possible bank of any pipe on the
192 * currently selected USB AVR model.
193 */
194 #define PIPE_MAX_SIZE 256
195
196 /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
197 * numerical address in the attached device.
198 */
199 #define PIPE_EPNUM_MASK 0x0F
200
201 /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's
202 * direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks.
203 */
204 #define PIPE_EPDIR_MASK 0x80
205
206 /* Enums: */
207 /** Enum for the possible error return codes of the Pipe_WaitUntilReady function.
208 *
209 * \ingroup Group_PipeRW
210 */
211 enum Pipe_WaitUntilReady_ErrorCodes_t
212 {
213 PIPE_READYWAIT_NoError = 0, /**< Pipe ready for next packet, no error. */
214 PIPE_READYWAIT_PipeStalled = 1, /**< The device stalled the pipe while waiting. */
215 PIPE_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while waiting. */
216 PIPE_READYWAIT_Timeout = 3, /**< The device failed to accept or send the next packet
217 * within the software timeout period set by the
218 * \ref USB_STREAM_TIMEOUT_MS macro.
219 */
220 };
221
222 /** Enum for the possible error return codes of the Pipe_*_Stream_* functions.
223 *
224 * \ingroup Group_PipeRW
225 */
226 enum Pipe_Stream_RW_ErrorCodes_t
227 {
228 PIPE_RWSTREAM_NoError = 0, /**< Command completed successfully, no error. */
229 PIPE_RWSTREAM_PipeStalled = 1, /**< The device stalled the pipe during the transfer. */
230 PIPE_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
231 * the transfer.
232 */
233 PIPE_RWSTREAM_Timeout = 3, /**< The device failed to accept or send the next packet
234 * within the software timeout period set by the
235 * \ref USB_STREAM_TIMEOUT_MS macro.
236 */
237 PIPE_RWSTREAM_CallbackAborted = 4, /**< Indicates that the stream's callback function aborted
238 * the transfer early.
239 */
240 };
241
242 /* Inline Functions: */
243 /** Indicates the number of bytes currently stored in the current pipes's selected bank.
244 *
245 * \note The return width of this function may differ, depending on the maximum pipe bank size
246 * of the selected AVR model.
247 *
248 * \ingroup Group_PipeRW
249 *
250 * \return Total number of bytes in the currently selected Pipe's FIFO buffer.
251 */
252 static inline uint16_t Pipe_BytesInPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
253 static inline uint16_t Pipe_BytesInPipe(void)
254 {
255 return UPBCX;
256 }
257
258 /** Returns the pipe address of the currently selected pipe. This is typically used to save the
259 * currently selected pipe number so that it can be restored after another pipe has been manipulated.
260 *
261 * \return Index of the currently selected pipe.
262 */
263 static inline uint8_t Pipe_GetCurrentPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
264 static inline uint8_t Pipe_GetCurrentPipe(void)
265 {
266 return (UPNUM & PIPE_PIPENUM_MASK);
267 }
268
269 /** Selects the given pipe number. Any pipe operations which do not require the pipe number to be
270 * indicated will operate on the currently selected pipe.
271 *
272 * \param[in] PipeNumber Index of the pipe to select.
273 */
274 static inline void Pipe_SelectPipe(const uint8_t PipeNumber) ATTR_ALWAYS_INLINE;
275 static inline void Pipe_SelectPipe(const uint8_t PipeNumber)
276 {
277 UPNUM = PipeNumber;
278 }
279
280 /** Resets the desired pipe, including the pipe banks and flags.
281 *
282 * \param[in] PipeNumber Index of the pipe to reset.
283 */
284 static inline void Pipe_ResetPipe(const uint8_t PipeNumber) ATTR_ALWAYS_INLINE;
285 static inline void Pipe_ResetPipe(const uint8_t PipeNumber)
286 {
287 UPRST = (1 << PipeNumber);
288 UPRST = 0;
289 }
290
291 /** Enables the currently selected pipe so that data can be sent and received through it to and from
292 * an attached device.
293 *
294 * \pre The currently selected pipe must first be configured properly via \ref Pipe_ConfigurePipe().
295 */
296 static inline void Pipe_EnablePipe(void) ATTR_ALWAYS_INLINE;
297 static inline void Pipe_EnablePipe(void)
298 {
299 UPCONX |= (1 << PEN);
300 }
301
302 /** Disables the currently selected pipe so that data cannot be sent and received through it to and
303 * from an attached device.
304 */
305 static inline void Pipe_DisablePipe(void) ATTR_ALWAYS_INLINE;
306 static inline void Pipe_DisablePipe(void)
307 {
308 UPCONX &= ~(1 << PEN);
309 }
310
311 /** Determines if the currently selected pipe is enabled, but not necessarily configured.
312 *
313 * \return Boolean True if the currently selected pipe is enabled, false otherwise.
314 */
315 static inline bool Pipe_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
316 static inline bool Pipe_IsEnabled(void)
317 {
318 return ((UPCONX & (1 << PEN)) ? true : false);
319 }
320
321 /** Gets the current pipe token, indicating the pipe's data direction and type.
322 *
323 * \return The current pipe token, as a PIPE_TOKEN_* mask.
324 */
325 static inline uint8_t Pipe_GetPipeToken(void) ATTR_ALWAYS_INLINE;
326 static inline uint8_t Pipe_GetPipeToken(void)
327 {
328 return (UPCFG0X & (0x03 << PTOKEN0));
329 }
330
331 /** Sets the token for the currently selected pipe to one of the tokens specified by the PIPE_TOKEN_*
332 * masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during
333 * control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices
334 * which have two endpoints of opposite direction sharing the same endpoint address within the device.
335 *
336 * \param[in] Token New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask.
337 */
338 static inline void Pipe_SetPipeToken(const uint8_t Token) ATTR_ALWAYS_INLINE;
339 static inline void Pipe_SetPipeToken(const uint8_t Token)
340 {
341 UPCFG0X = ((UPCFG0X & ~(0x03 << PTOKEN0)) | Token);
342 }
343
344 /** Configures the currently selected pipe to allow for an unlimited number of IN requests. */
345 static inline void Pipe_SetInfiniteINRequests(void) ATTR_ALWAYS_INLINE;
346 static inline void Pipe_SetInfiniteINRequests(void)
347 {
348 UPCONX |= (1 << INMODE);
349 }
350
351 /** Configures the currently selected pipe to only allow the specified number of IN requests to be
352 * accepted by the pipe before it is automatically frozen.
353 *
354 * \param[in] TotalINRequests Total number of IN requests that the pipe may receive before freezing.
355 */
356 static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests) ATTR_ALWAYS_INLINE;
357 static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests)
358 {
359 UPCONX &= ~(1 << INMODE);
360 UPINRQX = TotalINRequests;
361 }
362
363 /** Determines if the currently selected pipe is configured.
364 *
365 * \return Boolean true if the selected pipe is configured, false otherwise.
366 */
367 static inline bool Pipe_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
368 static inline bool Pipe_IsConfigured(void)
369 {
370 return ((UPSTAX & (1 << CFGOK)) ? true : false);
371 }
372
373 /** Retrieves the endpoint number of the endpoint within the attached device that the currently selected
374 * pipe is bound to.
375 *
376 * \return Endpoint number the currently selected pipe is bound to.
377 */
378 static inline uint8_t Pipe_BoundEndpointNumber(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
379 static inline uint8_t Pipe_BoundEndpointNumber(void)
380 {
381 return ((UPCFG0X >> PEPNUM0) & PIPE_EPNUM_MASK);
382 }
383
384 /** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.
385 *
386 * \param[in] Milliseconds Number of milliseconds between each pipe poll.
387 */
388 static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds) ATTR_ALWAYS_INLINE;
389 static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds)
390 {
391 UPCFG2X = Milliseconds;
392 }
393
394 /** Returns a mask indicating which pipe's interrupt periods have elapsed, indicating that the pipe should
395 * be serviced.
396 *
397 * \return Mask whose bits indicate which pipes have interrupted.
398 */
399 static inline uint8_t Pipe_GetPipeInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
400 static inline uint8_t Pipe_GetPipeInterrupts(void)
401 {
402 return UPINT;
403 }
404
405 /** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type
406 * pipes).
407 *
408 * \param[in] PipeNumber Index of the pipe whose interrupt flag should be tested.
409 *
410 * \return Boolean true if the specified pipe has interrupted, false otherwise.
411 */
412 static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
413 static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber)
414 {
415 return ((UPINT & (1 << PipeNumber)) ? true : false);
416 }
417
418 /** Unfreezes the selected pipe, allowing it to communicate with an attached device. */
419 static inline void Pipe_Unfreeze(void) ATTR_ALWAYS_INLINE;
420 static inline void Pipe_Unfreeze(void)
421 {
422 UPCONX &= ~(1 << PFREEZE);
423 }
424
425 /** Freezes the selected pipe, preventing it from communicating with an attached device. */
426 static inline void Pipe_Freeze(void) ATTR_ALWAYS_INLINE;
427 static inline void Pipe_Freeze(void)
428 {
429 UPCONX |= (1 << PFREEZE);
430 }
431
432 /** Determines if the currently selected pipe is frozen, and not able to accept data.
433 *
434 * \return Boolean true if the currently selected pipe is frozen, false otherwise.
435 */
436 static inline bool Pipe_IsFrozen(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
437 static inline bool Pipe_IsFrozen(void)
438 {
439 return ((UPCONX & (1 << PFREEZE)) ? true : false);
440 }
441
442 /** Clears the master pipe error flag. */
443 static inline void Pipe_ClearError(void) ATTR_ALWAYS_INLINE;
444 static inline void Pipe_ClearError(void)
445 {
446 UPINTX &= ~(1 << PERRI);
447 }
448
449 /** Determines if the master pipe error flag is set for the currently selected pipe, indicating that
450 * some sort of hardware error has occurred on the pipe.
451 *
452 * \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.
453 *
454 * \return Boolean true if an error has occurred on the selected pipe, false otherwise.
455 */
456 static inline bool Pipe_IsError(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
457 static inline bool Pipe_IsError(void)
458 {
459 return ((UPINTX & (1 << PERRI)) ? true : false);
460 }
461
462 /** Clears all the currently selected pipe's hardware error flags, but does not clear the master error
463 * flag for the pipe.
464 */
465 static inline void Pipe_ClearErrorFlags(void) ATTR_ALWAYS_INLINE;
466 static inline void Pipe_ClearErrorFlags(void)
467 {
468 UPERRX = 0;
469 }
470
471 /** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This
472 * value can then be masked against the PIPE_ERRORFLAG_* masks to determine what error has occurred.
473 *
474 * \return Mask comprising of PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe.
475 */
476 static inline uint8_t Pipe_GetErrorFlags(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
477 static inline uint8_t Pipe_GetErrorFlags(void)
478 {
479 return ((UPERRX & (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT |
480 PIPE_ERRORFLAG_PID | PIPE_ERRORFLAG_DATAPID |
481 PIPE_ERRORFLAG_DATATGL)) |
482 (UPSTAX & (PIPE_ERRORFLAG_OVERFLOW | PIPE_ERRORFLAG_UNDERFLOW)));
483 }
484
485 /** Determines if the currently selected pipe may be read from (if data is waiting in the pipe
486 * bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT
487 * direction). This function will return false if an error has occurred in the pipe, or if the pipe
488 * is an IN direction and no packet (or an empty packet) has been received, or if the pipe is an OUT
489 * direction and the pipe bank is full.
490 *
491 * \note This function is not valid on CONTROL type pipes.
492 *
493 * \ingroup Group_PipePacketManagement
494 *
495 * \return Boolean true if the currently selected pipe may be read from or written to, depending on its direction.
496 */
497 static inline bool Pipe_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
498 static inline bool Pipe_IsReadWriteAllowed(void)
499 {
500 return ((UPINTX & (1 << RWAL)) ? true : false);
501 }
502
503 /** Determines if an IN request has been received on the currently selected pipe.
504 *
505 * \ingroup Group_PipePacketManagement
506 *
507 * \return Boolean true if the current pipe has received an IN packet, false otherwise.
508 */
509 static inline bool Pipe_IsINReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
510 static inline bool Pipe_IsINReceived(void)
511 {
512 return ((UPINTX & (1 << RXINI)) ? true : false);
513 }
514
515 /** Determines if the currently selected pipe is ready to send an OUT request.
516 *
517 * \ingroup Group_PipePacketManagement
518 *
519 * \return Boolean true if the current pipe is ready for an OUT packet, false otherwise.
520 */
521 static inline bool Pipe_IsOUTReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
522 static inline bool Pipe_IsOUTReady(void)
523 {
524 return ((UPINTX & (1 << TXOUTI)) ? true : false);
525 }
526
527 /** Determines if no SETUP request is currently being sent to the attached device on the selected
528 * CONTROL type pipe.
529 *
530 * \ingroup Group_PipePacketManagement
531 *
532 * \return Boolean true if the current pipe is ready for a SETUP packet, false otherwise.
533 */
534 static inline bool Pipe_IsSETUPSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
535 static inline bool Pipe_IsSETUPSent(void)
536 {
537 return ((UPINTX & (1 << TXSTPI)) ? true : false);
538 }
539
540 /** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.
541 *
542 * \ingroup Group_PipePacketManagement
543 */
544 static inline void Pipe_ClearSETUP(void) ATTR_ALWAYS_INLINE;
545 static inline void Pipe_ClearSETUP(void)
546 {
547 UPINTX &= ~((1 << TXSTPI) | (1 << FIFOCON));
548 }
549
550 /** Acknowledges the reception of a setup IN request from the attached device on the currently selected
551 * pipe, freeing the bank ready for the next packet.
552 *
553 * \ingroup Group_PipePacketManagement
554 */
555 static inline void Pipe_ClearIN(void) ATTR_ALWAYS_INLINE;
556 static inline void Pipe_ClearIN(void)
557 {
558 UPINTX &= ~((1 << RXINI) | (1 << FIFOCON));
559 }
560
561 /** Sends the currently selected pipe's contents to the device as an OUT packet on the selected pipe, freeing
562 * the bank ready for the next packet.
563 *
564 * \ingroup Group_PipePacketManagement
565 */
566 static inline void Pipe_ClearOUT(void) ATTR_ALWAYS_INLINE;
567 static inline void Pipe_ClearOUT(void)
568 {
569 UPINTX &= ~((1 << TXOUTI) | (1 << FIFOCON));
570 }
571
572 /** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on
573 * the currently selected pipe. This occurs when the host sends a packet to the device, but the device
574 * is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been
575 * received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet
576 * can be re-sent.
577 *
578 * \ingroup Group_PipePacketManagement
579 *
580 * \return Boolean true if an NAK has been received on the current pipe, false otherwise.
581 */
582 static inline bool Pipe_IsNAKReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
583 static inline bool Pipe_IsNAKReceived(void)
584 {
585 return ((UPINTX & (1 << NAKEDI)) ? true : false);
586 }
587
588 /** Clears the NAK condition on the currently selected pipe.
589 *
590 * \ingroup Group_PipePacketManagement
591 *
592 * \see \ref Pipe_IsNAKReceived() for more details.
593 */
594 static inline void Pipe_ClearNAKReceived(void) ATTR_ALWAYS_INLINE;
595 static inline void Pipe_ClearNAKReceived(void)
596 {
597 UPINTX &= ~(1 << NAKEDI);
598 }
599
600 /** Determines if the currently selected pipe has had the STALL condition set by the attached device.
601 *
602 * \ingroup Group_PipePacketManagement
603 *
604 * \return Boolean true if the current pipe has been stalled by the attached device, false otherwise.
605 */
606 static inline bool Pipe_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
607 static inline bool Pipe_IsStalled(void)
608 {
609 return ((UPINTX & (1 << RXSTALLI)) ? true : false);
610 }
611
612 /** Clears the STALL condition detection flag on the currently selected pipe, but does not clear the
613 * STALL condition itself (this must be done via a ClearFeature control request to the device).
614 *
615 * \ingroup Group_PipePacketManagement
616 */
617 static inline void Pipe_ClearStall(void) ATTR_ALWAYS_INLINE;
618 static inline void Pipe_ClearStall(void)
619 {
620 UPINTX &= ~(1 << RXSTALLI);
621 }
622
623 /** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.
624 *
625 * \ingroup Group_PipePrimitiveRW
626 *
627 * \return Next byte in the currently selected pipe's FIFO buffer.
628 */
629 static inline uint8_t Pipe_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
630 static inline uint8_t Pipe_Read_Byte(void)
631 {
632 return UPDATX;
633 }
634
635 /** Writes one byte from the currently selected pipe's bank, for IN direction pipes.
636 *
637 * \ingroup Group_PipePrimitiveRW
638 *
639 * \param[in] Byte Next byte to write into the the currently selected pipe's FIFO buffer.
640 */
641 static inline void Pipe_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
642 static inline void Pipe_Write_Byte(const uint8_t Byte)
643 {
644 UPDATX = Byte;
645 }
646
647 /** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.
648 *
649 * \ingroup Group_PipePrimitiveRW
650 */
651 static inline void Pipe_Discard_Byte(void) ATTR_ALWAYS_INLINE;
652 static inline void Pipe_Discard_Byte(void)
653 {
654 uint8_t Dummy;
655
656 Dummy = UPDATX;
657 }
658
659 /** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT
660 * direction pipes.
661 *
662 * \ingroup Group_PipePrimitiveRW
663 *
664 * \return Next word in the currently selected pipe's FIFO buffer.
665 */
666 static inline uint16_t Pipe_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
667 static inline uint16_t Pipe_Read_Word_LE(void)
668 {
669 union
670 {
671 uint16_t Word;
672 uint8_t Bytes[2];
673 } Data;
674
675 Data.Bytes[0] = UPDATX;
676 Data.Bytes[1] = UPDATX;
677
678 return Data.Word;
679 }
680
681 /** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT
682 * direction pipes.
683 *
684 * \ingroup Group_PipePrimitiveRW
685 *
686 * \return Next word in the currently selected pipe's FIFO buffer.
687 */
688 static inline uint16_t Pipe_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
689 static inline uint16_t Pipe_Read_Word_BE(void)
690 {
691 union
692 {
693 uint16_t Word;
694 uint8_t Bytes[2];
695 } Data;
696
697 Data.Bytes[1] = UPDATX;
698 Data.Bytes[0] = UPDATX;
699
700 return Data.Word;
701 }
702
703 /** Writes two bytes to the currently selected pipe's bank in little endian format, for IN
704 * direction pipes.
705 *
706 * \ingroup Group_PipePrimitiveRW
707 *
708 * \param[in] Word Next word to write to the currently selected pipe's FIFO buffer.
709 */
710 static inline void Pipe_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
711 static inline void Pipe_Write_Word_LE(const uint16_t Word)
712 {
713 UPDATX = (Word & 0xFF);
714 UPDATX = (Word >> 8);
715 }
716
717 /** Writes two bytes to the currently selected pipe's bank in big endian format, for IN
718 * direction pipes.
719 *
720 * \ingroup Group_PipePrimitiveRW
721 *
722 * \param[in] Word Next word to write to the currently selected pipe's FIFO buffer.
723 */
724 static inline void Pipe_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
725 static inline void Pipe_Write_Word_BE(const uint16_t Word)
726 {
727 UPDATX = (Word >> 8);
728 UPDATX = (Word & 0xFF);
729 }
730
731 /** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.
732 *
733 * \ingroup Group_PipePrimitiveRW
734 */
735 static inline void Pipe_Discard_Word(void) ATTR_ALWAYS_INLINE;
736 static inline void Pipe_Discard_Word(void)
737 {
738 uint8_t Dummy;
739
740 Dummy = UPDATX;
741 Dummy = UPDATX;
742 }
743
744 /** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT
745 * direction pipes.
746 *
747 * \ingroup Group_PipePrimitiveRW
748 *
749 * \return Next double word in the currently selected pipe's FIFO buffer.
750 */
751 static inline uint32_t Pipe_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
752 static inline uint32_t Pipe_Read_DWord_LE(void)
753 {
754 union
755 {
756 uint32_t DWord;
757 uint8_t Bytes[4];
758 } Data;
759
760 Data.Bytes[0] = UPDATX;
761 Data.Bytes[1] = UPDATX;
762 Data.Bytes[2] = UPDATX;
763 Data.Bytes[3] = UPDATX;
764
765 return Data.DWord;
766 }
767
768 /** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT
769 * direction pipes.
770 *
771 * \ingroup Group_PipePrimitiveRW
772 *
773 * \return Next double word in the currently selected pipe's FIFO buffer.
774 */
775 static inline uint32_t Pipe_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
776 static inline uint32_t Pipe_Read_DWord_BE(void)
777 {
778 union
779 {
780 uint32_t DWord;
781 uint8_t Bytes[4];
782 } Data;
783
784 Data.Bytes[3] = UPDATX;
785 Data.Bytes[2] = UPDATX;
786 Data.Bytes[1] = UPDATX;
787 Data.Bytes[0] = UPDATX;
788
789 return Data.DWord;
790 }
791
792 /** Writes four bytes to the currently selected pipe's bank in little endian format, for IN
793 * direction pipes.
794 *
795 * \ingroup Group_PipePrimitiveRW
796 *
797 * \param[in] DWord Next double word to write to the currently selected pipe's FIFO buffer.
798 */
799 static inline void Pipe_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
800 static inline void Pipe_Write_DWord_LE(const uint32_t DWord)
801 {
802 UPDATX = (DWord & 0xFF);
803 UPDATX = (DWord >> 8);
804 UPDATX = (DWord >> 16);
805 UPDATX = (DWord >> 24);
806 }
807
808 /** Writes four bytes to the currently selected pipe's bank in big endian format, for IN
809 * direction pipes.
810 *
811 * \ingroup Group_PipePrimitiveRW
812 *
813 * \param[in] DWord Next double word to write to the currently selected pipe's FIFO buffer.
814 */
815 static inline void Pipe_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
816 static inline void Pipe_Write_DWord_BE(const uint32_t DWord)
817 {
818 UPDATX = (DWord >> 24);
819 UPDATX = (DWord >> 16);
820 UPDATX = (DWord >> 8);
821 UPDATX = (DWord & 0xFF);
822 }
823
824 /** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.
825 *
826 * \ingroup Group_PipePrimitiveRW
827 */
828 static inline void Pipe_Discard_DWord(void) ATTR_ALWAYS_INLINE;
829 static inline void Pipe_Discard_DWord(void)
830 {
831 uint8_t Dummy;
832
833 Dummy = UPDATX;
834 Dummy = UPDATX;
835 Dummy = UPDATX;
836 Dummy = UPDATX;
837 }
838
839 /* External Variables: */
840 /** Global indicating the maximum packet size of the default control pipe located at address
841 * 0 in the device. This value is set to the value indicated in the attached device's device
842 * descriptor once the USB interface is initialized into host mode and a device is attached
843 * to the USB bus.
844 *
845 * \note This variable should be treated as read-only in the user application, and never manually
846 * changed in value.
847 */
848 extern uint8_t USB_ControlPipeSize;
849
850 /* Function Prototypes: */
851 #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
852 #define __CALLBACK_PARAM , StreamCallbackPtr_t Callback
853 #else
854 #define __CALLBACK_PARAM
855 #endif
856
857 /** Configures the specified pipe number with the given pipe type, token, target endpoint number in the
858 * attached device, bank size and banking mode. Pipes should be allocated in ascending order by their
859 * address in the device (i.e. pipe 1 should be configured before pipe 2 and so on) to prevent fragmentation
860 * of the USB FIFO memory.
861 *
862 * The pipe type may be one of the EP_TYPE_* macros listed in LowLevel.h, the token may be one of the
863 * PIPE_TOKEN_* masks.
864 *
865 * The bank size must indicate the maximum packet size that the pipe can handle. Different pipe
866 * numbers can handle different maximum packet sizes - refer to the chosen USB AVR's datasheet to
867 * determine the maximum bank size for each pipe.
868 *
869 * The banking mode may be either \ref PIPE_BANK_SINGLE or \ref PIPE_BANK_DOUBLE.
870 *
871 * A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()
872 * before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or
873 * sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite
874 * numbers of IN requests without automatic freezing - this can be overridden by a call to
875 * \ref Pipe_SetFiniteINRequests().
876 *
877 * \note The default control pipe should not be manually configured by the user application, as it
878 * is automatically configured by the library internally.
879 * \n\n
880 *
881 * \note This routine will select the specified pipe, and the pipe will remain selected once the
882 * routine completes regardless of if the pipe configuration succeeds.
883 *
884 * \return Boolean true if the configuration is successful, false otherwise.
885 */
886 bool Pipe_ConfigurePipe(const uint8_t Number,
887 const uint8_t Type,
888 const uint8_t Token,
889 const uint8_t EndpointNumber,
890 const uint16_t Size,
891 const uint8_t Banks);
892
893 /** Spin-loops until the currently selected non-control pipe is ready for the next packed of data to be read
894 * or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).
895 *
896 * \ingroup Group_PipeRW
897 *
898 * \return A value from the Pipe_WaitUntilReady_ErrorCodes_t enum.
899 */
900 uint8_t Pipe_WaitUntilReady(void);
901
902 /** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given
903 * endpoint is found, it is automatically selected.
904 *
905 * \param[in] EndpointAddress Address and direction mask of the endpoint within the attached device to check.
906 *
907 * \return Boolean true if a pipe bound to the given endpoint address of the specified direction is found, false
908 * otherwise.
909 */
910 bool Pipe_IsEndpointBound(const uint8_t EndpointAddress);
911
912 /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host
913 * as needed. The last packet is not automatically discarded once the remaining bytes has been read; the
914 * user is responsible for manually discarding the last packet from the device via the \ref Pipe_ClearIN() macro.
915 * Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,
916 * allowing for early aborts of stream transfers.
917 *
918 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
919 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
920 * disabled and this function has the Callback parameter omitted.
921 *
922 * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
923 * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
924 *
925 * \ingroup Group_PipeStreamRW
926 *
927 * \param[in] Length Number of bytes to send via the currently selected pipe.
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 */
932 uint8_t Pipe_Discard_Stream(uint16_t Length
933 __CALLBACK_PARAM);
934
935 /** Writes the given number of bytes to the pipe from the given buffer in little endian,
936 * sending full packets to the device as needed. The last packet filled is not automatically sent;
937 * the user is responsible for manually sending the last written packet to the host via the
938 * \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is
939 * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
940 *
941 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
942 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
943 * disabled and this function has the Callback parameter omitted.
944 *
945 * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
946 * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
947 *
948 * \ingroup Group_PipeStreamRW
949 *
950 * \param[in] Buffer Pointer to the source data buffer to read from.
951 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
952 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.
953 *
954 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
955 */
956 uint8_t Pipe_Write_Stream_LE(const void* Buffer,
957 uint16_t Length
958 __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
959
960 /** EEPROM buffer source version of \ref Pipe_Write_Stream_LE().
961 *
962 * \ingroup Group_PipeStreamRW
963 *
964 * \param[in] Buffer Pointer to the source data buffer to read from.
965 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
966 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.
967 *
968 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
969 */
970 uint8_t Pipe_Write_EStream_LE(const void* Buffer,
971 uint16_t Length
972 __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
973
974 /** FLASH buffer source version of \ref Pipe_Write_Stream_LE().
975 *
976 * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
977 *
978 * \ingroup Group_PipeStreamRW
979 *
980 * \param[in] Buffer Pointer to the source data buffer to read from.
981 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
982 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.
983 *
984 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
985 */
986 uint8_t Pipe_Write_PStream_LE(const void* Buffer,
987 uint16_t Length
988 __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
989
990 /** Writes the given number of bytes to the pipe from the given buffer in big endian,
991 * sending full packets to the device as needed. The last packet filled is not automatically sent;
992 * the user is responsible for manually sending the last written packet to the host via the
993 * \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is
994 * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
995 *
996 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
997 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
998 * disabled and this function has the Callback parameter omitted.
999 *
1000 * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
1001 * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
1002 *
1003 * \ingroup Group_PipeStreamRW
1004 *
1005 * \param[in] Buffer Pointer to the source data buffer to read from.
1006 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
1007 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.
1008 *
1009 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
1010 */
1011 uint8_t Pipe_Write_Stream_BE(const void* Buffer,
1012 uint16_t Length
1013 __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
1014
1015 /** EEPROM buffer source version of \ref Pipe_Write_Stream_BE().
1016 *
1017 * \ingroup Group_PipeStreamRW
1018 *
1019 * \param[in] Buffer Pointer to the source data buffer to read from.
1020 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
1021 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.
1022 *
1023 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
1024 */
1025 uint8_t Pipe_Write_EStream_BE(const void* Buffer,
1026 uint16_t Length
1027 __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
1028
1029 /** FLASH buffer source version of \ref Pipe_Write_Stream_BE().
1030 *
1031 * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
1032 *
1033 * \ingroup Group_PipeStreamRW
1034 *
1035 * \param[in] Buffer Pointer to the source data buffer to read from.
1036 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
1037 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.
1038 *
1039 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
1040 */
1041 uint8_t Pipe_Write_PStream_BE(const void* Buffer,
1042 uint16_t Length
1043 __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
1044
1045 /** Reads the given number of bytes from the pipe into the given buffer in little endian,
1046 * sending full packets to the device as needed. The last packet filled is not automatically sent;
1047 * the user is responsible for manually sending the last written packet to the host via the
1048 * \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is
1049 * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
1050 *
1051 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
1052 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
1053 * disabled and this function has the Callback parameter omitted.
1054 *
1055 * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
1056 * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
1057 *
1058 * \ingroup Group_PipeStreamRW
1059 *
1060 * \param[out] Buffer Pointer to the source data buffer to write to.
1061 * \param[in] Length Number of bytes to read for the currently selected pipe to read from.
1062 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.
1063 *
1064 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
1065 */
1066 uint8_t Pipe_Read_Stream_LE(void* Buffer,
1067 uint16_t Length
1068 __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
1069
1070 /** EEPROM buffer source version of \ref Pipe_Read_Stream_LE().
1071 *
1072 * \ingroup Group_PipeStreamRW
1073 *
1074 * \param[out] Buffer Pointer to the source data buffer to write to.
1075 * \param[in] Length Number of bytes to read for the currently selected pipe to read from.
1076 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.
1077 *
1078 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
1079 */
1080 uint8_t Pipe_Read_EStream_LE(void* Buffer,
1081 uint16_t Length
1082 __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
1083
1084 /** Reads the given number of bytes from the pipe into the given buffer in big endian,
1085 * sending full packets to the device as needed. The last packet filled is not automatically sent;
1086 * the user is responsible for manually sending the last written packet to the host via the
1087 * \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is
1088 * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
1089 *
1090 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
1091 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
1092 * disabled and this function has the Callback parameter omitted.
1093 *
1094 * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
1095 * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
1096 *
1097 * \ingroup Group_PipeStreamRW
1098 *
1099 * \param[out] Buffer Pointer to the source data buffer to write to.
1100 * \param[in] Length Number of bytes to read for the currently selected pipe to read from.
1101 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.
1102 *
1103 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
1104 */
1105 uint8_t Pipe_Read_Stream_BE(void* Buffer,
1106 uint16_t Length
1107 __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
1108
1109 /** EEPROM buffer source version of \ref Pipe_Read_Stream_BE().
1110 *
1111 * \ingroup Group_PipeStreamRW
1112 *
1113 * \param[out] Buffer Pointer to the source data buffer to write to.
1114 * \param[in] Length Number of bytes to read for the currently selected pipe to read from.
1115 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.
1116 *
1117 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
1118 */
1119 uint8_t Pipe_Read_EStream_BE(void* Buffer,
1120 uint16_t Length
1121 __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
1122
1123 /* Private Interface - For use in library only: */
1124 #if !defined(__DOXYGEN__)
1125 /* Function Prototypes: */
1126 void Pipe_ClearPipes(void);
1127
1128 /* Inline Functions: */
1129 static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
1130 static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes)
1131 {
1132 uint8_t MaskVal = 0;
1133 uint16_t CheckBytes = 8;
1134
1135 while ((CheckBytes < Bytes) && (CheckBytes < PIPE_MAX_SIZE))
1136 {
1137 MaskVal++;
1138 CheckBytes <<= 1;
1139 }
1140
1141 return (MaskVal << EPSIZE0);
1142 }
1143
1144 #endif
1145
1146 /* Disable C linkage for C++ Compilers: */
1147 #if defined(__cplusplus)
1148 }
1149 #endif
1150
1151 #endif
1152
1153 /** @} */
USB isp AVR programmer