]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-120730/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h
git://git.gir.st / tmk_keyboard.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Squashed 'tmk_core/' changes from b9e0ea0..caca2c0
[tmk_keyboard.git] / protocol / lufa / LUFA-120730 / LUFA / Drivers / USB / Core / UC3 / Pipe_UC3.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2012.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.lufa-lib.org
7 */
8
9 /*
10 Copyright 2012 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 UC3 microcontrollers.
33 * \copydetails Group_PipeManagement_UC3
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_UC3 Pipe Data Reading and Writing (UC3)
41 * \brief Pipe data read/write definitions for the Atmel AVR32 UC3 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_UC3 Read/Write of Primitive Data Types (UC3)
48 * \brief Pipe primitive data read/write definitions for the Atmel AVR32 UC3 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_UC3 Pipe Packet Management (UC3)
56 * \brief Pipe packet management definitions for the Atmel AVR32 UC3 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_UC3 Pipe Control Request Management (UC3)
63 * \brief Pipe control request management definitions for the Atmel AVR32 UC3 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_UC3 Pipe Management (UC3)
73 * \brief Pipe management definitions for the Atmel AVR32 UC3 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_UC3_H__
83 #define __PIPE_UC3_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 /* Private Interface - For use in library only: */
100 #if !defined(__DOXYGEN__)
101 /* Macros: */
102 #define PIPE_HSB_ADDRESS_SPACE_SIZE (64 * 1024UL)
103
104 /* External Variables: */
105 extern volatile uint32_t USB_Pipe_SelectedPipe;
106 extern volatile uint8_t* USB_Pipe_FIFOPos[];
107 #endif
108
109 /* Public Interface - May be used in end-application: */
110 /* Macros: */
111 /** \name Pipe Error Flag Masks */
112 //@{
113 /** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */
114 #define PIPE_ERRORFLAG_OVERFLOW (AVR32_USBB_UPSTA0_OVERFI_MASK << 8)
115
116 /** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */
117 #define PIPE_ERRORFLAG_CRC16 AVR32_USBB_UPERR0_CRC16_MASK
118
119 /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */
120 #define PIPE_ERRORFLAG_TIMEOUT AVR32_USBB_UPERR0_TIMEOUT_MASK
121
122 /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */
123 #define PIPE_ERRORFLAG_PID AVR32_USBB_UPERR0_PID_MASK
124
125 /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */
126 #define PIPE_ERRORFLAG_DATAPID AVR32_USBB_UPERR0_DATAPID_MASK
127
128 /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */
129 #define PIPE_ERRORFLAG_DATATGL AVR32_USBB_UPERR0_DATATGL_MASK
130 //@}
131
132 /** \name Pipe Token Masks */
133 //@{
134 /** Token mask for \ref Pipe_SetPipeToken() and \ref Pipe_GetPipeToken(). This sets the pipe as a SETUP token (for CONTROL type pipes),
135 * which will trigger a control request on the attached device when data is written to the pipe.
136 */
137 #define PIPE_TOKEN_SETUP AVR32_USBB_UPCFG0_PTOKEN_SETUP
138
139 /** Token mask for \ref Pipe_SetPipeToken() and \ref Pipe_GetPipeToken(). This sets the pipe as a IN token (for non-CONTROL type pipes),
140 * indicating that the pipe data will flow from device to host.
141 */
142 #define PIPE_TOKEN_IN AVR32_USBB_UPCFG0_PTOKEN_IN
143
144 /** Token mask for \ref Pipe_SetPipeToken() and \ref Pipe_GetPipeToken(). This sets the pipe as a OUT token (for non-CONTROL type pipes),
145 * indicating that the pipe data will flow from host to device.
146 */
147 #define PIPE_TOKEN_OUT AVR32_USBB_UPCFG0_PTOKEN_OUT
148 //@}
149
150 /** Default size of the default control pipe's bank, until altered by the Endpoint0Size value
151 * in the device descriptor of the attached device.
152 */
153 #define PIPE_CONTROLPIPE_DEFAULT_SIZE 64
154
155 #if defined(USB_SERIES_UC3A3_AVR32) || defined(USB_SERIES_UC3A4_AVR32) || defined(__DOXYGEN__)
156 /** Total number of pipes (including the default control pipe at address 0) which may be used in
157 * the device.
158 */
159 #define PIPE_TOTAL_PIPES 8
160 #else
161 #define PIPE_TOTAL_PIPES 7
162 #endif
163
164 /** Size in bytes of the largest pipe bank size possible in the device. Not all banks on each AVR
165 * model supports the largest bank size possible on the device; different pipe numbers support
166 * different maximum bank sizes. This value reflects the largest possible bank of any pipe on the
167 * currently selected UC3 AVR model.
168 */
169 #define PIPE_MAX_SIZE 256
170
171 /* Enums: */
172 /** Enum for the possible error return codes of the \ref Pipe_WaitUntilReady() function.
173 *
174 * \ingroup Group_PipeRW_UC3
175 */
176 enum Pipe_WaitUntilReady_ErrorCodes_t
177 {
178 PIPE_READYWAIT_NoError = 0, /**< Pipe ready for next packet, no error. */
179 PIPE_READYWAIT_PipeStalled = 1, /**< The device stalled the pipe while waiting. */
180 PIPE_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while waiting. */
181 PIPE_READYWAIT_Timeout = 3, /**< The device failed to accept or send the next packet
182 * within the software timeout period set by the
183 * \ref USB_STREAM_TIMEOUT_MS macro.
184 */
185 };
186
187 /* Inline Functions: */
188 /** Indicates the number of bytes currently stored in the current pipes's selected bank.
189 *
190 * \ingroup Group_PipeRW_UC3
191 *
192 * \return Total number of bytes in the currently selected pipe's FIFO buffer.
193 */
194 static inline uint16_t Pipe_BytesInPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
195 static inline uint16_t Pipe_BytesInPipe(void)
196 {
197 return (&AVR32_USBB.UPSTA0)[USB_Pipe_SelectedPipe].pbyct;
198 }
199
200 /** Determines the currently selected pipe's direction.
201 *
202 * \return The currently selected pipe's direction, as a \c PIPE_DIR_* mask.
203 */
204 static inline uint8_t Pipe_GetPipeDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
205 static inline uint8_t Pipe_GetPipeDirection(void)
206 {
207 return (((&AVR32_USBB.UPCFG0)[USB_Pipe_SelectedPipe].ptoken == PIPE_TOKEN_OUT) ? PIPE_DIR_OUT : PIPE_DIR_IN);
208 }
209
210 /** Returns the pipe address of the currently selected pipe. This is typically used to save the
211 * currently selected pipe number so that it can be restored after another pipe has been manipulated.
212 *
213 * \return Index of the currently selected pipe.
214 */
215 static inline uint8_t Pipe_GetCurrentPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
216 static inline uint8_t Pipe_GetCurrentPipe(void)
217 {
218 return (USB_Pipe_SelectedPipe | Pipe_GetPipeDirection());
219 }
220
221 /** Selects the given pipe address. Any pipe operations which do not require the pipe address to be
222 * indicated will operate on the currently selected pipe.
223 *
224 * \param[in] Address Address of the pipe to select.
225 */
226 static inline void Pipe_SelectPipe(const uint8_t Address) ATTR_ALWAYS_INLINE;
227 static inline void Pipe_SelectPipe(const uint8_t Address)
228 {
229 USB_Pipe_SelectedPipe = (Address & PIPE_EPNUM_MASK);
230 }
231
232 /** Resets the desired pipe, including the pipe banks and flags.
233 *
234 * \param[in] Address Index of the pipe to reset.
235 */
236 static inline void Pipe_ResetPipe(const uint8_t Address) ATTR_ALWAYS_INLINE;
237 static inline void Pipe_ResetPipe(const uint8_t Address)
238 {
239 uint32_t PipeNumber = (Address & PIPE_EPNUM_MASK);
240
241 AVR32_USBB.uprst |= (AVR32_USBB_PRST0_MASK << PipeNumber);
242 AVR32_USBB.uprst &= ~(AVR32_USBB_PRST0_MASK << PipeNumber);
243 USB_Pipe_FIFOPos[PipeNumber] = &AVR32_USBB_SLAVE[PipeNumber * PIPE_HSB_ADDRESS_SPACE_SIZE];
244 }
245
246 /** Enables the currently selected pipe so that data can be sent and received through it to and from
247 * an attached device.
248 *
249 * \pre The currently selected pipe must first be configured properly via \ref Pipe_ConfigurePipe().
250 */
251 static inline void Pipe_EnablePipe(void) ATTR_ALWAYS_INLINE;
252 static inline void Pipe_EnablePipe(void)
253 {
254 AVR32_USBB.uprst |= (AVR32_USBB_PEN0_MASK << USB_Pipe_SelectedPipe);
255 }
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) ATTR_ALWAYS_INLINE;
261 static inline void Pipe_DisablePipe(void)
262 {
263 AVR32_USBB.uprst &= ~(AVR32_USBB_PEN0_MASK << USB_Pipe_SelectedPipe);
264 }
265
266 /** Determines if the currently selected pipe is enabled, but not necessarily configured.
267 *
268 * \return Boolean \c true if the currently selected pipe is enabled, \c false otherwise.
269 */
270 static inline bool Pipe_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
271 static inline bool Pipe_IsEnabled(void)
272 {
273 return ((AVR32_USBB.uprst & (AVR32_USBB_PEN0_MASK << USB_Pipe_SelectedPipe)) ? true : false);
274 }
275
276 /** Gets the current pipe token, indicating the pipe's data direction and type.
277 *
278 * \return The current pipe token, as a \c PIPE_TOKEN_* mask.
279 */
280 static inline uint8_t Pipe_GetPipeToken(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
281 static inline uint8_t Pipe_GetPipeToken(void)
282 {
283 return (&AVR32_USBB.UPCFG0)[USB_Pipe_SelectedPipe].ptoken;
284 }
285
286 /** Sets the token for the currently selected pipe to one of the tokens specified by the \c PIPE_TOKEN_*
287 * masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during
288 * control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices
289 * which have two endpoints of opposite direction sharing the same endpoint address within the device.
290 *
291 * \param[in] Token New pipe token to set the selected pipe to, as a \c PIPE_TOKEN_* mask.
292 */
293 static inline void Pipe_SetPipeToken(const uint8_t Token) ATTR_ALWAYS_INLINE;
294 static inline void Pipe_SetPipeToken(const uint8_t Token)
295 {
296 (&AVR32_USBB.UPCFG0)[USB_Pipe_SelectedPipe].ptoken = Token;
297 }
298
299 /** Configures the currently selected pipe to allow for an unlimited number of IN requests. */
300 static inline void Pipe_SetInfiniteINRequests(void) ATTR_ALWAYS_INLINE;
301 static inline void Pipe_SetInfiniteINRequests(void)
302 {
303 (&AVR32_USBB.UPINRQ0)[USB_Pipe_SelectedPipe].inmode = true;
304 }
305
306 /** Configures the currently selected pipe to only allow the specified number of IN requests to be
307 * accepted by the pipe before it is automatically frozen.
308 *
309 * \param[in] TotalINRequests Total number of IN requests that the pipe may receive before freezing.
310 */
311 static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests) ATTR_ALWAYS_INLINE;
312 static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests)
313 {
314 (&AVR32_USBB.UPINRQ0)[USB_Pipe_SelectedPipe].inmode = false;
315 (&AVR32_USBB.UPINRQ0)[USB_Pipe_SelectedPipe].inrq = TotalINRequests;
316 }
317
318 /** Determines if the currently selected pipe is configured.
319 *
320 * \return Boolean \c true if the selected pipe is configured, \c false otherwise.
321 */
322 static inline bool Pipe_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
323 static inline bool Pipe_IsConfigured(void)
324 {
325 return (&AVR32_USBB.UPSTA0)[USB_Pipe_SelectedPipe].cfgok;
326 }
327
328 /** Retrieves the endpoint address of the endpoint within the attached device that the currently selected
329 * pipe is bound to.
330 *
331 * \return Endpoint address the currently selected pipe is bound to.
332 */
333 static inline uint8_t Pipe_GetBoundEndpointAddress(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
334 static inline uint8_t Pipe_GetBoundEndpointAddress(void)
335 {
336 return ((&AVR32_USBB.UPCFG0)[USB_Pipe_SelectedPipe].pepnum |
337 ((Pipe_GetPipeToken() == PIPE_TOKEN_IN) ? PIPE_DIR_IN : PIPE_DIR_OUT));
338 }
339
340 /** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.
341 *
342 * \param[in] Milliseconds Number of milliseconds between each pipe poll.
343 */
344 static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds) ATTR_ALWAYS_INLINE;
345 static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds)
346 {
347 (&AVR32_USBB.UPCFG0)[USB_Pipe_SelectedPipe].intfrq = Milliseconds;
348 }
349
350 /** Returns a mask indicating which pipe's interrupt periods have elapsed, indicating that the pipe should
351 * be serviced.
352 *
353 * \return Mask whose bits indicate which pipes have interrupted.
354 */
355 static inline uint8_t Pipe_GetPipeInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
356 static inline uint8_t Pipe_GetPipeInterrupts(void)
357 {
358 return ((AVR32_USBB.uhint & (AVR32_USBB_P6INT_MASK | AVR32_USBB_P5INT_MASK |
359 AVR32_USBB_P4INT_MASK | AVR32_USBB_P3INT_MASK |
360 AVR32_USBB_P2INT_MASK | AVR32_USBB_P1INT_MASK |
361 AVR32_USBB_P0INT_MASK)) >> AVR32_USBB_P0INT_OFFSET);
362 }
363
364 /** Determines if the specified pipe address has interrupted (valid only for INTERRUPT type
365 * pipes).
366 *
367 * \param[in] Address Address of the pipe whose interrupt flag should be tested.
368 *
369 * \return Boolean \c true if the specified pipe has interrupted, \c false otherwise.
370 */
371 static inline bool Pipe_HasPipeInterrupted(const uint8_t Address) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
372 static inline bool Pipe_HasPipeInterrupted(const uint8_t Address)
373 {
374 return ((AVR32_USBB.uhint & (AVR32_USBB_P0INTES_MASK << (Address & PIPE_EPNUM_MASK))) ? true : false);
375 }
376
377 /** Unfreezes the selected pipe, allowing it to communicate with an attached device. */
378 static inline void Pipe_Unfreeze(void) ATTR_ALWAYS_INLINE;
379 static inline void Pipe_Unfreeze(void)
380 {
381 (&AVR32_USBB.UPCON0CLR)[USB_Pipe_SelectedPipe].pfreezec = true;
382 }
383
384 /** Freezes the selected pipe, preventing it from communicating with an attached device. */
385 static inline void Pipe_Freeze(void) ATTR_ALWAYS_INLINE;
386 static inline void Pipe_Freeze(void)
387 {
388 (&AVR32_USBB.UPCON0SET)[USB_Pipe_SelectedPipe].pfreezes = true;
389 }
390
391 /** Determines if the currently selected pipe is frozen, and not able to accept data.
392 *
393 * \return Boolean \c true if the currently selected pipe is frozen, \c false otherwise.
394 */
395 static inline bool Pipe_IsFrozen(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
396 static inline bool Pipe_IsFrozen(void)
397 {
398 return (((&AVR32_USBB.UPCON0)[USB_Pipe_SelectedPipe].pfreeze) ? true : false);
399 }
400
401 /** Clears the error flags for the currently selected pipe. */
402 static inline void Pipe_ClearError(void) ATTR_ALWAYS_INLINE;
403 static inline void Pipe_ClearError(void)
404 {
405 (&AVR32_USBB.uperr0)[USB_Pipe_SelectedPipe] = 0;
406 (&AVR32_USBB.UPSTA0CLR)[USB_Pipe_SelectedPipe].overfic = true;
407 }
408
409 /** Determines if the master pipe error flag is set for the currently selected pipe, indicating that
410 * some sort of hardware error has occurred on the pipe.
411 *
412 * \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.
413 *
414 * \return Boolean \c true if an error has occurred on the selected pipe, \c false otherwise.
415 */
416 static inline bool Pipe_IsError(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
417 static inline bool Pipe_IsError(void)
418 {
419 return (((&AVR32_USBB.upsta0)[USB_Pipe_SelectedPipe] &
420 (AVR32_USBB_PERRI_MASK | AVR32_USBB_OVERFI_MASK)) ? 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
432 return (((&AVR32_USBB.uperr0)[USB_Pipe_SelectedPipe] &
433 (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT |
434 PIPE_ERRORFLAG_PID | PIPE_ERRORFLAG_DATAPID |
435 PIPE_ERRORFLAG_DATATGL)) |
436 (((&AVR32_USBB.upsta0)[USB_Pipe_SelectedPipe] << 8) &
437 PIPE_ERRORFLAG_OVERFLOW));
438 }
439
440 /** Retrieves the number of busy banks in the currently selected pipe, which have been queued for
441 * transmission via the \ref Pipe_ClearOUT() command, or are awaiting acknowledgement via the
442 * \ref Pipe_ClearIN() command.
443 *
444 * \ingroup Group_PipePacketManagement_UC3
445 *
446 * \return Total number of busy banks in the selected pipe.
447 */
448 static inline uint8_t Pipe_GetBusyBanks(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
449 static inline uint8_t Pipe_GetBusyBanks(void)
450 {
451 return (&AVR32_USBB.UPSTA0)[USB_Pipe_SelectedPipe].nbusybk;
452 }
453
454 /** Determines if the currently selected pipe may be read from (if data is waiting in the pipe
455 * bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT
456 * direction). This function will return false if an error has occurred in the pipe, or if the pipe
457 * is an IN direction and no packet (or an empty packet) has been received, or if the pipe is an OUT
458 * direction and the pipe bank is full.
459 *
460 * \note This function is not valid on CONTROL type pipes.
461 *
462 * \ingroup Group_PipePacketManagement_UC3
463 *
464 * \return Boolean \c true if the currently selected pipe may be read from or written to, depending
465 * on its direction.
466 */
467 static inline bool Pipe_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
468 static inline bool Pipe_IsReadWriteAllowed(void)
469 {
470 return (&AVR32_USBB.UPSTA0)[USB_Pipe_SelectedPipe].rwall;
471 }
472
473 /** Determines if a packet has been received on the currently selected IN pipe from the attached device.
474 *
475 * \ingroup Group_PipePacketManagement_UC3
476 *
477 * \return Boolean \c true if the current pipe has received an IN packet, \c false otherwise.
478 */
479 static inline bool Pipe_IsINReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
480 static inline bool Pipe_IsINReceived(void)
481 {
482 return (&AVR32_USBB.UPSTA0)[USB_Pipe_SelectedPipe].rxini;
483 }
484
485 /** Determines if the currently selected OUT pipe is ready to send an OUT packet to the attached device.
486 *
487 * \ingroup Group_PipePacketManagement_UC3
488 *
489 * \return Boolean \c true if the current pipe is ready for an OUT packet, \c false otherwise.
490 */
491 static inline bool Pipe_IsOUTReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
492 static inline bool Pipe_IsOUTReady(void)
493 {
494 return (&AVR32_USBB.UPSTA0)[USB_Pipe_SelectedPipe].txouti;
495 }
496
497 /** Determines if no SETUP request is currently being sent to the attached device on the selected
498 * CONTROL type pipe.
499 *
500 * \ingroup Group_PipePacketManagement_UC3
501 *
502 * \return Boolean \c true if the current pipe is ready for a SETUP packet, \c false otherwise.
503 */
504 static inline bool Pipe_IsSETUPSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
505 static inline bool Pipe_IsSETUPSent(void)
506 {
507 return (&AVR32_USBB.UPSTA0)[USB_Pipe_SelectedPipe].txstpi;
508 }
509
510 /** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.
511 *
512 * \ingroup Group_PipePacketManagement_UC3
513 */
514 static inline void Pipe_ClearSETUP(void) ATTR_ALWAYS_INLINE;
515 static inline void Pipe_ClearSETUP(void)
516 {
517 (&AVR32_USBB.UPSTA0CLR)[USB_Pipe_SelectedPipe].txstpic = true;
518 (&AVR32_USBB.UPCON0CLR)[USB_Pipe_SelectedPipe].fifoconc = true;
519 USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe] = &AVR32_USBB_SLAVE[USB_Pipe_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
520 }
521
522 /** Acknowledges the reception of a setup IN request from the attached device on the currently selected
523 * pipe, freeing the bank ready for the next packet.
524 *
525 * \ingroup Group_PipePacketManagement_UC3
526 */
527 static inline void Pipe_ClearIN(void) ATTR_ALWAYS_INLINE;
528 static inline void Pipe_ClearIN(void)
529 {
530 (&AVR32_USBB.UPSTA0CLR)[USB_Pipe_SelectedPipe].rxinic = true;
531 (&AVR32_USBB.UPCON0CLR)[USB_Pipe_SelectedPipe].fifoconc = true;
532 USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe] = &AVR32_USBB_SLAVE[USB_Pipe_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
533 }
534
535 /** Sends the currently selected pipe's contents to the device as an OUT packet on the selected pipe, freeing
536 * the bank ready for the next packet.
537 *
538 * \ingroup Group_PipePacketManagement_UC3
539 */
540 static inline void Pipe_ClearOUT(void) ATTR_ALWAYS_INLINE;
541 static inline void Pipe_ClearOUT(void)
542 {
543 (&AVR32_USBB.UPSTA0CLR)[USB_Pipe_SelectedPipe].txoutic = true;
544 (&AVR32_USBB.UPCON0CLR)[USB_Pipe_SelectedPipe].fifoconc = true;
545 USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe] = &AVR32_USBB_SLAVE[USB_Pipe_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
546 }
547
548 /** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on
549 * the currently selected pipe. This occurs when the host sends a packet to the device, but the device
550 * is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been
551 * received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet
552 * can be re-sent.
553 *
554 * \ingroup Group_PipePacketManagement_UC3
555 *
556 * \return Boolean \c true if an NAK has been received on the current pipe, \c false otherwise.
557 */
558 static inline bool Pipe_IsNAKReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
559 static inline bool Pipe_IsNAKReceived(void)
560 {
561 return (&AVR32_USBB.UPSTA0)[USB_Pipe_SelectedPipe].nakedi;
562 }
563
564 /** Clears the NAK condition on the currently selected pipe.
565 *
566 * \ingroup Group_PipePacketManagement_UC3
567 *
568 * \see \ref Pipe_IsNAKReceived() for more details.
569 */
570 static inline void Pipe_ClearNAKReceived(void) ATTR_ALWAYS_INLINE;
571 static inline void Pipe_ClearNAKReceived(void)
572 {
573 (&AVR32_USBB.UPSTA0CLR)[USB_Pipe_SelectedPipe].nakedic = true;
574 }
575
576 /** Determines if the currently selected pipe has had the STALL condition set by the attached device.
577 *
578 * \ingroup Group_PipePacketManagement_UC3
579 *
580 * \return Boolean \c true if the current pipe has been stalled by the attached device, \c false otherwise.
581 */
582 static inline bool Pipe_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
583 static inline bool Pipe_IsStalled(void)
584 {
585 return (&AVR32_USBB.UPSTA0)[USB_Pipe_SelectedPipe].rxstalldi;
586 }
587
588 /** Clears the STALL condition detection flag on the currently selected pipe, but does not clear the
589 * STALL condition itself (this must be done via a ClearFeature control request to the device).
590 *
591 * \ingroup Group_PipePacketManagement_UC3
592 */
593 static inline void Pipe_ClearStall(void) ATTR_ALWAYS_INLINE;
594 static inline void Pipe_ClearStall(void)
595 {
596 (&AVR32_USBB.UPSTA0CLR)[USB_Pipe_SelectedPipe].rxstalldic = true;
597 USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe] = &AVR32_USBB_SLAVE[USB_Pipe_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
598 }
599
600 /** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.
601 *
602 * \ingroup Group_PipePrimitiveRW_UC3
603 *
604 * \return Next byte in the currently selected pipe's FIFO buffer.
605 */
606 static inline uint8_t Pipe_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
607 static inline uint8_t Pipe_Read_8(void)
608 {
609 return *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
610 }
611
612 /** Writes one byte to the currently selected pipe's bank, for IN direction pipes.
613 *
614 * \ingroup Group_PipePrimitiveRW_UC3
615 *
616 * \param[in] Data Data to write into the the currently selected pipe's FIFO buffer.
617 */
618 static inline void Pipe_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
619 static inline void Pipe_Write_8(const uint8_t Data)
620 {
621 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = Data;
622 }
623
624 /** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.
625 *
626 * \ingroup Group_PipePrimitiveRW_UC3
627 */
628 static inline void Pipe_Discard_8(void) ATTR_ALWAYS_INLINE;
629 static inline void Pipe_Discard_8(void)
630 {
631 uint8_t Dummy;
632
633 Dummy = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
634
635 (void)Dummy;
636 }
637
638 /** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT
639 * direction pipes.
640 *
641 * \ingroup Group_PipePrimitiveRW_UC3
642 *
643 * \return Next two bytes in the currently selected pipe's FIFO buffer.
644 */
645 static inline uint16_t Pipe_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
646 static inline uint16_t Pipe_Read_16_LE(void)
647 {
648 uint16_t Byte0 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
649 uint16_t Byte1 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
650
651 return ((Byte1 << 8) | Byte0);
652 }
653
654 /** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT
655 * direction pipes.
656 *
657 * \ingroup Group_PipePrimitiveRW_UC3
658 *
659 * \return Next two bytes in the currently selected pipe's FIFO buffer.
660 */
661 static inline uint16_t Pipe_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
662 static inline uint16_t Pipe_Read_16_BE(void)
663 {
664 uint16_t Byte0 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
665 uint16_t Byte1 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
666
667 return ((Byte0 << 8) | Byte1);
668 }
669
670 /** Writes two bytes to the currently selected pipe's bank in little endian format, for IN
671 * direction pipes.
672 *
673 * \ingroup Group_PipePrimitiveRW_UC3
674 *
675 * \param[in] Data Data to write to the currently selected pipe's FIFO buffer.
676 */
677 static inline void Pipe_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
678 static inline void Pipe_Write_16_LE(const uint16_t Data)
679 {
680 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data & 0xFF);
681 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data >> 8);
682 }
683
684 /** Writes two bytes to the currently selected pipe's bank in big endian format, for IN
685 * direction pipes.
686 *
687 * \ingroup Group_PipePrimitiveRW_UC3
688 *
689 * \param[in] Data Data to write to the currently selected pipe's FIFO buffer.
690 */
691 static inline void Pipe_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
692 static inline void Pipe_Write_16_BE(const uint16_t Data)
693 {
694 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data >> 8);
695 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data & 0xFF);
696 }
697
698 /** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.
699 *
700 * \ingroup Group_PipePrimitiveRW_UC3
701 */
702 static inline void Pipe_Discard_16(void) ATTR_ALWAYS_INLINE;
703 static inline void Pipe_Discard_16(void)
704 {
705 uint8_t Dummy;
706
707 Dummy = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
708 Dummy = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
709
710 (void)Dummy;
711 }
712
713 /** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT
714 * direction pipes.
715 *
716 * \ingroup Group_PipePrimitiveRW_UC3
717 *
718 * \return Next four bytes in the currently selected pipe's FIFO buffer.
719 */
720 static inline uint32_t Pipe_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
721 static inline uint32_t Pipe_Read_32_LE(void)
722 {
723 uint32_t Byte0 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
724 uint32_t Byte1 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
725 uint32_t Byte2 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
726 uint32_t Byte3 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
727
728 return ((Byte3 << 24) | (Byte2 << 16) | (Byte1 << 8) | Byte0);
729 }
730
731 /** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT
732 * direction pipes.
733 *
734 * \ingroup Group_PipePrimitiveRW_UC3
735 *
736 * \return Next four bytes in the currently selected pipe's FIFO buffer.
737 */
738 static inline uint32_t Pipe_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
739 static inline uint32_t Pipe_Read_32_BE(void)
740 {
741 uint32_t Byte0 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
742 uint32_t Byte1 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
743 uint32_t Byte2 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
744 uint32_t Byte3 = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
745
746 return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
747 }
748
749 /** Writes four bytes to the currently selected pipe's bank in little endian format, for IN
750 * direction pipes.
751 *
752 * \ingroup Group_PipePrimitiveRW_UC3
753 *
754 * \param[in] Data Data to write to the currently selected pipe's FIFO buffer.
755 */
756 static inline void Pipe_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
757 static inline void Pipe_Write_32_LE(const uint32_t Data)
758 {
759 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data & 0xFF);
760 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data >> 8);
761 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data >> 16);
762 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data >> 24);
763 }
764
765 /** Writes four bytes to the currently selected pipe's bank in big endian format, for IN
766 * direction pipes.
767 *
768 * \ingroup Group_PipePrimitiveRW_UC3
769 *
770 * \param[in] Data Data to write to the currently selected pipe's FIFO buffer.
771 */
772 static inline void Pipe_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
773 static inline void Pipe_Write_32_BE(const uint32_t Data)
774 {
775 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data >> 24);
776 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data >> 16);
777 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data >> 8);
778 *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++) = (Data & 0xFF);
779 }
780
781 /** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.
782 *
783 * \ingroup Group_PipePrimitiveRW_UC3
784 */
785 static inline void Pipe_Discard_32(void) ATTR_ALWAYS_INLINE;
786 static inline void Pipe_Discard_32(void)
787 {
788 uint8_t Dummy;
789
790 Dummy = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
791 Dummy = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
792 Dummy = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
793 Dummy = *(USB_Pipe_FIFOPos[USB_Pipe_SelectedPipe]++);
794
795 (void)Dummy;
796 }
797
798 /* External Variables: */
799 /** Global indicating the maximum packet size of the default control pipe located at address
800 * 0 in the device. This value is set to the value indicated in the attached device's device
801 * descriptor once the USB interface is initialized into host mode and a device is attached
802 * to the USB bus.
803 *
804 * \attention This variable should be treated as read-only in the user application, and never manually
805 * changed in value.
806 */
807 extern uint8_t USB_Host_ControlPipeSize;
808
809 /* Function Prototypes: */
810 /** Configures a table of pipe descriptions, in sequence. This function can be used to configure multiple
811 * pipes at the same time.
812 *
813 * \note Pipe with a zero address will be ignored, thus this function cannot be used to configure the
814 * control pipe.
815 *
816 * \param[in] Table Pointer to a table of pipe descriptions.
817 * \param[in] Entries Number of entries in the pipe table to configure.
818 *
819 * \return Boolean \c true if all pipes configured successfully, \c false otherwise.
820 */
821 bool Pipe_ConfigurePipeTable(const USB_Pipe_Table_t* const Table,
822 const uint8_t Entries);
823
824 /** Configures the specified pipe address with the given pipe type, endpoint address within the attached device, bank size
825 * and number of hardware banks.
826 *
827 * A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()
828 * before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or
829 * sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite
830 * numbers of IN requests without automatic freezing - this can be overridden by a call to
831 * \ref Pipe_SetFiniteINRequests().
832 *
833 * \param[in] Address Pipe address to configure.
834 *
835 * \param[in] Type Type of pipe to configure, an \c EP_TYPE_* mask. Not all pipe types are available on Low
836 * Speed USB devices - refer to the USB 2.0 specification.
837 *
838 * \param[in] EndpointAddress Endpoint address within the attached device that the pipe should interface to.
839 *
840 * \param[in] Size Size of the pipe's bank, where packets are stored before they are transmitted to
841 * the USB device, or after they have been received from the USB device (depending on
842 * the pipe's data direction). The bank size must indicate the maximum packet size that
843 * the pipe can handle.
844 *
845 * \param[in] Banks Number of banks to use for the pipe being configured.
846 *
847 * \note When the \c ORDERED_EP_CONFIG compile time option is used, Pipes <b>must</b> be configured in ascending order,
848 * or bank corruption will occur.
849 * \n\n
850 *
851 * \note Certain microcontroller model's pipes may have different maximum packet sizes based on the pipe's
852 * index - refer to the chosen microcontroller's datasheet to determine the maximum bank size for each pipe.
853 * \n\n
854 *
855 * \note The default control pipe should not be manually configured by the user application, as it is
856 * automatically configured by the library internally.
857 * \n\n
858 *
859 * \note This routine will automatically select the specified pipe upon success. Upon failure, the pipe which
860 * failed to reconfigure correctly will be selected.
861 *
862 * \return Boolean \c true if the configuration succeeded, \c false otherwise.
863 */
864 bool Pipe_ConfigurePipe(const uint8_t Address,
865 const uint8_t Type,
866 const uint8_t EndpointAddress,
867 const uint16_t Size,
868 const uint8_t Banks);
869
870 /** Spin-loops until the currently selected non-control pipe is ready for the next packet of data to be read
871 * or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).
872 *
873 * \ingroup Group_PipeRW_UC3
874 *
875 * \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
876 */
877 uint8_t Pipe_WaitUntilReady(void);
878
879 /** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given
880 * endpoint is found, it is automatically selected.
881 *
882 * \param[in] EndpointAddress Address and direction mask of the endpoint within the attached device to check.
883 *
884 * \return Boolean \c true if a pipe bound to the given endpoint address of the specified direction is found,
885 * \c false otherwise.
886 */
887 bool Pipe_IsEndpointBound(const uint8_t EndpointAddress) ATTR_WARN_UNUSED_RESULT;
888
889 /* Private Interface - For use in library only: */
890 #if !defined(__DOXYGEN__)
891 /* Macros: */
892 #if !defined(ENDPOINT_CONTROLEP)
893 #define ENDPOINT_CONTROLEP 0
894 #endif
895
896 /* Inline Functions: */
897 static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
898 static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes)
899 {
900 uint8_t MaskVal = 0;
901 uint16_t CheckBytes = 8;
902
903 while ((CheckBytes < Bytes) && (CheckBytes < PIPE_MAX_SIZE))
904 {
905 MaskVal++;
906 CheckBytes <<= 1;
907 }
908
909 return (MaskVal << AVR32_USBB_PSIZE_OFFSET);
910 }
911
912 /* Function Prototypes: */
913 void Pipe_ClearPipes(void);
914 #endif
915
916 /* Disable C linkage for C++ Compilers: */
917 #if defined(__cplusplus)
918 }
919 #endif
920
921 #endif
922
923 /** @} */
924
custom keymap for my minivan; forked from http://github.com/evangs/tmk_keyboard
Imprint / Impressum