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