projects / pub / USBasp.git / blob
? search:


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