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