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