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