LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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 Endpoint definitions for the AVR8 microcontrollers.
  33  *  \copydetails Group_EndpointManagement_AVR8
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  36  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  37  */
  38
  39 /** \ingroup Group_EndpointRW
  40  *  \defgroup Group_EndpointRW_AVR8 Endpoint Data Reading and Writing (AVR8)
  41  *  \brief Endpoint data read/write definitions for the Atmel AVR8 architecture.
  42  *
  43  *  Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
  44  */
  45
  46 /** \ingroup Group_EndpointPrimitiveRW
  47  *  \defgroup Group_EndpointPrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8)
  48  *  \brief Endpoint primitive read/write definitions for the Atmel AVR8 architecture.
  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_EndpointPacketManagement
  55  *  \defgroup Group_EndpointPacketManagement_AVR8 Endpoint Packet Management (AVR8)
  56  *  \brief Endpoint packet management definitions for the Atmel AVR8 architecture.
  57  *
  58  *  Functions, macros, variables, enums and types related to packet management of endpoints.
  59  */
  60
  61 /** \ingroup Group_EndpointManagement
  62  *  \defgroup Group_EndpointManagement_AVR8 Endpoint Management (AVR8)
  63  *  \brief Endpoint management definitions for the Atmel AVR8 architecture.
  64  *
  65  *  Functions, macros and enums related to endpoint management when in USB Device mode. This
  66  *  module contains the endpoint management macros, as well as endpoint interrupt and data
  67  *  send/receive functions for various data types.
  68  *
  69  *  @{
  70  */
  71
  72 #ifndef __ENDPOINT_AVR8_H__
  73 #define __ENDPOINT_AVR8_H__
  74
  75         /* Includes: */
  76                 #include "../../../../Common/Common.h"
  77                 #include "../USBTask.h"
  78                 #include "../USBInterrupt.h"
  79
  80         /* Enable C linkage for C++ Compilers: */
  81                 #if defined(__cplusplus)
  82                         extern "C" {
  83                 #endif
  84
  85         /* Preprocessor Checks: */
  86                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  87                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  88                 #endif
  89
  90         /* Private Interface - For use in library only: */
  91         #if !defined(__DOXYGEN__)
  92                 /* Inline Functions: */
  93                         static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST
  94                                                                                                ATTR_ALWAYS_INLINE;
  95                         static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
  96                         {
  97                                 uint8_t  MaskVal    = 0;
  98                                 uint16_t CheckBytes = 8;
  99
 100                                 while (CheckBytes < Bytes)
 101                                 {
 102                                         MaskVal++;
 103                                         CheckBytes <<= 1;
 104                                 }
 105
 106                                 return (MaskVal << EPSIZE0);
 107                         }
 108
 109                 /* Function Prototypes: */
 110                         void Endpoint_ClearEndpoints(void);
 111                         bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,
 112                                                             const uint8_t UECFG0XData,
 113                                                             const uint8_t UECFG1XData);
 114
 115         #endif
 116
 117         /* Public Interface - May be used in end-application: */
 118                 /* Macros: */
 119                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 120                                 /** Default size of the default control endpoint's bank, until altered by the control endpoint bank size
 121                                  *  value in the device descriptor. Not available if the \c FIXED_CONTROL_ENDPOINT_SIZE token is defined.
 122                                  */
 123                                 #define ENDPOINT_CONTROLEP_DEFAULT_SIZE     8
 124                         #endif
 125
 126                         #if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)
 127                                 #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
 128                                         #define ENDPOINT_TOTAL_ENDPOINTS        7
 129                                 #else
 130                                         /** Total number of endpoints (including the default control endpoint at address 0) which may
 131                                          *  be used in the device. Different USB AVR models support different amounts of endpoints,
 132                                          *  this value reflects the maximum number of endpoints for the currently selected AVR model.
 133                                          */
 134                                         #define ENDPOINT_TOTAL_ENDPOINTS        5
 135                                 #endif
 136                         #else
 137                                 #define ENDPOINT_TOTAL_ENDPOINTS            1
 138                         #endif
 139
 140                 /* Enums: */
 141                         /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
 142                          *
 143                          *  \ingroup Group_EndpointRW_AVR8
 144                          */
 145                         enum Endpoint_WaitUntilReady_ErrorCodes_t
 146                         {
 147                                 ENDPOINT_READYWAIT_NoError                 = 0, /**< Endpoint is ready for next packet, no error. */
 148                                 ENDPOINT_READYWAIT_EndpointStalled         = 1, /**< The endpoint was stalled during the stream
 149                                                                                  *   transfer by the host or device.
 150                                                                                  */
 151                                 ENDPOINT_READYWAIT_DeviceDisconnected      = 2, /**< Device was disconnected from the host while
 152                                                                                  *   waiting for the endpoint to become ready.
 153                                                                                  */
 154                                 ENDPOINT_READYWAIT_BusSuspended            = 3, /**< The USB bus has been suspended by the host and
 155                                                                                  *   no USB endpoint traffic can occur until the bus
 156                                                                                  *   has resumed.
 157                                                                                  */
 158                                 ENDPOINT_READYWAIT_Timeout                 = 4, /**< The host failed to accept or send the next packet
 159                                                                                  *   within the software timeout period set by the
 160                                                                                  *   \ref USB_STREAM_TIMEOUT_MS macro.
 161                                                                                  */
 162                         };
 163
 164                 /* Inline Functions: */
 165                         /** Configures the specified endpoint address with the given endpoint type, bank size and number of hardware
 166                          *  banks. Once configured, the endpoint may be read from or written to, depending on its direction.
 167                          *
 168                          *  \param[in] Address    Endpoint address to configure.
 169                          *
 170                          *  \param[in] Type       Type of endpoint to configure, a \c EP_TYPE_* mask. Not all endpoint types
 171                          *                        are available on Low Speed USB devices - refer to the USB 2.0 specification.
 172                          *
 173                          *  \param[in] Size       Size of the endpoint's bank, where packets are stored before they are transmitted
 174                          *                        to the USB host, or after they have been received from the USB host (depending on
 175                          *                        the endpoint's data direction). The bank size must indicate the maximum packet size
 176                          *                        that the endpoint can handle.
 177                          *
 178                          *  \param[in] Banks      Number of banks to use for the endpoint being configured.
 179                          *
 180                          *  \attention When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in
 181                          *             ascending order, or bank corruption will occur.
 182                          *
 183                          *  \note Different endpoints may have different maximum packet sizes based on the endpoint's index - please
 184                          *        refer to the chosen microcontroller model's datasheet to determine the maximum bank size for each endpoint.
 185                          *        \n\n
 186                          *
 187                          *  \note The default control endpoint should not be manually configured by the user application, as
 188                          *        it is automatically configured by the library internally.
 189                          *        \n\n
 190                          *
 191                          *  \note This routine will automatically select the specified endpoint upon success. Upon failure, the endpoint
 192                          *        which failed to reconfigure correctly will be selected.
 193                          *
 194                          *  \return Boolean \c true if the configuration succeeded, \c false otherwise.
 195                          */
 196                         static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,
 197                                                                       const uint8_t Type,
 198                                                                       const uint16_t Size,
 199                                                                       const uint8_t Banks) ATTR_ALWAYS_INLINE;
 200                         static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,
 201                                                                       const uint8_t Type,
 202                                                                       const uint16_t Size,
 203                                                                       const uint8_t Banks)
 204                         {
 205                                 return Endpoint_ConfigureEndpoint_Prv((Address & ENDPOINT_EPNUM_MASK),
 206                                                                       ((Type << EPTYPE0) | ((Address & ENDPOINT_DIR_IN) ? (1 << EPDIR) : 0)),
 207                                                                       ((1 << ALLOC) | ((Banks > 1) ? (1 << EPBK0) : 0) | Endpoint_BytesToEPSizeMask(Size)));
 208                         }
 209
 210                         /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
 211                          *
 212                          *  \ingroup Group_EndpointRW_AVR8
 213                          *
 214                          *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
 215                          */
 216                         static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 217                         static inline uint16_t Endpoint_BytesInEndpoint(void)
 218                         {
 219                                 #if (defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)) && !defined(__AVR_ATmega32U6__)
 220                                         return UEBCX;
 221                                 #elif defined(USB_SERIES_4_AVR) || defined(__AVR_ATmega32U6__)
 222                                         return (((uint16_t)UEBCHX << 8) | UEBCLX);
 223                                 #elif defined(USB_SERIES_2_AVR)
 224                                         return UEBCLX;
 225                                 #endif
 226                         }
 227
 228                         /** Determines the currently selected endpoint's direction.
 229                          *
 230                          *  \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.
 231                          */
 232                         static inline uint8_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 233                         static inline uint8_t Endpoint_GetEndpointDirection(void)
 234                         {
 235                                 return (UECFG0X & (1 << EPDIR)) ? ENDPOINT_DIR_IN : ENDPOINT_DIR_OUT;
 236                         }
 237
 238                         /** Get the endpoint address of the currently selected endpoint. This is typically used to save
 239                          *  the currently selected endpoint so that it can be restored after another endpoint has been
 240                          *  manipulated.
 241                          *
 242                          *  \return Index of the currently selected endpoint.
 243                          */
 244                         static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 245                         static inline uint8_t Endpoint_GetCurrentEndpoint(void)
 246                         {
 247                                 #if !defined(CONTROL_ONLY_DEVICE)
 248                                         return ((UENUM & ENDPOINT_EPNUM_MASK) | Endpoint_GetEndpointDirection());
 249                                 #else
 250                                         return ENDPOINT_CONTROLEP;
 251                                 #endif
 252                         }
 253
 254                         /** Selects the given endpoint address.
 255                          *
 256                          *  Any endpoint operations which do not require the endpoint address to be indicated will operate on
 257                          *  the currently selected endpoint.
 258                          *
 259                          *  \param[in] Address Endpoint address to select.
 260                          */
 261                         static inline void Endpoint_SelectEndpoint(const uint8_t Address) ATTR_ALWAYS_INLINE;
 262                         static inline void Endpoint_SelectEndpoint(const uint8_t Address)
 263                         {
 264                                 #if !defined(CONTROL_ONLY_DEVICE)
 265                                         UENUM = (Address & ENDPOINT_EPNUM_MASK);
 266                                 #endif
 267                         }
 268
 269                         /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
 270                          *  data In and Out pointers to the bank's contents.
 271                          *
 272                          *  \param[in] Address  Endpoint address whose FIFO buffers are to be reset.
 273                          */
 274                         static inline void Endpoint_ResetEndpoint(const uint8_t Address) ATTR_ALWAYS_INLINE;
 275                         static inline void Endpoint_ResetEndpoint(const uint8_t Address)
 276                         {
 277                                 UERST = (1 << (Address & ENDPOINT_EPNUM_MASK));
 278                                 UERST = 0;
 279                         }
 280
 281                         /** Enables the currently selected endpoint so that data can be sent and received through it to
 282                          *  and from a host.
 283                          *
 284                          *  \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
 285                          */
 286                         static inline void Endpoint_EnableEndpoint(void) ATTR_ALWAYS_INLINE;
 287                         static inline void Endpoint_EnableEndpoint(void)
 288                         {
 289                                 UECONX |= (1 << EPEN);
 290                         }
 291
 292                         /** Disables the currently selected endpoint so that data cannot be sent and received through it
 293                          *  to and from a host.
 294                          */
 295                         static inline void Endpoint_DisableEndpoint(void) ATTR_ALWAYS_INLINE;
 296                         static inline void Endpoint_DisableEndpoint(void)
 297                         {
 298                                 UECONX &= ~(1 << EPEN);
 299                         }
 300
 301                         /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
 302                          *
 303                          * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.
 304                          */
 305                         static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 306                         static inline bool Endpoint_IsEnabled(void)
 307                         {
 308                                 return ((UECONX & (1 << EPEN)) ? true : false);
 309                         }
 310
 311                         /** Retrieves the number of busy banks in the currently selected endpoint, which have been queued for
 312                          *  transmission via the \ref Endpoint_ClearIN() command, or are awaiting acknowledgement via the
 313                          *  \ref Endpoint_ClearOUT() command.
 314                          *
 315                          *  \ingroup Group_EndpointPacketManagement_AVR8
 316                          *
 317                          *  \return Total number of busy banks in the selected endpoint.
 318                          */
 319                         static inline uint8_t Endpoint_GetBusyBanks(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 320                         static inline uint8_t Endpoint_GetBusyBanks(void)
 321                         {
 322                                 return (UESTA0X & (0x03 << NBUSYBK0));
 323                         }
 324
 325                         /** Aborts all pending IN transactions on the currently selected endpoint, once the bank
 326                          *  has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
 327                          *  will terminate all queued transactions, resetting the endpoint banks ready for a new
 328                          *  packet.
 329                          *
 330                          *  \ingroup Group_EndpointPacketManagement_AVR8
 331                          */
 332                         static inline void Endpoint_AbortPendingIN(void)
 333                         {
 334                                 while (Endpoint_GetBusyBanks() != 0)
 335                                 {
 336                                         UEINTX |= (1 << RXOUTI);
 337                                         while (UEINTX & (1 << RXOUTI));
 338                                 }
 339                         }
 340
 341                         /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
 342                          *  bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
 343                          *  direction). This function will return false if an error has occurred in the endpoint, if the endpoint
 344                          *  is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
 345                          *  direction and the endpoint bank is full.
 346                          *
 347                          *  \ingroup Group_EndpointPacketManagement_AVR8
 348                          *
 349                          *  \return Boolean \c true if the currently selected endpoint may be read from or written to, depending
 350                          *          on its direction.
 351                          */
 352                         static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 353                         static inline bool Endpoint_IsReadWriteAllowed(void)
 354                         {
 355                                 return ((UEINTX & (1 << RWAL)) ? true : false);
 356                         }
 357
 358                         /** Determines if the currently selected endpoint is configured.
 359                          *
 360                          *  \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.
 361                          */
 362                         static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 363                         static inline bool Endpoint_IsConfigured(void)
 364                         {
 365                                 return ((UESTA0X & (1 << CFGOK)) ? true : false);
 366                         }
 367
 368                         /** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
 369                          *  interrupt duration has elapsed. Which endpoints have interrupted can be determined by
 370                          *  masking the return value against <tt>(1 << <i>{Endpoint Number}</i>)</tt>.
 371                          *
 372                          *  \return Mask whose bits indicate which endpoints have interrupted.
 373                          */
 374                         static inline uint8_t Endpoint_GetEndpointInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 375                         static inline uint8_t Endpoint_GetEndpointInterrupts(void)
 376                         {
 377                                 return UEINT;
 378                         }
 379
 380                         /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
 381                          *  endpoints).
 382                          *
 383                          *  \param[in] Address  Address of the endpoint whose interrupt flag should be tested.
 384                          *
 385                          *  \return Boolean \c true if the specified endpoint has interrupted, \c false otherwise.
 386                          */
 387                         static inline bool Endpoint_HasEndpointInterrupted(const uint8_t Address) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 388                         static inline bool Endpoint_HasEndpointInterrupted(const uint8_t Address)
 389                         {
 390                                 return ((Endpoint_GetEndpointInterrupts() & (1 << (Address & ENDPOINT_EPNUM_MASK))) ? true : false);
 391                         }
 392
 393                         /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
 394                          *
 395                          *  \ingroup Group_EndpointPacketManagement_AVR8
 396                          *
 397                          *  \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.
 398                          */
 399                         static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 400                         static inline bool Endpoint_IsINReady(void)
 401                         {
 402                                 return ((UEINTX & (1 << TXINI)) ? true : false);
 403                         }
 404
 405                         /** Determines if the selected OUT endpoint has received new packet from the host.
 406                          *
 407                          *  \ingroup Group_EndpointPacketManagement_AVR8
 408                          *
 409                          *  \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.
 410                          */
 411                         static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 412                         static inline bool Endpoint_IsOUTReceived(void)
 413                         {
 414                                 return ((UEINTX & (1 << RXOUTI)) ? true : false);
 415                         }
 416
 417                         /** Determines if the current CONTROL type endpoint has received a SETUP packet.
 418                          *
 419                          *  \ingroup Group_EndpointPacketManagement_AVR8
 420                          *
 421                          *  \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.
 422                          */
 423                         static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 424                         static inline bool Endpoint_IsSETUPReceived(void)
 425                         {
 426                                 return ((UEINTX & (1 << RXSTPI)) ? true : false);
 427                         }
 428
 429                         /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
 430                          *  endpoint for the next packet.
 431                          *
 432                          *  \ingroup Group_EndpointPacketManagement_AVR8
 433                          *
 434                          *  \note This is not applicable for non CONTROL type endpoints.
 435                          */
 436                         static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;
 437                         static inline void Endpoint_ClearSETUP(void)
 438                         {
 439                                 UEINTX &= ~(1 << RXSTPI);
 440                         }
 441
 442                         /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
 443                          *  next packet and switching to the alternative endpoint bank if double banked.
 444                          *
 445                          *  \ingroup Group_EndpointPacketManagement_AVR8
 446                          */
 447                         static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
 448                         static inline void Endpoint_ClearIN(void)
 449                         {
 450                                 #if !defined(CONTROL_ONLY_DEVICE)
 451                                         UEINTX &= ~((1 << TXINI) | (1 << FIFOCON));
 452                                 #else
 453                                         UEINTX &= ~(1 << TXINI);
 454                                 #endif
 455                         }
 456
 457                         /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
 458                          *  for the next packet and switching to the alternative endpoint bank if double banked.
 459                          *
 460                          *  \ingroup Group_EndpointPacketManagement_AVR8
 461                          */
 462                         static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
 463                         static inline void Endpoint_ClearOUT(void)
 464                         {
 465                                 #if !defined(CONTROL_ONLY_DEVICE)
 466                                         UEINTX &= ~((1 << RXOUTI) | (1 << FIFOCON));
 467                                 #else
 468                                         UEINTX &= ~(1 << RXOUTI);
 469                                 #endif
 470                         }
 471
 472                         /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
 473                          *  indicated endpoint and that the current transfer sequence should be aborted. This provides a
 474                          *  way for devices to indicate invalid commands to the host so that the current transfer can be
 475                          *  aborted and the host can begin its own recovery sequence.
 476                          *
 477                          *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
 478                          *  is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
 479                          *  endpoint.
 480                          *
 481                          *  \ingroup Group_EndpointPacketManagement_AVR8
 482                          */
 483                         static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
 484                         static inline void Endpoint_StallTransaction(void)
 485                         {
 486                                 UECONX |= (1 << STALLRQ);
 487                         }
 488
 489                         /** Clears the STALL condition on the currently selected endpoint.
 490                          *
 491                          *  \ingroup Group_EndpointPacketManagement_AVR8
 492                          */
 493                         static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
 494                         static inline void Endpoint_ClearStall(void)
 495                         {
 496                                 UECONX |= (1 << STALLRQC);
 497                         }
 498
 499                         /** Determines if the currently selected endpoint is stalled, false otherwise.
 500                          *
 501                          *  \ingroup Group_EndpointPacketManagement_AVR8
 502                          *
 503                          *  \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.
 504                          */
 505                         static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 506                         static inline bool Endpoint_IsStalled(void)
 507                         {
 508                                 return ((UECONX & (1 << STALLRQ)) ? true : false);
 509                         }
 510
 511                         /** Resets the data toggle of the currently selected endpoint. */
 512                         static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
 513                         static inline void Endpoint_ResetDataToggle(void)
 514                         {
 515                                 UECONX |= (1 << RSTDT);
 516                         }
 517
 518                         /** Sets the direction of the currently selected endpoint.
 519                          *
 520                          *  \param[in] DirectionMask  New endpoint direction, as a \c ENDPOINT_DIR_* mask.
 521                          */
 522                         static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask) ATTR_ALWAYS_INLINE;
 523                         static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask)
 524                         {
 525                                 UECFG0X = ((UECFG0X & ~(1 << EPDIR)) | (DirectionMask ? (1 << EPDIR) : 0));
 526                         }
 527
 528                         /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 529                          *
 530                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 531                          *
 532                          *  \return Next byte in the currently selected endpoint's FIFO buffer.
 533                          */
 534                         static inline uint8_t Endpoint_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 535                         static inline uint8_t Endpoint_Read_8(void)
 536                         {
 537                                 return UEDATX;
 538                         }
 539
 540                         /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
 541                          *
 542                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 543                          *
 544                          *  \param[in] Data  Data to write into the the currently selected endpoint's FIFO buffer.
 545                          */
 546                         static inline void Endpoint_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
 547                         static inline void Endpoint_Write_8(const uint8_t Data)
 548                         {
 549                                 UEDATX = Data;
 550                         }
 551
 552                         /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 553                          *
 554                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 555                          */
 556                         static inline void Endpoint_Discard_8(void) ATTR_ALWAYS_INLINE;
 557                         static inline void Endpoint_Discard_8(void)
 558                         {
 559                                 uint8_t Dummy;
 560
 561                                 Dummy = UEDATX;
 562
 563                                 (void)Dummy;
 564                         }
 565
 566                         /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
 567                          *  direction endpoints.
 568                          *
 569                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 570                          *
 571                          *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
 572                          */
 573                         static inline uint16_t Endpoint_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 574                         static inline uint16_t Endpoint_Read_16_LE(void)
 575                         {
 576                                 union
 577                                 {
 578                                         uint16_t Value;
 579                                         uint8_t  Bytes[2];
 580                                 } Data;
 581
 582                                 Data.Bytes[0] = UEDATX;
 583                                 Data.Bytes[1] = UEDATX;
 584
 585                                 return Data.Value;
 586                         }
 587
 588                         /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
 589                          *  direction endpoints.
 590                          *
 591                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 592                          *
 593                          *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
 594                          */
 595                         static inline uint16_t Endpoint_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 596                         static inline uint16_t Endpoint_Read_16_BE(void)
 597                         {
 598                                 union
 599                                 {
 600                                         uint16_t Value;
 601                                         uint8_t  Bytes[2];
 602                                 } Data;
 603
 604                                 Data.Bytes[1] = UEDATX;
 605                                 Data.Bytes[0] = UEDATX;
 606
 607                                 return Data.Value;
 608                         }
 609
 610                         /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
 611                          *  direction endpoints.
 612                          *
 613                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 614                          *
 615                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 616                          */
 617                         static inline void Endpoint_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 618                         static inline void Endpoint_Write_16_LE(const uint16_t Data)
 619                         {
 620                                 UEDATX = (Data & 0xFF);
 621                                 UEDATX = (Data >> 8);
 622                         }
 623
 624                         /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
 625                          *  direction endpoints.
 626                          *
 627                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 628                          *
 629                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 630                          */
 631                         static inline void Endpoint_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 632                         static inline void Endpoint_Write_16_BE(const uint16_t Data)
 633                         {
 634                                 UEDATX = (Data >> 8);
 635                                 UEDATX = (Data & 0xFF);
 636                         }
 637
 638                         /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 639                          *
 640                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 641                          */
 642                         static inline void Endpoint_Discard_16(void) ATTR_ALWAYS_INLINE;
 643                         static inline void Endpoint_Discard_16(void)
 644                         {
 645                                 uint8_t Dummy;
 646
 647                                 Dummy = UEDATX;
 648                                 Dummy = UEDATX;
 649
 650                                 (void)Dummy;
 651                         }
 652
 653                         /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
 654                          *  direction endpoints.
 655                          *
 656                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 657                          *
 658                          *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
 659                          */
 660                         static inline uint32_t Endpoint_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 661                         static inline uint32_t Endpoint_Read_32_LE(void)
 662                         {
 663                                 union
 664                                 {
 665                                         uint32_t Value;
 666                                         uint8_t  Bytes[4];
 667                                 } Data;
 668
 669                                 Data.Bytes[0] = UEDATX;
 670                                 Data.Bytes[1] = UEDATX;
 671                                 Data.Bytes[2] = UEDATX;
 672                                 Data.Bytes[3] = UEDATX;
 673
 674                                 return Data.Value;
 675                         }
 676
 677                         /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
 678                          *  direction endpoints.
 679                          *
 680                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 681                          *
 682                          *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
 683                          */
 684                         static inline uint32_t Endpoint_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 685                         static inline uint32_t Endpoint_Read_32_BE(void)
 686                         {
 687                                 union
 688                                 {
 689                                         uint32_t Value;
 690                                         uint8_t  Bytes[4];
 691                                 } Data;
 692
 693                                 Data.Bytes[3] = UEDATX;
 694                                 Data.Bytes[2] = UEDATX;
 695                                 Data.Bytes[1] = UEDATX;
 696                                 Data.Bytes[0] = UEDATX;
 697
 698                                 return Data.Value;
 699                         }
 700
 701                         /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
 702                          *  direction endpoints.
 703                          *
 704                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 705                          *
 706                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 707                          */
 708                         static inline void Endpoint_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 709                         static inline void Endpoint_Write_32_LE(const uint32_t Data)
 710                         {
 711                                 UEDATX = (Data &  0xFF);
 712                                 UEDATX = (Data >> 8);
 713                                 UEDATX = (Data >> 16);
 714                                 UEDATX = (Data >> 24);
 715                         }
 716
 717                         /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
 718                          *  direction endpoints.
 719                          *
 720                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 721                          *
 722                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 723                          */
 724                         static inline void Endpoint_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 725                         static inline void Endpoint_Write_32_BE(const uint32_t Data)
 726                         {
 727                                 UEDATX = (Data >> 24);
 728                                 UEDATX = (Data >> 16);
 729                                 UEDATX = (Data >> 8);
 730                                 UEDATX = (Data &  0xFF);
 731                         }
 732
 733                         /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 734                          *
 735                          *  \ingroup Group_EndpointPrimitiveRW_AVR8
 736                          */
 737                         static inline void Endpoint_Discard_32(void) ATTR_ALWAYS_INLINE;
 738                         static inline void Endpoint_Discard_32(void)
 739                         {
 740                                 uint8_t Dummy;
 741
 742                                 Dummy = UEDATX;
 743                                 Dummy = UEDATX;
 744                                 Dummy = UEDATX;
 745                                 Dummy = UEDATX;
 746
 747                                 (void)Dummy;
 748                         }
 749
 750                 /* External Variables: */
 751                         /** Global indicating the maximum packet size of the default control endpoint located at address
 752                          *  0 in the device. This value is set to the value indicated in the device descriptor in the user
 753                          *  project once the USB interface is initialized into device mode.
 754                          *
 755                          *  If space is an issue, it is possible to fix this to a static value by defining the control
 756                          *  endpoint size in the \c FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
 757                          *  via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
 758                          *  read from the descriptors at runtime and instead fixed to the given value. When used, it is
 759                          *  important that the descriptor control endpoint size value matches the size given as the
 760                          *  \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
 761                          *  be used in the device descriptors to ensure this.
 762                          *
 763                          *  \attention This variable should be treated as read-only in the user application, and never manually
 764                          *             changed in value.
 765                          */
 766                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 767                                 extern uint8_t USB_Device_ControlEndpointSize;
 768                         #else
 769                                 #define USB_Device_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
 770                         #endif
 771
 772                 /* Function Prototypes: */
 773                         /** Configures a table of endpoint descriptions, in sequence. This function can be used to configure multiple
 774                          *  endpoints at the same time.
 775                          *
 776                          *  \note Endpoints with a zero address will be ignored, thus this function cannot be used to configure the
 777                          *        control endpoint.
 778                          *
 779                          *  \param[in] Table    Pointer to a table of endpoint descriptions.
 780                          *  \param[in] Entries  Number of entries in the endpoint table to configure.
 781                          *
 782                          *  \return Boolean \c true if all endpoints configured successfully, \c false otherwise.
 783                          */
 784                         bool Endpoint_ConfigureEndpointTable(const USB_Endpoint_Table_t* const Table,
 785                                                              const uint8_t Entries);
 786
 787                         /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
 788                          *  with respect to the data direction. This is a convenience function which can be used to
 789                          *  simplify user control request handling.
 790                          *
 791                          *  \note This routine should not be called on non CONTROL type endpoints.
 792                          */
 793                         void Endpoint_ClearStatusStage(void);
 794
 795                         /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
 796                          *  to be read or written to it.
 797                          *
 798                          *  \note This routine should not be called on CONTROL type endpoints.
 799                          *
 800                          *  \ingroup Group_EndpointRW_AVR8
 801                          *
 802                          *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
 803                          */
 804                         uint8_t Endpoint_WaitUntilReady(void);
 805
 806         /* Disable C linkage for C++ Compilers: */
 807                 #if defined(__cplusplus)
 808                         }
 809                 #endif
 810
 811 #endif
 812
 813 /** @} */
 814