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

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