projects / pub / USBasp.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Update copyright year to 2010.
[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 /** \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/receive 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 OUT 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 /** Determines if the currently selected pipe is frozen, and not able to accept data.
296 *
297 * \return Boolean true if the currently selected pipe is frozen, false otherwise
298 */
299 static inline bool Pipe_IsFrozen(void);
300
301 /** Clears the master pipe error flag. */
302 static inline void Pipe_ClearError(void);
303
304 /** Determines if the master pipe error flag is set for the currently selected pipe, indicating that
305 * some sort of hardware error has occurred on the pipe.
306 *
307 * \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.
308 *
309 * \return Boolean true if an error has occurred on the selected pipe, false otherwise
310 */
311 static inline bool Pipe_IsError(void);
312
313 /** Clears all the currently selected pipe's hardware error flags, but does not clear the master error
314 * flag for the pipe.
315 */
316 static inline void Pipe_ClearErrorFlags(void);
317
318 /** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This
319 * value can then be masked against the PIPE_ERRORFLAG_* masks to determine what error has occurred.
320 *
321 * \return Mask comprising of PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe
322 */
323 static inline uint8_t Pipe_GetErrorFlags(void);
324
325 /** Determines if the currently selected pipe may be read from (if data is waiting in the pipe
326 * bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT
327 * direction). This function will return false if an error has occurred in the pipe, or if the pipe
328 * is an IN direction and no packet (or an empty packet) has been received, or if the pipe is an OUT
329 * direction and the pipe bank is full.
330 *
331 * \note This function is not valid on CONTROL type pipes.
332 *
333 * \ingroup Group_PipePacketManagement
334 *
335 * \return Boolean true if the currently selected pipe may be read from or written to, depending on its direction
336 */
337 static inline bool Pipe_IsReadWriteAllowed(void);
338
339 /** Determines if an IN request has been received on the currently selected pipe.
340 *
341 * \ingroup Group_PipePacketManagement
342 *
343 * \return Boolean true if the current pipe has received an IN packet, false otherwise.
344 */
345 static inline bool Pipe_IsINReceived(void);
346
347 /** Determines if the currently selected pipe is ready to send an OUT request.
348 *
349 * \ingroup Group_PipePacketManagement
350 *
351 * \return Boolean true if the current pipe is ready for an OUT packet, false otherwise.
352 */
353 static inline bool Pipe_IsOUTReady(void);
354
355 /** Determines if no SETUP request is currently being sent to the attached device on the selected
356 * CONTROL type pipe.
357 *
358 * \ingroup Group_PipePacketManagement
359 *
360 * \return Boolean true if the current pipe is ready for a SETUP packet, false otherwise.
361 */
362 static inline bool Pipe_IsSETUPSent(void);
363
364 /** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.
365 *
366 * \ingroup Group_PipePacketManagement
367 */
368 static inline void Pipe_ClearSETUP(void);
369
370 /** Acknowledges the reception of a setup IN request from the attached device on the currently selected
371 * pipe, freeing the bank ready for the next packet.
372 *
373 * \ingroup Group_PipePacketManagement
374 */
375 static inline void Pipe_ClearIN(void);
376
377 /** Sends the currently selected pipe's contents to the device as an OUT packet on the selected pipe, freeing
378 * the bank ready for the next packet.
379 *
380 * \ingroup Group_PipePacketManagement
381 */
382 static inline void Pipe_ClearOUT(void);
383
384 /** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on
385 * the currently selected pipe. This occurs when the host sends a packet to the device, but the device
386 * is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been
387 * received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet
388 * can be re-sent.
389 *
390 * \ingroup Group_PipePacketManagement
391 *
392 * \return Boolean true if an NAK has been received on the current pipe, false otherwise
393 */
394 static inline bool Pipe_IsNAKReceived(void);
395
396 /** Clears the NAK condition on the currently selected pipe.
397 *
398 * \ingroup Group_PipePacketManagement
399 *
400 * \see \ref Pipe_IsNAKReceived() for more details.
401 */
402 static inline void Pipe_ClearNAKReceived(void);
403
404 /** Determines if the currently selected pipe has had the STALL condition set by the attached device.
405 *
406 * \ingroup Group_PipePacketManagement
407 *
408 * \return Boolean true if the current pipe has been stalled by the attached device, false otherwise
409 */
410 static inline bool Pipe_IsStalled(void);
411
412 /** Clears the STALL condition detection flag on the currently selected pipe, but does not clear the
413 * STALL condition itself (this must be done via a ClearFeature control request to the device).
414 *
415 * \ingroup Group_PipePacketManagement
416 */
417 static inline void Pipe_ClearStall(void);
418 #else
419 #define Pipe_BytesInPipe() UPBCX
420
421 #define Pipe_GetCurrentPipe() (UPNUM & PIPE_PIPENUM_MASK)
422
423 #define Pipe_SelectPipe(pipenum) MACROS{ UPNUM = (pipenum); }MACROE
424
425 #define Pipe_ResetPipe(pipenum) MACROS{ UPRST = (1 << (pipenum)); UPRST = 0; }MACROE
426
427 #define Pipe_EnablePipe() MACROS{ UPCONX |= (1 << PEN); }MACROE
428
429 #define Pipe_DisablePipe() MACROS{ UPCONX &= ~(1 << PEN); }MACROE
430
431 #define Pipe_IsEnabled() ((UPCONX & (1 << PEN)) ? true : false)
432
433 #define Pipe_GetPipeToken() (UPCFG0X & PIPE_TOKEN_MASK)
434
435 #define Pipe_SetPipeToken(token) MACROS{ UPCFG0X = ((UPCFG0X & ~PIPE_TOKEN_MASK) | (token)); }MACROE
436
437 #define Pipe_SetInfiniteINRequests() MACROS{ UPCONX |= (1 << INMODE); }MACROE
438
439 #define Pipe_SetFiniteINRequests(n) MACROS{ UPCONX &= ~(1 << INMODE); UPINRQX = (n); }MACROE
440
441 #define Pipe_IsConfigured() ((UPSTAX & (1 << CFGOK)) ? true : false)
442
443 #define Pipe_BoundEndpointNumber() ((UPCFG0X >> PEPNUM0) & PIPE_EPNUM_MASK)
444
445 #define Pipe_SetInterruptPeriod(ms) MACROS{ UPCFG2X = (ms); }MACROE
446
447 #define Pipe_GetPipeInterrupts() UPINT
448
449 #define Pipe_HasPipeInterrupted(n) ((UPINT & (1 << (n))) ? true : false)
450
451 #define Pipe_Unfreeze() MACROS{ UPCONX &= ~(1 << PFREEZE); }MACROE
452
453 #define Pipe_Freeze() MACROS{ UPCONX |= (1 << PFREEZE); }MACROE
454
455 #define Pipe_IsFrozen() ((UPCONX & (1 << PFREEZE)) ? true : false)
456
457 #define Pipe_ClearError() MACROS{ UPINTX &= ~(1 << PERRI); }MACROE
458
459 #define Pipe_IsError() ((UPINTX & (1 << PERRI)) ? true : false)
460
461 #define Pipe_ClearErrorFlags() MACROS{ UPERRX = 0; }MACROE
462
463 #define Pipe_GetErrorFlags() ((UPERRX & (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT | \
464 PIPE_ERRORFLAG_PID | PIPE_ERRORFLAG_DATAPID | \
465 PIPE_ERRORFLAG_DATATGL)) | \
466 (UPSTAX & PIPE_ERRORFLAG_OVERFLOW | PIPE_ERRORFLAG_UNDERFLOW))
467
468 #define Pipe_IsReadWriteAllowed() ((UPINTX & (1 << RWAL)) ? true : false)
469
470 #define Pipe_IsINReceived() ((UPINTX & (1 << RXINI)) ? true : false)
471
472 #define Pipe_IsOUTReady() ((UPINTX & (1 << TXOUTI)) ? true : false)
473
474 #define Pipe_IsSETUPSent() ((UPINTX & (1 << TXSTPI)) ? true : false)
475
476 #define Pipe_ClearIN() MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << RXINI)); \
477 UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE
478
479 #define Pipe_ClearOUT() MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << TXOUTI)); \
480 UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE
481
482 #define Pipe_ClearSETUP() MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << TXSTPI)); \
483 UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE
484
485 #define Pipe_IsNAKReceived() ((UPINTX & (1 << NAKEDI)) ? true : false)
486
487 #define Pipe_ClearNAKReceived() MACROS{ UPINTX &= ~(1 << NAKEDI); }MACROE
488
489 #define Pipe_IsStalled() ((UPINTX & (1 << RXSTALLI)) ? true : false)
490
491 #define Pipe_ClearStall() MACROS{ UPINTX &= ~(1 << RXSTALLI); }MACROE
492 #endif
493
494 /* Enums: */
495 /** Enum for the possible error return codes of the Pipe_WaitUntilReady function
496 *
497 * \ingroup Group_PipeRW
498 */
499 enum Pipe_WaitUntilReady_ErrorCodes_t
500 {
501 PIPE_READYWAIT_NoError = 0, /**< Pipe ready for next packet, no error */
502 PIPE_READYWAIT_PipeStalled = 1, /**< The device stalled the pipe while waiting. */
503 PIPE_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while waiting. */
504 PIPE_READYWAIT_Timeout = 3, /**< The device failed to accept or send the next packet
505 * within the software timeout period set by the
506 * \ref USB_STREAM_TIMEOUT_MS macro.
507 */
508 };
509
510 /** Enum for the possible error return codes of the Pipe_*_Stream_* functions.
511 *
512 * \ingroup Group_PipeRW
513 */
514 enum Pipe_Stream_RW_ErrorCodes_t
515 {
516 PIPE_RWSTREAM_NoError = 0, /**< Command completed successfully, no error. */
517 PIPE_RWSTREAM_PipeStalled = 1, /**< The device stalled the pipe during the transfer. */
518 PIPE_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
519 * the transfer.
520 */
521 PIPE_RWSTREAM_Timeout = 3, /**< The device failed to accept or send the next packet
522 * within the software timeout period set by the
523 * \ref USB_STREAM_TIMEOUT_MS macro.
524 */
525 PIPE_RWSTREAM_CallbackAborted = 4, /**< Indicates that the stream's callback function aborted
526 * the transfer early.
527 */
528 };
529
530 /* Inline Functions: */
531 /** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.
532 *
533 * \ingroup Group_PipePrimitiveRW
534 *
535 * \return Next byte in the currently selected pipe's FIFO buffer
536 */
537 static inline uint8_t Pipe_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
538 static inline uint8_t Pipe_Read_Byte(void)
539 {
540 return UPDATX;
541 }
542
543 /** Writes one byte from the currently selected pipe's bank, for IN direction pipes.
544 *
545 * \ingroup Group_PipePrimitiveRW
546 *
547 * \param[in] Byte Next byte to write into the the currently selected pipe's FIFO buffer
548 */
549 static inline void Pipe_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
550 static inline void Pipe_Write_Byte(const uint8_t Byte)
551 {
552 UPDATX = Byte;
553 }
554
555 /** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.
556 *
557 * \ingroup Group_PipePrimitiveRW
558 */
559 static inline void Pipe_Discard_Byte(void) ATTR_ALWAYS_INLINE;
560 static inline void Pipe_Discard_Byte(void)
561 {
562 uint8_t Dummy;
563
564 Dummy = UPDATX;
565 }
566
567 /** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT
568 * direction pipes.
569 *
570 * \ingroup Group_PipePrimitiveRW
571 *
572 * \return Next word in the currently selected pipe's FIFO buffer
573 */
574 static inline uint16_t Pipe_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
575 static inline uint16_t Pipe_Read_Word_LE(void)
576 {
577 union
578 {
579 uint16_t Word;
580 uint8_t Bytes[2];
581 } Data;
582
583 Data.Bytes[0] = UPDATX;
584 Data.Bytes[1] = UPDATX;
585
586 return Data.Word;
587 }
588
589 /** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT
590 * direction pipes.
591 *
592 * \ingroup Group_PipePrimitiveRW
593 *
594 * \return Next word in the currently selected pipe's FIFO buffer
595 */
596 static inline uint16_t Pipe_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
597 static inline uint16_t Pipe_Read_Word_BE(void)
598 {
599 union
600 {
601 uint16_t Word;
602 uint8_t Bytes[2];
603 } Data;
604
605 Data.Bytes[1] = UPDATX;
606 Data.Bytes[0] = UPDATX;
607
608 return Data.Word;
609 }
610
611 /** Writes two bytes to the currently selected pipe's bank in little endian format, for IN
612 * direction pipes.
613 *
614 * \ingroup Group_PipePrimitiveRW
615 *
616 * \param[in] Word Next word to write to the currently selected pipe's FIFO buffer
617 */
618 static inline void Pipe_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
619 static inline void Pipe_Write_Word_LE(const uint16_t Word)
620 {
621 UPDATX = (Word & 0xFF);
622 UPDATX = (Word >> 8);
623 }
624
625 /** Writes two bytes to the currently selected pipe's bank in big endian format, for IN
626 * direction pipes.
627 *
628 * \ingroup Group_PipePrimitiveRW
629 *
630 * \param[in] Word Next word to write to the currently selected pipe's FIFO buffer
631 */
632 static inline void Pipe_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
633 static inline void Pipe_Write_Word_BE(const uint16_t Word)
634 {
635 UPDATX = (Word >> 8);
636 UPDATX = (Word & 0xFF);
637 }
638
639 /** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.
640 *
641 * \ingroup Group_PipePrimitiveRW
642 */
643 static inline void Pipe_Discard_Word(void) ATTR_ALWAYS_INLINE;
644 static inline void Pipe_Discard_Word(void)
645 {
646 uint8_t Dummy;
647
648 Dummy = UPDATX;
649 Dummy = UPDATX;
650 }
651
652 /** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT
653 * direction pipes.
654 *
655 * \ingroup Group_PipePrimitiveRW
656 *
657 * \return Next double word in the currently selected pipe's FIFO buffer
658 */
659 static inline uint32_t Pipe_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
660 static inline uint32_t Pipe_Read_DWord_LE(void)
661 {
662 union
663 {
664 uint32_t DWord;
665 uint8_t Bytes[4];
666 } Data;
667
668 Data.Bytes[0] = UPDATX;
669 Data.Bytes[1] = UPDATX;
670 Data.Bytes[2] = UPDATX;
671 Data.Bytes[3] = UPDATX;
672
673 return Data.DWord;
674 }
675
676 /** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT
677 * direction pipes.
678 *
679 * \ingroup Group_PipePrimitiveRW
680 *
681 * \return Next double word in the currently selected pipe's FIFO buffer
682 */
683 static inline uint32_t Pipe_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
684 static inline uint32_t Pipe_Read_DWord_BE(void)
685 {
686 union
687 {
688 uint32_t DWord;
689 uint8_t Bytes[4];
690 } Data;
691
692 Data.Bytes[3] = UPDATX;
693 Data.Bytes[2] = UPDATX;
694 Data.Bytes[1] = UPDATX;
695 Data.Bytes[0] = UPDATX;
696
697 return Data.DWord;
698 }
699
700 /** Writes four bytes to the currently selected pipe's bank in little endian format, for IN
701 * direction pipes.
702 *
703 * \ingroup Group_PipePrimitiveRW
704 *
705 * \param[in] DWord Next double word to write to the currently selected pipe's FIFO buffer
706 */
707 static inline void Pipe_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
708 static inline void Pipe_Write_DWord_LE(const uint32_t DWord)
709 {
710 UPDATX = (DWord & 0xFF);
711 UPDATX = (DWord >> 8);
712 UPDATX = (DWord >> 16);
713 UPDATX = (DWord >> 24);
714 }
715
716 /** Writes four bytes to the currently selected pipe's bank in big endian format, for IN
717 * direction pipes.
718 *
719 * \ingroup Group_PipePrimitiveRW
720 *
721 * \param[in] DWord Next double word to write to the currently selected pipe's FIFO buffer
722 */
723 static inline void Pipe_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
724 static inline void Pipe_Write_DWord_BE(const uint32_t DWord)
725 {
726 UPDATX = (DWord >> 24);
727 UPDATX = (DWord >> 16);
728 UPDATX = (DWord >> 8);
729 UPDATX = (DWord & 0xFF);
730 }
731
732 /** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.
733 *
734 * \ingroup Group_PipePrimitiveRW
735 */
736 static inline void Pipe_Discard_DWord(void) ATTR_ALWAYS_INLINE;
737 static inline void Pipe_Discard_DWord(void)
738 {
739 uint8_t Dummy;
740
741 Dummy = UPDATX;
742 Dummy = UPDATX;
743 Dummy = UPDATX;
744 Dummy = UPDATX;
745 }
746
747 /* External Variables: */
748 /** Global indicating the maximum packet size of the default control pipe located at address
749 * 0 in the device. This value is set to the value indicated in the attached device's device
750 * descriptor once the USB interface is initialized into host mode and a device is attached
751 * to the USB bus.
752 *
753 * \note This variable should be treated as read-only in the user application, and never manually
754 * changed in value.
755 */
756 extern uint8_t USB_ControlPipeSize;
757
758 /* Function Prototypes: */
759 #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
760 #define __CALLBACK_PARAM , StreamCallbackPtr_t Callback
761 #else
762 #define __CALLBACK_PARAM
763 #endif
764
765 /** Configures the specified pipe number with the given pipe type, token, target endpoint number in the
766 * attached device, bank size and banking mode. Pipes should be allocated in ascending order by their
767 * address in the device (i.e. pipe 1 should be configured before pipe 2 and so on) to prevent fragmentation
768 * of the USB FIFO memory.
769 *
770 * The pipe type may be one of the EP_TYPE_* macros listed in LowLevel.h, the token may be one of the
771 * PIPE_TOKEN_* masks.
772 *
773 * The bank size must indicate the maximum packet size that the pipe can handle. Different pipe
774 * numbers can handle different maximum packet sizes - refer to the chosen USB AVR's datasheet to
775 * determine the maximum bank size for each pipe.
776 *
777 * The banking mode may be either \ref PIPE_BANK_SINGLE or \ref PIPE_BANK_DOUBLE.
778 *
779 * A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()
780 * before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or
781 * sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite
782 * numbers of IN requests without automatic freezing - this can be overridden by a call to
783 * \ref Pipe_SetFiniteINRequests().
784 *
785 * \note The default control pipe does not have to be manually configured, as it is automatically
786 * configured by the library internally.
787 *
788 * \note This routine will select the specified pipe, and the pipe will remain selected once the
789 * routine completes regardless of if the pipe configuration succeeds.
790 *
791 * \return Boolean true if the configuration is successful, false otherwise
792 */
793 bool Pipe_ConfigurePipe(const uint8_t Number, const uint8_t Type, const uint8_t Token, const uint8_t EndpointNumber,
794 const uint16_t Size, const uint8_t Banks);
795
796 /** Spin-loops until the currently selected non-control pipe is ready for the next packed of data to be read
797 * or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).
798 *
799 * \ingroup Group_PipeRW
800 *
801 * \return A value from the Pipe_WaitUntilReady_ErrorCodes_t enum.
802 */
803 uint8_t Pipe_WaitUntilReady(void);
804
805 /** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given
806 * endpoint is found, it is automatically selected.
807 *
808 * \param[in] EndpointAddress Address of the endpoint within the attached device to check
809 *
810 * \return Boolean true if a pipe bound to the given endpoint address is found, false otherwise
811 */
812 bool Pipe_IsEndpointBound(const uint8_t EndpointAddress);
813
814 /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host
815 * as needed. The last packet is not automatically discarded once the remaining bytes has been read; the
816 * user is responsible for manually discarding the last packet from the device via the \ref Pipe_ClearIN() macro.
817 * Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,
818 * allowing for early aborts of stream transfers.
819 *
820 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
821 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
822 * disabled and this function has the Callback parameter omitted.
823 *
824 * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
825 * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
826 *
827 * \ingroup Group_PipeStreamRW
828 *
829 * \param[in] Length Number of bytes to send via the currently selected pipe.
830 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
831 *
832 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
833 */
834 uint8_t Pipe_Discard_Stream(uint16_t Length __CALLBACK_PARAM);
835
836 /** Writes the given number of bytes to the pipe from the given buffer in little endian,
837 * sending full packets to the device as needed. The last packet filled is not automatically sent;
838 * the user is responsible for manually sending the last written packet to the host via the
839 * \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is
840 * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
841 *
842 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
843 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
844 * disabled and this function has the Callback parameter omitted.
845 *
846 * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
847 * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
848 *
849 * \ingroup Group_PipeStreamRW
850 *
851 * \param[in] Buffer Pointer to the source data buffer to read from.
852 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
853 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
854 *
855 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
856 */
857 uint8_t Pipe_Write_Stream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
858
859 /** EEPROM buffer source version of \ref Pipe_Write_Stream_LE().
860 *
861 * \ingroup Group_PipeStreamRW
862 *
863 * \param[in] Buffer Pointer to the source data buffer to read from.
864 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
865 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
866 *
867 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
868 */
869 uint8_t Pipe_Write_EStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
870
871 /** FLASH buffer source version of \ref Pipe_Write_Stream_LE().
872 *
873 * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
874 *
875 * \ingroup Group_PipeStreamRW
876 *
877 * \param[in] Buffer Pointer to the source data buffer to read from.
878 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
879 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
880 *
881 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
882 */
883 uint8_t Pipe_Write_PStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
884
885 /** Writes the given number of bytes to the pipe from the given buffer in big endian,
886 * sending full packets to the device as needed. The last packet filled is not automatically sent;
887 * the user is responsible for manually sending the last written packet to the host via the
888 * \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is
889 * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
890 *
891 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
892 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
893 * disabled and this function has the Callback parameter omitted.
894 *
895 * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
896 * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
897 *
898 * \ingroup Group_PipeStreamRW
899 *
900 * \param[in] Buffer Pointer to the source data buffer to read from.
901 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
902 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
903 *
904 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
905 */
906 uint8_t Pipe_Write_Stream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
907
908 /** EEPROM buffer source version of \ref Pipe_Write_Stream_BE().
909 *
910 * \ingroup Group_PipeStreamRW
911 *
912 * \param[in] Buffer Pointer to the source data buffer to read from.
913 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
914 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
915 *
916 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
917 */
918 uint8_t Pipe_Write_EStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
919
920 /** FLASH buffer source version of \ref Pipe_Write_Stream_BE().
921 *
922 * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
923 *
924 * \ingroup Group_PipeStreamRW
925 *
926 * \param[in] Buffer Pointer to the source data buffer to read from.
927 * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer.
928 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
929 *
930 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
931 */
932 uint8_t Pipe_Write_PStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
933
934 /** Reads the given number of bytes from the pipe into the given buffer in little endian,
935 * sending full packets to the device as needed. The last packet filled is not automatically sent;
936 * the user is responsible for manually sending the last written packet to the host via the
937 * \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is
938 * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
939 *
940 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
941 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
942 * disabled and this function has the Callback parameter omitted.
943 *
944 * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
945 * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
946 *
947 * \ingroup Group_PipeStreamRW
948 *
949 * \param[out] Buffer Pointer to the source data buffer to write to.
950 * \param[in] Length Number of bytes to read for the currently selected pipe to read from.
951 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
952 *
953 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
954 */
955 uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
956
957 /** EEPROM buffer source version of \ref Pipe_Read_Stream_LE().
958 *
959 * \ingroup Group_PipeStreamRW
960 *
961 * \param[out] Buffer Pointer to the source data buffer to write to.
962 * \param[in] Length Number of bytes to read for the currently selected pipe to read from.
963 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
964 *
965 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
966 */
967 uint8_t Pipe_Read_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
968
969 /** Reads the given number of bytes from the pipe into the given buffer in big endian,
970 * sending full packets to the device as needed. The last packet filled is not automatically sent;
971 * the user is responsible for manually sending the last written packet to the host via the
972 * \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is
973 * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
974 *
975 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
976 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
977 * disabled and this function has the Callback parameter omitted.
978 *
979 * The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
980 * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
981 *
982 * \ingroup Group_PipeStreamRW
983 *
984 * \param[out] Buffer Pointer to the source data buffer to write to.
985 * \param[in] Length Number of bytes to read for the currently selected pipe to read from.
986 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
987 *
988 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
989 */
990 uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
991
992 /** EEPROM buffer source version of \ref Pipe_Read_Stream_BE().
993 *
994 * \ingroup Group_PipeStreamRW
995 *
996 * \param[out] Buffer Pointer to the source data buffer to write to.
997 * \param[in] Length Number of bytes to read for the currently selected pipe to read from.
998 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
999 *
1000 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
1001 */
1002 uint8_t Pipe_Read_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
1003
1004 /* Private Interface - For use in library only: */
1005 #if !defined(__DOXYGEN__)
1006 /* Macros: */
1007 #define PIPE_TOKEN_MASK (0x03 << PTOKEN0)
1008
1009 #if !defined(ENDPOINT_CONTROLEP)
1010 #define ENDPOINT_CONTROLEP 0
1011 #endif
1012
1013 #define Pipe_AllocateMemory() MACROS{ UPCFG1X |= (1 << ALLOC); }MACROE
1014 #define Pipe_DeallocateMemory() MACROS{ UPCFG1X &= ~(1 << ALLOC); }MACROE
1015
1016 /* Function Prototypes: */
1017 void Pipe_ClearPipes(void);
1018
1019 /* Inline Functions: */
1020 static inline uint8_t Pipe_BytesToEPSizeMask(uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
1021 static inline uint8_t Pipe_BytesToEPSizeMask(uint16_t Bytes)
1022 {
1023 if (Bytes <= 8)
1024 return (0 << EPSIZE0);
1025 else if (Bytes <= 16)
1026 return (1 << EPSIZE0);
1027 else if (Bytes <= 32)
1028 return (2 << EPSIZE0);
1029 else if (Bytes <= 64)
1030 return (3 << EPSIZE0);
1031 else if (Bytes <= 128)
1032 return (4 << EPSIZE0);
1033 else
1034 return (5 << EPSIZE0);
1035 }
1036
1037 #endif
1038
1039 /* Disable C linkage for C++ Compilers: */
1040 #if defined(__cplusplus)
1041 }
1042 #endif
1043
1044 #endif
1045
1046 /** @} */
USB isp AVR programmer