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