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