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