LUFA/Drivers/USB/LowLevel/Endpoint.h

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