projects / pub / lufa.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Correct TeensyHID bootloader descriptors to use the correct revision code for the...
[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/receive 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
335 /** Sets the direction of the currently selected endpoint.
336 *
337 * \param[in] DirectionMask New endpoint direction, as a ENDPOINT_DIR_* mask.
338 */
339 static inline void Endpoint_SetEndpointDirection(uint8_t DirectionMask);
340 #else
341 #if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
342 #define Endpoint_BytesInEndpoint() UEBCX
343 #elif defined(USB_SERIES_4_AVR)
344 #define Endpoint_BytesInEndpoint() (((uint16_t)UEBCHX << 8) | UEBCLX)
345 #elif defined(USB_SERIES_2_AVR)
346 #define Endpoint_BytesInEndpoint() UEBCLX
347 #endif
348
349 #if !defined(CONTROL_ONLY_DEVICE)
350 #define Endpoint_GetCurrentEndpoint() (UENUM & ENDPOINT_EPNUM_MASK)
351 #else
352 #define Endpoint_GetCurrentEndpoint() ENDPOINT_CONTROLEP
353 #endif
354
355 #if !defined(CONTROL_ONLY_DEVICE)
356 #define Endpoint_SelectEndpoint(epnum) MACROS{ UENUM = (epnum); }MACROE
357 #else
358 #define Endpoint_SelectEndpoint(epnum) (void)(epnum)
359 #endif
360
361 #define Endpoint_ResetFIFO(epnum) MACROS{ UERST = (1 << (epnum)); UERST = 0; }MACROE
362
363 #define Endpoint_EnableEndpoint() MACROS{ UECONX |= (1 << EPEN); }MACROE
364
365 #define Endpoint_DisableEndpoint() MACROS{ UECONX &= ~(1 << EPEN); }MACROE
366
367 #define Endpoint_IsEnabled() ((UECONX & (1 << EPEN)) ? true : false)
368
369 #if !defined(CONTROL_ONLY_DEVICE)
370 #define Endpoint_IsReadWriteAllowed() ((UEINTX & (1 << RWAL)) ? true : false)
371 #endif
372
373 #define Endpoint_IsConfigured() ((UESTA0X & (1 << CFGOK)) ? true : false)
374
375 #define Endpoint_GetEndpointInterrupts() UEINT
376
377 #define Endpoint_HasEndpointInterrupted(n) ((UEINT & (1 << (n))) ? true : false)
378
379 #define Endpoint_IsINReady() ((UEINTX & (1 << TXINI)) ? true : false)
380
381 #define Endpoint_IsOUTReceived() ((UEINTX & (1 << RXOUTI)) ? true : false)
382
383 #define Endpoint_IsSETUPReceived() ((UEINTX & (1 << RXSTPI)) ? true : false)
384
385 #define Endpoint_ClearSETUP() MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE
386
387 #if !defined(CONTROL_ONLY_DEVICE)
388 #define Endpoint_ClearIN() MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << TXINI)); \
389 UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
390 #else
391 #define Endpoint_ClearIN() MACROS{ UEINTX &= ~(1 << TXINI); }MACROE
392 #endif
393
394 #if !defined(CONTROL_ONLY_DEVICE)
395 #define Endpoint_ClearOUT() MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << RXOUTI)); \
396 UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
397 #else
398 #define Endpoint_ClearOUT() MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE
399 #endif
400
401 #define Endpoint_StallTransaction() MACROS{ UECONX |= (1 << STALLRQ); }MACROE
402
403 #define Endpoint_ClearStall() MACROS{ UECONX |= (1 << STALLRQC); }MACROE
404
405 #define Endpoint_IsStalled() ((UECONX & (1 << STALLRQ)) ? true : false)
406
407 #define Endpoint_ResetDataToggle() MACROS{ UECONX |= (1 << RSTDT); }MACROE
408
409 #define Endpoint_GetEndpointDirection() (UECFG0X & ENDPOINT_DIR_IN)
410
411 #define Endpoint_SetEndpointDirection(dir) MACROS{ UECFG0X = ((UECFG0X & ~ENDPOINT_DIR_IN) | (dir)); }MACROE
412 #endif
413
414 /* Enums: */
415 /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
416 *
417 * \ingroup Group_EndpointRW
418 */
419 enum Endpoint_WaitUntilReady_ErrorCodes_t
420 {
421 ENDPOINT_READYWAIT_NoError = 0, /**< Endpoint is ready for next packet, no error. */
422 ENDPOINT_READYWAIT_EndpointStalled = 1, /**< The endpoint was stalled during the stream
423 * transfer by the host or device.
424 */
425 ENDPOINT_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while
426 * waiting for the endpoint to become ready.
427 */
428 ENDPOINT_READYWAIT_Timeout = 3, /**< The host failed to accept or send the next packet
429 * within the software timeout period set by the
430 * \ref USB_STREAM_TIMEOUT_MS macro.
431 */
432 };
433
434 /** Enum for the possible error return codes of the Endpoint_*_Stream_* functions.
435 *
436 * \ingroup Group_EndpointStreamRW
437 */
438 enum Endpoint_Stream_RW_ErrorCodes_t
439 {
440 ENDPOINT_RWSTREAM_NoError = 0, /**< Command completed successfully, no error. */
441 ENDPOINT_RWSTREAM_EndpointStalled = 1, /**< The endpoint was stalled during the stream
442 * transfer by the host or device.
443 */
444 ENDPOINT_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
445 * the transfer.
446 */
447 ENDPOINT_RWSTREAM_Timeout = 3, /**< The host failed to accept or send the next packet
448 * within the software timeout period set by the
449 * \ref USB_STREAM_TIMEOUT_MS macro.
450 */
451 ENDPOINT_RWSTREAM_CallbackAborted = 4, /**< Indicates that the stream's callback function
452 * aborted the transfer early.
453 */
454 };
455
456 /** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..
457 *
458 * \ingroup Group_EndpointStreamRW
459 */
460 enum Endpoint_ControlStream_RW_ErrorCodes_t
461 {
462 ENDPOINT_RWCSTREAM_NoError = 0, /**< Command completed successfully, no error. */
463 ENDPOINT_RWCSTREAM_HostAborted = 1, /**< The aborted the transfer prematurely. */
464 ENDPOINT_RWCSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
465 * the transfer.
466 */
467 };
468
469 /* Inline Functions: */
470 /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
471 *
472 * \ingroup Group_EndpointPrimitiveRW
473 *
474 * \return Next byte in the currently selected endpoint's FIFO buffer
475 */
476 static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
477 static inline uint8_t Endpoint_Read_Byte(void)
478 {
479 return UEDATX;
480 }
481
482 /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
483 *
484 * \ingroup Group_EndpointPrimitiveRW
485 *
486 * \param[in] Byte Next byte to write into the the currently selected endpoint's FIFO buffer
487 */
488 static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
489 static inline void Endpoint_Write_Byte(const uint8_t Byte)
490 {
491 UEDATX = Byte;
492 }
493
494 /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
495 *
496 * \ingroup Group_EndpointPrimitiveRW
497 */
498 static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
499 static inline void Endpoint_Discard_Byte(void)
500 {
501 uint8_t Dummy;
502
503 Dummy = UEDATX;
504 }
505
506 /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
507 * direction endpoints.
508 *
509 * \ingroup Group_EndpointPrimitiveRW
510 *
511 * \return Next word in the currently selected endpoint's FIFO buffer
512 */
513 static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
514 static inline uint16_t Endpoint_Read_Word_LE(void)
515 {
516 union
517 {
518 uint16_t Word;
519 uint8_t Bytes[2];
520 } Data;
521
522 Data.Bytes[0] = UEDATX;
523 Data.Bytes[1] = UEDATX;
524
525 return Data.Word;
526 }
527
528 /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
529 * direction endpoints.
530 *
531 * \ingroup Group_EndpointPrimitiveRW
532 *
533 * \return Next word in the currently selected endpoint's FIFO buffer
534 */
535 static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
536 static inline uint16_t Endpoint_Read_Word_BE(void)
537 {
538 union
539 {
540 uint16_t Word;
541 uint8_t Bytes[2];
542 } Data;
543
544 Data.Bytes[1] = UEDATX;
545 Data.Bytes[0] = UEDATX;
546
547 return Data.Word;
548 }
549
550 /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
551 * direction endpoints.
552 *
553 * \ingroup Group_EndpointPrimitiveRW
554 *
555 * \param[in] Word Next word to write to the currently selected endpoint's FIFO buffer
556 */
557 static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
558 static inline void Endpoint_Write_Word_LE(const uint16_t Word)
559 {
560 UEDATX = (Word & 0xFF);
561 UEDATX = (Word >> 8);
562 }
563
564 /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
565 * direction endpoints.
566 *
567 * \ingroup Group_EndpointPrimitiveRW
568 *
569 * \param[in] Word Next word to write to the currently selected endpoint's FIFO buffer
570 */
571 static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
572 static inline void Endpoint_Write_Word_BE(const uint16_t Word)
573 {
574 UEDATX = (Word >> 8);
575 UEDATX = (Word & 0xFF);
576 }
577
578 /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
579 *
580 * \ingroup Group_EndpointPrimitiveRW
581 */
582 static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
583 static inline void Endpoint_Discard_Word(void)
584 {
585 uint8_t Dummy;
586
587 Dummy = UEDATX;
588 Dummy = UEDATX;
589 }
590
591 /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
592 * direction endpoints.
593 *
594 * \ingroup Group_EndpointPrimitiveRW
595 *
596 * \return Next double word in the currently selected endpoint's FIFO buffer
597 */
598 static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
599 static inline uint32_t Endpoint_Read_DWord_LE(void)
600 {
601 union
602 {
603 uint32_t DWord;
604 uint8_t Bytes[4];
605 } Data;
606
607 Data.Bytes[0] = UEDATX;
608 Data.Bytes[1] = UEDATX;
609 Data.Bytes[2] = UEDATX;
610 Data.Bytes[3] = UEDATX;
611
612 return Data.DWord;
613 }
614
615 /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
616 * direction endpoints.
617 *
618 * \ingroup Group_EndpointPrimitiveRW
619 *
620 * \return Next double word in the currently selected endpoint's FIFO buffer
621 */
622 static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
623 static inline uint32_t Endpoint_Read_DWord_BE(void)
624 {
625 union
626 {
627 uint32_t DWord;
628 uint8_t Bytes[4];
629 } Data;
630
631 Data.Bytes[3] = UEDATX;
632 Data.Bytes[2] = UEDATX;
633 Data.Bytes[1] = UEDATX;
634 Data.Bytes[0] = UEDATX;
635
636 return Data.DWord;
637 }
638
639 /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
640 * direction endpoints.
641 *
642 * \ingroup Group_EndpointPrimitiveRW
643 *
644 * \param[in] DWord Next double word to write to the currently selected endpoint's FIFO buffer
645 */
646 static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
647 static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
648 {
649 UEDATX = (DWord & 0xFF);
650 UEDATX = (DWord >> 8);
651 UEDATX = (DWord >> 16);
652 UEDATX = (DWord >> 24);
653 }
654
655 /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
656 * direction endpoints.
657 *
658 * \ingroup Group_EndpointPrimitiveRW
659 *
660 * \param[in] DWord Next double word to write to the currently selected endpoint's FIFO buffer
661 */
662 static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
663 static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
664 {
665 UEDATX = (DWord >> 24);
666 UEDATX = (DWord >> 16);
667 UEDATX = (DWord >> 8);
668 UEDATX = (DWord & 0xFF);
669 }
670
671 /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
672 *
673 * \ingroup Group_EndpointPrimitiveRW
674 */
675 static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
676 static inline void Endpoint_Discard_DWord(void)
677 {
678 uint8_t Dummy;
679
680 Dummy = UEDATX;
681 Dummy = UEDATX;
682 Dummy = UEDATX;
683 Dummy = UEDATX;
684 }
685
686 /* External Variables: */
687 /** Global indicating the maximum packet size of the default control endpoint located at address
688 * 0 in the device. This value is set to the value indicated in the device descriptor in the user
689 * project once the USB interface is initialized into device mode.
690 *
691 * If space is an issue, it is possible to fix this to a static value by defining the control
692 * endpoint size in the FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
693 * via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
694 * read from the descriptors at runtime and instead fixed to the given value. When used, it is
695 * important that the descriptor control endpoint size value matches the size given as the
696 * FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the FIXED_CONTROL_ENDPOINT_SIZE token
697 * be used in the descriptors to ensure this.
698 *
699 * \note This variable should be treated as read-only in the user application, and never manually
700 * changed in value.
701 */
702 #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
703 extern uint8_t USB_ControlEndpointSize;
704 #else
705 #define USB_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
706 #endif
707
708 /* Function Prototypes: */
709 #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
710 #define __CALLBACK_PARAM , StreamCallbackPtr_t Callback
711 #else
712 #define __CALLBACK_PARAM
713 #endif
714
715 /** Configures the specified endpoint number with the given endpoint type, direction, bank size
716 * and banking mode. Endpoints should be allocated in ascending order by their address in the
717 * device (i.e. endpoint 1 should be configured before endpoint 2 and so on) to prevent fragmentation
718 * of the USB FIFO memory.
719 *
720 * The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction
721 * may be either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
722 *
723 * The bank size must indicate the maximum packet size that the endpoint can handle. Different
724 * endpoint numbers can handle different maximum packet sizes - refer to the chosen USB AVR's
725 * datasheet to determine the maximum bank size for each endpoint.
726 *
727 * The banking mode may be either \ref ENDPOINT_BANK_SINGLE or \ref ENDPOINT_BANK_DOUBLE.
728 *
729 * \note The default control endpoint does not have to be manually configured, as it is automatically
730 * configured by the library internally.
731 *
732 * \note This routine will select the specified endpoint, and the endpoint will remain selected
733 * once the routine completes regardless of if the endpoint configuration succeeds.
734 *
735 * \return Boolean true if the configuration succeeded, false otherwise
736 */
737 bool Endpoint_ConfigureEndpoint(const uint8_t Number, const uint8_t Type, const uint8_t Direction,
738 const uint16_t Size, const uint8_t Banks);
739
740 /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
741 * to be read or written to it.
742 *
743 * \note This routine should not be called on CONTROL type endpoints.
744 *
745 * \ingroup Group_EndpointRW
746 *
747 * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
748 */
749 uint8_t Endpoint_WaitUntilReady(void);
750
751 /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
752 * with respect to the data direction. This is a convenience function which can be used to
753 * simplify user control request handling.
754 */
755 void Endpoint_ClearStatusStage(void);
756
757 /** Reads and discards the given number of bytes from the endpoint from the given buffer,
758 * discarding fully read packets from the host as needed. The last packet is not automatically
759 * discarded once the remaining bytes has been read; the user is responsible for manually
760 * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
761 * each USB packet, the given stream callback function is executed repeatedly until the next
762 * packet is ready, allowing for early aborts of stream transfers.
763 *
764 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
765 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
766 * disabled and this function has the Callback parameter omitted.
767 *
768 * \note This routine should not be used on CONTROL type endpoints.
769 *
770 * \ingroup Group_EndpointStreamRW
771 *
772 * \param[in] Length Number of bytes to send via the currently selected endpoint.
773 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
774 *
775 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
776 */
777 uint8_t Endpoint_Discard_Stream(uint16_t Length __CALLBACK_PARAM);
778
779 /** Writes the given number of bytes to the endpoint from the given buffer in little endian,
780 * sending full packets to the host as needed. The last packet filled is not automatically sent;
781 * the user is responsible for manually sending the last written packet to the host via the
782 * \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
783 * is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
784 * aborts of stream transfers.
785 *
786 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
787 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
788 * disabled and this function has the Callback parameter omitted.
789 *
790 * \note This routine should not be used on CONTROL type endpoints.
791 *
792 * \ingroup Group_EndpointStreamRW
793 *
794 * \param[in] Buffer Pointer to the source data buffer to read from.
795 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
796 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
797 *
798 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
799 */
800 uint8_t Endpoint_Write_Stream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
801
802 /** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE().
803 *
804 * \ingroup Group_EndpointStreamRW
805 *
806 * \param[in] Buffer Pointer to the source data buffer to read from.
807 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
808 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
809 *
810 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
811 */
812 uint8_t Endpoint_Write_EStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
813
814 /** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().
815 *
816 * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
817 *
818 * \ingroup Group_EndpointStreamRW
819 *
820 * \param[in] Buffer Pointer to the source data buffer to read from.
821 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
822 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
823 *
824 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
825 */
826 uint8_t Endpoint_Write_PStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
827
828 /** Writes the given number of bytes to the endpoint from the given buffer in big endian,
829 * sending full packets to the host as needed. The last packet filled is not automatically sent;
830 * the user is responsible for manually sending the last written packet to the host via the
831 * \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
832 * is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
833 * aborts of stream transfers.
834 *
835 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
836 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
837 * disabled and this function has the Callback parameter omitted.
838 *
839 * \note This routine should not be used on CONTROL type endpoints.
840 *
841 * \ingroup Group_EndpointStreamRW
842 *
843 * \param[in] Buffer Pointer to the source data buffer to read from.
844 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
845 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
846 *
847 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
848 */
849 uint8_t Endpoint_Write_Stream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
850
851 /** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE().
852 *
853 * \ingroup Group_EndpointStreamRW
854 *
855 * \param[in] Buffer Pointer to the source data buffer to read from.
856 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
857 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
858 *
859 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
860 */
861 uint8_t Endpoint_Write_EStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
862
863 /** FLASH buffer source version of \ref Endpoint_Write_Stream_BE().
864 *
865 * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
866 *
867 * \ingroup Group_EndpointStreamRW
868 *
869 * \param[in] Buffer Pointer to the source data buffer to read from.
870 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
871 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
872 *
873 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
874 */
875 uint8_t Endpoint_Write_PStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
876
877 /** Reads the given number of bytes from the endpoint from the given buffer in little endian,
878 * discarding fully read packets from the host as needed. The last packet is not automatically
879 * discarded once the remaining bytes has been read; the user is responsible for manually
880 * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
881 * each USB packet, the given stream callback function is executed repeatedly until the endpoint
882 * is ready to accept the next packet, allowing for early aborts of stream transfers.
883 *
884 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
885 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
886 * disabled and this function has the Callback parameter omitted.
887 *
888 * \note This routine should not be used on CONTROL type endpoints.
889 *
890 * \ingroup Group_EndpointStreamRW
891 *
892 * \param[out] Buffer Pointer to the destination data buffer to write to.
893 * \param[in] Length Number of bytes to send via the currently selected endpoint.
894 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
895 *
896 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
897 */
898 uint8_t Endpoint_Read_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
899
900 /** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().
901 *
902 * \ingroup Group_EndpointStreamRW
903 *
904 * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
905 * \param[in] Length Number of bytes to send via the currently selected endpoint.
906 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
907 *
908 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
909 */
910 uint8_t Endpoint_Read_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
911
912 /** Reads the given number of bytes from the endpoint from the given buffer in big endian,
913 * discarding fully read packets from the host as needed. The last packet is not automatically
914 * discarded once the remaining bytes has been read; the user is responsible for manually
915 * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
916 * each USB packet, the given stream callback function is executed repeatedly until the endpoint
917 * is ready to accept the next packet, allowing for early aborts of stream transfers.
918 *
919 * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
920 * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
921 * disabled and this function has the Callback parameter omitted.
922 *
923 * \note This routine should not be used on CONTROL type endpoints.
924 *
925 * \ingroup Group_EndpointStreamRW
926 *
927 * \param[out] Buffer Pointer to the destination data buffer to write to.
928 * \param[in] Length Number of bytes to send via the currently selected endpoint.
929 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
930 *
931 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
932 */
933 uint8_t Endpoint_Read_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
934
935 /** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().
936 *
937 * \ingroup Group_EndpointStreamRW
938 *
939 * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
940 * \param[in] Length Number of bytes to send via the currently selected endpoint.
941 * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
942 *
943 * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
944 */
945 uint8_t Endpoint_Read_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
946
947 /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
948 * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
949 * in both failure and success states; the user is responsible for manually clearing the setup OUT to
950 * finalize the transfer via the \ref Endpoint_ClearOUT() macro.
951 *
952 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
953 * to clear the status stage when using this routine in a control transaction.
954 *
955 * \note This routine should only be used on CONTROL type endpoints.
956 *
957 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
958 * together; i.e. the entire stream data must be read or written at the one time.
959 *
960 * \ingroup Group_EndpointStreamRW
961 *
962 * \param[in] Buffer Pointer to the source data buffer to read from.
963 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
964 *
965 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
966 */
967 uint8_t Endpoint_Write_Control_Stream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
968
969 /** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.
970 *
971 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
972 * to clear the status stage when using this routine in a control transaction.
973 *
974 * \note This routine should only be used on CONTROL type endpoints.
975 *
976 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
977 * together; i.e. the entire stream data must be read or written at the one time.
978 *
979 * \ingroup Group_EndpointStreamRW
980 *
981 * \param[in] Buffer Pointer to the source data buffer to read from.
982 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
983 *
984 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
985 */
986 uint8_t Endpoint_Write_Control_EStream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
987
988 /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_LE().
989 *
990 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
991 * to clear the status stage when using this routine in a control transaction.
992 *
993 * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
994 *
995 * \note This routine should only be used on CONTROL type endpoints.
996 *
997 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
998 * together; i.e. the entire stream data must be read or written at the one time.
999 *
1000 * \ingroup Group_EndpointStreamRW
1001 *
1002 * \param[in] Buffer Pointer to the source data buffer to read from.
1003 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
1004 *
1005 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1006 */
1007 uint8_t Endpoint_Write_Control_PStream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1008
1009 /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
1010 * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
1011 * in both failure and success states; the user is responsible for manually clearing the setup OUT to
1012 * finalize the transfer via the \ref Endpoint_ClearOUT() macro.
1013 *
1014 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1015 * to clear the status stage when using this routine in a control transaction.
1016 *
1017 * \note This routine should only be used on CONTROL type endpoints.
1018 *
1019 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1020 * together; i.e. the entire stream data must be read or written at the one time.
1021 *
1022 * \ingroup Group_EndpointStreamRW
1023 *
1024 * \param[in] Buffer Pointer to the source data buffer to read from.
1025 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
1026 *
1027 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1028 */
1029 uint8_t Endpoint_Write_Control_Stream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1030
1031 /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().
1032 *
1033 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1034 * to clear the status stage when using this routine in a control transaction.
1035 *
1036 * \note This routine should only be used on CONTROL type endpoints.
1037 *
1038 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1039 * together; i.e. the entire stream data must be read or written at the one time.
1040 *
1041 * \ingroup Group_EndpointStreamRW
1042 *
1043 * \param[in] Buffer Pointer to the source data buffer to read from.
1044 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
1045 *
1046 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1047 */
1048 uint8_t Endpoint_Write_Control_EStream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1049
1050 /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_BE().
1051 *
1052 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1053 * to clear the status stage when using this routine in a control transaction.
1054 *
1055 * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
1056 *
1057 * \note This routine should only be used on CONTROL type endpoints.
1058 *
1059 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1060 * together; i.e. the entire stream data must be read or written at the one time.
1061 *
1062 * \ingroup Group_EndpointStreamRW
1063 *
1064 * \param[in] Buffer Pointer to the source data buffer to read from.
1065 * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
1066 *
1067 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1068 */
1069 uint8_t Endpoint_Write_Control_PStream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1070
1071 /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
1072 * discarding fully read packets from the host as needed. The device IN acknowledgement is not
1073 * automatically sent after success or failure states; the user is responsible for manually sending the
1074 * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
1075 *
1076 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1077 * to clear the status stage when using this routine in a control transaction.
1078 *
1079 * \note This routine should only be used on CONTROL type endpoints.
1080 *
1081 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1082 * together; i.e. the entire stream data must be read or written at the one time.
1083 *
1084 * \ingroup Group_EndpointStreamRW
1085 *
1086 * \param[out] Buffer Pointer to the destination data buffer to write to.
1087 * \param[in] Length Number of bytes to send via the currently selected endpoint.
1088 *
1089 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1090 */
1091 uint8_t Endpoint_Read_Control_Stream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1092
1093 /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE().
1094 *
1095 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1096 * to clear the status stage when using this routine in a control transaction.
1097 *
1098 * \note This routine should only be used on CONTROL type endpoints.
1099 *
1100 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1101 * together; i.e. the entire stream data must be read or written at the one time.
1102 *
1103 * \ingroup Group_EndpointStreamRW
1104 *
1105 * \param[out] Buffer Pointer to the destination data buffer to write to.
1106 * \param[in] Length Number of bytes to send via the currently selected endpoint.
1107 *
1108 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1109 */
1110 uint8_t Endpoint_Read_Control_EStream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1111
1112 /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
1113 * discarding fully read packets from the host as needed. The device IN acknowledgement is not
1114 * automatically sent after success or failure states; the user is responsible for manually sending the
1115 * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
1116 *
1117 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1118 * to clear the status stage when using this routine in a control transaction.
1119 *
1120 * \note This routine should only be used on CONTROL type endpoints.
1121 *
1122 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1123 * together; i.e. the entire stream data must be read or written at the one time.
1124 *
1125 * \ingroup Group_EndpointStreamRW
1126 *
1127 * \param[out] Buffer Pointer to the destination data buffer to write to.
1128 * \param[in] Length Number of bytes to send via the currently selected endpoint.
1129 *
1130 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1131 */
1132 uint8_t Endpoint_Read_Control_Stream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1133
1134 /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE().
1135 *
1136 * \note This function automatically clears the control transfer's status stage. Do not manually attempt
1137 * to clear the status stage when using this routine in a control transaction.
1138 *
1139 * \note This routine should only be used on CONTROL type endpoints.
1140 *
1141 * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
1142 * together; i.e. the entire stream data must be read or written at the one time.
1143 *
1144 * \ingroup Group_EndpointStreamRW
1145 *
1146 * \param[out] Buffer Pointer to the destination data buffer to write to.
1147 * \param[in] Length Number of bytes to send via the currently selected endpoint.
1148 *
1149 * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
1150 */
1151 uint8_t Endpoint_Read_Control_EStream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
1152
1153 /* Private Interface - For use in library only: */
1154 #if !defined(__DOXYGEN__)
1155 /* Macros: */
1156 #define Endpoint_AllocateMemory() MACROS{ UECFG1X |= (1 << ALLOC); }MACROE
1157 #define Endpoint_DeallocateMemory() MACROS{ UECFG1X &= ~(1 << ALLOC); }MACROE
1158
1159 #define _ENDPOINT_GET_MAXSIZE(n) _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## n)
1160 #define _ENDPOINT_GET_MAXSIZE2(details) _ENDPOINT_GET_MAXSIZE3(details)
1161 #define _ENDPOINT_GET_MAXSIZE3(maxsize, db) maxsize
1162
1163 #define _ENDPOINT_GET_DOUBLEBANK(n) _ENDPOINT_GET_DOUBLEBANK2(ENDPOINT_DETAILS_EP ## n)
1164 #define _ENDPOINT_GET_DOUBLEBANK2(details) _ENDPOINT_GET_DOUBLEBANK3(details)
1165 #define _ENDPOINT_GET_DOUBLEBANK3(maxsize, db) db
1166
1167 #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
1168 #define ENDPOINT_DETAILS_EP0 64, true
1169 #define ENDPOINT_DETAILS_EP1 256, true
1170 #define ENDPOINT_DETAILS_EP2 64, true
1171 #define ENDPOINT_DETAILS_EP3 64, true
1172 #define ENDPOINT_DETAILS_EP4 64, true
1173 #define ENDPOINT_DETAILS_EP5 64, true
1174 #define ENDPOINT_DETAILS_EP6 64, true
1175 #else
1176 #define ENDPOINT_DETAILS_EP0 64, true
1177 #define ENDPOINT_DETAILS_EP1 64, false
1178 #define ENDPOINT_DETAILS_EP2 64, false
1179 #define ENDPOINT_DETAILS_EP3 64, true
1180 #define ENDPOINT_DETAILS_EP4 64, true
1181 #endif
1182
1183 #define Endpoint_ConfigureEndpoint(Number, Type, Direction, Size, Banks) \
1184 Endpoint_ConfigureEndpoint_Prv((Number), \
1185 (((Type) << EPTYPE0) | (Direction)), \
1186 ((1 << ALLOC) | (Banks) | \
1187 (__builtin_constant_p(Size) ? \
1188 Endpoint_BytesToEPSizeMask(Size) : \
1189 Endpoint_BytesToEPSizeMaskDynamic(Size))))
1190
1191 /* Function Prototypes: */
1192 void Endpoint_ClearEndpoints(void);
1193 uint8_t Endpoint_BytesToEPSizeMaskDynamic(const uint16_t Size);
1194 bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number, const uint8_t UECFG0XData, const uint8_t UECFG1XData);
1195
1196 /* Inline Functions: */
1197 static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
1198 static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
1199 {
1200 uint8_t MaskVal = 0;
1201 uint16_t CheckBytes = 8;
1202
1203 while (CheckBytes < Bytes)
1204 {
1205 MaskVal++;
1206 CheckBytes <<= 1;
1207 }
1208
1209 return (MaskVal << EPSIZE0);
1210 }
1211
1212 #endif
1213
1214 /* Disable C linkage for C++ Compilers: */
1215 #if defined(__cplusplus)
1216 }
1217 #endif
1218
1219 #endif
1220
1221 /** @} */
Lightweight USB Framework for AVRs