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