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


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