LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief USB Endpoint definitions for the AVR32 UC3 microcontrollers.
  33  *  \copydetails Group_EndpointManagement_UC3
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  36  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  37  */
  38
  39 /** \ingroup Group_EndpointRW
  40  *  \defgroup Group_EndpointRW_UC3 Endpoint Data Reading and Writing (UC3)
  41  *  \brief Endpoint data read/write definitions for the Atmel AVR32 UC3 architecture.
  42  *
  43  *  Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
  44  */
  45
  46 /** \ingroup Group_EndpointPrimitiveRW
  47  *  \defgroup Group_EndpointPrimitiveRW_UC3 Read/Write of Primitive Data Types (UC3)
  48  *  \brief Endpoint primitive read/write definitions for the Atmel AVR32 UC3 architecture.
  49  *
  50  *  Functions, macros, variables, enums and types related to data reading and writing of primitive data types
  51  *  from and to endpoints.
  52  */
  53
  54 /** \ingroup Group_EndpointPacketManagement
  55  *  \defgroup Group_EndpointPacketManagement_UC3 Endpoint Packet Management (UC3)
  56  *  \brief Endpoint packet management definitions for the Atmel AVR32 UC3 architecture.
  57  *
  58  *  Functions, macros, variables, enums and types related to packet management of endpoints.
  59  */
  60
  61 /** \ingroup Group_EndpointManagement
  62  *  \defgroup Group_EndpointManagement_UC3 Endpoint Management (UC3)
  63  *  \brief Endpoint management definitions for the Atmel AVR32 UC3 architecture.
  64  *
  65  *  Functions, macros and enums related to endpoint management when in USB Device mode. This
  66  *  module contains the endpoint management macros, as well as endpoint interrupt and data
  67  *  send/receive functions for various data types.
  68  *
  69  *  @{
  70  */
  71
  72 #ifndef __ENDPOINT_UC3_H__
  73 #define __ENDPOINT_UC3_H__
  74
  75         /* Includes: */
  76                 #include "../../../../Common/Common.h"
  77                 #include "../USBTask.h"
  78                 #include "../USBInterrupt.h"
  79
  80         /* Enable C linkage for C++ Compilers: */
  81                 #if defined(__cplusplus)
  82                         extern "C" {
  83                 #endif
  84
  85         /* Preprocessor Checks: */
  86                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  87                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  88                 #endif
  89
  90         /* Private Interface - For use in library only: */
  91         #if !defined(__DOXYGEN__)
  92                 /* Macros: */
  93                         #define _ENDPOINT_GET_MAXSIZE(EPIndex)            _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## EPIndex)
  94                         #define _ENDPOINT_GET_MAXSIZE2(EPDetails)         _ENDPOINT_GET_MAXSIZE3(EPDetails)
  95                         #define _ENDPOINT_GET_MAXSIZE3(MaxSize, Banks)    (MaxSize)
  96
  97                         #define _ENDPOINT_GET_BANKS(EPIndex)              _ENDPOINT_GET_BANKS2(ENDPOINT_DETAILS_EP ## EPIndex)
  98                         #define _ENDPOINT_GET_BANKS2(EPDetails)           _ENDPOINT_GET_BANKS3(EPDetails)
  99                         #define _ENDPOINT_GET_BANKS3(MaxSize, Banks)      (Banks)
 100
 101                         #if defined(USB_SERIES_UC3A0_AVR32) || defined(USB_SERIES_UC3A1_AVR32)
 102                                 #define ENDPOINT_DETAILS_MAXEP                 7
 103
 104                                 #define ENDPOINT_DETAILS_EP0                   64,  1
 105                                 #define ENDPOINT_DETAILS_EP1                   256, 2
 106                                 #define ENDPOINT_DETAILS_EP2                   256, 2
 107                                 #define ENDPOINT_DETAILS_EP3                   64,  2
 108                                 #define ENDPOINT_DETAILS_EP4                   64,  2
 109                                 #define ENDPOINT_DETAILS_EP5                   256, 2
 110                                 #define ENDPOINT_DETAILS_EP6                   256, 2
 111                         #elif defined(USB_SERIES_UC3A3_AVR32) || defined(USB_SERIES_UC3A4_AVR32)
 112                                 #define ENDPOINT_DETAILS_MAXEP                 8
 113
 114                                 #define ENDPOINT_DETAILS_EP0                   64,  1
 115                                 #define ENDPOINT_DETAILS_EP1                   512, 2
 116                                 #define ENDPOINT_DETAILS_EP2                   512, 2
 117                                 #define ENDPOINT_DETAILS_EP3                   512, 2
 118                                 #define ENDPOINT_DETAILS_EP4                   512, 2
 119                                 #define ENDPOINT_DETAILS_EP5                   512, 2
 120                                 #define ENDPOINT_DETAILS_EP6                   512, 2
 121                         #elif defined(USB_SERIES_UC3B0_AVR32) || defined(USB_SERIES_UC3B1_AVR32)
 122                                 #define ENDPOINT_DETAILS_MAXEP                 7
 123
 124                                 #define ENDPOINT_DETAILS_EP0                   64,  1
 125                                 #define ENDPOINT_DETAILS_EP1                   64,  2
 126                                 #define ENDPOINT_DETAILS_EP2                   64,  2
 127                                 #define ENDPOINT_DETAILS_EP3                   64,  2
 128                                 #define ENDPOINT_DETAILS_EP4                   64,  2
 129                                 #define ENDPOINT_DETAILS_EP5                   256, 2
 130                                 #define ENDPOINT_DETAILS_EP6                   256, 2
 131                         #endif
 132
 133                         #define ENDPOINT_HSB_ADDRESS_SPACE_SIZE            (64 * 1024UL)
 134
 135                 /* Inline Functions: */
 136                         static inline uint32_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST
 137                                                                                                 ATTR_ALWAYS_INLINE;
 138                         static inline uint32_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
 139                         {
 140                                 uint8_t  MaskVal    = 0;
 141                                 uint16_t CheckBytes = 8;
 142
 143                                 while (CheckBytes < Bytes)
 144                                 {
 145                                         MaskVal++;
 146                                         CheckBytes <<= 1;
 147                                 }
 148
 149                                 return (MaskVal << AVR32_USBB_EPSIZE_OFFSET);
 150                         }
 151
 152                 /* Function Prototypes: */
 153                         void Endpoint_ClearEndpoints(void);
 154                         bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,
 155                                                             const uint32_t UECFGXData);
 156
 157                 /* External Variables: */
 158                         extern volatile uint32_t USB_SelectedEndpoint;
 159                         extern volatile uint8_t* USB_EndpointFIFOPos[];
 160         #endif
 161
 162         /* Public Interface - May be used in end-application: */
 163                 /* Macros: */
 164                         /** \name Endpoint Direction Masks */
 165                         //@{
 166                         /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
 167                          *  should be initialized in the OUT direction - i.e. data flows from host to device.
 168                          */
 169                         #define ENDPOINT_DIR_OUT                        AVR32_USBB_UECFG0_EPDIR_OUT
 170
 171                         /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
 172                          *  should be initialized in the IN direction - i.e. data flows from device to host.
 173                          */
 174                         #define ENDPOINT_DIR_IN                         AVR32_USBB_UECFG0_EPDIR_IN
 175                         //@}
 176
 177                         /** \name Endpoint Bank Mode Masks */
 178                         //@{
 179                         /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
 180                          *  that the endpoint should have one single bank, which requires less USB FIFO memory but results
 181                          *  in slower transfers as only one USB device (the AVR or the host) can access the endpoint's
 182                          *  bank at the one time.
 183                          */
 184                         #define ENDPOINT_BANK_SINGLE                    AVR32_USBB_UECFG0_EPBK_SINGLE
 185
 186                         /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
 187                          *  that the endpoint should have two banks, which requires more USB FIFO memory but results
 188                          *  in faster transfers as one USB device (the AVR or the host) can access one bank while the other
 189                          *  accesses the second bank.
 190                          */
 191                         #define ENDPOINT_BANK_DOUBLE                    AVR32_USBB_UECFG0_EPBK_DOUBLE
 192                         //@}
 193
 194                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 195                                 /** Default size of the default control endpoint's bank, until altered by the control endpoint bank size
 196                                  *  value in the device descriptor. Not available if the \c FIXED_CONTROL_ENDPOINT_SIZE token is defined.
 197                                  */
 198                                 #define ENDPOINT_CONTROLEP_DEFAULT_SIZE     8
 199                         #endif
 200
 201                         /** Retrieves the maximum bank size in bytes of a given endpoint.
 202                          *
 203                          *  \note This macro will only work correctly on endpoint indexes that are compile-time constants
 204                          *        defined by the preprocessor.
 205                          *
 206                          *  \param[in] EPIndex  Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
 207                          */
 208                         #define ENDPOINT_MAX_SIZE(EPIndex)              _ENDPOINT_GET_MAXSIZE(EPIndex)
 209
 210                         /** Retrieves the total number of banks supported by the given endpoint.
 211                          *
 212                          *  \note This macro will only work correctly on endpoint indexes that are compile-time constants
 213                          *        defined by the preprocessor.
 214                          *
 215                          *  \param[in] EPIndex  Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
 216                          */
 217                         #define ENDPOINT_BANKS_SUPPORTED(EPIndex)       _ENDPOINT_GET_BANKS(EPIndex)
 218
 219                         #if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)
 220                                 /** Total number of endpoints (including the default control endpoint at address 0) which may
 221                                  *  be used in the device. Different AVR models support different amounts of endpoints,
 222                                  *  this value reflects the maximum number of endpoints for the currently selected AVR model.
 223                                  */
 224                                 #define ENDPOINT_TOTAL_ENDPOINTS            ENDPOINT_DETAILS_MAXEP
 225                         #else
 226                                 #define ENDPOINT_TOTAL_ENDPOINTS            1
 227                         #endif
 228
 229                 /* Enums: */
 230                         /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
 231                          *
 232                          *  \ingroup Group_EndpointRW_UC3
 233                          */
 234                         enum Endpoint_WaitUntilReady_ErrorCodes_t
 235                         {
 236                                 ENDPOINT_READYWAIT_NoError                 = 0, /**< Endpoint is ready for next packet, no error. */
 237                                 ENDPOINT_READYWAIT_EndpointStalled         = 1, /**< The endpoint was stalled during the stream
 238                                                                                  *   transfer by the host or device.
 239                                                                                  */
 240                                 ENDPOINT_READYWAIT_DeviceDisconnected      = 2, /**< Device was disconnected from the host while
 241                                                                                  *   waiting for the endpoint to become ready.
 242                                                                                  */
 243                                 ENDPOINT_READYWAIT_BusSuspended            = 3, /**< The USB bus has been suspended by the host and
 244                                                                                  *   no USB endpoint traffic can occur until the bus
 245                                                                                  *   has resumed.
 246                                                                                  */
 247                                 ENDPOINT_READYWAIT_Timeout                 = 4, /**< The host failed to accept or send the next packet
 248                                                                                  *   within the software timeout period set by the
 249                                                                                  *   \ref USB_STREAM_TIMEOUT_MS macro.
 250                                                                                  */
 251                         };
 252
 253                 /* Inline Functions: */
 254                         /** Configures the specified endpoint number with the given endpoint type, direction, bank size
 255                          *  and banking mode. Once configured, the endpoint may be read from or written to, depending
 256                          *  on its direction.
 257                          *
 258                          *  \param[in] Number     Endpoint number to configure. This must be more than 0 and less than
 259                          *                        \ref ENDPOINT_TOTAL_ENDPOINTS.
 260                          *
 261                          *  \param[in] Type       Type of endpoint to configure, a \c EP_TYPE_* mask. Not all endpoint types
 262                          *                        are available on Low Speed USB devices - refer to the USB 2.0 specification.
 263                          *
 264                          *  \param[in] Direction  Endpoint data direction, either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
 265                          *                        All endpoints (except Control type) are unidirectional - data may only be read
 266                          *                        from or written to the endpoint bank based on its direction, not both.
 267                          *
 268                          *  \param[in] Size       Size of the endpoint's bank, where packets are stored before they are transmitted
 269                          *                        to the USB host, or after they have been received from the USB host (depending on
 270                          *                        the endpoint's data direction). The bank size must indicate the maximum packet size
 271                          *                        that the endpoint can handle.
 272                          *
 273                          *  \param[in] Banks      Number of banks to use for the endpoint being configured, an \c ENDPOINT_BANK_* mask.
 274                          *                        More banks uses more USB DPRAM, but offers better performance. Isochronous type
 275                          *                        endpoints <b>must</b> have at least two banks.
 276                          *
 277                          *  \note When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in
 278                          *        ascending order, or bank corruption will occur.
 279                          *        \n\n
 280                          *
 281                          *  \note Different endpoints may have different maximum packet sizes based on the endpoint's index - refer to
 282                          *        the chosen microcontroller model's datasheet to determine the maximum bank size for each endpoint.
 283                          *        \n\n
 284                          *
 285                          *  \note The default control endpoint should not be manually configured by the user application, as
 286                          *        it is automatically configured by the library internally.
 287                          *        \n\n
 288                          *
 289                          *  \note This routine will automatically select the specified endpoint upon success. Upon failure, the endpoint
 290                          *        which failed to reconfigure correctly will be selected.
 291                          *
 292                          *  \return Boolean \c true if the configuration succeeded, \c false otherwise.
 293                          */
 294                         static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
 295                                                                       const uint8_t Type,
 296                                                                       const uint8_t Direction,
 297                                                                       const uint16_t Size,
 298                                                                       const uint8_t Banks) ATTR_ALWAYS_INLINE;
 299                         static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
 300                                                                       const uint8_t Type,
 301                                                                       const uint8_t Direction,
 302                                                                       const uint16_t Size,
 303                                                                       const uint8_t Banks)
 304                         {
 305                                 return Endpoint_ConfigureEndpoint_Prv(Number, (AVR32_USBB_ALLOC_MASK |
 306                                                                                ((uint32_t)Type      << AVR32_USBB_EPTYPE_OFFSET) |
 307                                                                                ((uint32_t)Direction << AVR32_USBB_EPDIR_OFFSET)  |
 308                                                                                ((uint32_t)Banks     << AVR32_USBB_EPBK_OFFSET)   |
 309                                                                                Endpoint_BytesToEPSizeMask(Size)));
 310                         }
 311
 312                         /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
 313                          *
 314                          *  \note The return width of this function may differ, depending on the maximum endpoint bank size
 315                          *        of the selected AVR model.
 316                          *
 317                          *  \ingroup Group_EndpointRW_UC3
 318                          *
 319                          *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
 320                          */
 321                         static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 322                         static inline uint16_t Endpoint_BytesInEndpoint(void)
 323                         {
 324                                 return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].byct;
 325                         }
 326
 327                         /** Get the endpoint address of the currently selected endpoint. This is typically used to save
 328                          *  the currently selected endpoint number so that it can be restored after another endpoint has
 329                          *  been manipulated.
 330                          *
 331                          *  \return Index of the currently selected endpoint.
 332                          */
 333                         static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 334                         static inline uint8_t Endpoint_GetCurrentEndpoint(void)
 335                         {
 336                                 return USB_SelectedEndpoint;
 337                         }
 338
 339                         /** Selects the given endpoint number. If the address from the device descriptors is used, the
 340                          *  value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
 341                          *  number (and discarding the endpoint direction bit).
 342                          *
 343                          *  Any endpoint operations which do not require the endpoint number to be indicated will operate on
 344                          *  the currently selected endpoint.
 345                          *
 346                          *  \param[in] EndpointNumber Endpoint number to select.
 347                          */
 348                         static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
 349                         static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber)
 350                         {
 351                                 USB_SelectedEndpoint = EndpointNumber;
 352                         }
 353
 354                         /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
 355                          *  data In and Out pointers to the bank's contents.
 356                          *
 357                          *  \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset.
 358                          */
 359                         static inline void Endpoint_ResetEndpoint(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
 360                         static inline void Endpoint_ResetEndpoint(const uint8_t EndpointNumber)
 361                         {
 362                                 AVR32_USBB.uerst |=  (AVR32_USBB_EPRST0_MASK << EndpointNumber);
 363                                 AVR32_USBB.uerst &= ~(AVR32_USBB_EPRST0_MASK << EndpointNumber);
 364                                 USB_EndpointFIFOPos[EndpointNumber] = &AVR32_USBB_SLAVE[EndpointNumber * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
 365                         }
 366
 367                         /** Enables the currently selected endpoint so that data can be sent and received through it to
 368                          *  and from a host.
 369                          *
 370                          *  \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
 371                          */
 372                         static inline void Endpoint_EnableEndpoint(void) ATTR_ALWAYS_INLINE;
 373                         static inline void Endpoint_EnableEndpoint(void)
 374                         {
 375                                 AVR32_USBB.uerst |=  (AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint);
 376                         }
 377
 378                         /** Disables the currently selected endpoint so that data cannot be sent and received through it
 379                          *  to and from a host.
 380                          */
 381                         static inline void Endpoint_DisableEndpoint(void) ATTR_ALWAYS_INLINE;
 382                         static inline void Endpoint_DisableEndpoint(void)
 383                         {
 384                                 AVR32_USBB.uerst &= ~(AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint);
 385                         }
 386
 387                         /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
 388                          *
 389                          * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.
 390                          */
 391                         static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 392                         static inline bool Endpoint_IsEnabled(void)
 393                         {
 394                                 return ((AVR32_USBB.uerst & (AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint)) ? true : false);
 395                         }
 396
 397                         /** Retrieves the number of busy banks in the currently selected endpoint, which have been queued for
 398                          *  transmission via the \ref Endpoint_ClearIN() command, or are awaiting acknowledgement via the
 399                          *  \ref Endpoint_ClearOUT() command.
 400                          *
 401                          *  \ingroup Group_EndpointPacketManagement_UC3
 402                          *
 403                          *  \return Total number of busy banks in the selected endpoint.
 404                          */
 405                         static inline uint8_t Endpoint_GetBusyBanks(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 406                         static inline uint8_t Endpoint_GetBusyBanks(void)
 407                         {
 408                                 return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].nbusybk;
 409                         }
 410
 411                         /** Aborts all pending IN transactions on the currently selected endpoint, once the bank
 412                          *  has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
 413                          *  will terminate all queued transactions, resetting the endpoint banks ready for a new
 414                          *  packet.
 415                          *
 416                          *  \ingroup Group_EndpointPacketManagement_UC3
 417                          */
 418                         static inline void Endpoint_AbortPendingIN(void)
 419                         {
 420                                 while (Endpoint_GetBusyBanks() != 0)
 421                                 {
 422                                         (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].killbks = true;
 423                                         while ((&AVR32_USBB.UECON0)[USB_SelectedEndpoint].killbk);
 424                                 }
 425                         }
 426
 427                         /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
 428                          *  bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
 429                          *  direction). This function will return false if an error has occurred in the endpoint, if the endpoint
 430                          *  is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
 431                          *  direction and the endpoint bank is full.
 432                          *
 433                          *  \ingroup Group_EndpointPacketManagement_UC3
 434                          *
 435                          *  \return Boolean \c true if the currently selected endpoint may be read from or written to, depending
 436                          *          on its direction.
 437                          */
 438                         static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 439                         static inline bool Endpoint_IsReadWriteAllowed(void)
 440                         {
 441                                 return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rwall;
 442                         }
 443
 444                         /** Determines if the currently selected endpoint is configured.
 445                          *
 446                          *  \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.
 447                          */
 448                         static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 449                         static inline bool Endpoint_IsConfigured(void)
 450                         {
 451                                 return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].cfgok;
 452                         }
 453
 454                         /** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
 455                          *  interrupt duration has elapsed. Which endpoints have interrupted can be determined by
 456                          *  masking the return value against <tt>(1 << <i>{Endpoint Number}</i>)</tt>.
 457                          *
 458                          *  \return Mask whose bits indicate which endpoints have interrupted.
 459                          */
 460                         static inline uint8_t Endpoint_GetEndpointInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 461                         static inline uint8_t Endpoint_GetEndpointInterrupts(void)
 462                         {
 463                                 return ((AVR32_USBB.udint & (AVR32_USBB_EP6INT_MASK | AVR32_USBB_EP5INT_MASK |
 464                                                              AVR32_USBB_EP4INT_MASK | AVR32_USBB_EP3INT_MASK |
 465                                                              AVR32_USBB_EP2INT_MASK | AVR32_USBB_EP1INT_MASK |
 466                                                              AVR32_USBB_EP0INT_MASK)) >> AVR32_USBB_EP0INT_OFFSET);
 467                         }
 468
 469                         /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
 470                          *  endpoints).
 471                          *
 472                          *  \param[in] EndpointNumber  Index of the endpoint whose interrupt flag should be tested.
 473                          *
 474                          *  \return Boolean \c true if the specified endpoint has interrupted, \c false otherwise.
 475                          */
 476                         static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 477                         static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber)
 478                         {
 479                                 return ((Endpoint_GetEndpointInterrupts() & (AVR32_USBB_EP0INT_MASK << EndpointNumber)) ? true : false);
 480                         }
 481
 482                         /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
 483                          *
 484                          *  \ingroup Group_EndpointPacketManagement_UC3
 485                          *
 486                          *  \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.
 487                          */
 488                         static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 489                         static inline bool Endpoint_IsINReady(void)
 490                         {
 491                                 return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].txini;
 492                         }
 493
 494                         /** Determines if the selected OUT endpoint has received new packet from the host.
 495                          *
 496                          *  \ingroup Group_EndpointPacketManagement_UC3
 497                          *
 498                          *  \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.
 499                          */
 500                         static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 501                         static inline bool Endpoint_IsOUTReceived(void)
 502                         {
 503                                 return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rxouti;
 504                         }
 505
 506                         /** Determines if the current CONTROL type endpoint has received a SETUP packet.
 507                          *
 508                          *  \ingroup Group_EndpointPacketManagement_UC3
 509                          *
 510                          *  \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.
 511                          */
 512                         static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 513                         static inline bool Endpoint_IsSETUPReceived(void)
 514                         {
 515                                 return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rxstpi;
 516                         }
 517
 518                         /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
 519                          *  endpoint for the next packet.
 520                          *
 521                          *  \ingroup Group_EndpointPacketManagement_UC3
 522                          *
 523                          *  \note This is not applicable for non CONTROL type endpoints.
 524                          */
 525                         static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;
 526                         static inline void Endpoint_ClearSETUP(void)
 527                         {
 528                                 (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].rxstpic = true;
 529                                 USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
 530                         }
 531
 532                         /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
 533                          *  next packet and switching to the alternative endpoint bank if double banked.
 534                          *
 535                          *  \ingroup Group_EndpointPacketManagement_UC3
 536                          */
 537                         static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
 538                         static inline void Endpoint_ClearIN(void)
 539                         {
 540                                 (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].txinic   = true;
 541                                 (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].fifoconc = true;
 542                                 USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
 543                         }
 544
 545                         /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
 546                          *  for the next packet and switching to the alternative endpoint bank if double banked.
 547                          *
 548                          *  \ingroup Group_EndpointPacketManagement_UC3
 549                          */
 550                         static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
 551                         static inline void Endpoint_ClearOUT(void)
 552                         {
 553                                 (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].rxoutic  = true;
 554                                 (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].fifoconc = true;
 555                                 USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
 556                         }
 557
 558                         /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
 559                          *  indicated endpoint and that the current transfer sequence should be aborted. This provides a
 560                          *  way for devices to indicate invalid commands to the host so that the current transfer can be
 561                          *  aborted and the host can begin its own recovery sequence.
 562                          *
 563                          *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
 564                          *  is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
 565                          *  endpoint.
 566                          *
 567                          *  \ingroup Group_EndpointPacketManagement_UC3
 568                          */
 569                         static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
 570                         static inline void Endpoint_StallTransaction(void)
 571                         {
 572                                 (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].stallrqs = true;
 573                         }
 574
 575                         /** Clears the STALL condition on the currently selected endpoint.
 576                          *
 577                          *  \ingroup Group_EndpointPacketManagement_UC3
 578                          */
 579                         static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
 580                         static inline void Endpoint_ClearStall(void)
 581                         {
 582                                 (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].stallrqc = true;
 583                         }
 584
 585                         /** Determines if the currently selected endpoint is stalled, false otherwise.
 586                          *
 587                          *  \ingroup Group_EndpointPacketManagement_UC3
 588                          *
 589                          *  \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.
 590                          */
 591                         static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 592                         static inline bool Endpoint_IsStalled(void)
 593                         {
 594                                 return (&AVR32_USBB.UECON0)[USB_SelectedEndpoint].stallrq;
 595                         }
 596
 597                         /** Resets the data toggle of the currently selected endpoint. */
 598                         static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
 599                         static inline void Endpoint_ResetDataToggle(void)
 600                         {
 601                                 (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].rstdts = true;
 602                         }
 603
 604                         /** Determines the currently selected endpoint's direction.
 605                          *
 606                          *  \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.
 607                          */
 608                         static inline uint32_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 609                         static inline uint32_t Endpoint_GetEndpointDirection(void)
 610                         {
 611                                 return ((&AVR32_USBB.UECFG0)[USB_SelectedEndpoint].epdir ? ENDPOINT_DIR_IN : ENDPOINT_DIR_OUT);
 612                         }
 613
 614                         /** Sets the direction of the currently selected endpoint.
 615                          *
 616                          *  \param[in] DirectionMask  New endpoint direction, as a \c ENDPOINT_DIR_* mask.
 617                          */
 618                         static inline void Endpoint_SetEndpointDirection(const uint32_t DirectionMask) ATTR_ALWAYS_INLINE;
 619                         static inline void Endpoint_SetEndpointDirection(const uint32_t DirectionMask)
 620                         {
 621                                 (&AVR32_USBB.UECFG0)[USB_SelectedEndpoint].epdir = (DirectionMask == ENDPOINT_DIR_IN);
 622                         }
 623
 624                         /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 625                          *
 626                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 627                          *
 628                          *  \return Next byte in the currently selected endpoint's FIFO buffer.
 629                          */
 630                         static inline uint8_t Endpoint_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 631                         static inline uint8_t Endpoint_Read_8(void)
 632                         {
 633                                 return *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 634                         }
 635
 636                         /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
 637                          *
 638                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 639                          *
 640                          *  \param[in] Data  Data to write into the the currently selected endpoint's FIFO buffer.
 641                          */
 642                         static inline void Endpoint_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
 643                         static inline void Endpoint_Write_8(const uint8_t Data)
 644                         {
 645                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = Data;
 646                         }
 647
 648                         /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 649                          *
 650                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 651                          */
 652                         static inline void Endpoint_Discard_8(void) ATTR_ALWAYS_INLINE;
 653                         static inline void Endpoint_Discard_8(void)
 654                         {
 655                                 uint8_t Dummy;
 656
 657                                 Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 658                         }
 659
 660                         /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
 661                          *  direction endpoints.
 662                          *
 663                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 664                          *
 665                          *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
 666                          */
 667                         static inline uint16_t Endpoint_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 668                         static inline uint16_t Endpoint_Read_16_LE(void)
 669                         {
 670                                 uint16_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 671                                 uint16_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 672
 673                                 return ((Byte0 << 8) | Byte1);
 674                         }
 675
 676                         /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
 677                          *  direction endpoints.
 678                          *
 679                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 680                          *
 681                          *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
 682                          */
 683                         static inline uint16_t Endpoint_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 684                         static inline uint16_t Endpoint_Read_16_BE(void)
 685                         {
 686                                 uint16_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 687                                 uint16_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 688
 689                                 return ((Byte0 << 8) | Byte1);
 690                         }
 691
 692                         /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
 693                          *  direction endpoints.
 694                          *
 695                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 696                          *
 697                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 698                          */
 699                         static inline void Endpoint_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 700                         static inline void Endpoint_Write_16_LE(const uint16_t Data)
 701                         {
 702                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
 703                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);
 704                         }
 705
 706                         /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
 707                          *  direction endpoints.
 708                          *
 709                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 710                          *
 711                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 712                          */
 713                         static inline void Endpoint_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 714                         static inline void Endpoint_Write_16_BE(const uint16_t Data)
 715                         {
 716                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);
 717                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
 718                         }
 719
 720                         /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 721                          *
 722                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 723                          */
 724                         static inline void Endpoint_Discard_16(void) ATTR_ALWAYS_INLINE;
 725                         static inline void Endpoint_Discard_16(void)
 726                         {
 727                                 uint8_t Dummy;
 728
 729                                 Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 730                                 Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 731                         }
 732
 733                         /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
 734                          *  direction endpoints.
 735                          *
 736                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 737                          *
 738                          *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
 739                          */
 740                         static inline uint32_t Endpoint_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 741                         static inline uint32_t Endpoint_Read_32_LE(void)
 742                         {
 743                                 uint32_t Byte3 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 744                                 uint32_t Byte2 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 745                                 uint32_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 746                                 uint32_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 747
 748                                 return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
 749                         }
 750
 751                         /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
 752                          *  direction endpoints.
 753                          *
 754                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 755                          *
 756                          *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
 757                          */
 758                         static inline uint32_t Endpoint_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 759                         static inline uint32_t Endpoint_Read_32_BE(void)
 760                         {
 761                                 uint32_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 762                                 uint32_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 763                                 uint32_t Byte2 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 764                                 uint32_t Byte3 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 765
 766                                 return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
 767                         }
 768
 769                         /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
 770                          *  direction endpoints.
 771                          *
 772                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 773                          *
 774                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 775                          */
 776                         static inline void Endpoint_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 777                         static inline void Endpoint_Write_32_LE(const uint32_t Data)
 778                         {
 779                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 24);
 780                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 16);
 781                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
 782                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data &  0xFF);
 783                         }
 784
 785                         /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
 786                          *  direction endpoints.
 787                          *
 788                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 789                          *
 790                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 791                          */
 792                         static inline void Endpoint_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 793                         static inline void Endpoint_Write_32_BE(const uint32_t Data)
 794                         {
 795                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data &  0xFF);
 796                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
 797                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 16);
 798                                 *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 24);
 799                         }
 800
 801                         /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 802                          *
 803                          *  \ingroup Group_EndpointPrimitiveRW_UC3
 804                          */
 805                         static inline void Endpoint_Discard_32(void) ATTR_ALWAYS_INLINE;
 806                         static inline void Endpoint_Discard_32(void)
 807                         {
 808                                 uint8_t Dummy;
 809
 810                                 Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 811                                 Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 812                                 Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 813                                 Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
 814                         }
 815
 816                 /* External Variables: */
 817                         /** Global indicating the maximum packet size of the default control endpoint located at address
 818                          *  0 in the device. This value is set to the value indicated in the device descriptor in the user
 819                          *  project once the USB interface is initialized into device mode.
 820                          *
 821                          *  If space is an issue, it is possible to fix this to a static value by defining the control
 822                          *  endpoint size in the \c FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
 823                          *  via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
 824                          *  read from the descriptors at runtime and instead fixed to the given value. When used, it is
 825                          *  important that the descriptor control endpoint size value matches the size given as the
 826                          *  \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
 827                          *  be used in the device descriptors to ensure this.
 828                          *
 829                          *  \note This variable should be treated as read-only in the user application, and never manually
 830                          *        changed in value.
 831                          */
 832                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 833                                 extern uint8_t USB_Device_ControlEndpointSize;
 834                         #else
 835                                 #define USB_Device_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
 836                         #endif
 837
 838                 /* Function Prototypes: */
 839                         /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
 840                          *  with respect to the data direction. This is a convenience function which can be used to
 841                          *  simplify user control request handling.
 842                          */
 843                         void Endpoint_ClearStatusStage(void);
 844
 845                         /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
 846                          *  to be read or written to it.
 847                          *
 848                          *  \note This routine should not be called on CONTROL type endpoints.
 849                          *
 850                          *  \ingroup Group_EndpointRW_UC3
 851                          *
 852                          *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
 853                          */
 854                         uint8_t Endpoint_WaitUntilReady(void);
 855
 856         /* Disable C linkage for C++ Compilers: */
 857                 #if defined(__cplusplus)
 858                         }
 859                 #endif
 860
 861 #endif
 862
 863 /** @} */
 864