projects / pub / lufa.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Fix build error in TestApp demo caused by previous commit.
[pub/lufa.git] / LUFA / Drivers / USB / LowLevel / Endpoint.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2009.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, and distribute this software
13 and its documentation for any purpose and without fee is hereby
14 granted, provided that the above copyright notice appear in all
15 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 /** \ingroup Group_USB
32 * @defgroup Group_EndpointManagement Endpoint Management
33 *
34 * Functions, macros and enums related to endpoint management when in USB Device mode. This
35 * module contains the endpoint management macros, as well as endpoint interrupt and data
36 * send/recieve functions for various data types.
37 *
38 * @{
39 */
40
41 /** @defgroup Group_EndpointRW Endpoint Data Reading and Writing
42 *
43 * Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
44 */
45
46 /** \ingroup Group_EndpointRW
47 * @defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types
48 *
49 * Functions, macros, variables, enums and types related to data reading and writing of primitive data types
50 * from and to endpoints.
51 */
52
53 /** \ingroup Group_EndpointRW
54 * @defgroup Group_EndpointStreamRW Read/Write of Multi-Byte Streams
55 *
56 * Functions, macros, variables, enums and types related to data reading and writing of data streams from
57 * and to endpoints.
58 */
59
60 /** @defgroup Group_EndpointPacketManagement Endpoint Packet Management
61 *
62 * Functions, macros, variables, enums and types related to packet management of endpoints.
63 */
64
65 #ifndef __ENDPOINT_H__
66 #define __ENDPOINT_H__
67
68 /* Includes: */
69 #include <avr/io.h>
70 #include <avr/pgmspace.h>
71 #include <avr/eeprom.h>
72 #include <stdbool.h>
73
74 #include "../../../Common/Common.h"
75 #include "../HighLevel/USBTask.h"
76
77 #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
78 #include "../HighLevel/StreamCallbacks.h"
79 #endif
80
81 /* Enable C linkage for C++ Compilers: */
82 #if defined(__cplusplus)
83 extern "C" {
84 #endif
85
86 /* Public Interface - May be used in end-application: */
87 /* Macros: */
88 /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
89 * should be initialized in the OUT direction - i.e. data flows from host to device.
90 */
91 #define ENDPOINT_DIR_OUT (0 << EPDIR)
92
93 /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
94 * should be initialized in the IN direction - i.e. data flows from device to host.
95 */
96 #define ENDPOINT_DIR_IN (1 << EPDIR)
97
98 /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
99 * that the endpoint should have one single bank, which requires less USB FIFO memory but results
100 * in slower transfers as only one USB device (the AVR or the host) can access the endpoint's
101 * bank at the one time.
102 */
103 #define ENDPOINT_BANK_SINGLE (0 << EPBK0)
104
105 /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
106 * that the endpoint should have two banks, which requires more USB FIFO memory but results
107 * in faster transfers as one USB device (the AVR or the host) can access one bank while the other
108 * accesses the second bank.
109 */
110 #define ENDPOINT_BANK_DOUBLE (1 << EPBK0)
111
112 /** Endpoint address for the default control endpoint, which always resides in address 0. This is
113 * defined for convenience to give more readable code when used with the endpoint macros.
114 */
115 #define ENDPOINT_CONTROLEP 0
116
117 #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
118 /** Default size of the default control endpoint's bank, until altered by the Endpoint0Size value
119 * in the device descriptor. Not available if the FIXED_CONTROL_ENDPOINT_SIZE token is defined.
120 */
121 #define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8
122 #endif
123
124 /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
125 * numerical address in the device.
126 */
127 #define ENDPOINT_EPNUM_MASK 0x07
128
129 /** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's
130 * bank size in the device.
131 */
132 #define ENDPOINT_EPSIZE_MASK 0x7FF
133
134 /** Maximum size in bytes of a given endpoint.
135 *
136 * \param[in] n Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
137 */
138 #define ENDPOINT_MAX_SIZE(n) _ENDPOINT_GET_MAXSIZE(n)
139
140 /** Indicates if the given endpoint supports double banking.
141 *
142 * \param[in] n Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
143 */
144 #define ENDPOINT_DOUBLEBANK_SUPPORTED(n) _ENDPOINT_GET_DOUBLEBANK(n)
145
146 #if !defined(CONTROL_ONLY_DEVICE)
147 #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
148 /** Total number of endpoints (including the default control endpoint at address 0) which may
149 * be used in the device. Different USB AVR models support different amounts of endpoints,
150 * this value reflects the maximum number of endpoints for the currently selected AVR model.
151 */
152 #define ENDPOINT_TOTAL_ENDPOINTS 7
153 #else
154 #define ENDPOINT_TOTAL_ENDPOINTS 5
155 #endif
156 #else
157 #define ENDPOINT_TOTAL_ENDPOINTS 1
158 #endif
159
160 /* Pseudo-Function Macros: */
161 #if defined(__DOXYGEN__)
162 /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
163 *
164 * \note The return width of this function may differ, depending on the maximum endpoint bank size
165 * of the selected AVR model.
166 *
167 * \ingroup Group_EndpointRW
168 *
169 * \return Total number of bytes in the currently selected Endpoint's FIFO buffer
170 */
171 static inline uint16_t Endpoint_BytesInEndpoint(void);
172
173 /** Get the endpoint address of the currently selected endpoint. This is typically used to save
174 * the currently selected endpoint number so that it can be restored after another endpoint has
175 * been manipulated.
176 *
177 * \return Index of the currently selected endpoint
178 */
179 static inline uint8_t Endpoint_GetCurrentEndpoint(void);
180
181 /** Selects the given endpoint number. If the address from the device descriptors is used, the
182 * value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
183 * number (and discarding the endpoint direction bit).
184 *
185 * Any endpoint operations which do not require the endpoint number to be indicated will operate on
186 * the currently selected endpoint.
187 *
188 * \param[in] EndpointNumber Endpoint number to select
189 */
190 static inline void Endpoint_SelectEndpoint(uint8_t EndpointNumber);
191
192 /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
193 * In and Out pointers to the bank's contents.
194 *
195 * \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset
196 */
197 static inline void Endpoint_ResetFIFO(uint8_t EndpointNumber);
198
199 /** Enables the currently selected endpoint so that data can be sent and received through it to
200 * and from a host.
201 *
202 * \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
203 */
204 static inline void Endpoint_EnableEndpoint(void);
205
206 /** Disables the currently selected endpoint so that data cannot be sent and received through it
207 * to and from a host.
208 */
209 static inline void Endpoint_DisableEndpoint(void);
210
211 /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
212 *
213 * \return Boolean True if the currently selected endpoint is enabled, false otherwise
214 */
215 static inline bool Endpoint_IsEnabled(void);
216
217 /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
218 * bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
219 * direction). This function will return false if an error has occurred in the endpoint, if the endpoint
220 * is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
221 * direction and the endpoint bank is full.
222 *
223 * \ingroup Group_EndpointPacketManagement
224 *
225 * \return Boolean true if the currently selected endpoint may be read from or written to, depending on its direction
226 */
227 static inline bool Endpoint_IsReadWriteAllowed(void);
228
229 /** Determines if the currently selected endpoint is configured.
230 *
231 * \return Boolean true if the currently selected endpoint has been configured, false otherwise
232 */
233 static inline bool Endpoint_IsConfigured(void);
234
235 /** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
236 * interrupt duration has elapsed. Which endpoints have interrupted can be determined by
237 * masking the return value against (1 << {Endpoint Number}).
238 *
239 * \return Mask whose bits indicate which endpoints have interrupted
240 */
241 static inline uint8_t Endpoint_GetEndpointInterrupts(void);
242
243 /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
244 * endpoints).
245 *
246 * \param[in] EndpointNumber Index of the endpoint whose interrupt flag should be tested
247 *
248 * \return Boolean true if the specified endpoint has interrupted, false otherwise
249 */
250 static inline bool Endpoint_HasEndpointInterrupted(uint8_t EndpointNumber);
251
252 /** Determines if the selected IN endpoint is ready for a new packet.
253 *
254 * \ingroup Group_EndpointPacketManagement
255 *
256 * \return Boolean true if the current endpoint is ready for an IN packet, false otherwise.
257 */
258 static inline bool Endpoint_IsINReady(void);
259
260 /** Determines if the selected OUT endpoint has received new packet.
261 *
262 * \ingroup Group_EndpointPacketManagement
263 *
264 * \return Boolean true if current endpoint is has received an OUT packet, false otherwise.
265 */
266 static inline bool Endpoint_IsOUTReceived(void);
267
268 /** Determines if the current CONTROL type endpoint has received a SETUP packet.
269 *
270 * \ingroup Group_EndpointPacketManagement
271 *
272 * \return Boolean true if the selected endpoint has received a SETUP packet, false otherwise.
273 */
274 static inline bool Endpoint_IsSETUPReceived(void);
275
276 /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
277 * endpoint for the next packet.
278 *
279 * \ingroup Group_EndpointPacketManagement
280 *
281 * \note This is not applicable for non CONTROL type endpoints.
282 */
283 static inline void Endpoint_ClearSETUP(void);
284
285 /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
286 * next packet and switching to the alternative endpoint bank if double banked.
287 *
288 * \ingroup Group_EndpointPacketManagement
289 */
290 static inline void Endpoint_ClearIN(void);
291
292 /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
293 * for the next packet and switching to the alternative endpoint bank if double banked.
294 *
295 * \ingroup Group_EndpointPacketManagement
296 */
297 static inline void Endpoint_ClearOUT(void);
298
299 /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
300 * indicated endpoint and that the current transfer sequence should be aborted. This provides a
301 * way for devices to indicate invalid commands to the host so that the current transfer can be
302 * aborted and the host can begin its own recovery sequence.
303 *
304 * The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
305 * is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
306 * endpoint.
307 *
308 * \ingroup Group_EndpointPacketManagement
309 */
310 static inline void Endpoint_StallTransaction(void);
311
312 /** Clears the STALL condition on the currently selected endpoint.
313 *
314 * \ingroup Group_EndpointPacketManagement
315 */
316 static inline void Endpoint_ClearStall(void);
317
318 /** Determines if the currently selected endpoint is stalled, false otherwise.
319 *
320 * \ingroup Group_EndpointPacketManagement
321 *
322 * \return Boolean true if the currently selected endpoint is stalled, false otherwise
323 */
324 static inline bool Endpoint_IsStalled(void);
325
326 /** Resets the data toggle of the currently selected endpoint. */
327 static inline void Endpoint_ResetDataToggle(void);
328
329 /** Determines the currently selected endpoint's direction.
330 *
331 * \return The currently selected endpoint's direction, as a ENDPOINT_DIR_* mask.
332 */
333 static inline uint8_t Endpoint_GetEndpointDirection(void);
334 #else
335 #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
336 #define Endpoint_BytesInEndpoint() UEBCX
337 #else
338 #define Endpoint_BytesInEndpoint() UEBCLX
339 #endif
340
341 #if !defined(CONTROL_ONLY_DEVICE)
342 #define Endpoint_GetCurrentEndpoint() (UENUM & ENDPOINT_EPNUM_MASK)
343 #else
344 #define Endpoint_GetCurrentEndpoint() ENDPOINT_CONTROLEP
345 #endif
346
347 #if !defined(CONTROL_ONLY_DEVICE)
348 #define Endpoint_SelectEndpoint(epnum) MACROS{ UENUM = epnum; }MACROE
349 #else
350 #define Endpoint_SelectEndpoint(epnum) (void)epnum
351 #endif
352
353 #define Endpoint_ResetFIFO(epnum) MACROS{ UERST = (1 << epnum); UERST = 0; }MACROE
354
355 #define Endpoint_EnableEndpoint() MACROS{ UECONX |= (1 << EPEN); }MACROE
356
357 #define Endpoint_DisableEndpoint() MACROS{ UECONX &= ~(1 << EPEN); }MACROE
358
359 #define Endpoint_IsEnabled() ((UECONX & (1 << EPEN)) ? true : false)
360
361 #if !defined(CONTROL_ONLY_DEVICE)
362 #define Endpoint_IsReadWriteAllowed() ((UEINTX & (1 << RWAL)) ? true : false)
363 #endif
364
365 #define Endpoint_IsConfigured() ((UESTA0X & (1 << CFGOK)) ? true : false)
366
367 #define Endpoint_GetEndpointInterrupts() UEINT
368
369 #define Endpoint_HasEndpointInterrupted(n) ((UEINT & (1 << n)) ? true : false)
370
371 #define Endpoint_IsINReady() ((UEINTX & (1 << TXINI)) ? true : false)
372
373 #define Endpoint_IsOUTReceived() ((UEINTX & (1 << RXOUTI)) ? true : false)
374
375 #define Endpoint_IsSETUPReceived() ((UEINTX & (1 << RXSTPI)) ? true : false)
376
377 #define Endpoint_ClearSETUP() MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE
378
379 #if !defined(CONTROL_ONLY_DEVICE)
380 #define Endpoint_ClearIN() MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << TXINI)); \
381 UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
382 #else
383 #define Endpoint_ClearIN() MACROS{ UEINTX &= ~(1 << TXINI); }MACROE
384 #endif
385
386 #if !defined(CONTROL_ONLY_DEVICE)
387 #define Endpoint_ClearOUT() MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << RXOUTI)); \
388 UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
389 #else
390 #define Endpoint_ClearOUT() MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE
391 #endif
392
393 #define Endpoint_StallTransaction() MACROS{ UECONX |= (1 << STALLRQ); }MACROE
394
395 #define Endpoint_ClearStall() MACROS{ UECONX |= (1 << STALLRQC); }MACROE
396
397 #define Endpoint_IsStalled() ((UECONX & (1 << STALLRQ)) ? true : false)
398
399 #define Endpoint_ResetDataToggle() MACROS{ UECONX |= (1 << RSTDT); }MACROE
400
401 #define Endpoint_GetEndpointDirection() (UECFG0X & ENDPOINT_DIR_IN)
402 #endif
403
404 /* Enums: */
405 /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
406 *
407 * \ingroup Group_EndpointRW
408 */
409 enum Endpoint_WaitUntilReady_ErrorCodes_t
410 {
411 ENDPOINT_READYWAIT_NoError = 0, /**< Endpoint is ready for next packet, no error. */
412 ENDPOINT_READYWAIT_EndpointStalled = 1, /**< The endpoint was stalled during the stream
413 * transfer by the host or device.
414 */
415 ENDPOINT_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while
416 * waiting for the endpoint to become ready.
417 */
418 ENDPOINT_READYWAIT_Timeout = 3, /**< The host failed to accept or send the next packet
419 * within the software timeout period set by the
420 * \ref USB_STREAM_TIMEOUT_MS macro.
421 */
422 };
423
424 /** Enum for the possible error return codes of the Endpoint_*_Stream_* functions.
425 *
426 * \ingroup Group_EndpointStreamRW
427 */
428 enum Endpoint_Stream_RW_ErrorCodes_t
429 {
430 ENDPOINT_RWSTREAM_NoError = 0, /**< Command completed successfully, no error. */
431 ENDPOINT_RWSTREAM_EndpointStalled = 1, /**< The endpoint was stalled during the stream
432 * transfer by the host or device.
433 */
434 ENDPOINT_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
435 * the transfer.
436 */
437 ENDPOINT_RWSTREAM_Timeout = 3, /**< The host failed to accept or send the next packet
438 * within the software timeout period set by the
439 * \ref USB_STREAM_TIMEOUT_MS macro.
440 */
441 ENDPOINT_RWSTREAM_CallbackAborted = 4, /**< Indicates that the stream's callback function
442 * aborted the transfer early.
443 */
444 };
445
446 /** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..
447 *
448 * \ingroup Group_EndpointStreamRW
449 */
450 enum Endpoint_ControlStream_RW_ErrorCodes_t
451 {
452 ENDPOINT_RWCSTREAM_NoError = 0, /**< Command completed successfully, no error. */
453 ENDPOINT_RWCSTREAM_HostAborted = 1, /**< The aborted the transfer prematurely. */
454 ENDPOINT_RWCSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
455 * the transfer.
456 */
457 };
458
459 /* Inline Functions: */
460 /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
461 *
462 * \ingroup Group_EndpointPrimitiveRW
463 *
464 * \return Next byte in the currently selected endpoint's FIFO buffer
465 */
466 static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
467 static inline uint8_t Endpoint_Read_Byte(void)
468 {
469 return UEDATX;
470 }
471
472 /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
473 *
474 * \ingroup Group_EndpointPrimitiveRW
475 *
476 * \param[in] Byte Next byte to write into the the currently selected endpoint's FIFO buffer
477 */
478 static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
479 static inline void Endpoint_Write_Byte(const uint8_t Byte)
480 {
481 UEDATX = Byte;
482 }
483
484 /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
485 *
486 * \ingroup Group_EndpointPrimitiveRW
487 */
488 static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
489 static inline void Endpoint_Discard_Byte(void)
490 {
491 uint8_t Dummy;
492
493 Dummy = UEDATX;
494 }
495
496 /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
497 * direction endpoints.
498 *
499 * \ingroup Group_EndpointPrimitiveRW
500 *
501 * \return Next word in the currently selected endpoint's FIFO buffer
502 */
503 static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
504 static inline uint16_t Endpoint_Read_Word_LE(void)
505 {
506 uint16_t Data;
507
508 Data = UEDATX;
509 Data |= (((uint16_t)UEDATX) << 8);
510
511 return Data;
512 }
513
514 /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
515 * direction endpoints.
516 *
517 * \ingroup Group_EndpointPrimitiveRW
518 *
519 * \return Next word in the currently selected endpoint's FIFO buffer
520 */
521 static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
522 static inline uint16_t Endpoint_Read_Word_BE(void)
523 {
524 uint16_t Data;
525
526 Data = (((uint16_t)UEDATX) << 8);
527 Data |= UEDATX;
528
529 return Data;
530 }
531
532 /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
533 * direction endpoints.
534 *
535 * \ingroup Group_EndpointPrimitiveRW
536 *
537 * \param[in] Word Next word to write to the currently selected endpoint's FIFO buffer
538 */
539 static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
540 static inline void Endpoint_Write_Word_LE(const uint16_t Word)
541 {
542 UEDATX = (Word & 0xFF);
543 UEDATX = (Word >> 8);
544 }
545
546 /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
547 * direction endpoints.
548 *
549 * \ingroup Group_EndpointPrimitiveRW
550 *
551 * \param[in] Word Next word to write to the currently selected endpoint's FIFO buffer
552 */
553 static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
554 static inline void Endpoint_Write_Word_BE(const uint16_t Word)
555 {
556 UEDATX = (Word >> 8);
557 UEDATX = (Word & 0xFF);
558 }
559
560 /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
561 *
562 * \ingroup Group_EndpointPrimitiveRW
563 */
564 static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
565 static inline void Endpoint_Discard_Word(void)
566 {
567 uint8_t Dummy;
568
569 Dummy = UEDATX;
570 Dummy = UEDATX;
571 }
572
573 /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
574 * direction endpoints.
575 *
576 * \ingroup Group_EndpointPrimitiveRW
577 *
578 * \return Next double word in the currently selected endpoint's FIFO buffer
579 */
580 static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
581 static inline uint32_t Endpoint_Read_DWord_LE(void)
582 {
583 union
584 {
585 uint32_t DWord;
586 uint8_t Bytes[4];
587 } Data;
588
589 Data.Bytes[0] = UEDATX;
590 Data.Bytes[1] = UEDATX;
591 Data.Bytes[2] = UEDATX;
592 Data.Bytes[3] = UEDATX;
593
594 return Data.DWord;
595 }
596
597 /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
598 * direction endpoints.
599 *
600 * \ingroup Group_EndpointPrimitiveRW
601 *
602 * \return Next double word in the currently selected endpoint's FIFO buffer
603 */
604 static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
605 static inline uint32_t Endpoint_Read_DWord_BE(void)
606 {
607 union
608 {
609 uint32_t DWord;
610 uint8_t Bytes[4];
611 } Data;
612
613 Data.Bytes[3] = UEDATX;
614 Data.Bytes[2] = UEDATX;
615 Data.Bytes[1] = UEDATX;
616 Data.Bytes[0] = UEDATX;
617
618 return Data.DWord;
619 }
620
621 /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
622 * direction endpoints.
623 *
624 * \ingroup Group_EndpointPrimitiveRW
625 *
626 * \param[in] DWord Next double word to write to the currently selected endpoint's FIFO buffer
627 */
628 static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
629 static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
630 {
631 UEDATX = (DWord & 0xFF);
632 UEDATX = (DWord >> 8);
633 UEDATX = (DWord >> 16);
634 UEDATX = (DWord >> 24);
635 }
636
637 /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
638 * direction endpoints.
639 *
640 * \ingroup Group_EndpointPrimitiveRW
641 *
642 * \param[in] DWord Next double word to write to the currently selected endpoint's FIFO buffer
643 */
644 static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
645 static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
646 {
647 UEDATX = (DWord >> 24);
648 UEDATX = (DWord >> 16);
649 UEDATX = (DWord >> 8);
650 UEDATX = (DWord & 0xFF);
651 }
652
653 /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
654 *
655 * \ingroup Group_EndpointPrimitiveRW
656 */
657 static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
658 static inline void Endpoint_Discard_DWord(void)
659 {
660 uint8_t Dummy;
661
662 Dummy = UEDATX;
663 Dummy = UEDATX;
664 Dummy = UEDATX;
665 Dummy = UEDATX;
666 }
667
668 /* External Variables: */
669 /** Global indicating the maximum packet size of the default control endpoint located at address
670 * 0 in the device. This value is set to the value indicated in the device descriptor in the user
671 * project once the USB interface is initialized into device mode.
672 *
673 * If space is an issue, it is possible to fix this to a static value by defining the control
674 * endpoint size in the FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
675 * via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
676 * read from the descriptors at runtime and instead fixed to the given value. When used, it is
677 * important that the descriptor control endpoint size value matches the size given as the
678 * FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the FIXED_CONTROL_ENDPOINT_SIZE token
679 * be used in the descriptors to ensure this.
680 *
681 * \note This variable should be treated as read-only in the user application, and never manually
682 * changed in value.
683 */
684 #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
685 extern uint8_t USB_ControlEndpointSize;
686 #else
687 #define USB_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
688 #endif
689
690 /* Function Prototypes: */
691 #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
692 #define _CALLBACK_PARAM , StreamCallbackPtr_t Callback
693 #else
694 #define _CALLBACK_PARAM
695 #endif
696
697 /** Configures the specified endpoint number with the given endpoint type, direction, bank size
698 * and banking mode. Endpoints should be allocated in ascending order by their address in the
699 * device (i.e. endpoint 1 should be configured before endpoint 2 and so on) to prevent fragmentation
700 * of the USB FIFO memory.
701 *
702 * The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction
703 * may be either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
704 *
705 * The bank size must indicate the maximum packet size that the endpoint can handle. Different
706 * endpoint numbers can handle different maximum packet sizes - refer to the chosen USB AVR's
707 * datasheet to determine the maximum bank size for each endpoint.
708 *
709 * The banking mode may be either \ref ENDPOINT_BANK_SINGLE or \ref ENDPOINT_BANK_DOUBLE.
710 *
711 * \note The default control endpoint does not have to be manually configured, as it is automatically
712 * configured by the library internally.
713 *
714 * \note This routine will select the specified endpoint, and the endpoint will remain selected
715 * once the routine completes regardless of if the endpoint configuration succeeds.
716 *
717 * \return Boolean true if the configuration succeeded, false otherwise
718 */
719 bool Endpoint_ConfigureEndpoint(const uint8_t Number, const uint8_t Type, const uint8_t Direction,
720 const uint16_t Size, const uint8_t Banks);
721
722 /** Spinloops until the currently selected non-control endpoint is ready for the next packet of data
723 * to be read or written to it.
724 *
725 * \note This routine should not be called on CONTROL type endpoints.
726 *
727 * \ingroup Group_EndpointRW
728 *
729 * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
730 */
731 uint8_t Endpoint_WaitUntilReady(void);
732
733 /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
734 * with respect to the data direction. This is a convenience function which can be used to
735 * simplify user control request handling.
736 */
737 void Endpoint_ClearStatusStage(void);
738
739 /** Reads and discards the given number of bytes from the endpoint from the given buffer,
740 * discarding fully read packets from the host as needed. The last packet is not automatically
741 * discarded once the remaining bytes has been read; the user is responsible for manually
742 * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
743 * each USB packet, the given stream callback function is executed repeatedly until the next
744 * packet is ready, allowing for early aborts of stream transfers.
745 *
746 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
747 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
748 * disabled and this function has the Callback parameter omitted.
749 *
750 * \note This routine should not be used on CONTROL type endpoints.
751 *
752 * \ingroup Group_EndpointStreamRW
753 *
754 * \param[in] Length Number of bytes to send via the currently selected endpoint.
755 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
756 *
757 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
758 */
759 uint8_t Endpoint_Discard_Stream(uint16_t Length _CALLBACK_PARAM);
760
761 /** Writes the given number of bytes to the endpoint from the given buffer in little endian,
762 * sending full packets to the host as needed. The last packet filled is not automatically sent;
763 * the user is responsible for manually sending the last written packet to the host via the
764 * \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
765 * is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
766 * aborts of stream transfers.
767 *
768 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
769 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
770 * disabled and this function has the Callback parameter omitted.
771 *
772 * \note This routine should not be used on CONTROL type endpoints.
773 *
774 * \ingroup Group_EndpointStreamRW
775 *
776 * \param[in] Buffer Pointer to the source data buffer to read from.
777 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
778 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
779 *
780 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
781 */
782 uint8_t Endpoint_Write_Stream_LE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
783
784 /** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE.
785 *
786 * \ingroup Group_EndpointStreamRW
787 *
788 * \param[in] Buffer Pointer to the source data buffer to read from.
789 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
790 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
791 *
792 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
793 */
794 uint8_t Endpoint_Write_EStream_LE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
795
796 /** FLASH buffer source version of \ref Endpoint_Write_Stream_LE.
797 *
798 * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
799 *
800 * \ingroup Group_EndpointStreamRW
801 *
802 * \param[in] Buffer Pointer to the source data buffer to read from.
803 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
804 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
805 *
806 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
807 */
808 uint8_t Endpoint_Write_PStream_LE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
809
810 /** Writes the given number of bytes to the endpoint from the given buffer in big endian,
811 * sending full packets to the host as needed. The last packet filled is not automatically sent;
812 * the user is responsible for manually sending the last written packet to the host via the
813 * \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
814 * is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
815 * aborts of stream transfers.
816 *
817 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
818 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
819 * disabled and this function has the Callback parameter omitted.
820 *
821 * \note This routine should not be used on CONTROL type endpoints.
822 *
823 * \ingroup Group_EndpointStreamRW
824 *
825 * \param[in] Buffer Pointer to the source data buffer to read from.
826 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
827 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
828 *
829 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
830 */
831 uint8_t Endpoint_Write_Stream_BE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
832
833 /** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE.
834 *
835 * \ingroup Group_EndpointStreamRW
836 *
837 * \param[in] Buffer Pointer to the source data buffer to read from.
838 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
839 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
840 *
841 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
842 */
843 uint8_t Endpoint_Write_EStream_BE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
844
845 /** FLASH buffer source version of \ref Endpoint_Write_Stream_BE.
846 *
847 * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
848 *
849 * \ingroup Group_EndpointStreamRW
850 *
851 * \param[in] Buffer Pointer to the source data buffer to read from.
852 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
853 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
854 *
855 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
856 */
857 uint8_t Endpoint_Write_PStream_BE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
858
859 /** Reads the given number of bytes from the endpoint from the given buffer in little endian,
860 * discarding fully read packets from the host as needed. The last packet is not automatically
861 * discarded once the remaining bytes has been read; the user is responsible for manually
862 * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
863 * each USB packet, the given stream callback function is executed repeatedly until the endpoint
864 * is ready to accept the next packet, allowing for early aborts of stream transfers.
865 *
866 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
867 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
868 * disabled and this function has the Callback parameter omitted.
869 *
870 * \note This routine should not be used on CONTROL type endpoints.
871 *
872 * \ingroup Group_EndpointStreamRW
873 *
874 * \param[out] Buffer Pointer to the destination data buffer to write to.
875 * \param[in] Length Number of bytes to send via the currently selected endpoint.
876 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
877 *
878 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
879 */
880 uint8_t Endpoint_Read_Stream_LE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
881
882 /** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE.
883 *
884 * \ingroup Group_EndpointStreamRW
885 *
886 * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
887 * \param[in] Length Number of bytes to send via the currently selected endpoint.
888 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
889 *
890 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
891 */
892 uint8_t Endpoint_Read_EStream_LE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
893
894 /** Reads the given number of bytes from the endpoint from the given buffer in big endian,
895 * discarding fully read packets from the host as needed. The last packet is not automatically
896 * discarded once the remaining bytes has been read; the user is responsible for manually
897 * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
898 * each USB packet, the given stream callback function is executed repeatedly until the endpoint
899 * is ready to accept the next packet, allowing for early aborts of stream transfers.
900 *
901 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
902 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
903 * disabled and this function has the Callback parameter omitted.
904 *
905 * \note This routine should not be used on CONTROL type endpoints.
906 *
907 * \ingroup Group_EndpointStreamRW
908 *
909 * \param[out] Buffer Pointer to the destination data buffer to write to.
910 * \param[in] Length Number of bytes to send via the currently selected endpoint.
911 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
912 *
913 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
914 */
915 uint8_t Endpoint_Read_Stream_BE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
916
917 /** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE.
918 *
919 * \ingroup Group_EndpointStreamRW
920 *
921 * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
922 * \param[in] Length Number of bytes to send via the currently selected endpoint.
923 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
924 *
925 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
926 */
927 uint8_t Endpoint_Read_EStream_BE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
928
929 /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
930 * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
931 * in both failure and success states; the user is responsible for manually clearing the setup OUT to
932 * finalize the transfer via the \ref Endpoint_ClearOUT() macro.
933 *
934 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
935 * to clear the status stage when using this routine in a control transaction.
936 *
937 * \note This routine should only be used on CONTROL type endpoints.
938 *
939 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
940 * together; i.e. the entire stream data must be read or written at the one time.
941 *
942 * \ingroup Group_EndpointStreamRW
943 *
944 * \param[in] Buffer Pointer to the source data buffer to read from.
945 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
946 *
947 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
948 */
949 uint8_t Endpoint_Write_Control_Stream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
950
951 /** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.
952 *
953 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
954 * to clear the status stage when using this routine in a control transaction.
955 *
956 * \note This routine should only be used on CONTROL type endpoints.
957 *
958 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
959 * together; i.e. the entire stream data must be read or written at the one time.
960 *
961 * \ingroup Group_EndpointStreamRW
962 *
963 * \param[in] Buffer Pointer to the source data buffer to read from.
964 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
965 *
966 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
967 */
968 uint8_t Endpoint_Write_Control_EStream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
969
970 /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_LE.
971 *
972 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
973 * to clear the status stage when using this routine in a control transaction.
974 *
975 * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
976 *
977 * \note This routine should only be used on CONTROL type endpoints.
978 *
979 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
980 * together; i.e. the entire stream data must be read or written at the one time.
981 *
982 * \ingroup Group_EndpointStreamRW
983 *
984 * \param[in] Buffer Pointer to the source data buffer to read from.
985 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
986 *
987 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
988 */
989 uint8_t Endpoint_Write_Control_PStream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
990
991 /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
992 * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
993 * in both failure and success states; the user is responsible for manually clearing the setup OUT to
994 * finalize the transfer via the \ref Endpoint_ClearOUT() macro.
995 *
996 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
997 * to clear the status stage when using this routine in a control transaction.
998 *
999 * \note This routine should only be used on CONTROL type endpoints.
1000 *
1001 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1002 * together; i.e. the entire stream data must be read or written at the one time.
1003 *
1004 * \ingroup Group_EndpointStreamRW
1005 *
1006 * \param[in] Buffer Pointer to the source data buffer to read from.
1007 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
1008 *
1009 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1010 */
1011 uint8_t Endpoint_Write_Control_Stream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1012
1013 /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE.
1014 *
1015 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1016 * to clear the status stage when using this routine in a control transaction.
1017 *
1018 * \note This routine should only be used on CONTROL type endpoints.
1019 *
1020 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1021 * together; i.e. the entire stream data must be read or written at the one time.
1022 *
1023 * \ingroup Group_EndpointStreamRW
1024 *
1025 * \param[in] Buffer Pointer to the source data buffer to read from.
1026 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
1027 *
1028 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1029 */
1030 uint8_t Endpoint_Write_Control_EStream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1031
1032 /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_BE.
1033 *
1034 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1035 * to clear the status stage when using this routine in a control transaction.
1036 *
1037 * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
1038 *
1039 * \note This routine should only be used on CONTROL type endpoints.
1040 *
1041 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1042 * together; i.e. the entire stream data must be read or written at the one time.
1043 *
1044 * \ingroup Group_EndpointStreamRW
1045 *
1046 * \param[in] Buffer Pointer to the source data buffer to read from.
1047 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
1048 *
1049 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1050 */
1051 uint8_t Endpoint_Write_Control_PStream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1052
1053 /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
1054 * discarding fully read packets from the host as needed. The device IN acknowledgement is not
1055 * automatically sent after success or failure states; the user is responsible for manually sending the
1056 * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
1057 *
1058 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1059 * to clear the status stage when using this routine in a control transaction.
1060 *
1061 * \note This routine should only be used on CONTROL type endpoints.
1062 *
1063 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1064 * together; i.e. the entire stream data must be read or written at the one time.
1065 *
1066 * \ingroup Group_EndpointStreamRW
1067 *
1068 * \param[out] Buffer Pointer to the destination data buffer to write to.
1069 * \param[in] Length Number of bytes to send via the currently selected endpoint.
1070 *
1071 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1072 */
1073 uint8_t Endpoint_Read_Control_Stream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1074
1075 /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE.
1076 *
1077 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1078 * to clear the status stage when using this routine in a control transaction.
1079 *
1080 * \note This routine should only be used on CONTROL type endpoints.
1081 *
1082 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1083 * together; i.e. the entire stream data must be read or written at the one time.
1084 *
1085 * \ingroup Group_EndpointStreamRW
1086 *
1087 * \param[out] Buffer Pointer to the destination data buffer to write to.
1088 * \param[in] Length Number of bytes to send via the currently selected endpoint.
1089 *
1090 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1091 */
1092 uint8_t Endpoint_Read_Control_EStream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1093
1094 /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
1095 * discarding fully read packets from the host as needed. The device IN acknowledgement is not
1096 * automatically sent after success or failure states; the user is responsible for manually sending the
1097 * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
1098 *
1099 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1100 * to clear the status stage when using this routine in a control transaction.
1101 *
1102 * \note This routine should only be used on CONTROL type endpoints.
1103 *
1104 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1105 * together; i.e. the entire stream data must be read or written at the one time.
1106 *
1107 * \ingroup Group_EndpointStreamRW
1108 *
1109 * \param[out] Buffer Pointer to the destination data buffer to write to.
1110 * \param[in] Length Number of bytes to send via the currently selected endpoint.
1111 *
1112 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1113 */
1114 uint8_t Endpoint_Read_Control_Stream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1115
1116 /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE.
1117 *
1118 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1119 * to clear the status stage when using this routine in a control transaction.
1120 *
1121 * \note This routine should only be used on CONTROL type endpoints.
1122 *
1123 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1124 * together; i.e. the entire stream data must be read or written at the one time.
1125 *
1126 * \ingroup Group_EndpointStreamRW
1127 *
1128 * \param[out] Buffer Pointer to the destination data buffer to write to.
1129 * \param[in] Length Number of bytes to send via the currently selected endpoint.
1130 *
1131 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1132 */
1133 uint8_t Endpoint_Read_Control_EStream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1134
1135 /* Private Interface - For use in library only: */
1136 #if !defined(__DOXYGEN__)
1137 /* Macros: */
1138 #define Endpoint_AllocateMemory() MACROS{ UECFG1X |= (1 << ALLOC); }MACROE
1139 #define Endpoint_DeallocateMemory() MACROS{ UECFG1X &= ~(1 << ALLOC); }MACROE
1140
1141 #define _ENDPOINT_GET_MAXSIZE(n) _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## n)
1142 #define _ENDPOINT_GET_MAXSIZE2(details) _ENDPOINT_GET_MAXSIZE3(details)
1143 #define _ENDPOINT_GET_MAXSIZE3(maxsize, db) maxsize
1144
1145 #define _ENDPOINT_GET_DOUBLEBANK(n) _ENDPOINT_GET_DOUBLEBANK2(ENDPOINT_DETAILS_EP ## n)
1146 #define _ENDPOINT_GET_DOUBLEBANK2(details) _ENDPOINT_GET_DOUBLEBANK3(details)
1147 #define _ENDPOINT_GET_DOUBLEBANK3(maxsize, db) db
1148
1149 #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
1150 #define ENDPOINT_DETAILS_EP0 64, true
1151 #define ENDPOINT_DETAILS_EP1 256, true
1152 #define ENDPOINT_DETAILS_EP2 64, true
1153 #define ENDPOINT_DETAILS_EP3 64, true
1154 #define ENDPOINT_DETAILS_EP4 64, true
1155 #define ENDPOINT_DETAILS_EP5 64, true
1156 #define ENDPOINT_DETAILS_EP6 64, true
1157 #else
1158 #define ENDPOINT_DETAILS_EP0 64, true
1159 #define ENDPOINT_DETAILS_EP1 64, false
1160 #define ENDPOINT_DETAILS_EP2 64, false
1161 #define ENDPOINT_DETAILS_EP3 64, true
1162 #define ENDPOINT_DETAILS_EP4 64, true
1163 #endif
1164
1165 #define Endpoint_ConfigureEndpoint(Number, Type, Direction, Size, Banks) \
1166 Endpoint_ConfigureEndpoint_Prv(Number, \
1167 ((Type << EPTYPE0) | Direction), \
1168 ((1 << ALLOC) | Banks | \
1169 (__builtin_constant_p(Size) ? \
1170 Endpoint_BytesToEPSizeMask(Size) : \
1171 Endpoint_BytesToEPSizeMaskDynamic(Size))))
1172
1173 /* Function Prototypes: */
1174 void Endpoint_ClearEndpoints(void);
1175 uint8_t Endpoint_BytesToEPSizeMaskDynamic(const uint16_t Size);
1176 bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number, const uint8_t UECFG0XData, const uint8_t UECFG1XData);
1177
1178 /* Inline Functions: */
1179 static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
1180 static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
1181 {
1182 uint8_t MaskVal = 0;
1183 uint16_t CheckBytes = 8;
1184
1185 while (CheckBytes < Bytes)
1186 {
1187 MaskVal++;
1188 CheckBytes <<= 1;
1189 }
1190
1191 return (MaskVal << EPSIZE0);
1192 };
1193
1194 #endif
1195
1196 /* Disable C linkage for C++ Compilers: */
1197 #if defined(__cplusplus)
1198 }
1199 #endif
1200
1201 #endif
1202
1203 /** @} */
Lightweight USB Framework for AVRs