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