-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this \r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in \r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting \r
- documentation, and that the name of the author not be used in \r
- advertising or publicity pertaining to distribution of the \r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- * \brief USB device endpoint management definitions.\r
- *\r
- * This file contains structures, function prototypes and macros related to the management of the device's\r
- * data endpoints when the library is initialized in USB device mode.\r
- *\r
- * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
- * dispatch header located in LUFA/Drivers/USB/USB.h.\r
- */\r
-\r
-/** \ingroup Group_USB\r
- * @defgroup Group_EndpointManagement Endpoint Management\r
- *\r
- * Functions, macros and enums related to endpoint management when in USB Device mode. This\r
- * module contains the endpoint management macros, as well as endpoint interrupt and data\r
- * send/receive functions for various data types.\r
- *\r
- * @{\r
- */\r
-\r
-/** @defgroup Group_EndpointRW Endpoint Data Reading and Writing\r
- *\r
- * Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.\r
- */\r
- \r
-/** \ingroup Group_EndpointRW \r
- * @defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types\r
- *\r
- * Functions, macros, variables, enums and types related to data reading and writing of primitive data types\r
- * from and to endpoints.\r
- */ \r
-\r
-/** \ingroup Group_EndpointRW \r
- * @defgroup Group_EndpointStreamRW Read/Write of Multi-Byte Streams\r
- *\r
- * Functions, macros, variables, enums and types related to data reading and writing of data streams from\r
- * and to endpoints.\r
- */ \r
-\r
-/** @defgroup Group_EndpointPacketManagement Endpoint Packet Management\r
- *\r
- * Functions, macros, variables, enums and types related to packet management of endpoints.\r
- */\r
-\r
-#ifndef __ENDPOINT_H__\r
-#define __ENDPOINT_H__\r
-\r
- /* Includes: */\r
- #include <avr/io.h>\r
- #include <avr/pgmspace.h>\r
- #include <avr/eeprom.h>\r
- #include <stdbool.h>\r
-\r
- #include "../../../Common/Common.h"\r
- #include "../HighLevel/USBTask.h"\r
-\r
- #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
- #include "../HighLevel/StreamCallbacks.h"\r
- #endif\r
- \r
- /* Enable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- extern "C" {\r
- #endif\r
-\r
- /* Preprocessor Checks: */\r
- #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
- #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
- #endif\r
- \r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint\r
- * should be initialized in the OUT direction - i.e. data flows from host to device.\r
- */\r
- #define ENDPOINT_DIR_OUT (0 << EPDIR)\r
-\r
- /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint\r
- * should be initialized in the IN direction - i.e. data flows from device to host.\r
- */\r
- #define ENDPOINT_DIR_IN (1 << EPDIR)\r
-\r
- /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates\r
- * that the endpoint should have one single bank, which requires less USB FIFO memory but results\r
- * in slower transfers as only one USB device (the AVR or the host) can access the endpoint's\r
- * bank at the one time.\r
- */\r
- #define ENDPOINT_BANK_SINGLE (0 << EPBK0)\r
-\r
- /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates\r
- * that the endpoint should have two banks, which requires more USB FIFO memory but results\r
- * in faster transfers as one USB device (the AVR or the host) can access one bank while the other\r
- * accesses the second bank.\r
- */\r
- #define ENDPOINT_BANK_DOUBLE (1 << EPBK0)\r
- \r
- /** Endpoint address for the default control endpoint, which always resides in address 0. This is\r
- * defined for convenience to give more readable code when used with the endpoint macros.\r
- */\r
- #define ENDPOINT_CONTROLEP 0\r
-\r
- #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))\r
- /** Default size of the default control endpoint's bank, until altered by the Endpoint0Size value \r
- * in the device descriptor. Not available if the FIXED_CONTROL_ENDPOINT_SIZE token is defined.\r
- */\r
- #define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8\r
- #endif\r
- \r
- /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's\r
- * numerical address in the device.\r
- */\r
- #define ENDPOINT_EPNUM_MASK 0x07\r
-\r
- /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's\r
- * direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks.\r
- */\r
- #define ENDPOINT_EPDIR_MASK 0x80\r
-\r
- /** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's\r
- * bank size in the device.\r
- */\r
- #define ENDPOINT_EPSIZE_MASK 0x7FF\r
- \r
- /** Maximum size in bytes of a given endpoint.\r
- *\r
- * \param[in] n Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)\r
- */ \r
- #define ENDPOINT_MAX_SIZE(n) _ENDPOINT_GET_MAXSIZE(n)\r
-\r
- /** Indicates if the given endpoint supports double banking.\r
- *\r
- * \param[in] n Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)\r
- */ \r
- #define ENDPOINT_DOUBLEBANK_SUPPORTED(n) _ENDPOINT_GET_DOUBLEBANK(n)\r
-\r
- #if !defined(CONTROL_ONLY_DEVICE)\r
- #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)\r
- /** Total number of endpoints (including the default control endpoint at address 0) which may\r
- * be used in the device. Different USB AVR models support different amounts of endpoints,\r
- * this value reflects the maximum number of endpoints for the currently selected AVR model.\r
- */\r
- #define ENDPOINT_TOTAL_ENDPOINTS 7\r
- #else\r
- #define ENDPOINT_TOTAL_ENDPOINTS 5 \r
- #endif\r
- #else\r
- #define ENDPOINT_TOTAL_ENDPOINTS 1\r
- #endif\r
- \r
- /* Pseudo-Function Macros: */\r
- #if defined(__DOXYGEN__)\r
- /** Indicates the number of bytes currently stored in the current endpoint's selected bank.\r
- *\r
- * \note The return width of this function may differ, depending on the maximum endpoint bank size\r
- * of the selected AVR model.\r
- *\r
- * \ingroup Group_EndpointRW\r
- *\r
- * \return Total number of bytes in the currently selected Endpoint's FIFO buffer\r
- */\r
- static inline uint16_t Endpoint_BytesInEndpoint(void);\r
- \r
- /** Get the endpoint address of the currently selected endpoint. This is typically used to save\r
- * the currently selected endpoint number so that it can be restored after another endpoint has\r
- * been manipulated.\r
- *\r
- * \return Index of the currently selected endpoint\r
- */\r
- static inline uint8_t Endpoint_GetCurrentEndpoint(void);\r
- \r
- /** Selects the given endpoint number. If the address from the device descriptors is used, the\r
- * value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint\r
- * number (and discarding the endpoint direction bit).\r
- *\r
- * Any endpoint operations which do not require the endpoint number to be indicated will operate on\r
- * the currently selected endpoint.\r
- *\r
- * \param[in] EndpointNumber Endpoint number to select\r
- */\r
- static inline void Endpoint_SelectEndpoint(uint8_t EndpointNumber);\r
- \r
- /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's\r
- * In and Out pointers to the bank's contents.\r
- *\r
- * \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset\r
- */\r
- static inline void Endpoint_ResetFIFO(uint8_t EndpointNumber);\r
- \r
- /** Enables the currently selected endpoint so that data can be sent and received through it to\r
- * and from a host.\r
- *\r
- * \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().\r
- */\r
- static inline void Endpoint_EnableEndpoint(void);\r
-\r
- /** Disables the currently selected endpoint so that data cannot be sent and received through it\r
- * to and from a host.\r
- */\r
- static inline void Endpoint_DisableEndpoint(void);\r
- \r
- /** Determines if the currently selected endpoint is enabled, but not necessarily configured.\r
- *\r
- * \return Boolean True if the currently selected endpoint is enabled, false otherwise\r
- */\r
- static inline bool Endpoint_IsEnabled(void);\r
- \r
- /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint\r
- * bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN\r
- * direction). This function will return false if an error has occurred in the endpoint, if the endpoint\r
- * is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN\r
- * direction and the endpoint bank is full.\r
- *\r
- * \ingroup Group_EndpointPacketManagement\r
- *\r
- * \return Boolean true if the currently selected endpoint may be read from or written to, depending on its direction\r
- */\r
- static inline bool Endpoint_IsReadWriteAllowed(void);\r
- \r
- /** Determines if the currently selected endpoint is configured.\r
- *\r
- * \return Boolean true if the currently selected endpoint has been configured, false otherwise\r
- */\r
- static inline bool Endpoint_IsConfigured(void);\r
- \r
- /** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their\r
- * interrupt duration has elapsed. Which endpoints have interrupted can be determined by\r
- * masking the return value against (1 << {Endpoint Number}).\r
- *\r
- * \return Mask whose bits indicate which endpoints have interrupted\r
- */\r
- static inline uint8_t Endpoint_GetEndpointInterrupts(void);\r
- \r
- /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type\r
- * endpoints).\r
- *\r
- * \param[in] EndpointNumber Index of the endpoint whose interrupt flag should be tested\r
- *\r
- * \return Boolean true if the specified endpoint has interrupted, false otherwise\r
- */\r
- static inline bool Endpoint_HasEndpointInterrupted(uint8_t EndpointNumber);\r
- \r
- /** Determines if the selected IN endpoint is ready for a new packet.\r
- *\r
- * \ingroup Group_EndpointPacketManagement\r
- *\r
- * \return Boolean true if the current endpoint is ready for an IN packet, false otherwise.\r
- */\r
- static inline bool Endpoint_IsINReady(void);\r
- \r
- /** Determines if the selected OUT endpoint has received new packet.\r
- *\r
- * \ingroup Group_EndpointPacketManagement\r
- *\r
- * \return Boolean true if current endpoint is has received an OUT packet, false otherwise.\r
- */\r
- static inline bool Endpoint_IsOUTReceived(void);\r
- \r
- /** Determines if the current CONTROL type endpoint has received a SETUP packet.\r
- *\r
- * \ingroup Group_EndpointPacketManagement\r
- *\r
- * \return Boolean true if the selected endpoint has received a SETUP packet, false otherwise.\r
- */\r
- static inline bool Endpoint_IsSETUPReceived(void);\r
- \r
- /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the\r
- * endpoint for the next packet.\r
- *\r
- * \ingroup Group_EndpointPacketManagement\r
- *\r
- * \note This is not applicable for non CONTROL type endpoints. \r
- */\r
- static inline void Endpoint_ClearSETUP(void);\r
- \r
- /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the\r
- * next packet and switching to the alternative endpoint bank if double banked.\r
- *\r
- * \ingroup Group_EndpointPacketManagement\r
- */\r
- static inline void Endpoint_ClearIN(void);\r
- \r
- /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint\r
- * for the next packet and switching to the alternative endpoint bank if double banked.\r
- *\r
- * \ingroup Group_EndpointPacketManagement\r
- */\r
- static inline void Endpoint_ClearOUT(void);\r
- \r
- /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the\r
- * indicated endpoint and that the current transfer sequence should be aborted. This provides a\r
- * way for devices to indicate invalid commands to the host so that the current transfer can be\r
- * aborted and the host can begin its own recovery sequence.\r
- *\r
- * The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro\r
- * is called, or the host issues a CLEAR FEATURE request to the device for the currently selected\r
- * endpoint.\r
- *\r
- * \ingroup Group_EndpointPacketManagement\r
- */\r
- static inline void Endpoint_StallTransaction(void);\r
- \r
- /** Clears the STALL condition on the currently selected endpoint.\r
- *\r
- * \ingroup Group_EndpointPacketManagement\r
- */\r
- static inline void Endpoint_ClearStall(void);\r
- \r
- /** Determines if the currently selected endpoint is stalled, false otherwise.\r
- *\r
- * \ingroup Group_EndpointPacketManagement\r
- *\r
- * \return Boolean true if the currently selected endpoint is stalled, false otherwise\r
- */\r
- static inline bool Endpoint_IsStalled(void);\r
- \r
- /** Resets the data toggle of the currently selected endpoint. */\r
- static inline void Endpoint_ResetDataToggle(void);\r
- \r
- /** Determines the currently selected endpoint's direction.\r
- *\r
- * \return The currently selected endpoint's direction, as a ENDPOINT_DIR_* mask.\r
- */\r
- static inline uint8_t Endpoint_GetEndpointDirection(void);\r
-\r
- /** Sets the direction of the currently selected endpoint.\r
- *\r
- * \param[in] DirectionMask New endpoint direction, as a ENDPOINT_DIR_* mask.\r
- */\r
- static inline void Endpoint_SetEndpointDirection(uint8_t DirectionMask);\r
- #else\r
- #if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)\r
- #define Endpoint_BytesInEndpoint() UEBCX\r
- #elif defined(USB_SERIES_4_AVR)\r
- #define Endpoint_BytesInEndpoint() (((uint16_t)UEBCHX << 8) | UEBCLX) \r
- #elif defined(USB_SERIES_2_AVR)\r
- #define Endpoint_BytesInEndpoint() UEBCLX\r
- #endif\r
- \r
- #if !defined(CONTROL_ONLY_DEVICE)\r
- #define Endpoint_GetCurrentEndpoint() (UENUM & ENDPOINT_EPNUM_MASK)\r
- #else\r
- #define Endpoint_GetCurrentEndpoint() ENDPOINT_CONTROLEP\r
- #endif\r
- \r
- #if !defined(CONTROL_ONLY_DEVICE)\r
- #define Endpoint_SelectEndpoint(epnum) MACROS{ UENUM = (epnum); }MACROE\r
- #else\r
- #define Endpoint_SelectEndpoint(epnum) (void)(epnum)\r
- #endif\r
-\r
- #define Endpoint_ResetFIFO(epnum) MACROS{ UERST = (1 << (epnum)); UERST = 0; }MACROE\r
-\r
- #define Endpoint_EnableEndpoint() MACROS{ UECONX |= (1 << EPEN); }MACROE\r
-\r
- #define Endpoint_DisableEndpoint() MACROS{ UECONX &= ~(1 << EPEN); }MACROE\r
-\r
- #define Endpoint_IsEnabled() ((UECONX & (1 << EPEN)) ? true : false)\r
-\r
- #if !defined(CONTROL_ONLY_DEVICE)\r
- #define Endpoint_IsReadWriteAllowed() ((UEINTX & (1 << RWAL)) ? true : false)\r
- #endif\r
- \r
- #define Endpoint_IsConfigured() ((UESTA0X & (1 << CFGOK)) ? true : false)\r
-\r
- #define Endpoint_GetEndpointInterrupts() UEINT\r
-\r
- #define Endpoint_HasEndpointInterrupted(n) ((UEINT & (1 << (n))) ? true : false)\r
- \r
- #define Endpoint_IsINReady() ((UEINTX & (1 << TXINI)) ? true : false)\r
- \r
- #define Endpoint_IsOUTReceived() ((UEINTX & (1 << RXOUTI)) ? true : false)\r
-\r
- #define Endpoint_IsSETUPReceived() ((UEINTX & (1 << RXSTPI)) ? true : false)\r
-\r
- #define Endpoint_ClearSETUP() MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE\r
-\r
- #if !defined(CONTROL_ONLY_DEVICE)\r
- #define Endpoint_ClearIN() MACROS{ UEINTX &= ~((1 << TXINI) | (1 << FIFOCON)); }MACROE\r
- #else\r
- #define Endpoint_ClearIN() MACROS{ UEINTX &= ~(1 << TXINI); }MACROE\r
- #endif\r
-\r
- #if !defined(CONTROL_ONLY_DEVICE)\r
- #define Endpoint_ClearOUT() MACROS{ UEINTX &= ~((1 << RXOUTI) | (1 << FIFOCON)); }MACROE\r
- #else\r
- #define Endpoint_ClearOUT() MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE \r
- #endif\r
-\r
- #define Endpoint_StallTransaction() MACROS{ UECONX |= (1 << STALLRQ); }MACROE\r
-\r
- #define Endpoint_ClearStall() MACROS{ UECONX |= (1 << STALLRQC); }MACROE\r
-\r
- #define Endpoint_IsStalled() ((UECONX & (1 << STALLRQ)) ? true : false)\r
-\r
- #define Endpoint_ResetDataToggle() MACROS{ UECONX |= (1 << RSTDT); }MACROE\r
- \r
- #define Endpoint_GetEndpointDirection() (UECFG0X & ENDPOINT_DIR_IN)\r
- \r
- #define Endpoint_SetEndpointDirection(dir) MACROS{ UECFG0X = ((UECFG0X & ~ENDPOINT_DIR_IN) | (dir)); }MACROE\r
- #endif\r
-\r
- /* Enums: */\r
- /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.\r
- *\r
- * \ingroup Group_EndpointRW\r
- */\r
- enum Endpoint_WaitUntilReady_ErrorCodes_t\r
- {\r
- ENDPOINT_READYWAIT_NoError = 0, /**< Endpoint is ready for next packet, no error. */\r
- ENDPOINT_READYWAIT_EndpointStalled = 1, /**< The endpoint was stalled during the stream\r
- * transfer by the host or device.\r
- */\r
- ENDPOINT_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while\r
- * waiting for the endpoint to become ready.\r
- */\r
- ENDPOINT_READYWAIT_BusSuspended = 3, /**< The USB bus has been suspended by the host and\r
- * no USB endpoint traffic can occur until the bus\r
- * has resumed.\r
- */\r
- ENDPOINT_READYWAIT_Timeout = 4, /**< The host failed to accept or send the next packet\r
- * within the software timeout period set by the\r
- * \ref USB_STREAM_TIMEOUT_MS macro.\r
- */\r
- };\r
- \r
- /** Enum for the possible error return codes of the Endpoint_*_Stream_* functions.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- */\r
- enum Endpoint_Stream_RW_ErrorCodes_t\r
- {\r
- ENDPOINT_RWSTREAM_NoError = 0, /**< Command completed successfully, no error. */\r
- ENDPOINT_RWSTREAM_EndpointStalled = 1, /**< The endpoint was stalled during the stream\r
- * transfer by the host or device.\r
- */\r
- ENDPOINT_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during\r
- * the transfer.\r
- */\r
- ENDPOINT_RWSTREAM_BusSuspended = 3, /**< The USB bus has been suspended by the host and\r
- * no USB endpoint traffic can occur until the bus\r
- * has resumed.\r
- */\r
- ENDPOINT_RWSTREAM_Timeout = 4, /**< The host failed to accept or send the next packet\r
- * within the software timeout period set by the\r
- * \ref USB_STREAM_TIMEOUT_MS macro.\r
- */\r
- ENDPOINT_RWSTREAM_CallbackAborted = 5, /**< Indicates that the stream's callback function\r
- * aborted the transfer early.\r
- */\r
- };\r
- \r
- /** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- */\r
- enum Endpoint_ControlStream_RW_ErrorCodes_t\r
- {\r
- ENDPOINT_RWCSTREAM_NoError = 0, /**< Command completed successfully, no error. */\r
- ENDPOINT_RWCSTREAM_HostAborted = 1, /**< The aborted the transfer prematurely. */\r
- ENDPOINT_RWCSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during\r
- * the transfer.\r
- */\r
- ENDPOINT_RWCSTREAM_BusSuspended = 3, /**< The USB bus has been suspended by the host and\r
- * no USB endpoint traffic can occur until the bus\r
- * has resumed.\r
- */\r
- };\r
-\r
- /* Inline Functions: */\r
- /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- *\r
- * \return Next byte in the currently selected endpoint's FIFO buffer\r
- */\r
- static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint8_t Endpoint_Read_Byte(void)\r
- {\r
- return UEDATX;\r
- }\r
-\r
- /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- *\r
- * \param[in] Byte Next byte to write into the the currently selected endpoint's FIFO buffer\r
- */\r
- static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Write_Byte(const uint8_t Byte)\r
- {\r
- UEDATX = Byte;\r
- }\r
-\r
- /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- */\r
- static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Discard_Byte(void)\r
- {\r
- uint8_t Dummy;\r
- \r
- Dummy = UEDATX;\r
- }\r
- \r
- /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT\r
- * direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- *\r
- * \return Next word in the currently selected endpoint's FIFO buffer\r
- */\r
- static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint16_t Endpoint_Read_Word_LE(void)\r
- {\r
- union\r
- {\r
- uint16_t Word;\r
- uint8_t Bytes[2];\r
- } Data;\r
- \r
- Data.Bytes[0] = UEDATX;\r
- Data.Bytes[1] = UEDATX;\r
- \r
- return Data.Word;\r
- }\r
-\r
- /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT\r
- * direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- *\r
- * \return Next word in the currently selected endpoint's FIFO buffer\r
- */\r
- static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint16_t Endpoint_Read_Word_BE(void)\r
- {\r
- union\r
- {\r
- uint16_t Word;\r
- uint8_t Bytes[2];\r
- } Data;\r
- \r
- Data.Bytes[1] = UEDATX;\r
- Data.Bytes[0] = UEDATX;\r
- \r
- return Data.Word;\r
- }\r
-\r
- /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN\r
- * direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- *\r
- * \param[in] Word Next word to write to the currently selected endpoint's FIFO buffer\r
- */\r
- static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Write_Word_LE(const uint16_t Word)\r
- {\r
- UEDATX = (Word & 0xFF);\r
- UEDATX = (Word >> 8);\r
- }\r
- \r
- /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN\r
- * direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- *\r
- * \param[in] Word Next word to write to the currently selected endpoint's FIFO buffer\r
- */\r
- static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Write_Word_BE(const uint16_t Word)\r
- {\r
- UEDATX = (Word >> 8);\r
- UEDATX = (Word & 0xFF);\r
- }\r
-\r
- /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- */\r
- static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Discard_Word(void)\r
- {\r
- uint8_t Dummy;\r
- \r
- Dummy = UEDATX;\r
- Dummy = UEDATX;\r
- }\r
-\r
- /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT\r
- * direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- *\r
- * \return Next double word in the currently selected endpoint's FIFO buffer\r
- */\r
- static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint32_t Endpoint_Read_DWord_LE(void)\r
- {\r
- union\r
- {\r
- uint32_t DWord;\r
- uint8_t Bytes[4];\r
- } Data;\r
- \r
- Data.Bytes[0] = UEDATX;\r
- Data.Bytes[1] = UEDATX;\r
- Data.Bytes[2] = UEDATX;\r
- Data.Bytes[3] = UEDATX;\r
- \r
- return Data.DWord;\r
- }\r
-\r
- /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT\r
- * direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- *\r
- * \return Next double word in the currently selected endpoint's FIFO buffer\r
- */\r
- static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint32_t Endpoint_Read_DWord_BE(void)\r
- {\r
- union\r
- {\r
- uint32_t DWord;\r
- uint8_t Bytes[4];\r
- } Data;\r
- \r
- Data.Bytes[3] = UEDATX;\r
- Data.Bytes[2] = UEDATX;\r
- Data.Bytes[1] = UEDATX;\r
- Data.Bytes[0] = UEDATX;\r
- \r
- return Data.DWord;\r
- }\r
-\r
- /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN\r
- * direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- *\r
- * \param[in] DWord Next double word to write to the currently selected endpoint's FIFO buffer\r
- */\r
- static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)\r
- {\r
- UEDATX = (DWord & 0xFF);\r
- UEDATX = (DWord >> 8);\r
- UEDATX = (DWord >> 16);\r
- UEDATX = (DWord >> 24);\r
- }\r
- \r
- /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN\r
- * direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- *\r
- * \param[in] DWord Next double word to write to the currently selected endpoint's FIFO buffer\r
- */\r
- static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)\r
- {\r
- UEDATX = (DWord >> 24);\r
- UEDATX = (DWord >> 16);\r
- UEDATX = (DWord >> 8);\r
- UEDATX = (DWord & 0xFF);\r
- }\r
-\r
- /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints. \r
- *\r
- * \ingroup Group_EndpointPrimitiveRW\r
- */\r
- static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Discard_DWord(void)\r
- {\r
- uint8_t Dummy;\r
- \r
- Dummy = UEDATX;\r
- Dummy = UEDATX;\r
- Dummy = UEDATX;\r
- Dummy = UEDATX;\r
- }\r
-\r
- /* External Variables: */\r
- /** Global indicating the maximum packet size of the default control endpoint located at address\r
- * 0 in the device. This value is set to the value indicated in the device descriptor in the user\r
- * project once the USB interface is initialized into device mode.\r
- *\r
- * If space is an issue, it is possible to fix this to a static value by defining the control\r
- * endpoint size in the FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile\r
- * via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically\r
- * read from the descriptors at runtime and instead fixed to the given value. When used, it is\r
- * important that the descriptor control endpoint size value matches the size given as the\r
- * FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the FIXED_CONTROL_ENDPOINT_SIZE token\r
- * be used in the descriptors to ensure this.\r
- *\r
- * \note This variable should be treated as read-only in the user application, and never manually\r
- * changed in value.\r
- */\r
- #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))\r
- extern uint8_t USB_ControlEndpointSize;\r
- #else\r
- #define USB_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE\r
- #endif\r
-\r
- /* Function Prototypes: */\r
- #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
- #define __CALLBACK_PARAM , StreamCallbackPtr_t Callback\r
- #else\r
- #define __CALLBACK_PARAM \r
- #endif\r
- \r
- /** Configures the specified endpoint number with the given endpoint type, direction, bank size\r
- * and banking mode. Endpoints should be allocated in ascending order by their address in the\r
- * device (i.e. endpoint 1 should be configured before endpoint 2 and so on) to prevent fragmentation\r
- * of the USB FIFO memory.\r
- *\r
- * The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction\r
- * may be either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.\r
- *\r
- * The bank size must indicate the maximum packet size that the endpoint can handle. Different\r
- * endpoint numbers can handle different maximum packet sizes - refer to the chosen USB AVR's\r
- * datasheet to determine the maximum bank size for each endpoint.\r
- *\r
- * The banking mode may be either \ref ENDPOINT_BANK_SINGLE or \ref ENDPOINT_BANK_DOUBLE.\r
- *\r
- * \note The default control endpoint does not have to be manually configured, as it is automatically\r
- * configured by the library internally.\r
- * \n\n\r
- *\r
- * \note This routine will select the specified endpoint, and the endpoint will remain selected\r
- * once the routine completes regardless of if the endpoint configuration succeeds.\r
- *\r
- * \return Boolean true if the configuration succeeded, false otherwise\r
- */\r
- bool Endpoint_ConfigureEndpoint(const uint8_t Number, const uint8_t Type, const uint8_t Direction,\r
- const uint16_t Size, const uint8_t Banks);\r
-\r
- /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data\r
- * to be read or written to it.\r
- *\r
- * \note This routine should not be called on CONTROL type endpoints.\r
- *\r
- * \ingroup Group_EndpointRW\r
- *\r
- * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_WaitUntilReady(void);\r
- \r
- /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,\r
- * with respect to the data direction. This is a convenience function which can be used to\r
- * simplify user control request handling.\r
- */\r
- void Endpoint_ClearStatusStage(void);\r
-\r
- /** Reads and discards the given number of bytes from the endpoint from the given buffer,\r
- * discarding fully read packets from the host as needed. The last packet is not automatically\r
- * discarded once the remaining bytes has been read; the user is responsible for manually\r
- * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between\r
- * each USB packet, the given stream callback function is executed repeatedly until the next\r
- * packet is ready, allowing for early aborts of stream transfers.\r
- *\r
- * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
- * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
- * disabled and this function has the Callback parameter omitted.\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Discard_Stream(uint16_t Length __CALLBACK_PARAM);\r
-\r
- /** Writes the given number of bytes to the endpoint from the given buffer in little endian,\r
- * sending full packets to the host as needed. The last packet filled is not automatically sent;\r
- * the user is responsible for manually sending the last written packet to the host via the\r
- * \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function\r
- * is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early\r
- * aborts of stream transfers.\r
- *\r
- * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
- * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
- * disabled and this function has the Callback parameter omitted.\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Stream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE().\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_EStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().\r
- *\r
- * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_PStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Writes the given number of bytes to the endpoint from the given buffer in big endian,\r
- * sending full packets to the host as needed. The last packet filled is not automatically sent;\r
- * the user is responsible for manually sending the last written packet to the host via the\r
- * \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function\r
- * is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early\r
- * aborts of stream transfers.\r
- *\r
- * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
- * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
- * disabled and this function has the Callback parameter omitted.\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Stream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE().\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_EStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** FLASH buffer source version of \ref Endpoint_Write_Stream_BE().\r
- *\r
- * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_PStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Reads the given number of bytes from the endpoint from the given buffer in little endian,\r
- * discarding fully read packets from the host as needed. The last packet is not automatically\r
- * discarded once the remaining bytes has been read; the user is responsible for manually\r
- * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between\r
- * each USB packet, the given stream callback function is executed repeatedly until the endpoint\r
- * is ready to accept the next packet, allowing for early aborts of stream transfers.\r
- *\r
- * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
- * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
- * disabled and this function has the Callback parameter omitted.\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
- \r
- /** Reads the given number of bytes from the endpoint from the given buffer in big endian,\r
- * discarding fully read packets from the host as needed. The last packet is not automatically\r
- * discarded once the remaining bytes has been read; the user is responsible for manually\r
- * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between\r
- * each USB packet, the given stream callback function is executed repeatedly until the endpoint\r
- * is ready to accept the next packet, allowing for early aborts of stream transfers.\r
- *\r
- * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
- * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
- * disabled and this function has the Callback parameter omitted.\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,\r
- * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared\r
- * in both failure and success states; the user is responsible for manually clearing the setup OUT to\r
- * finalize the transfer via the \ref Endpoint_ClearOUT() macro.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_Stream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_EStream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_LE().\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_PStream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,\r
- * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared\r
- * in both failure and success states; the user is responsible for manually clearing the setup OUT to\r
- * finalize the transfer via the \ref Endpoint_ClearOUT() macro.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_Stream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_EStream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_BE().\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_PStream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,\r
- * discarding fully read packets from the host as needed. The device IN acknowledgement is not\r
- * automatically sent after success or failure states; the user is responsible for manually sending the\r
- * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Control_Stream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE().\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Control_EStream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,\r
- * discarding fully read packets from the host as needed. The device IN acknowledgement is not\r
- * automatically sent after success or failure states; the user is responsible for manually sending the\r
- * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Control_Stream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); \r
- \r
- /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE().\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \ingroup Group_EndpointStreamRW\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Control_EStream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); \r
-\r
- /* Private Interface - For use in library only: */\r
- #if !defined(__DOXYGEN__)\r
- /* Macros: */\r
- #define Endpoint_AllocateMemory() MACROS{ UECFG1X |= (1 << ALLOC); }MACROE\r
- #define Endpoint_DeallocateMemory() MACROS{ UECFG1X &= ~(1 << ALLOC); }MACROE\r
- \r
- #define _ENDPOINT_GET_MAXSIZE(n) _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## n)\r
- #define _ENDPOINT_GET_MAXSIZE2(details) _ENDPOINT_GET_MAXSIZE3(details)\r
- #define _ENDPOINT_GET_MAXSIZE3(maxsize, db) maxsize\r
-\r
- #define _ENDPOINT_GET_DOUBLEBANK(n) _ENDPOINT_GET_DOUBLEBANK2(ENDPOINT_DETAILS_EP ## n)\r
- #define _ENDPOINT_GET_DOUBLEBANK2(details) _ENDPOINT_GET_DOUBLEBANK3(details)\r
- #define _ENDPOINT_GET_DOUBLEBANK3(maxsize, db) db\r
- \r
- #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)\r
- #define ENDPOINT_DETAILS_EP0 64, true\r
- #define ENDPOINT_DETAILS_EP1 256, true\r
- #define ENDPOINT_DETAILS_EP2 64, true\r
- #define ENDPOINT_DETAILS_EP3 64, true\r
- #define ENDPOINT_DETAILS_EP4 64, true\r
- #define ENDPOINT_DETAILS_EP5 64, true\r
- #define ENDPOINT_DETAILS_EP6 64, true\r
- #else\r
- #define ENDPOINT_DETAILS_EP0 64, true\r
- #define ENDPOINT_DETAILS_EP1 64, false\r
- #define ENDPOINT_DETAILS_EP2 64, false\r
- #define ENDPOINT_DETAILS_EP3 64, true\r
- #define ENDPOINT_DETAILS_EP4 64, true \r
- #endif\r
-\r
- #define Endpoint_ConfigureEndpoint(Number, Type, Direction, Size, Banks) \\r
- Endpoint_ConfigureEndpoint_Prv((Number), \\r
- (((Type) << EPTYPE0) | (Direction)), \\r
- ((1 << ALLOC) | (Banks) | \\r
- (__builtin_constant_p(Size) ? \\r
- Endpoint_BytesToEPSizeMask(Size) : \\r
- Endpoint_BytesToEPSizeMaskDynamic(Size))))\r
- \r
- /* Function Prototypes: */\r
- void Endpoint_ClearEndpoints(void);\r
- uint8_t Endpoint_BytesToEPSizeMaskDynamic(const uint16_t Size);\r
- bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number, const uint8_t UECFG0XData, const uint8_t UECFG1XData);\r
- \r
- /* Inline Functions: */\r
- static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;\r
- static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)\r
- {\r
- uint8_t MaskVal = 0;\r
- uint16_t CheckBytes = 8;\r
- \r
- while (CheckBytes < Bytes)\r
- {\r
- MaskVal++;\r
- CheckBytes <<= 1;\r
- }\r
- \r
- return (MaskVal << EPSIZE0);\r
- }\r
-\r
- #endif\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
- \r
-#endif\r
-\r
-/** @} */\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2010.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.fourwalledcubicle.com
+*/
+
+/*
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ * \brief USB device endpoint management definitions.
+ *
+ * This file contains structures, function prototypes and macros related to the management of the device's
+ * data endpoints when the library is initialized in USB device mode.
+ *
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver
+ * dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
+/** \ingroup Group_USB
+ * @defgroup Group_EndpointManagement Endpoint Management
+ *
+ * Functions, macros and enums related to endpoint management when in USB Device mode. This
+ * module contains the endpoint management macros, as well as endpoint interrupt and data
+ * send/receive functions for various data types.
+ *
+ * @{
+ */
+
+/** @defgroup Group_EndpointRW Endpoint Data Reading and Writing
+ *
+ * Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
+ */
+
+/** \ingroup Group_EndpointRW
+ * @defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types
+ *
+ * Functions, macros, variables, enums and types related to data reading and writing of primitive data types
+ * from and to endpoints.
+ */
+
+/** \ingroup Group_EndpointRW
+ * @defgroup Group_EndpointStreamRW Read/Write of Multi-Byte Streams
+ *
+ * Functions, macros, variables, enums and types related to data reading and writing of data streams from
+ * and to endpoints.
+ */
+
+/** @defgroup Group_EndpointPacketManagement Endpoint Packet Management
+ *
+ * Functions, macros, variables, enums and types related to packet management of endpoints.
+ */
+
+#ifndef __ENDPOINT_H__
+#define __ENDPOINT_H__
+
+ /* Includes: */
+ #include <avr/io.h>
+ #include <avr/pgmspace.h>
+ #include <avr/eeprom.h>
+ #include <stdbool.h>
+
+ #include "../../../Common/Common.h"
+ #include "../HighLevel/USBTask.h"
+
+ #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
+ #include "../HighLevel/StreamCallbacks.h"
+ #endif
+
+ /* Enable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ extern "C" {
+ #endif
+
+ /* Preprocessor Checks: */
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)
+ #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
+ #endif
+
+ /* Public Interface - May be used in end-application: */
+ /* Macros: */
+ /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
+ * should be initialized in the OUT direction - i.e. data flows from host to device.
+ */
+ #define ENDPOINT_DIR_OUT (0 << EPDIR)
+
+ /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
+ * should be initialized in the IN direction - i.e. data flows from device to host.
+ */
+ #define ENDPOINT_DIR_IN (1 << EPDIR)
+
+ /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
+ * that the endpoint should have one single bank, which requires less USB FIFO memory but results
+ * in slower transfers as only one USB device (the AVR or the host) can access the endpoint's
+ * bank at the one time.
+ */
+ #define ENDPOINT_BANK_SINGLE (0 << EPBK0)
+
+ /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
+ * that the endpoint should have two banks, which requires more USB FIFO memory but results
+ * in faster transfers as one USB device (the AVR or the host) can access one bank while the other
+ * accesses the second bank.
+ */
+ #define ENDPOINT_BANK_DOUBLE (1 << EPBK0)
+
+ /** Endpoint address for the default control endpoint, which always resides in address 0. This is
+ * defined for convenience to give more readable code when used with the endpoint macros.
+ */
+ #define ENDPOINT_CONTROLEP 0
+
+ #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
+ /** Default size of the default control endpoint's bank, until altered by the Endpoint0Size value
+ * in the device descriptor. Not available if the FIXED_CONTROL_ENDPOINT_SIZE token is defined.
+ */
+ #define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8
+ #endif
+
+ /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
+ * numerical address in the device.
+ */
+ #define ENDPOINT_EPNUM_MASK 0x07
+
+ /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's
+ * direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks.
+ */
+ #define ENDPOINT_EPDIR_MASK 0x80
+
+ /** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's
+ * bank size in the device.
+ */
+ #define ENDPOINT_EPSIZE_MASK 0x7FF
+
+ /** Maximum size in bytes of a given endpoint.
+ *
+ * \param[in] n Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
+ */
+ #define ENDPOINT_MAX_SIZE(n) _ENDPOINT_GET_MAXSIZE(n)
+
+ /** Indicates if the given endpoint supports double banking.
+ *
+ * \param[in] n Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
+ */
+ #define ENDPOINT_DOUBLEBANK_SUPPORTED(n) _ENDPOINT_GET_DOUBLEBANK(n)
+
+ #if !defined(CONTROL_ONLY_DEVICE)
+ #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
+ /** Total number of endpoints (including the default control endpoint at address 0) which may
+ * be used in the device. Different USB AVR models support different amounts of endpoints,
+ * this value reflects the maximum number of endpoints for the currently selected AVR model.
+ */
+ #define ENDPOINT_TOTAL_ENDPOINTS 7
+ #else
+ #define ENDPOINT_TOTAL_ENDPOINTS 5
+ #endif
+ #else
+ #define ENDPOINT_TOTAL_ENDPOINTS 1
+ #endif
+
+ /* Pseudo-Function Macros: */
+ #if defined(__DOXYGEN__)
+ /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
+ *
+ * \note The return width of this function may differ, depending on the maximum endpoint bank size
+ * of the selected AVR model.
+ *
+ * \ingroup Group_EndpointRW
+ *
+ * \return Total number of bytes in the currently selected Endpoint's FIFO buffer
+ */
+ static inline uint16_t Endpoint_BytesInEndpoint(void);
+
+ /** Get the endpoint address of the currently selected endpoint. This is typically used to save
+ * the currently selected endpoint number so that it can be restored after another endpoint has
+ * been manipulated.
+ *
+ * \return Index of the currently selected endpoint
+ */
+ static inline uint8_t Endpoint_GetCurrentEndpoint(void);
+
+ /** Selects the given endpoint number. If the address from the device descriptors is used, the
+ * value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
+ * number (and discarding the endpoint direction bit).
+ *
+ * Any endpoint operations which do not require the endpoint number to be indicated will operate on
+ * the currently selected endpoint.
+ *
+ * \param[in] EndpointNumber Endpoint number to select
+ */
+ static inline void Endpoint_SelectEndpoint(uint8_t EndpointNumber);
+
+ /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
+ * In and Out pointers to the bank's contents.
+ *
+ * \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset
+ */
+ static inline void Endpoint_ResetFIFO(uint8_t EndpointNumber);
+
+ /** Enables the currently selected endpoint so that data can be sent and received through it to
+ * and from a host.
+ *
+ * \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
+ */
+ static inline void Endpoint_EnableEndpoint(void);
+
+ /** Disables the currently selected endpoint so that data cannot be sent and received through it
+ * to and from a host.
+ */
+ static inline void Endpoint_DisableEndpoint(void);
+
+ /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
+ *
+ * \return Boolean True if the currently selected endpoint is enabled, false otherwise
+ */
+ static inline bool Endpoint_IsEnabled(void);
+
+ /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
+ * bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
+ * direction). This function will return false if an error has occurred in the endpoint, if the endpoint
+ * is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
+ * direction and the endpoint bank is full.
+ *
+ * \ingroup Group_EndpointPacketManagement
+ *
+ * \return Boolean true if the currently selected endpoint may be read from or written to, depending on its direction
+ */
+ static inline bool Endpoint_IsReadWriteAllowed(void);
+
+ /** Determines if the currently selected endpoint is configured.
+ *
+ * \return Boolean true if the currently selected endpoint has been configured, false otherwise
+ */
+ static inline bool Endpoint_IsConfigured(void);
+
+ /** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
+ * interrupt duration has elapsed. Which endpoints have interrupted can be determined by
+ * masking the return value against (1 << {Endpoint Number}).
+ *
+ * \return Mask whose bits indicate which endpoints have interrupted
+ */
+ static inline uint8_t Endpoint_GetEndpointInterrupts(void);
+
+ /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
+ * endpoints).
+ *
+ * \param[in] EndpointNumber Index of the endpoint whose interrupt flag should be tested
+ *
+ * \return Boolean true if the specified endpoint has interrupted, false otherwise
+ */
+ static inline bool Endpoint_HasEndpointInterrupted(uint8_t EndpointNumber);
+
+ /** Determines if the selected IN endpoint is ready for a new packet.
+ *
+ * \ingroup Group_EndpointPacketManagement
+ *
+ * \return Boolean true if the current endpoint is ready for an IN packet, false otherwise.
+ */
+ static inline bool Endpoint_IsINReady(void);
+
+ /** Determines if the selected OUT endpoint has received new packet.
+ *
+ * \ingroup Group_EndpointPacketManagement
+ *
+ * \return Boolean true if current endpoint is has received an OUT packet, false otherwise.
+ */
+ static inline bool Endpoint_IsOUTReceived(void);
+
+ /** Determines if the current CONTROL type endpoint has received a SETUP packet.
+ *
+ * \ingroup Group_EndpointPacketManagement
+ *
+ * \return Boolean true if the selected endpoint has received a SETUP packet, false otherwise.
+ */
+ static inline bool Endpoint_IsSETUPReceived(void);
+
+ /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
+ * endpoint for the next packet.
+ *
+ * \ingroup Group_EndpointPacketManagement
+ *
+ * \note This is not applicable for non CONTROL type endpoints.
+ */
+ static inline void Endpoint_ClearSETUP(void);
+
+ /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
+ * next packet and switching to the alternative endpoint bank if double banked.
+ *
+ * \ingroup Group_EndpointPacketManagement
+ */
+ static inline void Endpoint_ClearIN(void);
+
+ /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
+ * for the next packet and switching to the alternative endpoint bank if double banked.
+ *
+ * \ingroup Group_EndpointPacketManagement
+ */
+ static inline void Endpoint_ClearOUT(void);
+
+ /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
+ * indicated endpoint and that the current transfer sequence should be aborted. This provides a
+ * way for devices to indicate invalid commands to the host so that the current transfer can be
+ * aborted and the host can begin its own recovery sequence.
+ *
+ * The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
+ * is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
+ * endpoint.
+ *
+ * \ingroup Group_EndpointPacketManagement
+ */
+ static inline void Endpoint_StallTransaction(void);
+
+ /** Clears the STALL condition on the currently selected endpoint.
+ *
+ * \ingroup Group_EndpointPacketManagement
+ */
+ static inline void Endpoint_ClearStall(void);
+
+ /** Determines if the currently selected endpoint is stalled, false otherwise.
+ *
+ * \ingroup Group_EndpointPacketManagement
+ *
+ * \return Boolean true if the currently selected endpoint is stalled, false otherwise
+ */
+ static inline bool Endpoint_IsStalled(void);
+
+ /** Resets the data toggle of the currently selected endpoint. */
+ static inline void Endpoint_ResetDataToggle(void);
+
+ /** Determines the currently selected endpoint's direction.
+ *
+ * \return The currently selected endpoint's direction, as a ENDPOINT_DIR_* mask.
+ */
+ static inline uint8_t Endpoint_GetEndpointDirection(void);
+
+ /** Sets the direction of the currently selected endpoint.
+ *
+ * \param[in] DirectionMask New endpoint direction, as a ENDPOINT_DIR_* mask.
+ */
+ static inline void Endpoint_SetEndpointDirection(uint8_t DirectionMask);
+ #else
+ #if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
+ #define Endpoint_BytesInEndpoint() UEBCX
+ #elif defined(USB_SERIES_4_AVR)
+ #define Endpoint_BytesInEndpoint() (((uint16_t)UEBCHX << 8) | UEBCLX)
+ #elif defined(USB_SERIES_2_AVR)
+ #define Endpoint_BytesInEndpoint() UEBCLX
+ #endif
+
+ #if !defined(CONTROL_ONLY_DEVICE)
+ #define Endpoint_GetCurrentEndpoint() (UENUM & ENDPOINT_EPNUM_MASK)
+ #else
+ #define Endpoint_GetCurrentEndpoint() ENDPOINT_CONTROLEP
+ #endif
+
+ #if !defined(CONTROL_ONLY_DEVICE)
+ #define Endpoint_SelectEndpoint(epnum) MACROS{ UENUM = (epnum); }MACROE
+ #else
+ #define Endpoint_SelectEndpoint(epnum) (void)(epnum)
+ #endif
+
+ #define Endpoint_ResetFIFO(epnum) MACROS{ UERST = (1 << (epnum)); UERST = 0; }MACROE
+
+ #define Endpoint_EnableEndpoint() MACROS{ UECONX |= (1 << EPEN); }MACROE
+
+ #define Endpoint_DisableEndpoint() MACROS{ UECONX &= ~(1 << EPEN); }MACROE
+
+ #define Endpoint_IsEnabled() ((UECONX & (1 << EPEN)) ? true : false)
+
+ #if !defined(CONTROL_ONLY_DEVICE)
+ #define Endpoint_IsReadWriteAllowed() ((UEINTX & (1 << RWAL)) ? true : false)
+ #endif
+
+ #define Endpoint_IsConfigured() ((UESTA0X & (1 << CFGOK)) ? true : false)
+
+ #define Endpoint_GetEndpointInterrupts() UEINT
+
+ #define Endpoint_HasEndpointInterrupted(n) ((UEINT & (1 << (n))) ? true : false)
+
+ #define Endpoint_IsINReady() ((UEINTX & (1 << TXINI)) ? true : false)
+
+ #define Endpoint_IsOUTReceived() ((UEINTX & (1 << RXOUTI)) ? true : false)
+
+ #define Endpoint_IsSETUPReceived() ((UEINTX & (1 << RXSTPI)) ? true : false)
+
+ #define Endpoint_ClearSETUP() MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE
+
+ #if !defined(CONTROL_ONLY_DEVICE)
+ #define Endpoint_ClearIN() MACROS{ UEINTX &= ~((1 << TXINI) | (1 << FIFOCON)); }MACROE
+ #else
+ #define Endpoint_ClearIN() MACROS{ UEINTX &= ~(1 << TXINI); }MACROE
+ #endif
+
+ #if !defined(CONTROL_ONLY_DEVICE)
+ #define Endpoint_ClearOUT() MACROS{ UEINTX &= ~((1 << RXOUTI) | (1 << FIFOCON)); }MACROE
+ #else
+ #define Endpoint_ClearOUT() MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE
+ #endif
+
+ #define Endpoint_StallTransaction() MACROS{ UECONX |= (1 << STALLRQ); }MACROE
+
+ #define Endpoint_ClearStall() MACROS{ UECONX |= (1 << STALLRQC); }MACROE
+
+ #define Endpoint_IsStalled() ((UECONX & (1 << STALLRQ)) ? true : false)
+
+ #define Endpoint_ResetDataToggle() MACROS{ UECONX |= (1 << RSTDT); }MACROE
+
+ #define Endpoint_GetEndpointDirection() (UECFG0X & ENDPOINT_DIR_IN)
+
+ #define Endpoint_SetEndpointDirection(dir) MACROS{ UECFG0X = ((UECFG0X & ~ENDPOINT_DIR_IN) | (dir)); }MACROE
+ #endif
+
+ /* Enums: */
+ /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
+ *
+ * \ingroup Group_EndpointRW
+ */
+ enum Endpoint_WaitUntilReady_ErrorCodes_t
+ {
+ ENDPOINT_READYWAIT_NoError = 0, /**< Endpoint is ready for next packet, no error. */
+ ENDPOINT_READYWAIT_EndpointStalled = 1, /**< The endpoint was stalled during the stream
+ * transfer by the host or device.
+ */
+ ENDPOINT_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while
+ * waiting for the endpoint to become ready.
+ */
+ ENDPOINT_READYWAIT_BusSuspended = 3, /**< The USB bus has been suspended by the host and
+ * no USB endpoint traffic can occur until the bus
+ * has resumed.
+ */
+ ENDPOINT_READYWAIT_Timeout = 4, /**< The host failed to accept or send the next packet
+ * within the software timeout period set by the
+ * \ref USB_STREAM_TIMEOUT_MS macro.
+ */
+ };
+
+ /** Enum for the possible error return codes of the Endpoint_*_Stream_* functions.
+ *
+ * \ingroup Group_EndpointStreamRW
+ */
+ enum Endpoint_Stream_RW_ErrorCodes_t
+ {
+ ENDPOINT_RWSTREAM_NoError = 0, /**< Command completed successfully, no error. */
+ ENDPOINT_RWSTREAM_EndpointStalled = 1, /**< The endpoint was stalled during the stream
+ * transfer by the host or device.
+ */
+ ENDPOINT_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
+ * the transfer.
+ */
+ ENDPOINT_RWSTREAM_BusSuspended = 3, /**< The USB bus has been suspended by the host and
+ * no USB endpoint traffic can occur until the bus
+ * has resumed.
+ */
+ ENDPOINT_RWSTREAM_Timeout = 4, /**< The host failed to accept or send the next packet
+ * within the software timeout period set by the
+ * \ref USB_STREAM_TIMEOUT_MS macro.
+ */
+ ENDPOINT_RWSTREAM_CallbackAborted = 5, /**< Indicates that the stream's callback function
+ * aborted the transfer early.
+ */
+ };
+
+ /** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..
+ *
+ * \ingroup Group_EndpointStreamRW
+ */
+ enum Endpoint_ControlStream_RW_ErrorCodes_t
+ {
+ ENDPOINT_RWCSTREAM_NoError = 0, /**< Command completed successfully, no error. */
+ ENDPOINT_RWCSTREAM_HostAborted = 1, /**< The aborted the transfer prematurely. */
+ ENDPOINT_RWCSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
+ * the transfer.
+ */
+ ENDPOINT_RWCSTREAM_BusSuspended = 3, /**< The USB bus has been suspended by the host and
+ * no USB endpoint traffic can occur until the bus
+ * has resumed.
+ */
+ };
+
+ /* Inline Functions: */
+ /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ *
+ * \return Next byte in the currently selected endpoint's FIFO buffer
+ */
+ static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint8_t Endpoint_Read_Byte(void)
+ {
+ return UEDATX;
+ }
+
+ /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ *
+ * \param[in] Byte Next byte to write into the the currently selected endpoint's FIFO buffer
+ */
+ static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Write_Byte(const uint8_t Byte)
+ {
+ UEDATX = Byte;
+ }
+
+ /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ */
+ static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Discard_Byte(void)
+ {
+ uint8_t Dummy;
+
+ Dummy = UEDATX;
+ }
+
+ /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ *
+ * \return Next word in the currently selected endpoint's FIFO buffer
+ */
+ static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint16_t Endpoint_Read_Word_LE(void)
+ {
+ union
+ {
+ uint16_t Word;
+ uint8_t Bytes[2];
+ } Data;
+
+ Data.Bytes[0] = UEDATX;
+ Data.Bytes[1] = UEDATX;
+
+ return Data.Word;
+ }
+
+ /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ *
+ * \return Next word in the currently selected endpoint's FIFO buffer
+ */
+ static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint16_t Endpoint_Read_Word_BE(void)
+ {
+ union
+ {
+ uint16_t Word;
+ uint8_t Bytes[2];
+ } Data;
+
+ Data.Bytes[1] = UEDATX;
+ Data.Bytes[0] = UEDATX;
+
+ return Data.Word;
+ }
+
+ /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ *
+ * \param[in] Word Next word to write to the currently selected endpoint's FIFO buffer
+ */
+ static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Write_Word_LE(const uint16_t Word)
+ {
+ UEDATX = (Word & 0xFF);
+ UEDATX = (Word >> 8);
+ }
+
+ /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ *
+ * \param[in] Word Next word to write to the currently selected endpoint's FIFO buffer
+ */
+ static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Write_Word_BE(const uint16_t Word)
+ {
+ UEDATX = (Word >> 8);
+ UEDATX = (Word & 0xFF);
+ }
+
+ /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ */
+ static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Discard_Word(void)
+ {
+ uint8_t Dummy;
+
+ Dummy = UEDATX;
+ Dummy = UEDATX;
+ }
+
+ /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ *
+ * \return Next double word in the currently selected endpoint's FIFO buffer
+ */
+ static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint32_t Endpoint_Read_DWord_LE(void)
+ {
+ union
+ {
+ uint32_t DWord;
+ uint8_t Bytes[4];
+ } Data;
+
+ Data.Bytes[0] = UEDATX;
+ Data.Bytes[1] = UEDATX;
+ Data.Bytes[2] = UEDATX;
+ Data.Bytes[3] = UEDATX;
+
+ return Data.DWord;
+ }
+
+ /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ *
+ * \return Next double word in the currently selected endpoint's FIFO buffer
+ */
+ static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint32_t Endpoint_Read_DWord_BE(void)
+ {
+ union
+ {
+ uint32_t DWord;
+ uint8_t Bytes[4];
+ } Data;
+
+ Data.Bytes[3] = UEDATX;
+ Data.Bytes[2] = UEDATX;
+ Data.Bytes[1] = UEDATX;
+ Data.Bytes[0] = UEDATX;
+
+ return Data.DWord;
+ }
+
+ /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ *
+ * \param[in] DWord Next double word to write to the currently selected endpoint's FIFO buffer
+ */
+ static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
+ {
+ UEDATX = (DWord & 0xFF);
+ UEDATX = (DWord >> 8);
+ UEDATX = (DWord >> 16);
+ UEDATX = (DWord >> 24);
+ }
+
+ /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ *
+ * \param[in] DWord Next double word to write to the currently selected endpoint's FIFO buffer
+ */
+ static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
+ {
+ UEDATX = (DWord >> 24);
+ UEDATX = (DWord >> 16);
+ UEDATX = (DWord >> 8);
+ UEDATX = (DWord & 0xFF);
+ }
+
+ /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW
+ */
+ static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Discard_DWord(void)
+ {
+ uint8_t Dummy;
+
+ Dummy = UEDATX;
+ Dummy = UEDATX;
+ Dummy = UEDATX;
+ Dummy = UEDATX;
+ }
+
+ /* External Variables: */
+ /** Global indicating the maximum packet size of the default control endpoint located at address
+ * 0 in the device. This value is set to the value indicated in the device descriptor in the user
+ * project once the USB interface is initialized into device mode.
+ *
+ * If space is an issue, it is possible to fix this to a static value by defining the control
+ * endpoint size in the FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
+ * via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
+ * read from the descriptors at runtime and instead fixed to the given value. When used, it is
+ * important that the descriptor control endpoint size value matches the size given as the
+ * FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the FIXED_CONTROL_ENDPOINT_SIZE token
+ * be used in the descriptors to ensure this.
+ *
+ * \note This variable should be treated as read-only in the user application, and never manually
+ * changed in value.
+ */
+ #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
+ extern uint8_t USB_ControlEndpointSize;
+ #else
+ #define USB_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
+ #endif
+
+ /* Function Prototypes: */
+ #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
+ #define __CALLBACK_PARAM , StreamCallbackPtr_t Callback
+ #else
+ #define __CALLBACK_PARAM
+ #endif
+
+ /** Configures the specified endpoint number with the given endpoint type, direction, bank size
+ * and banking mode. Endpoints should be allocated in ascending order by their address in the
+ * device (i.e. endpoint 1 should be configured before endpoint 2 and so on) to prevent fragmentation
+ * of the USB FIFO memory.
+ *
+ * The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction
+ * may be either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
+ *
+ * The bank size must indicate the maximum packet size that the endpoint can handle. Different
+ * endpoint numbers can handle different maximum packet sizes - refer to the chosen USB AVR's
+ * datasheet to determine the maximum bank size for each endpoint.
+ *
+ * The banking mode may be either \ref ENDPOINT_BANK_SINGLE or \ref ENDPOINT_BANK_DOUBLE.
+ *
+ * \note The default control endpoint does not have to be manually configured, as it is automatically
+ * configured by the library internally.
+ * \n\n
+ *
+ * \note This routine will select the specified endpoint, and the endpoint will remain selected
+ * once the routine completes regardless of if the endpoint configuration succeeds.
+ *
+ * \return Boolean true if the configuration succeeded, false otherwise
+ */
+ bool Endpoint_ConfigureEndpoint(const uint8_t Number, const uint8_t Type, const uint8_t Direction,
+ const uint16_t Size, const uint8_t Banks);
+
+ /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
+ * to be read or written to it.
+ *
+ * \note This routine should not be called on CONTROL type endpoints.
+ *
+ * \ingroup Group_EndpointRW
+ *
+ * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_WaitUntilReady(void);
+
+ /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
+ * with respect to the data direction. This is a convenience function which can be used to
+ * simplify user control request handling.
+ */
+ void Endpoint_ClearStatusStage(void);
+
+ /** Reads and discards the given number of bytes from the endpoint from the given buffer,
+ * discarding fully read packets from the host as needed. The last packet is not automatically
+ * discarded once the remaining bytes has been read; the user is responsible for manually
+ * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
+ * each USB packet, the given stream callback function is executed repeatedly until the next
+ * packet is ready, allowing for early aborts of stream transfers.
+ *
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
+ * disabled and this function has the Callback parameter omitted.
+ *
+ * \note This routine should not be used on CONTROL type endpoints.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Length Number of bytes to send via the currently selected endpoint.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Discard_Stream(uint16_t Length __CALLBACK_PARAM);
+
+ /** Writes the given number of bytes to the endpoint from the given buffer in little endian,
+ * sending full packets to the host as needed. The last packet filled is not automatically sent;
+ * the user is responsible for manually sending the last written packet to the host via the
+ * \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
+ * is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
+ * aborts of stream transfers.
+ *
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
+ * disabled and this function has the Callback parameter omitted.
+ *
+ * \note This routine should not be used on CONTROL type endpoints.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_Stream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE().
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_EStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().
+ *
+ * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_PStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Writes the given number of bytes to the endpoint from the given buffer in big endian,
+ * sending full packets to the host as needed. The last packet filled is not automatically sent;
+ * the user is responsible for manually sending the last written packet to the host via the
+ * \ref Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
+ * is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
+ * aborts of stream transfers.
+ *
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
+ * disabled and this function has the Callback parameter omitted.
+ *
+ * \note This routine should not be used on CONTROL type endpoints.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_Stream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE().
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_EStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** FLASH buffer source version of \ref Endpoint_Write_Stream_BE().
+ *
+ * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_PStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Reads the given number of bytes from the endpoint from the given buffer in little endian,
+ * discarding fully read packets from the host as needed. The last packet is not automatically
+ * discarded once the remaining bytes has been read; the user is responsible for manually
+ * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
+ * each USB packet, the given stream callback function is executed repeatedly until the endpoint
+ * is ready to accept the next packet, allowing for early aborts of stream transfers.
+ *
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
+ * disabled and this function has the Callback parameter omitted.
+ *
+ * \note This routine should not be used on CONTROL type endpoints.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[out] Buffer Pointer to the destination data buffer to write to.
+ * \param[in] Length Number of bytes to send via the currently selected endpoint.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Read_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
+ * \param[in] Length Number of bytes to send via the currently selected endpoint.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Read_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Reads the given number of bytes from the endpoint from the given buffer in big endian,
+ * discarding fully read packets from the host as needed. The last packet is not automatically
+ * discarded once the remaining bytes has been read; the user is responsible for manually
+ * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro. Between
+ * each USB packet, the given stream callback function is executed repeatedly until the endpoint
+ * is ready to accept the next packet, allowing for early aborts of stream transfers.
+ *
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
+ * disabled and this function has the Callback parameter omitted.
+ *
+ * \note This routine should not be used on CONTROL type endpoints.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[out] Buffer Pointer to the destination data buffer to write to.
+ * \param[in] Length Number of bytes to send via the currently selected endpoint.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Read_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
+ * \param[in] Length Number of bytes to send via the currently selected endpoint.
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+ *
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Read_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
+ * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
+ * in both failure and success states; the user is responsible for manually clearing the setup OUT to
+ * finalize the transfer via the \ref Endpoint_ClearOUT() macro.
+ *
+ * \note This function automatically clears the control transfer's status stage. Do not manually attempt
+ * to clear the status stage when using this routine in a control transaction.
+ * \n\n
+ *
+ * \note This routine should only be used on CONTROL type endpoints.
+ *
+ * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
+ * together; i.e. the entire stream data must be read or written at the one time.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ *
+ * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_Control_Stream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.
+ *
+ * \note This function automatically clears the control transfer's status stage. Do not manually attempt
+ * to clear the status stage when using this routine in a control transaction.
+ * \n\n
+ *
+ * \note This routine should only be used on CONTROL type endpoints.
+ *
+ * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
+ * together; i.e. the entire stream data must be read or written at the one time.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ *
+ * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_Control_EStream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_LE().
+ *
+ * \note This function automatically clears the control transfer's status stage. Do not manually attempt
+ * to clear the status stage when using this routine in a control transaction.
+ * \n\n
+ *
+ * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
+ * \n\n
+ *
+ * \note This routine should only be used on CONTROL type endpoints.
+ *
+ * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
+ * together; i.e. the entire stream data must be read or written at the one time.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ *
+ * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_Control_PStream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
+ * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
+ * in both failure and success states; the user is responsible for manually clearing the setup OUT to
+ * finalize the transfer via the \ref Endpoint_ClearOUT() macro.
+ *
+ * \note This function automatically clears the control transfer's status stage. Do not manually attempt
+ * to clear the status stage when using this routine in a control transaction.
+ * \n\n
+ *
+ * \note This routine should only be used on CONTROL type endpoints.
+ *
+ * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
+ * together; i.e. the entire stream data must be read or written at the one time.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ *
+ * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_Control_Stream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().
+ *
+ * \note This function automatically clears the control transfer's status stage. Do not manually attempt
+ * to clear the status stage when using this routine in a control transaction.
+ * \n\n
+ *
+ * \note This routine should only be used on CONTROL type endpoints.
+ *
+ * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
+ * together; i.e. the entire stream data must be read or written at the one time.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ *
+ * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_Control_EStream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_BE().
+ *
+ * \note This function automatically clears the control transfer's status stage. Do not manually attempt
+ * to clear the status stage when using this routine in a control transaction.
+ * \n\n
+ *
+ * \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
+ * \n\n
+ *
+ * \note This routine should only be used on CONTROL type endpoints.
+ *
+ * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
+ * together; i.e. the entire stream data must be read or written at the one time.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[in] Buffer Pointer to the source data buffer to read from.
+ * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.
+ *
+ * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Write_Control_PStream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
+ * discarding fully read packets from the host as needed. The device IN acknowledgement is not
+ * automatically sent after success or failure states; the user is responsible for manually sending the
+ * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
+ *
+ * \note This function automatically clears the control transfer's status stage. Do not manually attempt
+ * to clear the status stage when using this routine in a control transaction.
+ * \n\n
+ *
+ * \note This routine should only be used on CONTROL type endpoints.
+ *
+ * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
+ * together; i.e. the entire stream data must be read or written at the one time.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[out] Buffer Pointer to the destination data buffer to write to.
+ * \param[in] Length Number of bytes to send via the currently selected endpoint.
+ *
+ * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Read_Control_Stream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE().
+ *
+ * \note This function automatically clears the control transfer's status stage. Do not manually attempt
+ * to clear the status stage when using this routine in a control transaction.
+ * \n\n
+ *
+ * \note This routine should only be used on CONTROL type endpoints.
+ *
+ * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
+ * together; i.e. the entire stream data must be read or written at the one time.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[out] Buffer Pointer to the destination data buffer to write to.
+ * \param[in] Length Number of bytes to send via the currently selected endpoint.
+ *
+ * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Read_Control_EStream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
+ * discarding fully read packets from the host as needed. The device IN acknowledgement is not
+ * automatically sent after success or failure states; the user is responsible for manually sending the
+ * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
+ *
+ * \note This function automatically clears the control transfer's status stage. Do not manually attempt
+ * to clear the status stage when using this routine in a control transaction.
+ * \n\n
+ *
+ * \note This routine should only be used on CONTROL type endpoints.
+ *
+ * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
+ * together; i.e. the entire stream data must be read or written at the one time.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[out] Buffer Pointer to the destination data buffer to write to.
+ * \param[in] Length Number of bytes to send via the currently selected endpoint.
+ *
+ * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Read_Control_Stream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+ /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE().
+ *
+ * \note This function automatically clears the control transfer's status stage. Do not manually attempt
+ * to clear the status stage when using this routine in a control transaction.
+ * \n\n
+ *
+ * \note This routine should only be used on CONTROL type endpoints.
+ *
+ * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
+ * together; i.e. the entire stream data must be read or written at the one time.
+ *
+ * \ingroup Group_EndpointStreamRW
+ *
+ * \param[out] Buffer Pointer to the destination data buffer to write to.
+ * \param[in] Length Number of bytes to send via the currently selected endpoint.
+ *
+ * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_Read_Control_EStream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+ /* Private Interface - For use in library only: */
+ #if !defined(__DOXYGEN__)
+ /* Macros: */
+ #define Endpoint_AllocateMemory() MACROS{ UECFG1X |= (1 << ALLOC); }MACROE
+ #define Endpoint_DeallocateMemory() MACROS{ UECFG1X &= ~(1 << ALLOC); }MACROE
+
+ #define _ENDPOINT_GET_MAXSIZE(n) _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## n)
+ #define _ENDPOINT_GET_MAXSIZE2(details) _ENDPOINT_GET_MAXSIZE3(details)
+ #define _ENDPOINT_GET_MAXSIZE3(maxsize, db) maxsize
+
+ #define _ENDPOINT_GET_DOUBLEBANK(n) _ENDPOINT_GET_DOUBLEBANK2(ENDPOINT_DETAILS_EP ## n)
+ #define _ENDPOINT_GET_DOUBLEBANK2(details) _ENDPOINT_GET_DOUBLEBANK3(details)
+ #define _ENDPOINT_GET_DOUBLEBANK3(maxsize, db) db
+
+ #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
+ #define ENDPOINT_DETAILS_EP0 64, true
+ #define ENDPOINT_DETAILS_EP1 256, true
+ #define ENDPOINT_DETAILS_EP2 64, true
+ #define ENDPOINT_DETAILS_EP3 64, true
+ #define ENDPOINT_DETAILS_EP4 64, true
+ #define ENDPOINT_DETAILS_EP5 64, true
+ #define ENDPOINT_DETAILS_EP6 64, true
+ #else
+ #define ENDPOINT_DETAILS_EP0 64, true
+ #define ENDPOINT_DETAILS_EP1 64, false
+ #define ENDPOINT_DETAILS_EP2 64, false
+ #define ENDPOINT_DETAILS_EP3 64, true
+ #define ENDPOINT_DETAILS_EP4 64, true
+ #endif
+
+ #define Endpoint_ConfigureEndpoint(Number, Type, Direction, Size, Banks) \
+ Endpoint_ConfigureEndpoint_Prv((Number), \
+ (((Type) << EPTYPE0) | (Direction)), \
+ ((1 << ALLOC) | (Banks) | \
+ (__builtin_constant_p(Size) ? \
+ Endpoint_BytesToEPSizeMask(Size) : \
+ Endpoint_BytesToEPSizeMaskDynamic(Size))))
+
+ /* Function Prototypes: */
+ void Endpoint_ClearEndpoints(void);
+ uint8_t Endpoint_BytesToEPSizeMaskDynamic(const uint16_t Size);
+ bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number, const uint8_t UECFG0XData, const uint8_t UECFG1XData);
+
+ /* Inline Functions: */
+ static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
+ static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
+ {
+ uint8_t MaskVal = 0;
+ uint16_t CheckBytes = 8;
+
+ while (CheckBytes < Bytes)
+ {
+ MaskVal++;
+ CheckBytes <<= 1;
+ }
+
+ return (MaskVal << EPSIZE0);
+ }
+
+ #endif
+
+ /* Disable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ }
+ #endif
+
+#endif
+
+/** @} */
projects / pub / USBasp.git / blobdiff