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


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