* module contains the endpoint management macros, as well as endpoint interrupt and data\r
* send/recieve functions for various data types.\r
*/\r
+\r
+/** \ingroup Group_USB\r
+ * @defgroup Group_EndpointManagement Endpoint Management\r
+ *\r
+ * Functions, macros, variables, enums and types related to the setup and management of endpoints while in USB Device mode.\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
+/** @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
*/\r
#define ENDPOINT_CONTROLEP 0\r
\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
#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
*/\r
#define ENDPOINT_INT_OUT UEIENX, (1 << RXOUTE), UEINTX, (1 << RXOUTI)\r
\r
- #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)\r
- /** Indicates the number of bytes currently stored in the current endpoint's selected bank. */\r
- #define Endpoint_BytesInEndpoint() UEBCX\r
- #else\r
- #define Endpoint_BytesInEndpoint() UEBCLX\r
- #endif\r
- \r
- /** Returns 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
- #define Endpoint_GetCurrentEndpoint() (UENUM & ENDPOINT_EPNUM_MASK)\r
+ /* Psuedo-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
- /** Selects the given endpoint number. If the address from the device descriptors is used, the\r
- * value should be masked with the 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
- #define Endpoint_SelectEndpoint(epnum) MACROS{ UENUM = epnum; }MACROE\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 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 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 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 rather than just being enabled via the\r
+ * Endpoint_ConfigureEndpoint() macro, which calls Endpoint_EnableEndpoint() automatically.\r
+ */\r
+ static inline void Endpoint_EnableEndpoint(void);\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
- #define Endpoint_ResetFIFO(epnum) MACROS{ UERST = (1 << epnum); UERST = 0; }MACROE\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
+ /** Clears the endpoint interrupt flag. This clears the specified endpoint number's interrupt\r
+ * mask in the endpoint interrupt flag register.\r
+ *\r
+ * \param EndpointNumber Index of the endpoint whose interrupt flag should be cleared\r
+ */\r
+ static inline void Endpoint_ClearEndpointInterrupt(uint8_t EndpointNumber);\r
+ \r
+ /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type\r
+ * endpoints).\r
+ *\r
+ * \param 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_ClearControlSETUP(void);\r
+ \r
+ /** Sends an IN packet to the host on the currently selected CONTROL type endpoint, freeing up the\r
+ * endpoint for the next packet.\r
+ *\r
+ * \ingroup Group_EndpointPacketManagement\r
+ *\r
+ * \note For non CONTROL type endpoints, use Endpoint_ClearIN() instead. \r
+ */\r
+ static inline void Endpoint_ClearControlIN(void);\r
+ \r
+ /** Acknowledges an OUT packet to the host on the currently selected CONTROL type endpoint, freeing\r
+ * up the endpoint for the next packet.\r
+ *\r
+ * \ingroup Group_EndpointPacketManagement\r
+ *\r
+ * \note For non CONTROL type endpoints, use Endpoint_ClearOUT() instead.\r
+ */\r
+ static inline void Endpoint_ClearControlOUT(void);\r
+ \r
+ /** Sends an IN packet to the host on the currently selected non CONTROL type endpoint, freeing\r
+ * up the endpoint for the next packet and switching to the alternative endpoint bank if double banked.\r
+ *\r
+ * \ingroup Group_EndpointPacketManagement\r
+ *\r
+ * \note For CONTROL type endpoints, use Endpoint_ClearControlIN() instead.\r
+ */\r
+ static inline void Endpoint_ClearIN(void);\r
+ \r
+ /** Acknowledges an OUT packet to the host on the currently selected non CONTROL type endpoint, freeing\r
+ * up the endpoint for the next packet and switching to the alternative endpoint bank if double banked.\r
+ *\r
+ * \ingroup Group_EndpointPacketManagement\r
+ *\r
+ * \note For CONTROL type endpoints, use Endpoint_ClearControlOUT() instead.\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 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
+ #else\r
+ #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)\r
+ #define Endpoint_BytesInEndpoint() UEBCX\r
+ #else\r
+ #define Endpoint_BytesInEndpoint() UEBCLX\r
+ #endif\r
+ \r
+ #define Endpoint_GetCurrentEndpoint() (UENUM & ENDPOINT_EPNUM_MASK)\r
+ \r
+ #define Endpoint_SelectEndpoint(epnum) MACROS{ UENUM = epnum; }MACROE\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 rather than just being enabled via the\r
- * Endpoint_ConfigureEndpoint() macro, which calls Endpoint_EnableEndpoint() automatically.\r
- */\r
- #define Endpoint_EnableEndpoint() MACROS{ UECONX |= (1 << EPEN); }MACROE\r
+ #define Endpoint_ResetFIFO(epnum) MACROS{ UERST = (1 << epnum); UERST = 0; }MACROE\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
- #define Endpoint_DisableEndpoint() MACROS{ UECONX &= ~(1 << EPEN); }MACROE\r
+ #define Endpoint_EnableEndpoint() MACROS{ UECONX |= (1 << EPEN); }MACROE\r
\r
- /** Returns true if the currently selected endpoint is enabled, false otherwise. */\r
- #define Endpoint_IsEnabled() ((UECONX & (1 << EPEN)) ? true : false)\r
+ #define Endpoint_DisableEndpoint() MACROS{ UECONX &= ~(1 << EPEN); }MACROE\r
\r
- /** Returns true 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\r
- * IN direction). This function will return false if an error has occurred in the endpoint, or if\r
- * the endpoint is an OUT direction and no packet has been received, or if the endpoint is an IN\r
- * direction and the endpoint bank is full.\r
- */\r
- #define Endpoint_ReadWriteAllowed() ((UEINTX & (1 << RWAL)) ? true : false)\r
+ #define Endpoint_IsEnabled() ((UECONX & (1 << EPEN)) ? true : false)\r
\r
- /** Returns true if the currently selected endpoint is configured, false otherwise. */\r
- #define Endpoint_IsConfigured() ((UESTA0X & (1 << CFGOK)) ? true : false)\r
+ #define Endpoint_IsReadWriteAllowed() ((UEINTX & (1 << RWAL)) ? true : false)\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
- #define Endpoint_GetEndpointInterrupts() UEINT\r
+ #define Endpoint_IsConfigured() ((UESTA0X & (1 << CFGOK)) ? true : false)\r
\r
- /** Clears the endpoint interrupt flag. This clears the specified endpoint number's interrupt\r
- * mask in the endpoint interrupt flag register.\r
- */\r
- #define Endpoint_ClearEndpointInterrupt(n) MACROS{ UEINT &= ~(1 << n); }MACROE\r
+ #define Endpoint_GetEndpointInterrupts() UEINT\r
\r
- /** Returns true if the specified endpoint number has interrupted (valid only for INTERRUPT type\r
- * endpoints), false otherwise.\r
- */\r
- #define Endpoint_HasEndpointInterrupted(n) ((UEINT & (1 << n)) ? true : false)\r
+ #define Endpoint_ClearEndpointInterrupt(n) MACROS{ UEINT &= ~(1 << n); }MACROE\r
\r
- /** Clears the currently selected endpoint bank, and switches to the alternate bank if the currently\r
- * selected endpoint is dual-banked. When cleared, this either frees the bank up for the next packet\r
- * from the host (if the endpoint is of the OUT direction) or sends the packet contents to the host\r
- * (if the endpoint is of the IN direction).\r
- */\r
- #define Endpoint_ClearCurrentBank() MACROS{ UEINTX &= ~(1 << FIFOCON); }MACROE\r
- \r
- /** Returns true if the current CONTROL type endpoint is ready for an IN packet, false otherwise. */\r
- #define Endpoint_IsSetupINReady() ((UEINTX & (1 << TXINI)) ? true : false)\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
- /** Returns true if the current CONTROL type endpoint is ready for an OUT packet, false otherwise. */\r
- #define Endpoint_IsSetupOUTReceived() ((UEINTX & (1 << RXOUTI)) ? true : false)\r
+ #define Endpoint_IsSETUPReceived() ((UEINTX & (1 << RXSTPI)) ? true : false)\r
\r
- /** Returns true if the current CONTROL type endpoint is ready for a SETUP packet, false otherwise. */\r
- #define Endpoint_IsSetupReceived() ((UEINTX & (1 << RXSTPI)) ? true : false)\r
+ #define Endpoint_ClearControlSETUP() MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE\r
\r
- /** Clears a received SETUP packet on the currently selected CONTROL type endpoint. */\r
- #define Endpoint_ClearSetupReceived() MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE\r
+ #define Endpoint_ClearControlIN() MACROS{ UEINTX &= ~(1 << TXINI); }MACROE\r
\r
- /** Sends an IN packet to the host on the currently selected CONTROL type endpoint. */\r
- #define Endpoint_ClearSetupIN() MACROS{ UEINTX &= ~(1 << TXINI); }MACROE\r
+ #define Endpoint_ClearControlOUT() MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE\r
\r
- /** Acknowledges an OUT packet to the host on the currently selected CONTROL type endpoint, freeing\r
- * up the endpoint for the next packet.\r
- */\r
- #define Endpoint_ClearSetupOUT() MACROS{ UEINTX &= ~(1 << RXOUTI); }MACROE\r
+ #define Endpoint_ClearIN() MACROS{ UEINTX &= ~(1 << TXINI); UEINTX &= ~(1 << FIFOCON); }MACROE\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 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
- #define Endpoint_StallTransaction() MACROS{ UECONX |= (1 << STALLRQ); }MACROE\r
+ #define Endpoint_ClearOUT() MACROS{ UEINTX &= ~(1 << RXOUTI); UEINTX &= ~(1 << FIFOCON); }MACROE\r
\r
- /** Clears the stall on the currently selected endpoint. */\r
- #define Endpoint_ClearStall() MACROS{ UECONX |= (1 << STALLRQC); }MACROE\r
+ #define Endpoint_StallTransaction() MACROS{ UECONX |= (1 << STALLRQ); }MACROE\r
\r
- /** Returns true if the currently selected endpoint is stalled, false otherwise. */\r
- #define Endpoint_IsStalled() ((UECONX & (1 << STALLRQ)) ? true : false)\r
+ #define Endpoint_ClearStall() MACROS{ UECONX |= (1 << STALLRQC); }MACROE\r
\r
- /** Resets the data toggle of the currently selected endpoint. */\r
- #define Endpoint_ResetDataToggle() MACROS{ UECONX |= (1 << RSTDT); }MACROE\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
+ #endif\r
\r
/* Enums: */\r
- /** Enum for the possible error return codes of the Endpoint_WaitUntilReady function */\r
+ /** Enum for the possible error return codes of the 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
*/\r
};\r
\r
- /** Enum for the possible error return codes of the Endpoint_*_Stream_* functions. */\r
+ /** Enum for the possible error return codes of the Endpoint_*_Stream_* functions.\r
+ *\r
+ * \ingroup Group_EndpointRW\r
+ */\r
enum Endpoint_Stream_RW_ErrorCodes_t\r
{\r
ENDPOINT_RWSTREAM_ERROR_NoError = 0, /**< Command completed successfully, no error. */\r
*/\r
};\r
\r
- /** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions. */\r
+ /** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..\r
+ *\r
+ * \ingroup Group_EndpointRW\r
+ */\r
enum Endpoint_ControlStream_RW_ErrorCodes_t\r
{\r
ENDPOINT_RWCSTREAM_ERROR_NoError = 0, /**< Command completed successfully, no error. */\r
};\r
\r
/* Inline Functions: */\r
- /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints. */\r
+ /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.\r
+ *\r
+ * \ingroup Group_EndpointRW\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
+ /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.\r
+ *\r
+ * \ingroup Group_EndpointRW\r
+ *\r
+ * \param 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
+ /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.\r
+ *\r
+ * \ingroup Group_EndpointRW\r
+ */\r
static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;\r
static inline void Endpoint_Discard_Byte(void)\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_EndpointRW\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
/** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT\r
* direction endpoints.\r
+ *\r
+ * \ingroup Group_EndpointRW\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
/** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN\r
* direction endpoints.\r
+ *\r
+ * \ingroup Group_EndpointRW\r
+ *\r
+ * \param 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
/** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN\r
* direction endpoints.\r
+ *\r
+ * \ingroup Group_EndpointRW\r
+ *\r
+ * \param 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
UEDATX = (Word & 0xFF);\r
}\r
\r
- /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints. */\r
+ /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.\r
+ *\r
+ * \ingroup Group_EndpointRW\r
+ */\r
static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;\r
static inline void Endpoint_Discard_Word(void)\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_EndpointRW\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
/** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT\r
* direction endpoints.\r
+ *\r
+ * \ingroup Group_EndpointRW\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
/** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN\r
* direction endpoints.\r
+ *\r
+ * \ingroup Group_EndpointRW\r
+ *\r
+ * \param 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
/** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN\r
* direction endpoints.\r
+ *\r
+ * \ingroup Group_EndpointRW\r
+ *\r
+ * \param 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
UEDATX = (DWord & 0xFF);\r
}\r
\r
- /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints. */\r
+ /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints. \r
+ *\r
+ * \ingroup Group_EndpointRW\r
+ */\r
static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;\r
static inline void Endpoint_Discard_DWord(void)\r
{\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 Endpoint_WaitUntilReady_ErrorCodes_t enum.\r
*/\r
uint8_t Endpoint_WaitUntilReady(void);\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 Endpoint_ClearCurrentBank() macro. Between\r
+ * discarding the last packet from the host via the 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
*\r
* \note This routine should not be used on CONTROL type endpoints.\r
*\r
+ * \ingroup Group_EndpointRW\r
+ *\r
* \param Length Number of bytes to send via the currently selected endpoint.\r
* \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\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
- * Endpoint_ClearCurrentBank() macro. Between each USB packet, the given stream callback function\r
+ * 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
*\r
* \note This routine should not be used on CONTROL type endpoints.\r
*\r
+ * \ingroup Group_EndpointRW\r
+ *\r
* \param Buffer Pointer to the source data buffer to read from.\r
* \param Length Number of bytes to read for the currently selected endpoint into the buffer.\r
* \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\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
- * Endpoint_ClearCurrentBank() macro. Between each USB packet, the given stream callback function\r
+ * 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
*\r
* \note This routine should not be used on CONTROL type endpoints.\r
*\r
+ * \ingroup Group_EndpointRW\r
+ *\r
* \param Buffer Pointer to the source data buffer to read from.\r
* \param Length Number of bytes to read for the currently selected endpoint into the buffer.\r
* \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\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 Endpoint_ClearCurrentBank() macro. Between\r
+ * discarding the last packet from the host via the 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
*\r
* \note This routine should not be used on CONTROL type endpoints.\r
*\r
+ * \ingroup Group_EndpointRW\r
+ *\r
* \param Buffer Pointer to the destination data buffer to write to.\r
* \param Length Number of bytes to send via the currently selected endpoint.\r
* \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\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 Endpoint_ClearCurrentBank() macro. Between\r
+ * discarding the last packet from the host via the 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
*\r
* \note This routine should not be used on CONTROL type endpoints.\r
*\r
+ * \ingroup Group_EndpointRW\r
+ *\r
* \param Buffer Pointer to the destination data buffer to write to.\r
* \param Length Number of bytes to send via the currently selected endpoint.\r
* \param Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback\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 Endpoint_ClearSetupOUT() macro.\r
+ * finalize the transfer via the Endpoint_ClearControlOUT() macro.\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_EndpointRW\r
+ *\r
* \param Buffer Pointer to the source data buffer to read from.\r
* \param Length Number of bytes to read for the currently selected endpoint into the buffer.\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 Endpoint_ClearSetupOUT() macro.\r
+ * finalize the transfer via the Endpoint_ClearControlOUT() macro.\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_EndpointRW\r
+ *\r
* \param Buffer Pointer to the source data buffer to read from.\r
* \param Length Number of bytes to read for the currently selected endpoint into the buffer.\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 Endpoint_ClearSetupIN() macro.\r
+ * setup IN to finalize the transfer via the Endpoint_ClearControlIN() macro.\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_EndpointRW\r
+ *\r
* \param Buffer Pointer to the destination data buffer to write to.\r
* \param Length Number of bytes to send via the currently selected endpoint.\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 Endpoint_ClearSetupIN() macro.\r
+ * setup IN to finalize the transfer via the Endpoint_ClearControlIN() macro.\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_EndpointRW\r
+ *\r
* \param Buffer Pointer to the destination data buffer to write to.\r
* \param Length Number of bytes to send via the currently selected endpoint.\r
*\r
* \return A value from the 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
- /* Function Aliases: */\r
- /** Alias for Endpoint_Discard_Byte().\r
- */\r
- #define Endpoint_Ignore_Byte() Endpoint_Discard_Byte()\r
-\r
- /** Alias for Endpoint_Discard_Word().\r
- */\r
- #define Endpoint_Ignore_Word() Endpoint_Discard_Word() \r
-\r
- /** Alias for Endpoint_Discard_DWord().\r
- */\r
- #define Endpoint_Ignore_DWord() Endpoint_Discard_DWord()\r
- \r
- /** Alias for Endpoint_Read_Word_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specified indicates little endian mode.\r
- */\r
- #define Endpoint_Read_Word() Endpoint_Read_Word_LE() \r
-\r
- /** Alias for Endpoint_Write_Word_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specified indicates little endian mode.\r
- */\r
- #define Endpoint_Write_Word(Word) Endpoint_Write_Word_LE(Word)\r
-\r
- /** Alias for Endpoint_Read_DWord_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specified indicates little endian mode.\r
- */\r
- #define Endpoint_Read_DWord() Endpoint_Read_DWord_LE()\r
-\r
- /** Alias for Endpoint_Write_DWord_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specified indicates little endian mode.\r
- */\r
- #define Endpoint_Write_DWord(DWord) Endpoint_Write_DWord_LE(DWord)\r
-\r
- /** Alias for Endpoint_Read_Stream_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specified indicates little endian mode.\r
- */\r
- #if !defined(NO_STREAM_CALLBACKS)\r
- #define Endpoint_Read_Stream(Buffer, Length, Callback) Endpoint_Read_Stream_LE(Buffer, Length, Callback)\r
- #else\r
- #define Endpoint_Read_Stream(Buffer, Length) Endpoint_Read_Stream_LE(Buffer, Length)\r
- #endif\r
-\r
- /** Alias for Endpoint_Write_Stream_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specified indicates little endian mode.\r
- */\r
- #if !defined(NO_STREAM_CALLBACKS)\r
- #define Endpoint_Write_Stream(Buffer, Length, Callback) Endpoint_Write_Stream_LE(Buffer, Length, Callback)\r
- #else\r
- #define Endpoint_Write_Stream(Buffer, Length) Endpoint_Write_Stream_LE(Buffer, Length)\r
- #endif\r
-\r
- /** Alias for Endpoint_Read_Control_Stream_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specified indicates little endian mode.\r
- */\r
- #define Endpoint_Read_Control_Stream(Data, Length) Endpoint_Read_Control_Stream_LE(Data, Length)\r
-\r
- /** Alias for Endpoint_Write_Control_Stream_LE(). By default USB transfers use little endian format, thus\r
- * the command with no endianness specified indicates little endian mode.\r
- */\r
- #define Endpoint_Write_Control_Stream(Data, Length) Endpoint_Write_Control_Stream_LE(Data, Length) \r
+ uint8_t Endpoint_Read_Control_Stream_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
#endif\r
\r
#endif\r
+\r
+/** @} */\r
projects / pub / lufa.git / blobdiff