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