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