+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2012.\r
-\r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2012 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 Endpoint definitions for the AVR8 microcontrollers.\r
- * \copydetails Group_EndpointManagement_AVR8\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_EndpointRW\r
- * \defgroup Group_EndpointRW_AVR8 Endpoint Data Reading and Writing (AVR8)\r
- * \brief Endpoint data read/write definitions for the Atmel AVR8 architecture.\r
- *\r
- * Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.\r
- */\r
-\r
-/** \ingroup Group_EndpointPrimitiveRW\r
- * \defgroup Group_EndpointPrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8)\r
- * \brief Endpoint primitive read/write definitions for the Atmel AVR8 architecture.\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_EndpointPacketManagement\r
- * \defgroup Group_EndpointPacketManagement_AVR8 Endpoint Packet Management (AVR8)\r
- * \brief Endpoint packet management definitions for the Atmel AVR8 architecture.\r
- *\r
- * Functions, macros, variables, enums and types related to packet management of endpoints.\r
- */\r
-\r
-/** \ingroup Group_EndpointManagement\r
- * \defgroup Group_EndpointManagement_AVR8 Endpoint Management (AVR8)\r
- * \brief Endpoint management definitions for the Atmel AVR8 architecture.\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
-#ifndef __ENDPOINT_AVR8_H__\r
-#define __ENDPOINT_AVR8_H__\r
-\r
- /* Includes: */\r
- #include "../../../../Common/Common.h"\r
- #include "../USBTask.h"\r
- #include "../USBInterrupt.h"\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
- /* Private Interface - For use in library only: */\r
- #if !defined(__DOXYGEN__)\r
- /* Inline Functions: */\r
- static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST\r
- 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
- /* Function Prototypes: */\r
- void Endpoint_ClearEndpoints(void);\r
- bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,\r
- const uint8_t UECFG0XData,\r
- const uint8_t UECFG1XData);\r
-\r
- #endif\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))\r
- /** Default size of the default control endpoint's bank, until altered by the control endpoint bank size\r
- * value in the device descriptor. Not available if the \c FIXED_CONTROL_ENDPOINT_SIZE token is defined.\r
- */\r
- #define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8\r
- #endif\r
-\r
- #if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)\r
- #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)\r
- #define ENDPOINT_TOTAL_ENDPOINTS 7\r
- #else\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 5\r
- #endif\r
- #else\r
- #define ENDPOINT_TOTAL_ENDPOINTS 1\r
- #endif\r
-\r
- /* Enums: */\r
- /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.\r
- *\r
- * \ingroup Group_EndpointRW_AVR8\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
- /* Inline Functions: */\r
- /** Configures the specified endpoint address with the given endpoint type, bank size and number of hardware\r
- * banks. Once configured, the endpoint may be read from or written to, depending on its direction.\r
- *\r
- * \param[in] Address Endpoint address to configure.\r
- *\r
- * \param[in] Type Type of endpoint to configure, a \c EP_TYPE_* mask. Not all endpoint types\r
- * are available on Low Speed USB devices - refer to the USB 2.0 specification.\r
- *\r
- * \param[in] Size Size of the endpoint's bank, where packets are stored before they are transmitted\r
- * to the USB host, or after they have been received from the USB host (depending on\r
- * the endpoint's data direction). The bank size must indicate the maximum packet size\r
- * that the endpoint can handle.\r
- *\r
- * \param[in] Banks Number of banks to use for the endpoint being configured.\r
- *\r
- * \attention When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in\r
- * ascending order, or bank corruption will occur.\r
- *\r
- * \note Different endpoints may have different maximum packet sizes based on the endpoint's index - please\r
- * refer to the chosen microcontroller model's datasheet to determine the maximum bank size for each endpoint.\r
- * \n\n\r
- *\r
- * \note The default control endpoint should not be manually configured by the user application, as\r
- * it is automatically configured by the library internally.\r
- * \n\n\r
- *\r
- * \note This routine will automatically select the specified endpoint upon success. Upon failure, the endpoint\r
- * which failed to reconfigure correctly will be selected.\r
- *\r
- * \return Boolean \c true if the configuration succeeded, \c false otherwise.\r
- */\r
- static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,\r
- const uint8_t Type,\r
- const uint16_t Size,\r
- const uint8_t Banks) ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,\r
- const uint8_t Type,\r
- const uint16_t Size,\r
- const uint8_t Banks)\r
- {\r
- uint8_t Number = (Address & ENDPOINT_EPNUM_MASK);\r
- \r
- if (Number >= ENDPOINT_TOTAL_ENDPOINTS)\r
- return false;\r
- \r
- return Endpoint_ConfigureEndpoint_Prv(Number,\r
- ((Type << EPTYPE0) | ((Address & ENDPOINT_DIR_IN) ? (1 << EPDIR) : 0)),\r
- ((1 << ALLOC) | ((Banks > 1) ? (1 << EPBK0) : 0) | Endpoint_BytesToEPSizeMask(Size)));\r
- }\r
-\r
- /** Indicates the number of bytes currently stored in the current endpoint's selected bank.\r
- *\r
- * \ingroup Group_EndpointRW_AVR8\r
- *\r
- * \return Total number of bytes in the currently selected Endpoint's FIFO buffer.\r
- */\r
- static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint16_t Endpoint_BytesInEndpoint(void)\r
- {\r
- #if (defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)) && !defined(__AVR_ATmega32U6__)\r
- return UEBCX;\r
- #elif defined(USB_SERIES_4_AVR) || defined(__AVR_ATmega32U6__)\r
- return (((uint16_t)UEBCHX << 8) | UEBCLX);\r
- #elif defined(USB_SERIES_2_AVR)\r
- return UEBCLX;\r
- #endif\r
- }\r
-\r
- /** Determines the currently selected endpoint's direction.\r
- *\r
- * \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.\r
- */\r
- static inline uint8_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint8_t Endpoint_GetEndpointDirection(void)\r
- {\r
- return (UECFG0X & (1 << EPDIR)) ? ENDPOINT_DIR_IN : ENDPOINT_DIR_OUT;\r
- }\r
-\r
- /** Get the endpoint address of the currently selected endpoint. This is typically used to save\r
- * the currently selected endpoint so that it can be restored after another endpoint has been\r
- * manipulated.\r
- *\r
- * \return Index of the currently selected endpoint.\r
- */\r
- static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint8_t Endpoint_GetCurrentEndpoint(void)\r
- {\r
- #if !defined(CONTROL_ONLY_DEVICE)\r
- return ((UENUM & ENDPOINT_EPNUM_MASK) | Endpoint_GetEndpointDirection());\r
- #else\r
- return ENDPOINT_CONTROLEP;\r
- #endif\r
- }\r
-\r
- /** Selects the given endpoint address.\r
- *\r
- * Any endpoint operations which do not require the endpoint address to be indicated will operate on\r
- * the currently selected endpoint.\r
- *\r
- * \param[in] Address Endpoint address to select.\r
- */\r
- static inline void Endpoint_SelectEndpoint(const uint8_t Address) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_SelectEndpoint(const uint8_t Address)\r
- {\r
- #if !defined(CONTROL_ONLY_DEVICE)\r
- UENUM = (Address & ENDPOINT_EPNUM_MASK);\r
- #endif\r
- }\r
-\r
- /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's\r
- * data In and Out pointers to the bank's contents.\r
- *\r
- * \param[in] Address Endpoint address whose FIFO buffers are to be reset.\r
- */\r
- static inline void Endpoint_ResetEndpoint(const uint8_t Address) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_ResetEndpoint(const uint8_t Address)\r
- {\r
- UERST = (1 << (Address & ENDPOINT_EPNUM_MASK));\r
- UERST = 0;\r
- }\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) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_EnableEndpoint(void)\r
- {\r
- UECONX |= (1 << EPEN);\r
- }\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) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_DisableEndpoint(void)\r
- {\r
- UECONX &= ~(1 << EPEN);\r
- }\r
-\r
- /** Determines if the currently selected endpoint is enabled, but not necessarily configured.\r
- *\r
- * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.\r
- */\r
- static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_IsEnabled(void)\r
- {\r
- return ((UECONX & (1 << EPEN)) ? true : false);\r
- }\r
-\r
- /** Retrieves the number of busy banks in the currently selected endpoint, which have been queued for\r
- * transmission via the \ref Endpoint_ClearIN() command, or are awaiting acknowledgement via the\r
- * \ref Endpoint_ClearOUT() command.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_AVR8\r
- *\r
- * \return Total number of busy banks in the selected endpoint.\r
- */\r
- static inline uint8_t Endpoint_GetBusyBanks(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;\r
- static inline uint8_t Endpoint_GetBusyBanks(void)\r
- {\r
- return (UESTA0X & (0x03 << NBUSYBK0));\r
- }\r
-\r
- /** Aborts all pending IN transactions on the currently selected endpoint, once the bank\r
- * has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function\r
- * will terminate all queued transactions, resetting the endpoint banks ready for a new\r
- * packet.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_AVR8\r
- */\r
- static inline void Endpoint_AbortPendingIN(void)\r
- {\r
- while (Endpoint_GetBusyBanks() != 0)\r
- {\r
- UEINTX |= (1 << RXOUTI);\r
- while (UEINTX & (1 << RXOUTI));\r
- }\r
- }\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_AVR8\r
- *\r
- * \return Boolean \c true if the currently selected endpoint may be read from or written to, depending\r
- * on its direction.\r
- */\r
- static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_IsReadWriteAllowed(void)\r
- {\r
- return ((UEINTX & (1 << RWAL)) ? true : false);\r
- }\r
-\r
- /** Determines if the currently selected endpoint is configured.\r
- *\r
- * \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.\r
- */\r
- static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_IsConfigured(void)\r
- {\r
- return ((UESTA0X & (1 << CFGOK)) ? true : false);\r
- }\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 <tt>(1 << <i>{Endpoint Number}</i>)</tt>.\r
- *\r
- * \return Mask whose bits indicate which endpoints have interrupted.\r
- */\r
- static inline uint8_t Endpoint_GetEndpointInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint8_t Endpoint_GetEndpointInterrupts(void)\r
- {\r
- return UEINT;\r
- }\r
-\r
- /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type\r
- * endpoints).\r
- *\r
- * \param[in] Address Address of the endpoint whose interrupt flag should be tested.\r
- *\r
- * \return Boolean \c true if the specified endpoint has interrupted, \c false otherwise.\r
- */\r
- static inline bool Endpoint_HasEndpointInterrupted(const uint8_t Address) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_HasEndpointInterrupted(const uint8_t Address)\r
- {\r
- return ((Endpoint_GetEndpointInterrupts() & (1 << (Address & ENDPOINT_EPNUM_MASK))) ? true : false);\r
- }\r
-\r
- /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_AVR8\r
- *\r
- * \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.\r
- */\r
- static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_IsINReady(void)\r
- {\r
- return ((UEINTX & (1 << TXINI)) ? true : false);\r
- }\r
-\r
- /** Determines if the selected OUT endpoint has received new packet from the host.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_AVR8\r
- *\r
- * \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.\r
- */\r
- static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_IsOUTReceived(void)\r
- {\r
- return ((UEINTX & (1 << RXOUTI)) ? true : false);\r
- }\r
-\r
- /** Determines if the current CONTROL type endpoint has received a SETUP packet.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_AVR8\r
- *\r
- * \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.\r
- */\r
- static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_IsSETUPReceived(void)\r
- {\r
- return ((UEINTX & (1 << RXSTPI)) ? true : false);\r
- }\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_AVR8\r
- *\r
- * \note This is not applicable for non CONTROL type endpoints.\r
- */\r
- static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_ClearSETUP(void)\r
- {\r
- UEINTX &= ~(1 << RXSTPI);\r
- }\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_AVR8\r
- */\r
- static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_ClearIN(void)\r
- {\r
- #if !defined(CONTROL_ONLY_DEVICE)\r
- UEINTX &= ~((1 << TXINI) | (1 << FIFOCON));\r
- #else\r
- UEINTX &= ~(1 << TXINI);\r
- #endif\r
- }\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_AVR8\r
- */\r
- static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_ClearOUT(void)\r
- {\r
- #if !defined(CONTROL_ONLY_DEVICE)\r
- UEINTX &= ~((1 << RXOUTI) | (1 << FIFOCON));\r
- #else\r
- UEINTX &= ~(1 << RXOUTI);\r
- #endif\r
- }\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_AVR8\r
- */\r
- static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_StallTransaction(void)\r
- {\r
- UECONX |= (1 << STALLRQ);\r
- }\r
-\r
- /** Clears the STALL condition on the currently selected endpoint.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_AVR8\r
- */\r
- static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_ClearStall(void)\r
- {\r
- UECONX |= (1 << STALLRQC);\r
- }\r
-\r
- /** Determines if the currently selected endpoint is stalled, false otherwise.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_AVR8\r
- *\r
- * \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.\r
- */\r
- static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_IsStalled(void)\r
- {\r
- return ((UECONX & (1 << STALLRQ)) ? true : false);\r
- }\r
-\r
- /** Resets the data toggle of the currently selected endpoint. */\r
- static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_ResetDataToggle(void)\r
- {\r
- UECONX |= (1 << RSTDT);\r
- }\r
-\r
- /** Sets the direction of the currently selected endpoint.\r
- *\r
- * \param[in] DirectionMask New endpoint direction, as a \c ENDPOINT_DIR_* mask.\r
- */\r
- static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask)\r
- {\r
- UECFG0X = ((UECFG0X & ~(1 << EPDIR)) | (DirectionMask ? (1 << EPDIR) : 0));\r
- }\r
-\r
- /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW_AVR8\r
- *\r
- * \return Next byte in the currently selected endpoint's FIFO buffer.\r
- */\r
- static inline uint8_t Endpoint_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint8_t Endpoint_Read_8(void)\r
- {\r
- return UEDATX;\r
- }\r
-\r
- /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW_AVR8\r
- *\r
- * \param[in] Data Data to write into the the currently selected endpoint's FIFO buffer.\r
- */\r
- static inline void Endpoint_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Write_8(const uint8_t Data)\r
- {\r
- UEDATX = Data;\r
- }\r
-\r
- /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW_AVR8\r
- */\r
- static inline void Endpoint_Discard_8(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Discard_8(void)\r
- {\r
- uint8_t Dummy;\r
-\r
- Dummy = UEDATX;\r
-\r
- (void)Dummy;\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_AVR8\r
- *\r
- * \return Next two bytes in the currently selected endpoint's FIFO buffer.\r
- */\r
- static inline uint16_t Endpoint_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint16_t Endpoint_Read_16_LE(void)\r
- {\r
- union\r
- {\r
- uint16_t Value;\r
- uint8_t Bytes[2];\r
- } Data;\r
-\r
- Data.Bytes[0] = UEDATX;\r
- Data.Bytes[1] = UEDATX;\r
-\r
- return Data.Value;\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_AVR8\r
- *\r
- * \return Next two bytes in the currently selected endpoint's FIFO buffer.\r
- */\r
- static inline uint16_t Endpoint_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint16_t Endpoint_Read_16_BE(void)\r
- {\r
- union\r
- {\r
- uint16_t Value;\r
- uint8_t Bytes[2];\r
- } Data;\r
-\r
- Data.Bytes[1] = UEDATX;\r
- Data.Bytes[0] = UEDATX;\r
-\r
- return Data.Value;\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_AVR8\r
- *\r
- * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.\r
- */\r
- static inline void Endpoint_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Write_16_LE(const uint16_t Data)\r
- {\r
- UEDATX = (Data & 0xFF);\r
- UEDATX = (Data >> 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_AVR8\r
- *\r
- * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.\r
- */\r
- static inline void Endpoint_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Write_16_BE(const uint16_t Data)\r
- {\r
- UEDATX = (Data >> 8);\r
- UEDATX = (Data & 0xFF);\r
- }\r
-\r
- /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW_AVR8\r
- */\r
- static inline void Endpoint_Discard_16(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Discard_16(void)\r
- {\r
- uint8_t Dummy;\r
-\r
- Dummy = UEDATX;\r
- Dummy = UEDATX;\r
-\r
- (void)Dummy;\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_AVR8\r
- *\r
- * \return Next four bytes in the currently selected endpoint's FIFO buffer.\r
- */\r
- static inline uint32_t Endpoint_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint32_t Endpoint_Read_32_LE(void)\r
- {\r
- union\r
- {\r
- uint32_t Value;\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.Value;\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_AVR8\r
- *\r
- * \return Next four bytes in the currently selected endpoint's FIFO buffer.\r
- */\r
- static inline uint32_t Endpoint_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint32_t Endpoint_Read_32_BE(void)\r
- {\r
- union\r
- {\r
- uint32_t Value;\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.Value;\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_AVR8\r
- *\r
- * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.\r
- */\r
- static inline void Endpoint_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Write_32_LE(const uint32_t Data)\r
- {\r
- UEDATX = (Data & 0xFF);\r
- UEDATX = (Data >> 8);\r
- UEDATX = (Data >> 16);\r
- UEDATX = (Data >> 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_AVR8\r
- *\r
- * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.\r
- */\r
- static inline void Endpoint_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Write_32_BE(const uint32_t Data)\r
- {\r
- UEDATX = (Data >> 24);\r
- UEDATX = (Data >> 16);\r
- UEDATX = (Data >> 8);\r
- UEDATX = (Data & 0xFF);\r
- }\r
-\r
- /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW_AVR8\r
- */\r
- static inline void Endpoint_Discard_32(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_Discard_32(void)\r
- {\r
- uint8_t Dummy;\r
-\r
- Dummy = UEDATX;\r
- Dummy = UEDATX;\r
- Dummy = UEDATX;\r
- Dummy = UEDATX;\r
-\r
- (void)Dummy;\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 \c 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
- * \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token\r
- * be used in the device descriptors to ensure this.\r
- *\r
- * \attention 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_Device_ControlEndpointSize;\r
- #else\r
- #define USB_Device_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE\r
- #endif\r
-\r
- /* Function Prototypes: */\r
- /** Configures a table of endpoint descriptions, in sequence. This function can be used to configure multiple\r
- * endpoints at the same time.\r
- *\r
- * \note Endpoints with a zero address will be ignored, thus this function cannot be used to configure the\r
- * control endpoint.\r
- *\r
- * \param[in] Table Pointer to a table of endpoint descriptions.\r
- * \param[in] Entries Number of entries in the endpoint table to configure.\r
- *\r
- * \return Boolean \c true if all endpoints configured successfully, \c false otherwise.\r
- */\r
- bool Endpoint_ConfigureEndpointTable(const USB_Endpoint_Table_t* const Table,\r
- const uint8_t Entries);\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
- * \note This routine should not be called on non CONTROL type endpoints.\r
- */\r
- void Endpoint_ClearStatusStage(void);\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_AVR8\r
- *\r
- * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_WaitUntilReady(void);\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
-\r
-#endif\r
-\r
-/** @} */\r
-\r
projects / qmk_firmware.git / blobdiff