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