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


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