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