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