-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2011.\r
-\r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2011 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 AVR32 UC3 microcontrollers.\r
- * \copydetails Group_EndpointManagement_UC3\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_UC3 Endpoint Data Reading and Writing (UC3)\r
- * \brief Endpoint data read/write definitions for the Atmel AVR32 UC3 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_UC3 Read/Write of Primitive Data Types (UC3)\r
- * \brief Endpoint primative read/write definitions for the Atmel AVR32 UC3 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_UC3 Endpoint Packet Management (UC3)\r
- * \brief Endpoint packet management definitions for the Atmel AVR32 UC3 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_UC3 Endpoint Management (UC3)\r
- * \brief Endpoint management definitions for the Atmel AVR32 UC3 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_UC3_H__\r
-#define __ENDPOINT_UC3_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
- /* Macros: */\r
- #define _ENDPOINT_GET_MAXSIZE(EPIndex) _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## EPIndex)\r
- #define _ENDPOINT_GET_MAXSIZE2(EPDetails) _ENDPOINT_GET_MAXSIZE3(EPDetails)\r
- #define _ENDPOINT_GET_MAXSIZE3(MaxSize, Banks) (MaxSize)\r
-\r
- #define _ENDPOINT_GET_BANKS(EPIndex) _ENDPOINT_GET_BANKS2(ENDPOINT_DETAILS_EP ## EPIndex)\r
- #define _ENDPOINT_GET_BANKS2(EPDetails) _ENDPOINT_GET_BANKS3(EPDetails)\r
- #define _ENDPOINT_GET_BANKS3(MaxSize, Banks) (Banks)\r
-\r
- #if defined(USB_SERIES_UC3A0_AVR) || defined(USB_SERIES_UC3A1_AVR)\r
- #define ENDPOINT_DETAILS_MAXEP 7\r
-\r
- #define ENDPOINT_DETAILS_EP0 64, 1\r
- #define ENDPOINT_DETAILS_EP1 256, 2\r
- #define ENDPOINT_DETAILS_EP2 256, 2\r
- #define ENDPOINT_DETAILS_EP3 64, 2\r
- #define ENDPOINT_DETAILS_EP4 64, 2\r
- #define ENDPOINT_DETAILS_EP5 256, 2\r
- #define ENDPOINT_DETAILS_EP6 256, 2\r
- #elif defined(USB_SERIES_UC3A3_AVR) || defined(USB_SERIES_UC3A4_AVR)\r
- #define ENDPOINT_DETAILS_MAXEP 8\r
-\r
- #define ENDPOINT_DETAILS_EP0 64, 1\r
- #define ENDPOINT_DETAILS_EP1 512, 2\r
- #define ENDPOINT_DETAILS_EP2 512, 2\r
- #define ENDPOINT_DETAILS_EP3 512, 2\r
- #define ENDPOINT_DETAILS_EP4 512, 2\r
- #define ENDPOINT_DETAILS_EP5 512, 2\r
- #define ENDPOINT_DETAILS_EP6 512, 2 \r
- #elif defined(USB_SERIES_UC3B0_AVR) || defined(USB_SERIES_UC3B1_AVR) \r
- #define ENDPOINT_DETAILS_MAXEP 7\r
-\r
- #define ENDPOINT_DETAILS_EP0 64, 1\r
- #define ENDPOINT_DETAILS_EP1 64, 2\r
- #define ENDPOINT_DETAILS_EP2 64, 2\r
- #define ENDPOINT_DETAILS_EP3 64, 2\r
- #define ENDPOINT_DETAILS_EP4 64, 2\r
- #define ENDPOINT_DETAILS_EP5 256, 2\r
- #define ENDPOINT_DETAILS_EP6 256, 2 \r
- #endif\r
-\r
- #define ENDPOINT_HSB_ADDRESS_SPACE_SIZE (64 * 1024UL)\r
-\r
- /* Inline Functions: */\r
- static inline uint32_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST\r
- ATTR_ALWAYS_INLINE;\r
- static inline uint32_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 << AVR32_USBB_EPSIZE_OFFSET);\r
- }\r
-\r
- /* Function Prototypes: */\r
- void Endpoint_ClearEndpoints(void);\r
- bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,\r
- const uint32_t UECFGXData);\r
- \r
- /* External Variables: */\r
- extern volatile uint32_t USB_SelectedEndpoint;\r
- extern volatile uint8_t* USB_EndpointFIFOPos[];\r
- #endif\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- /** \name Endpoint Direction Masks */\r
- //@{\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 AVR32_USBB_UECFG0_EPDIR_OUT\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 AVR32_USBB_UECFG0_EPDIR_IN\r
- //@}\r
- \r
- /** \name Endpoint Bank Mode Masks */\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 AVR32_USBB_UECFG0_EPBK_SINGLE\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 AVR32_USBB_UECFG0_EPBK_DOUBLE\r
- //@}\r
-\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
- /** Retrives the maximum bank size in bytes of a given endpoint.\r
- *\r
- * \note This macro will only work correctly on endpoint indexes that are compile-time constants\r
- * defined by the preprocessor.\r
- *\r
- * \param[in] EPIndex Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)\r
- */\r
- #define ENDPOINT_MAX_SIZE(EPIndex) _ENDPOINT_GET_MAXSIZE(EPIndex)\r
-\r
- /** Retrieves the total number of banks supported by the given endpoint.\r
- *\r
- * \note This macro will only work correctly on endpoint indexes that are compile-time constants\r
- * defined by the preprocessor.\r
- *\r
- * \param[in] EPIndex Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)\r
- */\r
- #define ENDPOINT_BANKS_SUPPORTED(EPIndex) _ENDPOINT_GET_BANKS(EPIndex)\r
-\r
- #if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)\r
- /** Total number of endpoints (including the default control endpoint at address 0) which may\r
- * be used in the device. Different 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 ENDPOINT_DETAILS_MAXEP\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_UC3\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 number with the given endpoint type, direction, bank size\r
- * and banking mode. Once configured, the endpoint may be read from or written to, depending\r
- * on its direction.\r
- *\r
- * \param[in] Number Endpoint number to configure. This must be more than 0 and less than\r
- * \ref ENDPOINT_TOTAL_ENDPOINTS.\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] Direction Endpoint data direction, either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.\r
- * All endpoints (except Control type) are unidirectional - data may only be read\r
- * from or written to the endpoint bank based on its direction, not both.\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, an \c ENDPOINT_BANK_* mask.\r
- * More banks uses more USB DPRAM, but offers better performance. Isochronous type\r
- * endpoints <b>must</b> have at least two banks.\r
- *\r
- * \note 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
- * \n\n\r
- *\r
- * \note Different endpoints may have different maximum packet sizes based on the endpoint's index - refer to\r
- * 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 Number,\r
- const uint8_t Type,\r
- const uint8_t Direction,\r
- const uint16_t Size,\r
- const uint8_t Banks) ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,\r
- const uint8_t Type,\r
- const uint8_t Direction,\r
- const uint16_t Size,\r
- const uint8_t Banks)\r
- {\r
- return Endpoint_ConfigureEndpoint_Prv(Number, (AVR32_USBB_ALLOC_MASK |\r
- ((uint32_t)Type << AVR32_USBB_EPTYPE_OFFSET) | \r
- ((uint32_t)Direction << AVR32_USBB_EPDIR_OFFSET) |\r
- ((uint32_t)Banks << AVR32_USBB_EPBK_OFFSET) |\r
- Endpoint_BytesToEPSizeMask(Size)));\r
- }\r
-\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_UC3\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
- return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].byct;\r
- }\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) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint8_t Endpoint_GetCurrentEndpoint(void)\r
- {\r
- return USB_SelectedEndpoint;\r
- }\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(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber)\r
- {\r
- USB_SelectedEndpoint = EndpointNumber;\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] EndpointNumber Endpoint number whose FIFO buffers are to be reset.\r
- */\r
- static inline void Endpoint_ResetEndpoint(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_ResetEndpoint(const uint8_t EndpointNumber)\r
- {\r
- AVR32_USBB.uerst |= (AVR32_USBB_EPRST0_MASK << EndpointNumber);\r
- AVR32_USBB.uerst &= ~(AVR32_USBB_EPRST0_MASK << EndpointNumber);\r
- USB_EndpointFIFOPos[EndpointNumber] = &AVR32_USBB_SLAVE[EndpointNumber * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];\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
- AVR32_USBB.uerst |= (AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint);\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
- AVR32_USBB.uerst &= ~(AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint);\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 ((AVR32_USBB.uerst & (AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint)) ? 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_UC3\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 (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].nbusybk;\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_UC3\r
- */\r
- static inline void Endpoint_AbortPendingIN(void)\r
- {\r
- while (Endpoint_GetBusyBanks() != 0)\r
- {\r
- (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].killbks = true;\r
- while ((&AVR32_USBB.UECON0)[USB_SelectedEndpoint].killbk);\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_UC3\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 (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rwall;\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 (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].cfgok;\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 ((AVR32_USBB.udint & (AVR32_USBB_EP6INT_MASK | AVR32_USBB_EP5INT_MASK |\r
- AVR32_USBB_EP4INT_MASK | AVR32_USBB_EP3INT_MASK |\r
- AVR32_USBB_EP2INT_MASK | AVR32_USBB_EP1INT_MASK |\r
- AVR32_USBB_EP0INT_MASK)) >> AVR32_USBB_EP0INT_OFFSET);\r
- }\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 \c true if the specified endpoint has interrupted, \c false otherwise.\r
- */\r
- static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber)\r
- {\r
- return ((Endpoint_GetEndpointInterrupts() & (AVR32_USBB_EP0INT_MASK << EndpointNumber)) ? 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_UC3\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 (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].txini;\r
- }\r
-\r
- /** Determines if the selected OUT endpoint has received new packet from the host.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_UC3\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 (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rxouti;\r
- }\r
-\r
- /** Determines if the current CONTROL type endpoint has received a SETUP packet.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_UC3\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 (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rxstpi;\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_UC3\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
- (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].rxstpic = true;\r
- USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];\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_UC3\r
- */\r
- static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_ClearIN(void)\r
- {\r
- (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].txinic = true;\r
- (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].fifoconc = true;\r
- USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];\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_UC3\r
- */\r
- static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_ClearOUT(void)\r
- {\r
- (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].rxoutic = true;\r
- (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].fifoconc = true;\r
- USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];\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_UC3\r
- */\r
- static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_StallTransaction(void)\r
- {\r
- (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].stallrqs = true;\r
- }\r
-\r
- /** Clears the STALL condition on the currently selected endpoint.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_UC3\r
- */\r
- static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_ClearStall(void)\r
- {\r
- (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].stallrqc = true;\r
- }\r
-\r
- /** Determines if the currently selected endpoint is stalled, false otherwise.\r
- *\r
- * \ingroup Group_EndpointPacketManagement_UC3\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 (&AVR32_USBB.UECON0)[USB_SelectedEndpoint].stallrq;\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
- (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].rstdts = true;\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 uint32_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
- static inline uint32_t Endpoint_GetEndpointDirection(void)\r
- {\r
- return ((&AVR32_USBB.UECFG0)[USB_SelectedEndpoint].epdir ? ENDPOINT_DIR_IN : ENDPOINT_DIR_OUT);\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 uint32_t DirectionMask) ATTR_ALWAYS_INLINE;\r
- static inline void Endpoint_SetEndpointDirection(const uint32_t DirectionMask)\r
- {\r
- (&AVR32_USBB.UECFG0)[USB_SelectedEndpoint].epdir = (DirectionMask == ENDPOINT_DIR_IN);\r
- }\r
-\r
- /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW_UC3\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 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- }\r
-\r
- /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW_UC3\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
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = Data;\r
- }\r
-\r
- /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW_UC3\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 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\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_UC3\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
- uint16_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- uint16_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
-\r
- return ((Byte0 << 8) | Byte1);\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_UC3\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
- uint16_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- uint16_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
-\r
- return ((Byte0 << 8) | Byte1);\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_UC3\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
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);\r
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);\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_UC3\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
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);\r
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);\r
- }\r
-\r
- /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW_UC3\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 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\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_UC3\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
- uint32_t Byte3 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- uint32_t Byte2 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- uint32_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- uint32_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
-\r
- return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);\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_UC3\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
- uint32_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- uint32_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- uint32_t Byte2 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- uint32_t Byte3 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
-\r
- return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);\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_UC3\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
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 24);\r
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 16);\r
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);\r
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);\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_UC3\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
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);\r
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);\r
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 16);\r
- *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 24);\r
- }\r
-\r
- /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.\r
- *\r
- * \ingroup Group_EndpointPrimitiveRW_UC3\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 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\r
- Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);\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
- * \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
- /** 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
- /** 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_UC3\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
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2011.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ Copyright 2011 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 Endpoint definitions for the AVR32 UC3 microcontrollers.
+ * \copydetails Group_EndpointManagement_UC3
+ *
+ * \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_EndpointRW
+ * \defgroup Group_EndpointRW_UC3 Endpoint Data Reading and Writing (UC3)
+ * \brief Endpoint data read/write definitions for the Atmel AVR32 UC3 architecture.
+ *
+ * Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
+ */
+
+/** \ingroup Group_EndpointPrimitiveRW
+ * \defgroup Group_EndpointPrimitiveRW_UC3 Read/Write of Primitive Data Types (UC3)
+ * \brief Endpoint primative read/write definitions for the Atmel AVR32 UC3 architecture.
+ *
+ * Functions, macros, variables, enums and types related to data reading and writing of primitive data types
+ * from and to endpoints.
+ */
+
+/** \ingroup Group_EndpointPacketManagement
+ * \defgroup Group_EndpointPacketManagement_UC3 Endpoint Packet Management (UC3)
+ * \brief Endpoint packet management definitions for the Atmel AVR32 UC3 architecture.
+ *
+ * Functions, macros, variables, enums and types related to packet management of endpoints.
+ */
+
+/** \ingroup Group_EndpointManagement
+ * \defgroup Group_EndpointManagement_UC3 Endpoint Management (UC3)
+ * \brief Endpoint management definitions for the Atmel AVR32 UC3 architecture.
+ *
+ * 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.
+ *
+ * @{
+ */
+
+#ifndef __ENDPOINT_UC3_H__
+#define __ENDPOINT_UC3_H__
+
+ /* Includes: */
+ #include "../../../../Common/Common.h"
+ #include "../USBTask.h"
+ #include "../USBInterrupt.h"
+
+ /* 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
+
+ /* Private Interface - For use in library only: */
+ #if !defined(__DOXYGEN__)
+ /* Macros: */
+ #define _ENDPOINT_GET_MAXSIZE(EPIndex) _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## EPIndex)
+ #define _ENDPOINT_GET_MAXSIZE2(EPDetails) _ENDPOINT_GET_MAXSIZE3(EPDetails)
+ #define _ENDPOINT_GET_MAXSIZE3(MaxSize, Banks) (MaxSize)
+
+ #define _ENDPOINT_GET_BANKS(EPIndex) _ENDPOINT_GET_BANKS2(ENDPOINT_DETAILS_EP ## EPIndex)
+ #define _ENDPOINT_GET_BANKS2(EPDetails) _ENDPOINT_GET_BANKS3(EPDetails)
+ #define _ENDPOINT_GET_BANKS3(MaxSize, Banks) (Banks)
+
+ #if defined(USB_SERIES_UC3A0_AVR) || defined(USB_SERIES_UC3A1_AVR)
+ #define ENDPOINT_DETAILS_MAXEP 7
+
+ #define ENDPOINT_DETAILS_EP0 64, 1
+ #define ENDPOINT_DETAILS_EP1 256, 2
+ #define ENDPOINT_DETAILS_EP2 256, 2
+ #define ENDPOINT_DETAILS_EP3 64, 2
+ #define ENDPOINT_DETAILS_EP4 64, 2
+ #define ENDPOINT_DETAILS_EP5 256, 2
+ #define ENDPOINT_DETAILS_EP6 256, 2
+ #elif defined(USB_SERIES_UC3A3_AVR) || defined(USB_SERIES_UC3A4_AVR)
+ #define ENDPOINT_DETAILS_MAXEP 8
+
+ #define ENDPOINT_DETAILS_EP0 64, 1
+ #define ENDPOINT_DETAILS_EP1 512, 2
+ #define ENDPOINT_DETAILS_EP2 512, 2
+ #define ENDPOINT_DETAILS_EP3 512, 2
+ #define ENDPOINT_DETAILS_EP4 512, 2
+ #define ENDPOINT_DETAILS_EP5 512, 2
+ #define ENDPOINT_DETAILS_EP6 512, 2
+ #elif defined(USB_SERIES_UC3B0_AVR) || defined(USB_SERIES_UC3B1_AVR)
+ #define ENDPOINT_DETAILS_MAXEP 7
+
+ #define ENDPOINT_DETAILS_EP0 64, 1
+ #define ENDPOINT_DETAILS_EP1 64, 2
+ #define ENDPOINT_DETAILS_EP2 64, 2
+ #define ENDPOINT_DETAILS_EP3 64, 2
+ #define ENDPOINT_DETAILS_EP4 64, 2
+ #define ENDPOINT_DETAILS_EP5 256, 2
+ #define ENDPOINT_DETAILS_EP6 256, 2
+ #endif
+
+ #define ENDPOINT_HSB_ADDRESS_SPACE_SIZE (64 * 1024UL)
+
+ /* Inline Functions: */
+ static inline uint32_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST
+ ATTR_ALWAYS_INLINE;
+ static inline uint32_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
+ {
+ uint8_t MaskVal = 0;
+ uint16_t CheckBytes = 8;
+
+ while (CheckBytes < Bytes)
+ {
+ MaskVal++;
+ CheckBytes <<= 1;
+ }
+
+ return (MaskVal << AVR32_USBB_EPSIZE_OFFSET);
+ }
+
+ /* Function Prototypes: */
+ void Endpoint_ClearEndpoints(void);
+ bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,
+ const uint32_t UECFGXData);
+
+ /* External Variables: */
+ extern volatile uint32_t USB_SelectedEndpoint;
+ extern volatile uint8_t* USB_EndpointFIFOPos[];
+ #endif
+
+ /* Public Interface - May be used in end-application: */
+ /* Macros: */
+ /** \name Endpoint Direction Masks */
+ //@{
+ /** 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 AVR32_USBB_UECFG0_EPDIR_OUT
+
+ /** 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 AVR32_USBB_UECFG0_EPDIR_IN
+ //@}
+
+ /** \name Endpoint Bank Mode Masks */
+ //@{
+ /** 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 AVR32_USBB_UECFG0_EPBK_SINGLE
+
+ /** 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 AVR32_USBB_UECFG0_EPBK_DOUBLE
+ //@}
+
+ #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
+ /** Default size of the default control endpoint's bank, until altered by the control endpoint bank size
+ * value in the device descriptor. Not available if the \c FIXED_CONTROL_ENDPOINT_SIZE token is defined.
+ */
+ #define ENDPOINT_CONTROLEP_DEFAULT_SIZE 8
+ #endif
+
+ /** Retrives the maximum bank size in bytes of a given endpoint.
+ *
+ * \note This macro will only work correctly on endpoint indexes that are compile-time constants
+ * defined by the preprocessor.
+ *
+ * \param[in] EPIndex Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
+ */
+ #define ENDPOINT_MAX_SIZE(EPIndex) _ENDPOINT_GET_MAXSIZE(EPIndex)
+
+ /** Retrieves the total number of banks supported by the given endpoint.
+ *
+ * \note This macro will only work correctly on endpoint indexes that are compile-time constants
+ * defined by the preprocessor.
+ *
+ * \param[in] EPIndex Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
+ */
+ #define ENDPOINT_BANKS_SUPPORTED(EPIndex) _ENDPOINT_GET_BANKS(EPIndex)
+
+ #if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)
+ /** Total number of endpoints (including the default control endpoint at address 0) which may
+ * be used in the device. Different 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 ENDPOINT_DETAILS_MAXEP
+ #else
+ #define ENDPOINT_TOTAL_ENDPOINTS 1
+ #endif
+
+ /* Enums: */
+ /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
+ *
+ * \ingroup Group_EndpointRW_UC3
+ */
+ 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.
+ */
+ };
+
+ /* Inline Functions: */
+ /** Configures the specified endpoint number with the given endpoint type, direction, bank size
+ * and banking mode. Once configured, the endpoint may be read from or written to, depending
+ * on its direction.
+ *
+ * \param[in] Number Endpoint number to configure. This must be more than 0 and less than
+ * \ref ENDPOINT_TOTAL_ENDPOINTS.
+ *
+ * \param[in] Type Type of endpoint to configure, a \c EP_TYPE_* mask. Not all endpoint types
+ * are available on Low Speed USB devices - refer to the USB 2.0 specification.
+ *
+ * \param[in] Direction Endpoint data direction, either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
+ * All endpoints (except Control type) are unidirectional - data may only be read
+ * from or written to the endpoint bank based on its direction, not both.
+ *
+ * \param[in] Size Size of the endpoint's bank, where packets are stored before they are transmitted
+ * to the USB host, or after they have been received from the USB host (depending on
+ * the endpoint's data direction). The bank size must indicate the maximum packet size
+ * that the endpoint can handle.
+ *
+ * \param[in] Banks Number of banks to use for the endpoint being configured, an \c ENDPOINT_BANK_* mask.
+ * More banks uses more USB DPRAM, but offers better performance. Isochronous type
+ * endpoints <b>must</b> have at least two banks.
+ *
+ * \note When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in
+ * ascending order, or bank corruption will occur.
+ * \n\n
+ *
+ * \note Different endpoints may have different maximum packet sizes based on the endpoint's index - refer to
+ * the chosen microcontroller model's datasheet to determine the maximum bank size for each endpoint.
+ * \n\n
+ *
+ * \note The default control endpoint should not be manually configured by the user application, as
+ * it is automatically configured by the library internally.
+ * \n\n
+ *
+ * \note This routine will automatically select the specified endpoint upon success. Upon failure, the endpoint
+ * which failed to reconfigure correctly will be selected.
+ *
+ * \return Boolean \c true if the configuration succeeded, \c false otherwise.
+ */
+ static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
+ const uint8_t Type,
+ const uint8_t Direction,
+ const uint16_t Size,
+ const uint8_t Banks) ATTR_ALWAYS_INLINE;
+ static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
+ const uint8_t Type,
+ const uint8_t Direction,
+ const uint16_t Size,
+ const uint8_t Banks)
+ {
+ return Endpoint_ConfigureEndpoint_Prv(Number, (AVR32_USBB_ALLOC_MASK |
+ ((uint32_t)Type << AVR32_USBB_EPTYPE_OFFSET) |
+ ((uint32_t)Direction << AVR32_USBB_EPDIR_OFFSET) |
+ ((uint32_t)Banks << AVR32_USBB_EPBK_OFFSET) |
+ Endpoint_BytesToEPSizeMask(Size)));
+ }
+
+ /** 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_UC3
+ *
+ * \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
+ */
+ static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint16_t Endpoint_BytesInEndpoint(void)
+ {
+ return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].byct;
+ }
+
+ /** 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) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint8_t Endpoint_GetCurrentEndpoint(void)
+ {
+ return USB_SelectedEndpoint;
+ }
+
+ /** 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(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber)
+ {
+ USB_SelectedEndpoint = EndpointNumber;
+ }
+
+ /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
+ * data 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_ResetEndpoint(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_ResetEndpoint(const uint8_t EndpointNumber)
+ {
+ AVR32_USBB.uerst |= (AVR32_USBB_EPRST0_MASK << EndpointNumber);
+ AVR32_USBB.uerst &= ~(AVR32_USBB_EPRST0_MASK << EndpointNumber);
+ USB_EndpointFIFOPos[EndpointNumber] = &AVR32_USBB_SLAVE[EndpointNumber * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
+ }
+
+ /** 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) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_EnableEndpoint(void)
+ {
+ AVR32_USBB.uerst |= (AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint);
+ }
+
+ /** 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) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_DisableEndpoint(void)
+ {
+ AVR32_USBB.uerst &= ~(AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint);
+ }
+
+ /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
+ *
+ * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.
+ */
+ static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline bool Endpoint_IsEnabled(void)
+ {
+ return ((AVR32_USBB.uerst & (AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint)) ? true : false);
+ }
+
+ /** Retrieves the number of busy banks in the currently selected endpoint, which have been queued for
+ * transmission via the \ref Endpoint_ClearIN() command, or are awaiting acknowledgement via the
+ * \ref Endpoint_ClearOUT() command.
+ *
+ * \ingroup Group_EndpointPacketManagement_UC3
+ *
+ * \return Total number of busy banks in the selected endpoint.
+ */
+ static inline uint8_t Endpoint_GetBusyBanks(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
+ static inline uint8_t Endpoint_GetBusyBanks(void)
+ {
+ return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].nbusybk;
+ }
+
+ /** Aborts all pending IN transactions on the currently selected endpoint, once the bank
+ * has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
+ * will terminate all queued transactions, resetting the endpoint banks ready for a new
+ * packet.
+ *
+ * \ingroup Group_EndpointPacketManagement_UC3
+ */
+ static inline void Endpoint_AbortPendingIN(void)
+ {
+ while (Endpoint_GetBusyBanks() != 0)
+ {
+ (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].killbks = true;
+ while ((&AVR32_USBB.UECON0)[USB_SelectedEndpoint].killbk);
+ }
+ }
+
+ /** 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_UC3
+ *
+ * \return Boolean \c true if the currently selected endpoint may be read from or written to, depending
+ * on its direction.
+ */
+ static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline bool Endpoint_IsReadWriteAllowed(void)
+ {
+ return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rwall;
+ }
+
+ /** Determines if the currently selected endpoint is configured.
+ *
+ * \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.
+ */
+ static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline bool Endpoint_IsConfigured(void)
+ {
+ return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].cfgok;
+ }
+
+ /** 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 <tt>(1 << <i>{Endpoint Number}</i>)</tt>.
+ *
+ * \return Mask whose bits indicate which endpoints have interrupted.
+ */
+ static inline uint8_t Endpoint_GetEndpointInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint8_t Endpoint_GetEndpointInterrupts(void)
+ {
+ return ((AVR32_USBB.udint & (AVR32_USBB_EP6INT_MASK | AVR32_USBB_EP5INT_MASK |
+ AVR32_USBB_EP4INT_MASK | AVR32_USBB_EP3INT_MASK |
+ AVR32_USBB_EP2INT_MASK | AVR32_USBB_EP1INT_MASK |
+ AVR32_USBB_EP0INT_MASK)) >> AVR32_USBB_EP0INT_OFFSET);
+ }
+
+ /** 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 \c true if the specified endpoint has interrupted, \c false otherwise.
+ */
+ static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber)
+ {
+ return ((Endpoint_GetEndpointInterrupts() & (AVR32_USBB_EP0INT_MASK << EndpointNumber)) ? true : false);
+ }
+
+ /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
+ *
+ * \ingroup Group_EndpointPacketManagement_UC3
+ *
+ * \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.
+ */
+ static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline bool Endpoint_IsINReady(void)
+ {
+ return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].txini;
+ }
+
+ /** Determines if the selected OUT endpoint has received new packet from the host.
+ *
+ * \ingroup Group_EndpointPacketManagement_UC3
+ *
+ * \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.
+ */
+ static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline bool Endpoint_IsOUTReceived(void)
+ {
+ return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rxouti;
+ }
+
+ /** Determines if the current CONTROL type endpoint has received a SETUP packet.
+ *
+ * \ingroup Group_EndpointPacketManagement_UC3
+ *
+ * \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.
+ */
+ static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline bool Endpoint_IsSETUPReceived(void)
+ {
+ return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rxstpi;
+ }
+
+ /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
+ * endpoint for the next packet.
+ *
+ * \ingroup Group_EndpointPacketManagement_UC3
+ *
+ * \note This is not applicable for non CONTROL type endpoints.
+ */
+ static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_ClearSETUP(void)
+ {
+ (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].rxstpic = true;
+ USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
+ }
+
+ /** 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_UC3
+ */
+ static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_ClearIN(void)
+ {
+ (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].txinic = true;
+ (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].fifoconc = true;
+ USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
+ }
+
+ /** 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_UC3
+ */
+ static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_ClearOUT(void)
+ {
+ (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].rxoutic = true;
+ (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].fifoconc = true;
+ USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
+ }
+
+ /** 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_UC3
+ */
+ static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_StallTransaction(void)
+ {
+ (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].stallrqs = true;
+ }
+
+ /** Clears the STALL condition on the currently selected endpoint.
+ *
+ * \ingroup Group_EndpointPacketManagement_UC3
+ */
+ static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_ClearStall(void)
+ {
+ (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].stallrqc = true;
+ }
+
+ /** Determines if the currently selected endpoint is stalled, false otherwise.
+ *
+ * \ingroup Group_EndpointPacketManagement_UC3
+ *
+ * \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.
+ */
+ static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline bool Endpoint_IsStalled(void)
+ {
+ return (&AVR32_USBB.UECON0)[USB_SelectedEndpoint].stallrq;
+ }
+
+ /** Resets the data toggle of the currently selected endpoint. */
+ static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_ResetDataToggle(void)
+ {
+ (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].rstdts = true;
+ }
+
+ /** Determines the currently selected endpoint's direction.
+ *
+ * \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.
+ */
+ static inline uint32_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint32_t Endpoint_GetEndpointDirection(void)
+ {
+ return ((&AVR32_USBB.UECFG0)[USB_SelectedEndpoint].epdir ? ENDPOINT_DIR_IN : ENDPOINT_DIR_OUT);
+ }
+
+ /** Sets the direction of the currently selected endpoint.
+ *
+ * \param[in] DirectionMask New endpoint direction, as a \c ENDPOINT_DIR_* mask.
+ */
+ static inline void Endpoint_SetEndpointDirection(const uint32_t DirectionMask) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_SetEndpointDirection(const uint32_t DirectionMask)
+ {
+ (&AVR32_USBB.UECFG0)[USB_SelectedEndpoint].epdir = (DirectionMask == ENDPOINT_DIR_IN);
+ }
+
+ /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ *
+ * \return Next byte in the currently selected endpoint's FIFO buffer.
+ */
+ static inline uint8_t Endpoint_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint8_t Endpoint_Read_8(void)
+ {
+ return *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ }
+
+ /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ *
+ * \param[in] Data Data to write into the the currently selected endpoint's FIFO buffer.
+ */
+ static inline void Endpoint_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Write_8(const uint8_t Data)
+ {
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = Data;
+ }
+
+ /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ */
+ static inline void Endpoint_Discard_8(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Discard_8(void)
+ {
+ uint8_t Dummy;
+
+ Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ }
+
+ /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ *
+ * \return Next two bytes in the currently selected endpoint's FIFO buffer.
+ */
+ static inline uint16_t Endpoint_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint16_t Endpoint_Read_16_LE(void)
+ {
+ uint16_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ uint16_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+
+ return ((Byte0 << 8) | Byte1);
+ }
+
+ /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ *
+ * \return Next two bytes in the currently selected endpoint's FIFO buffer.
+ */
+ static inline uint16_t Endpoint_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint16_t Endpoint_Read_16_BE(void)
+ {
+ uint16_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ uint16_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+
+ return ((Byte0 << 8) | Byte1);
+ }
+
+ /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ *
+ * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
+ */
+ static inline void Endpoint_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Write_16_LE(const uint16_t Data)
+ {
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);
+ }
+
+ /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ *
+ * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
+ */
+ static inline void Endpoint_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Write_16_BE(const uint16_t Data)
+ {
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
+ }
+
+ /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ */
+ static inline void Endpoint_Discard_16(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Discard_16(void)
+ {
+ uint8_t Dummy;
+
+ Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ }
+
+ /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ *
+ * \return Next four bytes in the currently selected endpoint's FIFO buffer.
+ */
+ static inline uint32_t Endpoint_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint32_t Endpoint_Read_32_LE(void)
+ {
+ uint32_t Byte3 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ uint32_t Byte2 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ uint32_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ uint32_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+
+ return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
+ }
+
+ /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ *
+ * \return Next four bytes in the currently selected endpoint's FIFO buffer.
+ */
+ static inline uint32_t Endpoint_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+ static inline uint32_t Endpoint_Read_32_BE(void)
+ {
+ uint32_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ uint32_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ uint32_t Byte2 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ uint32_t Byte3 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+
+ return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
+ }
+
+ /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ *
+ * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
+ */
+ static inline void Endpoint_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Write_32_LE(const uint32_t Data)
+ {
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 24);
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 16);
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);
+ }
+
+ /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
+ * direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ *
+ * \param[in] Data Data to write to the currently selected endpoint's FIFO buffer.
+ */
+ static inline void Endpoint_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Write_32_BE(const uint32_t Data)
+ {
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 16);
+ *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 24);
+ }
+
+ /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
+ *
+ * \ingroup Group_EndpointPrimitiveRW_UC3
+ */
+ static inline void Endpoint_Discard_32(void) ATTR_ALWAYS_INLINE;
+ static inline void Endpoint_Discard_32(void)
+ {
+ uint8_t Dummy;
+
+ Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
+ }
+
+ /* 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 \c 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
+ * \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
+ * be used in the device 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: */
+ /** 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);
+
+ /** 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_UC3
+ *
+ * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
+ */
+ uint8_t Endpoint_WaitUntilReady(void);
+
+ /* Disable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ }
+ #endif
+
+#endif
+
+/** @} */
+
projects / pub / USBasp.git / blobdiff