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