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