]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-120730/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
git://git.gir.st / tmk_keyboard.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Change TOP_DIR to TMK_DIR in makefiles
[tmk_keyboard.git] / protocol / lufa / LUFA-120730 / LUFA / Drivers / USB / Core / UC3 / Endpoint_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 Endpoint definitions for the AVR32 UC3 microcontrollers.
33 * \copydetails Group_EndpointManagement_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_EndpointRW
40 * \defgroup Group_EndpointRW_UC3 Endpoint Data Reading and Writing (UC3)
41 * \brief Endpoint 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 endpoints.
44 */
45
46 /** \ingroup Group_EndpointPrimitiveRW
47 * \defgroup Group_EndpointPrimitiveRW_UC3 Read/Write of Primitive Data Types (UC3)
48 * \brief Endpoint primitive 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 endpoints.
52 */
53
54 /** \ingroup Group_EndpointPacketManagement
55 * \defgroup Group_EndpointPacketManagement_UC3 Endpoint Packet Management (UC3)
56 * \brief Endpoint packet management definitions for the Atmel AVR32 UC3 architecture.
57 *
58 * Functions, macros, variables, enums and types related to packet management of endpoints.
59 */
60
61 /** \ingroup Group_EndpointManagement
62 * \defgroup Group_EndpointManagement_UC3 Endpoint Management (UC3)
63 * \brief Endpoint management definitions for the Atmel AVR32 UC3 architecture.
64 *
65 * Functions, macros and enums related to endpoint management when in USB Device mode. This
66 * module contains the endpoint management macros, as well as endpoint interrupt and data
67 * send/receive functions for various data types.
68 *
69 * @{
70 */
71
72 #ifndef __ENDPOINT_UC3_H__
73 #define __ENDPOINT_UC3_H__
74
75 /* Includes: */
76 #include "../../../../Common/Common.h"
77 #include "../USBTask.h"
78 #include "../USBInterrupt.h"
79
80 /* Enable C linkage for C++ Compilers: */
81 #if defined(__cplusplus)
82 extern "C" {
83 #endif
84
85 /* Preprocessor Checks: */
86 #if !defined(__INCLUDE_FROM_USB_DRIVER)
87 #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
88 #endif
89
90 /* Private Interface - For use in library only: */
91 #if !defined(__DOXYGEN__)
92 /* Macros: */
93 #define ENDPOINT_HSB_ADDRESS_SPACE_SIZE (64 * 1024UL)
94
95 /* Inline Functions: */
96 static inline uint32_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST
97 ATTR_ALWAYS_INLINE;
98 static inline uint32_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
99 {
100 uint8_t MaskVal = 0;
101 uint16_t CheckBytes = 8;
102
103 while (CheckBytes < Bytes)
104 {
105 MaskVal++;
106 CheckBytes <<= 1;
107 }
108
109 return (MaskVal << AVR32_USBB_EPSIZE_OFFSET);
110 }
111
112 /* Function Prototypes: */
113 void Endpoint_ClearEndpoints(void);
114 bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,
115 const uint32_t UECFGXData);
116
117 /* External Variables: */
118 extern volatile uint32_t USB_Endpoint_SelectedEndpoint;
119 extern volatile uint8_t* USB_Endpoint_FIFOPos[];
120 #endif
121
122 /* Public Interface - May be used in end-application: */
123 /* Macros: */
124 #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
125 /** Default size of the default control endpoint's bank, until altered by the control endpoint bank size
126 * value in the device descriptor. Not available if the \c FIXED_CONTROL_ENDPOINT_SIZE token is defined.
127 */
128 #define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8
129 #endif
130
131 #if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)
132 #if defined(USB_SERIES_UC3A3_AVR32) || defined(USB_SERIES_UC3A4_AVR32)
133 #define ENDPOINT_TOTAL_ENDPOINTS 8
134 #else
135 /** Total number of endpoints (including the default control endpoint at address 0) which may
136 * be used in the device. Different AVR models support different amounts of endpoints,
137 * this value reflects the maximum number of endpoints for the currently selected AVR model.
138 */
139 #define ENDPOINT_TOTAL_ENDPOINTS 7
140 #endif
141 #else
142 #define ENDPOINT_TOTAL_ENDPOINTS 1
143 #endif
144
145 /* Enums: */
146 /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
147 *
148 * \ingroup Group_EndpointRW_UC3
149 */
150 enum Endpoint_WaitUntilReady_ErrorCodes_t
151 {
152 ENDPOINT_READYWAIT_NoError = 0, /**< Endpoint is ready for next packet, no error. */
153 ENDPOINT_READYWAIT_EndpointStalled = 1, /**< The endpoint was stalled during the stream
154 * transfer by the host or device.
155 */
156 ENDPOINT_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while
157 * waiting for the endpoint to become ready.
158 */
159 ENDPOINT_READYWAIT_BusSuspended = 3, /**< The USB bus has been suspended by the host and
160 * no USB endpoint traffic can occur until the bus
161 * has resumed.
162 */
163 ENDPOINT_READYWAIT_Timeout = 4, /**< The host failed to accept or send the next packet
164 * within the software timeout period set by the
165 * \ref USB_STREAM_TIMEOUT_MS macro.
166 */
167 };
168
169 /* Inline Functions: */
170 /** Configures the specified endpoint address with the given endpoint type, direction, bank size
171 * and banking mode. Once configured, the endpoint may be read from or written to, depending
172 * on its direction.
173 *
174 * \param[in] Address Endpoint address to configure.
175 *
176 * \param[in] Type Type of endpoint to configure, a \c EP_TYPE_* mask. Not all endpoint types
177 * are available on Low Speed USB devices - refer to the USB 2.0 specification.
178 *
179 * \param[in] Size Size of the endpoint's bank, where packets are stored before they are transmitted
180 * to the USB host, or after they have been received from the USB host (depending on
181 * the endpoint's data direction). The bank size must indicate the maximum packet size
182 * that the endpoint can handle.
183 *
184 * \param[in] Banks Number of hardware banks to use for the endpoint being configured.
185 *
186 * \attention When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in
187 * ascending order, or bank corruption will occur.
188 *
189 * \note Different endpoints may have different maximum packet sizes based on the endpoint's index - refer to
190 * the chosen microcontroller model's datasheet to determine the maximum bank size for each endpoint.
191 * \n\n
192 *
193 * \note The default control endpoint should not be manually configured by the user application, as
194 * it is automatically configured by the library internally.
195 * \n\n
196 *
197 * \note This routine will automatically select the specified endpoint upon success. Upon failure, the endpoint
198 * which failed to reconfigure correctly will be selected.
199 *
200 * \return Boolean \c true if the configuration succeeded, \c false otherwise.
201 */
202 static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,
203 const uint8_t Type,
204 const uint16_t Size,
205 const uint8_t Banks) ATTR_ALWAYS_INLINE;
206 static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,
207 const uint8_t Type,
208 const uint16_t Size,
209 const uint8_t Banks)
210 {
211 uint8_t Number = (Address & ENDPOINT_EPNUM_MASK);
212
213 if (Number >= ENDPOINT_TOTAL_ENDPOINTS)
214 return false;
215
216 return Endpoint_ConfigureEndpoint_Prv(Number,
217 (AVR32_USBB_ALLOC_MASK |
218 ((uint32_t)Type << AVR32_USBB_EPTYPE_OFFSET) |
219 ((Address & ENDPOINT_DIR_IN) ? AVR32_USBB_UECFG0_EPDIR_MASK : 0) |
220 ((Banks > 1) ? AVR32_USBB_UECFG0_EPBK_SINGLE : AVR32_USBB_UECFG0_EPBK_DOUBLE) |
221 Endpoint_BytesToEPSizeMask(Size)));
222 }
223
224 /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
225 *
226 * \ingroup Group_EndpointRW_UC3
227 *
228 * \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
229 */
230 static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
231 static inline uint16_t Endpoint_BytesInEndpoint(void)
232 {
233 return (&AVR32_USBB.UESTA0)[USB_Endpoint_SelectedEndpoint].byct;
234 }
235
236 /** Determines the currently selected endpoint's direction.
237 *
238 * \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.
239 */
240 static inline uint32_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
241 static inline uint32_t Endpoint_GetEndpointDirection(void)
242 {
243 return ((&AVR32_USBB.UECFG0)[USB_Endpoint_SelectedEndpoint].epdir ? ENDPOINT_DIR_IN : ENDPOINT_DIR_OUT);
244 }
245
246 /** Get the endpoint address of the currently selected endpoint. This is typically used to save
247 * the currently selected endpoint so that it can be restored after another endpoint has been
248 * manipulated.
249 *
250 * \return Index of the currently selected endpoint.
251 */
252 static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
253 static inline uint8_t Endpoint_GetCurrentEndpoint(void)
254 {
255 return (USB_Endpoint_SelectedEndpoint | Endpoint_GetEndpointDirection());
256 }
257
258 /** Selects the given endpoint address.
259 *
260 * Any endpoint operations which do not require the endpoint address to be indicated will operate on
261 * the currently selected endpoint.
262 *
263 * \param[in] Address Endpoint address to select.
264 */
265 static inline void Endpoint_SelectEndpoint(const uint8_t Address) ATTR_ALWAYS_INLINE;
266 static inline void Endpoint_SelectEndpoint(const uint8_t Address)
267 {
268 USB_Endpoint_SelectedEndpoint = (Address & ENDPOINT_EPNUM_MASK);
269 }
270
271 /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
272 * data In and Out pointers to the bank's contents.
273 *
274 * \param[in] Address Endpoint number whose FIFO buffers are to be reset.
275 */
276 static inline void Endpoint_ResetEndpoint(const uint8_t Address) ATTR_ALWAYS_INLINE;
277 static inline void Endpoint_ResetEndpoint(const uint8_t Address)
278 {
279 uint32_t EndpointNumber = (Address & ENDPOINT_EPNUM_MASK);
280
281 AVR32_USBB.uerst |= (AVR32_USBB_EPRST0_MASK << EndpointNumber);
282 AVR32_USBB.uerst &= ~(AVR32_USBB_EPRST0_MASK << EndpointNumber);
283 USB_Endpoint_FIFOPos[EndpointNumber] = &AVR32_USBB_SLAVE[EndpointNumber * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
284 }
285
286 /** Enables the currently selected endpoint so that data can be sent and received through it to
287 * and from a host.
288 *
289 * \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
290 */
291 static inline void Endpoint_EnableEndpoint(void) ATTR_ALWAYS_INLINE;
292 static inline void Endpoint_EnableEndpoint(void)
293 {
294 AVR32_USBB.uerst |= (AVR32_USBB_EPEN0_MASK << USB_Endpoint_SelectedEndpoint);
295 }
296
297 /** Disables the currently selected endpoint so that data cannot be sent and received through it
298 * to and from a host.
299 */
300 static inline void Endpoint_DisableEndpoint(void) ATTR_ALWAYS_INLINE;
301 static inline void Endpoint_DisableEndpoint(void)
302 {
303 AVR32_USBB.uerst &= ~(AVR32_USBB_EPEN0_MASK << USB_Endpoint_SelectedEndpoint);
304 }
305
306 /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
307 *
308 * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.
309 */
310 static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
311 static inline bool Endpoint_IsEnabled(void)
312 {
313 return ((AVR32_USBB.uerst & (AVR32_USBB_EPEN0_MASK << USB_Endpoint_SelectedEndpoint)) ? true : false);
314 }
315
316 /** Retrieves the number of busy banks in the currently selected endpoint, which have been queued for
317 * transmission via the \ref Endpoint_ClearIN() command, or are awaiting acknowledgement via the
318 * \ref Endpoint_ClearOUT() command.
319 *
320 * \ingroup Group_EndpointPacketManagement_UC3
321 *
322 * \return Total number of busy banks in the selected endpoint.
323 */
324 static inline uint8_t Endpoint_GetBusyBanks(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
325 static inline uint8_t Endpoint_GetBusyBanks(void)
326 {
327 return (&AVR32_USBB.UESTA0)[USB_Endpoint_SelectedEndpoint].nbusybk;
328 }
329
330 /** Aborts all pending IN transactions on the currently selected endpoint, once the bank
331 * has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
332 * will terminate all queued transactions, resetting the endpoint banks ready for a new
333 * packet.
334 *
335 * \ingroup Group_EndpointPacketManagement_UC3
336 */
337 static inline void Endpoint_AbortPendingIN(void)
338 {
339 while (Endpoint_GetBusyBanks() != 0)
340 {
341 (&AVR32_USBB.UECON0SET)[USB_Endpoint_SelectedEndpoint].killbks = true;
342 while ((&AVR32_USBB.UECON0)[USB_Endpoint_SelectedEndpoint].killbk);
343 }
344 }
345
346 /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
347 * bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
348 * direction). This function will return false if an error has occurred in the endpoint, if the endpoint
349 * is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
350 * direction and the endpoint bank is full.
351 *
352 * \ingroup Group_EndpointPacketManagement_UC3
353 *
354 * \return Boolean \c true if the currently selected endpoint may be read from or written to, depending
355 * on its direction.
356 */
357 static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
358 static inline bool Endpoint_IsReadWriteAllowed(void)
359 {
360 return (&AVR32_USBB.UESTA0)[USB_Endpoint_SelectedEndpoint].rwall;
361 }
362
363 /** Determines if the currently selected endpoint is configured.
364 *
365 * \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.
366 */
367 static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
368 static inline bool Endpoint_IsConfigured(void)
369 {
370 return (&AVR32_USBB.UESTA0)[USB_Endpoint_SelectedEndpoint].cfgok;
371 }
372
373 /** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
374 * interrupt duration has elapsed. Which endpoints have interrupted can be determined by
375 * masking the return value against <tt>(1 << <i>{Endpoint Number}</i>)</tt>.
376 *
377 * \return Mask whose bits indicate which endpoints have interrupted.
378 */
379 static inline uint32_t Endpoint_GetEndpointInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
380 static inline uint32_t Endpoint_GetEndpointInterrupts(void)
381 {
382 return ((AVR32_USBB.udint & (AVR32_USBB_EP6INT_MASK | AVR32_USBB_EP5INT_MASK |
383 AVR32_USBB_EP4INT_MASK | AVR32_USBB_EP3INT_MASK |
384 AVR32_USBB_EP2INT_MASK | AVR32_USBB_EP1INT_MASK |
385 AVR32_USBB_EP0INT_MASK)) >> AVR32_USBB_EP0INT_OFFSET);
386 }
387
388 /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
389 * endpoints).
390 *
391 * \param[in] Address Address of the endpoint whose interrupt flag should be tested.
392 *
393 * \return Boolean \c true if the specified endpoint has interrupted, \c false otherwise.
394 */
395 static inline bool Endpoint_HasEndpointInterrupted(const uint8_t Address) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
396 static inline bool Endpoint_HasEndpointInterrupted(const uint8_t Address)
397 {
398 return ((Endpoint_GetEndpointInterrupts() & (AVR32_USBB_EP0INT_MASK << (Address & ENDPOINT_EPNUM_MASK))) ? true : false);
399 }
400
401 /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
402 *
403 * \ingroup Group_EndpointPacketManagement_UC3
404 *
405 * \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.
406 */
407 static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
408 static inline bool Endpoint_IsINReady(void)
409 {
410 return (&AVR32_USBB.UESTA0)[USB_Endpoint_SelectedEndpoint].txini;
411 }
412
413 /** Determines if the selected OUT endpoint has received new packet from the host.
414 *
415 * \ingroup Group_EndpointPacketManagement_UC3
416 *
417 * \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.
418 */
419 static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
420 static inline bool Endpoint_IsOUTReceived(void)
421 {
422 return (&AVR32_USBB.UESTA0)[USB_Endpoint_SelectedEndpoint].rxouti;
423 }
424
425 /** Determines if the current CONTROL type endpoint has received a SETUP packet.
426 *
427 * \ingroup Group_EndpointPacketManagement_UC3
428 *
429 * \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.
430 */
431 static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
432 static inline bool Endpoint_IsSETUPReceived(void)
433 {
434 return (&AVR32_USBB.UESTA0)[USB_Endpoint_SelectedEndpoint].rxstpi;
435 }
436
437 /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
438 * endpoint for the next packet.
439 *
440 * \ingroup Group_EndpointPacketManagement_UC3
441 *
442 * \note This is not applicable for non CONTROL type endpoints.
443 */
444 static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;
445 static inline void Endpoint_ClearSETUP(void)
446 {
447 (&AVR32_USBB.UESTA0CLR)[USB_Endpoint_SelectedEndpoint].rxstpic = true;
448 USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_Endpoint_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
449 }
450
451 /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
452 * next packet and switching to the alternative endpoint bank if double banked.
453 *
454 * \ingroup Group_EndpointPacketManagement_UC3
455 */
456 static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
457 static inline void Endpoint_ClearIN(void)
458 {
459 (&AVR32_USBB.UESTA0CLR)[USB_Endpoint_SelectedEndpoint].txinic = true;
460 (&AVR32_USBB.UECON0CLR)[USB_Endpoint_SelectedEndpoint].fifoconc = true;
461 USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_Endpoint_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
462 }
463
464 /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
465 * for the next packet and switching to the alternative endpoint bank if double banked.
466 *
467 * \ingroup Group_EndpointPacketManagement_UC3
468 */
469 static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
470 static inline void Endpoint_ClearOUT(void)
471 {
472 (&AVR32_USBB.UESTA0CLR)[USB_Endpoint_SelectedEndpoint].rxoutic = true;
473 (&AVR32_USBB.UECON0CLR)[USB_Endpoint_SelectedEndpoint].fifoconc = true;
474 USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_Endpoint_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
475 }
476
477 /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
478 * indicated endpoint and that the current transfer sequence should be aborted. This provides a
479 * way for devices to indicate invalid commands to the host so that the current transfer can be
480 * aborted and the host can begin its own recovery sequence.
481 *
482 * The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
483 * is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
484 * endpoint.
485 *
486 * \ingroup Group_EndpointPacketManagement_UC3
487 */
488 static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
489 static inline void Endpoint_StallTransaction(void)
490 {
491 (&AVR32_USBB.UECON0SET)[USB_Endpoint_SelectedEndpoint].stallrqs = true;
492 }
493
494 /** Clears the STALL condition on the currently selected endpoint.
495 *
496 * \ingroup Group_EndpointPacketManagement_UC3
497 */
498 static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
499 static inline void Endpoint_ClearStall(void)
500 {
501 (&AVR32_USBB.UECON0CLR)[USB_Endpoint_SelectedEndpoint].stallrqc = true;
502 }
503
504 /** Determines if the currently selected endpoint is stalled, false otherwise.
505 *
506 * \ingroup Group_EndpointPacketManagement_UC3
507 *
508 * \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.
509 */
510 static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
511 static inline bool Endpoint_IsStalled(void)
512 {
513 return (&AVR32_USBB.UECON0)[USB_Endpoint_SelectedEndpoint].stallrq;
514 }
515
516 /** Resets the data toggle of the currently selected endpoint. */
517 static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
518 static inline void Endpoint_ResetDataToggle(void)
519 {
520 (&AVR32_USBB.UECON0SET)[USB_Endpoint_SelectedEndpoint].rstdts = true;
521 }
522
523 /** Sets the direction of the currently selected endpoint.
524 *
525 * \param[in] DirectionMask New endpoint direction, as a \c ENDPOINT_DIR_* mask.
526 */
527 static inline void Endpoint_SetEndpointDirection(const uint32_t DirectionMask) ATTR_ALWAYS_INLINE;
528 static inline void Endpoint_SetEndpointDirection(const uint32_t DirectionMask)
529 {
530 (&AVR32_USBB.UECFG0)[USB_Endpoint_SelectedEndpoint].epdir = (DirectionMask == ENDPOINT_DIR_IN);
531 }
532
533 /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
534 *
535 * \ingroup Group_EndpointPrimitiveRW_UC3
536 *
537 * \return Next byte in the currently selected endpoint's FIFO buffer.
538 */
539 static inline uint8_t Endpoint_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
540 static inline uint8_t Endpoint_Read_8(void)
541 {
542 return *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
543 }
544
545 /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
546 *
547 * \ingroup Group_EndpointPrimitiveRW_UC3
548 *
549 * \param[in] Data Data to write into the the currently selected endpoint's FIFO buffer.
550 */
551 static inline void Endpoint_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
552 static inline void Endpoint_Write_8(const uint8_t Data)
553 {
554 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = Data;
555 }
556
557 /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
558 *
559 * \ingroup Group_EndpointPrimitiveRW_UC3
560 */
561 static inline void Endpoint_Discard_8(void) ATTR_ALWAYS_INLINE;
562 static inline void Endpoint_Discard_8(void)
563 {
564 uint8_t Dummy;
565
566 Dummy = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
567
568 (void)Dummy;
569 }
570
571 /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
572 * direction endpoints.
573 *
574 * \ingroup Group_EndpointPrimitiveRW_UC3
575 *
576 * \return Next two bytes in the currently selected endpoint's FIFO buffer.
577 */
578 static inline uint16_t Endpoint_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
579 static inline uint16_t Endpoint_Read_16_LE(void)
580 {
581 uint16_t Byte0 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
582 uint16_t Byte1 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
583
584 return ((Byte1 << 8) | Byte0);
585 }
586
587 /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
588 * direction endpoints.
589 *
590 * \ingroup Group_EndpointPrimitiveRW_UC3
591 *
592 * \return Next two bytes in the currently selected endpoint's FIFO buffer.
593 */
594 static inline uint16_t Endpoint_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
595 static inline uint16_t Endpoint_Read_16_BE(void)
596 {
597 uint16_t Byte0 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
598 uint16_t Byte1 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
599
600 return ((Byte0 << 8) | Byte1);
601 }
602
603 /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
604 * direction endpoints.
605 *
606 * \ingroup Group_EndpointPrimitiveRW_UC3
607 *
608 * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
609 */
610 static inline void Endpoint_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
611 static inline void Endpoint_Write_16_LE(const uint16_t Data)
612 {
613 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data & 0xFF);
614 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data >> 8);
615 }
616
617 /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
618 * direction endpoints.
619 *
620 * \ingroup Group_EndpointPrimitiveRW_UC3
621 *
622 * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
623 */
624 static inline void Endpoint_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
625 static inline void Endpoint_Write_16_BE(const uint16_t Data)
626 {
627 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data >> 8);
628 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data & 0xFF);
629 }
630
631 /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
632 *
633 * \ingroup Group_EndpointPrimitiveRW_UC3
634 */
635 static inline void Endpoint_Discard_16(void) ATTR_ALWAYS_INLINE;
636 static inline void Endpoint_Discard_16(void)
637 {
638 uint8_t Dummy;
639
640 Dummy = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
641 Dummy = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
642
643 (void)Dummy;
644 }
645
646 /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
647 * direction endpoints.
648 *
649 * \ingroup Group_EndpointPrimitiveRW_UC3
650 *
651 * \return Next four bytes in the currently selected endpoint's FIFO buffer.
652 */
653 static inline uint32_t Endpoint_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
654 static inline uint32_t Endpoint_Read_32_LE(void)
655 {
656 uint32_t Byte0 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
657 uint32_t Byte1 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
658 uint32_t Byte2 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
659 uint32_t Byte3 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
660
661 return ((Byte3 << 24) | (Byte2 << 16) | (Byte1 << 8) | Byte0);
662 }
663
664 /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
665 * direction endpoints.
666 *
667 * \ingroup Group_EndpointPrimitiveRW_UC3
668 *
669 * \return Next four bytes in the currently selected endpoint's FIFO buffer.
670 */
671 static inline uint32_t Endpoint_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
672 static inline uint32_t Endpoint_Read_32_BE(void)
673 {
674 uint32_t Byte0 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
675 uint32_t Byte1 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
676 uint32_t Byte2 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
677 uint32_t Byte3 = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
678
679 return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
680 }
681
682 /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
683 * direction endpoints.
684 *
685 * \ingroup Group_EndpointPrimitiveRW_UC3
686 *
687 * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
688 */
689 static inline void Endpoint_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
690 static inline void Endpoint_Write_32_LE(const uint32_t Data)
691 {
692 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data & 0xFF);
693 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data >> 8);
694 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data >> 16);
695 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data >> 24);
696 }
697
698 /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
699 * direction endpoints.
700 *
701 * \ingroup Group_EndpointPrimitiveRW_UC3
702 *
703 * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
704 */
705 static inline void Endpoint_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
706 static inline void Endpoint_Write_32_BE(const uint32_t Data)
707 {
708 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data >> 24);
709 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data >> 16);
710 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data >> 8);
711 *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++) = (Data & 0xFF);
712 }
713
714 /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
715 *
716 * \ingroup Group_EndpointPrimitiveRW_UC3
717 */
718 static inline void Endpoint_Discard_32(void) ATTR_ALWAYS_INLINE;
719 static inline void Endpoint_Discard_32(void)
720 {
721 uint8_t Dummy;
722
723 Dummy = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
724 Dummy = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
725 Dummy = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
726 Dummy = *(USB_Endpoint_FIFOPos[USB_Endpoint_SelectedEndpoint]++);
727
728 (void)Dummy;
729 }
730
731 /* External Variables: */
732 /** Global indicating the maximum packet size of the default control endpoint located at address
733 * 0 in the device. This value is set to the value indicated in the device descriptor in the user
734 * project once the USB interface is initialized into device mode.
735 *
736 * If space is an issue, it is possible to fix this to a static value by defining the control
737 * endpoint size in the \c FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
738 * via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
739 * read from the descriptors at runtime and instead fixed to the given value. When used, it is
740 * important that the descriptor control endpoint size value matches the size given as the
741 * \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
742 * be used in the device descriptors to ensure this.
743 *
744 * \attention This variable should be treated as read-only in the user application, and never manually
745 * changed in value.
746 */
747 #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
748 extern uint8_t USB_Device_ControlEndpointSize;
749 #else
750 #define USB_Device_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
751 #endif
752
753 /* Function Prototypes: */
754 /** Configures a table of endpoint descriptions, in sequence. This function can be used to configure multiple
755 * endpoints at the same time.
756 *
757 * \note Endpoints with a zero address will be ignored, thus this function cannot be used to configure the
758 * control endpoint.
759 *
760 * \param[in] Table Pointer to a table of endpoint descriptions.
761 * \param[in] Entries Number of entries in the endpoint table to configure.
762 *
763 * \return Boolean \c true if all endpoints configured successfully, \c false otherwise.
764 */
765 bool Endpoint_ConfigureEndpointTable(const USB_Endpoint_Table_t* const Table,
766 const uint8_t Entries);
767
768 /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
769 * with respect to the data direction. This is a convenience function which can be used to
770 * simplify user control request handling.
771 *
772 * \note This routine should not be called on non CONTROL type endpoints.
773 */
774 void Endpoint_ClearStatusStage(void);
775
776 /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
777 * to be read or written to it.
778 *
779 * \note This routine should not be called on CONTROL type endpoints.
780 *
781 * \ingroup Group_EndpointRW_UC3
782 *
783 * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
784 */
785 uint8_t Endpoint_WaitUntilReady(void);
786
787 /* Disable C linkage for C++ Compilers: */
788 #if defined(__cplusplus)
789 }
790 #endif
791
792 #endif
793
794 /** @} */
795
custom keymap for my minivan; forked from http://github.com/evangs/tmk_keyboard
Imprint / Impressum