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