3 Copyright (C) Dean Camera, 2012.
\r
5 dean [at] fourwalledcubicle [dot] com
\r
10 Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
\r
12 Permission to use, copy, modify, distribute, and sell this
\r
13 software and its documentation for any purpose is hereby granted
\r
14 without fee, provided that the above copyright notice appear in
\r
15 all copies and that both that the copyright notice and this
\r
16 permission notice and warranty disclaimer appear in supporting
\r
17 documentation, and that the name of the author not be used in
\r
18 advertising or publicity pertaining to distribution of the
\r
19 software without specific, written prior permission.
\r
21 The author disclaim all warranties with regard to this
\r
22 software, including all implied warranties of merchantability
\r
23 and fitness. In no event shall the author be liable for any
\r
24 special, indirect or consequential damages or any damages
\r
25 whatsoever resulting from loss of use, data or profits, whether
\r
26 in an action of contract, negligence or other tortious action,
\r
27 arising out of or in connection with the use or performance of
\r
32 * \brief USB Endpoint definitions for the AVR XMEGA microcontrollers.
\r
33 * \copydetails Group_EndpointManagement_XMEGA
\r
35 * \note This file should not be included directly. It is automatically included as needed by the USB driver
\r
36 * dispatch header located in LUFA/Drivers/USB/USB.h.
\r
39 /** \ingroup Group_EndpointRW
\r
40 * \defgroup Group_EndpointRW_XMEGA Endpoint Data Reading and Writing (XMEGA)
\r
41 * \brief Endpoint data read/write definitions for the Atmel AVR XMEGA architecture.
\r
43 * Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
\r
46 /** \ingroup Group_EndpointPrimitiveRW
\r
47 * \defgroup Group_EndpointPrimitiveRW_XMEGA Read/Write of Primitive Data Types (XMEGA)
\r
48 * \brief Endpoint primitive read/write definitions for the Atmel AVR XMEGA architecture.
\r
50 * Functions, macros, variables, enums and types related to data reading and writing of primitive data types
\r
51 * from and to endpoints.
\r
54 /** \ingroup Group_EndpointPacketManagement
\r
55 * \defgroup Group_EndpointPacketManagement_XMEGA Endpoint Packet Management (XMEGA)
\r
56 * \brief Endpoint packet management definitions for the Atmel AVR XMEGA architecture.
\r
58 * Functions, macros, variables, enums and types related to packet management of endpoints.
\r
61 /** \ingroup Group_EndpointManagement
\r
62 * \defgroup Group_EndpointManagement_XMEGA Endpoint Management (XMEGA)
\r
63 * \brief Endpoint management definitions for the Atmel AVR XMEGA architecture.
\r
65 * Functions, macros and enums related to endpoint management when in USB Device mode. This
\r
66 * module contains the endpoint management macros, as well as endpoint interrupt and data
\r
67 * send/receive functions for various data types.
\r
72 #ifndef __ENDPOINT_XMEGA_H__
\r
73 #define __ENDPOINT_XMEGA_H__
\r
76 #include "../../../../Common/Common.h"
\r
77 #include "../USBTask.h"
\r
78 #include "../USBInterrupt.h"
\r
79 #include "../USBController.h"
\r
81 /* Enable C linkage for C++ Compilers: */
\r
82 #if defined(__cplusplus)
\r
86 /* Preprocessor Checks: */
\r
87 #if !defined(__INCLUDE_FROM_USB_DRIVER)
\r
88 #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
\r
91 /* Public Interface - May be used in end-application: */
\r
93 #if (!defined(MAX_ENDPOINT_INDEX) && !defined(CONTROL_ONLY_DEVICE)) || defined(__DOXYGEN__)
\r
94 /** Total number of endpoints (including the default control endpoint at address 0) which may
\r
95 * be used in the device. Different USB AVR models support different amounts of endpoints,
\r
96 * this value reflects the maximum number of endpoints for the currently selected AVR model.
\r
98 #define ENDPOINT_TOTAL_ENDPOINTS 16
\r
100 #if defined(CONTROL_ONLY_DEVICE)
\r
101 #define ENDPOINT_TOTAL_ENDPOINTS 1
\r
103 #define ENDPOINT_TOTAL_ENDPOINTS (MAX_ENDPOINT_INDEX + 1)
\r
107 /* Private Interface - For use in library only: */
\r
108 #if !defined(__DOXYGEN__)
\r
109 /* Type Defines: */
\r
120 Endpoint_FIFO_t OUT;
\r
121 Endpoint_FIFO_t IN;
\r
122 } Endpoint_FIFOPair_t;
\r
124 /* External Variables: */
\r
125 extern Endpoint_FIFOPair_t USB_Endpoint_FIFOs[ENDPOINT_TOTAL_ENDPOINTS];
\r
126 extern volatile uint8_t USB_Endpoint_SelectedEndpoint;
\r
127 extern volatile USB_EP_t* USB_Endpoint_SelectedHandle;
\r
128 extern volatile Endpoint_FIFO_t* USB_Endpoint_SelectedFIFO;
\r
130 /* Inline Functions: */
\r
131 static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST
\r
132 ATTR_ALWAYS_INLINE;
\r
133 static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
\r
135 uint8_t MaskVal = 0;
\r
136 uint16_t CheckBytes = 8;
\r
138 while (CheckBytes < Bytes)
\r
144 return (MaskVal << USB_EP_BUFSIZE_gp);
\r
147 /* Function Prototypes: */
\r
148 bool Endpoint_ConfigureEndpoint_PRV(const uint8_t Address,
\r
149 const uint8_t Config,
\r
150 const uint8_t Size);
\r
151 void Endpoint_ClearEndpoints(void);
\r
154 /* Public Interface - May be used in end-application: */
\r
156 #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
\r
157 /** Default size of the default control endpoint's bank, until altered by the control endpoint bank size
\r
158 * value in the device descriptor. Not available if the \c FIXED_CONTROL_ENDPOINT_SIZE token is defined.
\r
160 #define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8
\r
164 /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
\r
166 * \ingroup Group_EndpointRW_XMEGA
\r
168 enum Endpoint_WaitUntilReady_ErrorCodes_t
\r
170 ENDPOINT_READYWAIT_NoError = 0, /**< Endpoint is ready for next packet, no error. */
\r
171 ENDPOINT_READYWAIT_EndpointStalled = 1, /**< The endpoint was stalled during the stream
\r
172 * transfer by the host or device.
\r
174 ENDPOINT_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while
\r
175 * waiting for the endpoint to become ready.
\r
177 ENDPOINT_READYWAIT_BusSuspended = 3, /**< The USB bus has been suspended by the host and
\r
178 * no USB endpoint traffic can occur until the bus
\r
181 ENDPOINT_READYWAIT_Timeout = 4, /**< The host failed to accept or send the next packet
\r
182 * within the software timeout period set by the
\r
183 * \ref USB_STREAM_TIMEOUT_MS macro.
\r
187 /* Inline Functions: */
\r
188 /** Selects the given endpoint address.
\r
190 * Any endpoint operations which do not require the endpoint address to be indicated will operate on
\r
191 * the currently selected endpoint.
\r
193 * \param[in] Address Endpoint address to select.
\r
195 static inline void Endpoint_SelectEndpoint(const uint8_t Address);
\r
196 static inline void Endpoint_SelectEndpoint(const uint8_t Address)
\r
198 uint8_t EndpointNumber = (Address & ENDPOINT_EPNUM_MASK);
\r
200 USB_Endpoint_SelectedEndpoint = Address;
\r
202 if (Address & ENDPOINT_DIR_IN)
\r
204 USB_Endpoint_SelectedFIFO = &USB_Endpoint_FIFOs[EndpointNumber].IN;
\r
205 USB_Endpoint_SelectedHandle = &((USB_EndpointTable_t*)USB.EPPTR)->Endpoints[EndpointNumber].IN;
\r
209 USB_Endpoint_SelectedFIFO = &USB_Endpoint_FIFOs[EndpointNumber].OUT;
\r
210 USB_Endpoint_SelectedHandle = &((USB_EndpointTable_t*)USB.EPPTR)->Endpoints[EndpointNumber].OUT;
\r
214 /** Configures the specified endpoint address with the given endpoint type, direction, bank size
\r
215 * and banking mode. Once configured, the endpoint may be read from or written to, depending
\r
216 * on its direction.
\r
218 * \param[in] Address Endpoint address to configure.
\r
220 * \param[in] Type Type of endpoint to configure, a \c EP_TYPE_* mask. Not all endpoint types
\r
221 * are available on Low Speed USB devices - refer to the USB 2.0 specification.
\r
223 * \param[in] Size Size of the endpoint's bank, where packets are stored before they are transmitted
\r
224 * to the USB host, or after they have been received from the USB host (depending on
\r
225 * the endpoint's data direction). The bank size must indicate the maximum packet size
\r
226 * that the endpoint can handle.
\r
228 * \param[in] Banks Number of hardware banks to use for the endpoint being configured.
\r
230 * \note The default control endpoint should not be manually configured by the user application, as
\r
231 * it is automatically configured by the library internally.
\r
234 * \note This routine will automatically select the specified endpoint.
\r
236 * \return Boolean \c true if the configuration succeeded, \c false otherwise.
\r
238 static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,
\r
239 const uint8_t Type,
\r
240 const uint16_t Size,
\r
241 const uint8_t Banks) ATTR_ALWAYS_INLINE;
\r
242 static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,
\r
243 const uint8_t Type,
\r
244 const uint16_t Size,
\r
245 const uint8_t Banks)
\r
247 uint8_t EPConfigMask = (USB_EP_INTDSBL_bm | ((Banks > 1) ? USB_EP_PINGPONG_bm : 0) | Endpoint_BytesToEPSizeMask(Size));
\r
249 if ((Address & ENDPOINT_EPNUM_MASK) >= ENDPOINT_TOTAL_ENDPOINTS)
\r
252 // TODO - Fix once limitations are lifted
\r
253 EPConfigMask &= ~USB_EP_PINGPONG_bm;
\r
259 case EP_TYPE_CONTROL:
\r
260 EPConfigMask |= USB_EP_TYPE_CONTROL_gc;
\r
262 case EP_TYPE_ISOCHRONOUS:
\r
263 EPConfigMask |= USB_EP_TYPE_ISOCHRONOUS_gc;
\r
266 EPConfigMask |= USB_EP_TYPE_BULK_gc;
\r
270 if (Type == EP_TYPE_CONTROL)
\r
271 Endpoint_ConfigureEndpoint_PRV(Address ^ ENDPOINT_DIR_IN, EPConfigMask, Size);
\r
273 return Endpoint_ConfigureEndpoint_PRV(Address, EPConfigMask, Size);
\r
276 /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
\r
278 * \ingroup Group_EndpointRW_XMEGA
\r
280 * \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
\r
282 static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
283 static inline uint16_t Endpoint_BytesInEndpoint(void)
\r
285 if (USB_Endpoint_SelectedEndpoint & ENDPOINT_DIR_IN)
\r
286 return USB_Endpoint_SelectedFIFO->Position;
\r
288 return (USB_Endpoint_SelectedFIFO->Length - USB_Endpoint_SelectedFIFO->Position);
\r
291 /** Get the endpoint address of the currently selected endpoint. This is typically used to save
\r
292 * the currently selected endpoint so that it can be restored after another endpoint has been
\r
295 * \return Index of the currently selected endpoint.
\r
297 static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
298 static inline uint8_t Endpoint_GetCurrentEndpoint(void)
\r
300 return USB_Endpoint_SelectedEndpoint;
\r
303 /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
\r
304 * data In and Out pointers to the bank's contents.
\r
306 * \param[in] Address Endpoint address whose FIFO buffers are to be reset.
\r
308 static inline void Endpoint_ResetEndpoint(const uint8_t Address) ATTR_ALWAYS_INLINE;
\r
309 static inline void Endpoint_ResetEndpoint(const uint8_t Address)
\r
311 if (Address & ENDPOINT_DIR_IN)
\r
312 USB_Endpoint_FIFOs[Address & ENDPOINT_EPNUM_MASK].IN.Position = 0;
\r
314 USB_Endpoint_FIFOs[Address & ENDPOINT_EPNUM_MASK].OUT.Position = 0;
\r
317 /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
\r
319 * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.
\r
321 static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
322 static inline bool Endpoint_IsEnabled(void)
\r
327 /** Aborts all pending IN transactions on the currently selected endpoint, once the bank
\r
328 * has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
\r
329 * will terminate all queued transactions, resetting the endpoint banks ready for a new
\r
332 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
334 static inline void Endpoint_AbortPendingIN(void)
\r
336 USB_Endpoint_SelectedHandle->STATUS |= USB_EP_BUSNACK0_bm;
\r
339 /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
\r
340 * bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
\r
341 * direction). This function will return false if an error has occurred in the endpoint, if the endpoint
\r
342 * is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
\r
343 * direction and the endpoint bank is full.
\r
345 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
347 * \return Boolean \c true if the currently selected endpoint may be read from or written to, depending
\r
348 * on its direction.
\r
350 static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
351 static inline bool Endpoint_IsReadWriteAllowed(void)
\r
353 return (USB_Endpoint_SelectedFIFO->Position < USB_Endpoint_SelectedFIFO->Length);
\r
356 /** Determines if the currently selected endpoint is configured.
\r
358 * \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.
\r
360 static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
361 static inline bool Endpoint_IsConfigured(void)
\r
363 return ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_TYPE_gm) ? true : false);
\r
366 /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
\r
368 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
370 * \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.
\r
372 static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
373 static inline bool Endpoint_IsINReady(void)
\r
375 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint | ENDPOINT_DIR_IN);
\r
377 return ((USB_Endpoint_SelectedHandle->STATUS & USB_EP_BUSNACK0_bm) ? true : false);
\r
380 /** Determines if the selected OUT endpoint has received new packet from the host.
\r
382 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
384 * \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.
\r
386 static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
387 static inline bool Endpoint_IsOUTReceived(void)
\r
389 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint & ~ENDPOINT_DIR_IN);
\r
391 if (USB_Endpoint_SelectedHandle->STATUS & USB_EP_TRNCOMPL0_bm)
\r
393 USB_Endpoint_SelectedFIFO->Length = USB_Endpoint_SelectedHandle->CNT;
\r
400 /** Determines if the current CONTROL type endpoint has received a SETUP packet.
\r
402 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
404 * \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.
\r
406 static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
407 static inline bool Endpoint_IsSETUPReceived(void)
\r
409 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint & ~ENDPOINT_DIR_IN);
\r
411 if (USB_Endpoint_SelectedHandle->STATUS & USB_EP_SETUP_bm)
\r
413 USB_Endpoint_SelectedFIFO->Length = USB_Endpoint_SelectedHandle->CNT;
\r
420 /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
\r
421 * endpoint for the next packet.
\r
423 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
425 * \note This is not applicable for non CONTROL type endpoints.
\r
427 static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;
\r
428 static inline void Endpoint_ClearSETUP(void)
\r
430 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint & ~ENDPOINT_DIR_IN);
\r
431 USB_Endpoint_SelectedHandle->STATUS &= ~(USB_EP_SETUP_bm | USB_EP_TRNCOMPL0_bm | USB_EP_BUSNACK0_bm | USB_EP_OVF_bm);
\r
432 USB_Endpoint_SelectedHandle->STATUS |= USB_EP_TOGGLE_bm;
\r
433 USB_Endpoint_SelectedFIFO->Position = 0;
\r
435 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint | ENDPOINT_DIR_IN);
\r
436 USB_Endpoint_SelectedHandle->STATUS |= USB_EP_TOGGLE_bm;
\r
437 USB_Endpoint_SelectedFIFO->Position = 0;
\r
440 /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
\r
441 * next packet and switching to the alternative endpoint bank if double banked.
\r
443 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
445 static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
\r
446 static inline void Endpoint_ClearIN(void)
\r
448 USB_Endpoint_SelectedHandle->CNT = USB_Endpoint_SelectedFIFO->Position;
\r
449 USB_Endpoint_SelectedHandle->STATUS &= ~(USB_EP_TRNCOMPL0_bm | USB_EP_BUSNACK0_bm | USB_EP_OVF_bm);
\r
450 USB_Endpoint_SelectedFIFO->Position = 0;
\r
453 /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
\r
454 * for the next packet and switching to the alternative endpoint bank if double banked.
\r
456 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
458 static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
\r
459 static inline void Endpoint_ClearOUT(void)
\r
461 USB_Endpoint_SelectedHandle->STATUS &= ~(USB_EP_TRNCOMPL0_bm | USB_EP_BUSNACK0_bm | USB_EP_OVF_bm);
\r
462 USB_Endpoint_SelectedFIFO->Position = 0;
\r
465 /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
\r
466 * indicated endpoint and that the current transfer sequence should be aborted. This provides a
\r
467 * way for devices to indicate invalid commands to the host so that the current transfer can be
\r
468 * aborted and the host can begin its own recovery sequence.
\r
470 * The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
\r
471 * is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
\r
474 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
476 static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
\r
477 static inline void Endpoint_StallTransaction(void)
\r
479 USB_Endpoint_SelectedHandle->CTRL |= USB_EP_STALL_bm;
\r
481 if ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_TYPE_gm) == USB_EP_TYPE_CONTROL_gc)
\r
483 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint ^ ENDPOINT_DIR_IN);
\r
484 USB_Endpoint_SelectedHandle->CTRL |= USB_EP_STALL_bm;
\r
488 /** Clears the STALL condition on the currently selected endpoint.
\r
490 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
492 static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
\r
493 static inline void Endpoint_ClearStall(void)
\r
495 USB_Endpoint_SelectedHandle->CTRL &= ~USB_EP_STALL_bm;
\r
498 /** Determines if the currently selected endpoint is stalled, false otherwise.
\r
500 * \ingroup Group_EndpointPacketManagement_XMEGA
\r
502 * \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.
\r
504 static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
505 static inline bool Endpoint_IsStalled(void)
\r
507 return ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_STALL_bm) ? true : false);
\r
510 /** Resets the data toggle of the currently selected endpoint. */
\r
511 static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
\r
512 static inline void Endpoint_ResetDataToggle(void)
\r
514 USB_Endpoint_SelectedHandle->STATUS &= ~USB_EP_TOGGLE_bm;
\r
517 /** Determines the currently selected endpoint's direction.
\r
519 * \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.
\r
521 static inline uint8_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
522 static inline uint8_t Endpoint_GetEndpointDirection(void)
\r
524 return (USB_Endpoint_SelectedEndpoint & ENDPOINT_DIR_IN);
\r
527 /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
\r
529 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
531 * \return Next byte in the currently selected endpoint's FIFO buffer.
\r
533 static inline uint8_t Endpoint_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
534 static inline uint8_t Endpoint_Read_8(void)
\r
536 return USB_Endpoint_SelectedFIFO->Data[USB_Endpoint_SelectedFIFO->Position++];
\r
539 /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
\r
541 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
543 * \param[in] Data Data to write into the the currently selected endpoint's FIFO buffer.
\r
545 static inline void Endpoint_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
\r
546 static inline void Endpoint_Write_8(const uint8_t Data)
\r
548 USB_Endpoint_SelectedFIFO->Data[USB_Endpoint_SelectedFIFO->Position++] = Data;
\r
551 /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
\r
553 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
555 static inline void Endpoint_Discard_8(void) ATTR_ALWAYS_INLINE;
\r
556 static inline void Endpoint_Discard_8(void)
\r
558 USB_Endpoint_SelectedFIFO->Position++;
\r
561 /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
\r
562 * direction endpoints.
\r
564 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
566 * \return Next two bytes in the currently selected endpoint's FIFO buffer.
\r
568 static inline uint16_t Endpoint_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
569 static inline uint16_t Endpoint_Read_16_LE(void)
\r
571 uint16_t Byte0 = Endpoint_Read_8();
\r
572 uint16_t Byte1 = Endpoint_Read_8();
\r
574 return ((Byte1 << 8) | Byte0);
\r
577 /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
\r
578 * direction endpoints.
\r
580 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
582 * \return Next two bytes in the currently selected endpoint's FIFO buffer.
\r
584 static inline uint16_t Endpoint_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
585 static inline uint16_t Endpoint_Read_16_BE(void)
\r
587 uint16_t Byte0 = Endpoint_Read_8();
\r
588 uint16_t Byte1 = Endpoint_Read_8();
\r
590 return ((Byte0 << 8) | Byte1);
\r
593 /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
\r
594 * direction endpoints.
\r
596 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
598 * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
\r
600 static inline void Endpoint_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
\r
601 static inline void Endpoint_Write_16_LE(const uint16_t Data)
\r
603 Endpoint_Write_8(Data & 0xFF);
\r
604 Endpoint_Write_8(Data >> 8);
\r
607 /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
\r
608 * direction endpoints.
\r
610 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
612 * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
\r
614 static inline void Endpoint_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
\r
615 static inline void Endpoint_Write_16_BE(const uint16_t Data)
\r
617 Endpoint_Write_8(Data >> 8);
\r
618 Endpoint_Write_8(Data & 0xFF);
\r
621 /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
\r
623 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
625 static inline void Endpoint_Discard_16(void) ATTR_ALWAYS_INLINE;
\r
626 static inline void Endpoint_Discard_16(void)
\r
628 Endpoint_Discard_8();
\r
629 Endpoint_Discard_8();
\r
632 /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
\r
633 * direction endpoints.
\r
635 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
637 * \return Next four bytes in the currently selected endpoint's FIFO buffer.
\r
639 static inline uint32_t Endpoint_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
640 static inline uint32_t Endpoint_Read_32_LE(void)
\r
642 uint32_t Byte0 = Endpoint_Read_8();
\r
643 uint32_t Byte1 = Endpoint_Read_8();
\r
644 uint32_t Byte2 = Endpoint_Read_8();
\r
645 uint32_t Byte3 = Endpoint_Read_8();
\r
647 return ((Byte3 << 24) | (Byte2 << 16) | (Byte1 << 8) | Byte0);
\r
650 /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
\r
651 * direction endpoints.
\r
653 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
655 * \return Next four bytes in the currently selected endpoint's FIFO buffer.
\r
657 static inline uint32_t Endpoint_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
\r
658 static inline uint32_t Endpoint_Read_32_BE(void)
\r
660 uint32_t Byte0 = Endpoint_Read_8();
\r
661 uint32_t Byte1 = Endpoint_Read_8();
\r
662 uint32_t Byte2 = Endpoint_Read_8();
\r
663 uint32_t Byte3 = Endpoint_Read_8();
\r
665 return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
\r
668 /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
\r
669 * direction endpoints.
\r
671 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
673 * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
\r
675 static inline void Endpoint_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
\r
676 static inline void Endpoint_Write_32_LE(const uint32_t Data)
\r
678 Endpoint_Write_8(Data & 0xFF);
\r
679 Endpoint_Write_8(Data >> 8);
\r
680 Endpoint_Write_8(Data >> 16);
\r
681 Endpoint_Write_8(Data >> 24);
\r
684 /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
\r
685 * direction endpoints.
\r
687 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
689 * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
\r
691 static inline void Endpoint_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
\r
692 static inline void Endpoint_Write_32_BE(const uint32_t Data)
\r
694 Endpoint_Write_8(Data >> 24);
\r
695 Endpoint_Write_8(Data >> 16);
\r
696 Endpoint_Write_8(Data >> 8);
\r
697 Endpoint_Write_8(Data & 0xFF);
\r
700 /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
\r
702 * \ingroup Group_EndpointPrimitiveRW_XMEGA
\r
704 static inline void Endpoint_Discard_32(void) ATTR_ALWAYS_INLINE;
\r
705 static inline void Endpoint_Discard_32(void)
\r
707 Endpoint_Discard_8();
\r
708 Endpoint_Discard_8();
\r
709 Endpoint_Discard_8();
\r
710 Endpoint_Discard_8();
\r
713 /* External Variables: */
\r
714 /** Global indicating the maximum packet size of the default control endpoint located at address
\r
715 * 0 in the device. This value is set to the value indicated in the device descriptor in the user
\r
716 * project once the USB interface is initialized into device mode.
\r
718 * If space is an issue, it is possible to fix this to a static value by defining the control
\r
719 * endpoint size in the \c FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
\r
720 * via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
\r
721 * read from the descriptors at runtime and instead fixed to the given value. When used, it is
\r
722 * important that the descriptor control endpoint size value matches the size given as the
\r
723 * \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
\r
724 * be used in the device descriptors to ensure this.
\r
726 * \attention This variable should be treated as read-only in the user application, and never manually
\r
727 * changed in value.
\r
729 #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
\r
730 extern uint8_t USB_Device_ControlEndpointSize;
\r
732 #define USB_Device_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
\r
735 /* Function Prototypes: */
\r
736 /** Configures a table of endpoint descriptions, in sequence. This function can be used to configure multiple
\r
737 * endpoints at the same time.
\r
739 * \note Endpoints with a zero address will be ignored, thus this function cannot be used to configure the
\r
740 * control endpoint.
\r
742 * \param[in] Table Pointer to a table of endpoint descriptions.
\r
743 * \param[in] Entries Number of entries in the endpoint table to configure.
\r
745 * \return Boolean \c true if all endpoints configured successfully, \c false otherwise.
\r
747 bool Endpoint_ConfigureEndpointTable(const USB_Endpoint_Table_t* const Table,
\r
748 const uint8_t Entries);
\r
750 /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
\r
751 * with respect to the data direction. This is a convenience function which can be used to
\r
752 * simplify user control request handling.
\r
754 * \note This routine should not be called on non CONTROL type endpoints.
\r
756 void Endpoint_ClearStatusStage(void);
\r
758 /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
\r
759 * to be read or written to it.
\r
761 * \note This routine should not be called on CONTROL type endpoints.
\r
763 * \ingroup Group_EndpointRW_XMEGA
\r
765 * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
\r
767 uint8_t Endpoint_WaitUntilReady(void);
\r
769 /* Disable C linkage for C++ Compilers: */
\r
770 #if defined(__cplusplus)
\r