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