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