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