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