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                          *  \note 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                          *  \note 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                          *  \note The return width of this function may differ, depending on the maximum endpoint bank size
 320                          *        of the selected AVR model.
 321                          *
 322                          *  \ingroup Group_EndpointRW_XMEGA
 323                          *
 324                          *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
 325                          */
 326                         static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 327                         static inline uint16_t Endpoint_BytesInEndpoint(void)
 328                         {
 329                                 return USB_Endpoint_SelectedFIFO->Position;
 330                         }
 331
 332                         /** Get the endpoint address of the currently selected endpoint. This is typically used to save
 333                          *  the currently selected endpoint number so that it can be restored after another endpoint has
 334                          *  been manipulated.
 335                          *
 336                          *  \return Index of the currently selected endpoint.
 337                          */
 338                         static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 339                         static inline uint8_t Endpoint_GetCurrentEndpoint(void)
 340                         {
 341                                 return USB_Endpoint_SelectedEndpoint;
 342                         }
 343
 344                         /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
 345                          *  data In and Out pointers to the bank's contents.
 346                          *
 347                          *  \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset.
 348                          */
 349                         static inline void Endpoint_ResetEndpoint(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
 350                         static inline void Endpoint_ResetEndpoint(const uint8_t EndpointNumber)
 351                         {
 352                                 if (EndpointNumber & ENDPOINT_DIR_IN)
 353                                   USB_Endpoint_FIFOs[EndpointNumber & ENDPOINT_EPNUM_MASK].IN.Position  = 0;
 354                                 else
 355                                   USB_Endpoint_FIFOs[EndpointNumber & ENDPOINT_EPNUM_MASK].OUT.Position = 0;
 356                         }
 357
 358                         /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
 359                          *
 360                          * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.
 361                          */
 362                         static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 363                         static inline bool Endpoint_IsEnabled(void)
 364                         {
 365                                 return true;
 366                         }
 367
 368                         /** Aborts all pending IN transactions on the currently selected endpoint, once the bank
 369                          *  has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
 370                          *  will terminate all queued transactions, resetting the endpoint banks ready for a new
 371                          *  packet.
 372                          *
 373                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 374                          */
 375                         static inline void Endpoint_AbortPendingIN(void)
 376                         {
 377                                 USB_Endpoint_SelectedHandle->STATUS |= USB_EP_BUSNACK0_bm;
 378                         }
 379
 380                         /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
 381                          *  bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
 382                          *  direction). This function will return false if an error has occurred in the endpoint, if the endpoint
 383                          *  is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
 384                          *  direction and the endpoint bank is full.
 385                          *
 386                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 387                          *
 388                          *  \return Boolean \c true if the currently selected endpoint may be read from or written to, depending
 389                          *          on its direction.
 390                          */
 391                         static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 392                         static inline bool Endpoint_IsReadWriteAllowed(void)
 393                         {
 394                                 if (USB_Endpoint_SelectedEndpoint & ENDPOINT_DIR_IN)
 395                                   return (USB_Endpoint_SelectedFIFO->Position < USB_Endpoint_SelectedFIFO->Length);
 396                                 else
 397                                   return (USB_Endpoint_SelectedFIFO->Position > 0);
 398                         }
 399
 400                         /** Determines if the currently selected endpoint is configured.
 401                          *
 402                          *  \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.
 403                          */
 404                         static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 405                         static inline bool Endpoint_IsConfigured(void)
 406                         {
 407                                 return ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_TYPE_gm) ? true : false);
 408                         }
 409
 410                         /** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
 411                          *  interrupt duration has elapsed. Which endpoints have interrupted can be determined by
 412                          *  masking the return value against <tt>(1 << <i>{Endpoint Number}</i>)</tt>.
 413                          *
 414                          *  \return Mask whose bits indicate which endpoints have interrupted.
 415                          */
 416                         static inline uint8_t Endpoint_GetEndpointInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 417                         static inline uint8_t Endpoint_GetEndpointInterrupts(void)
 418                         {
 419                                 return 0; // TODO
 420                         }
 421
 422                         /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
 423                          *  endpoints).
 424                          *
 425                          *  \param[in] EndpointNumber  Index of the endpoint whose interrupt flag should be tested.
 426                          *
 427                          *  \return Boolean \c true if the specified endpoint has interrupted, \c false otherwise.
 428                          */
 429                         static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 430                         static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber)
 431                         {
 432                                 (void)EndpointNumber;
 433                                 return 0; // TODO
 434                         }
 435
 436                         /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
 437                          *
 438                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 439                          *
 440                          *  \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.
 441                          */
 442                         static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 443                         static inline bool Endpoint_IsINReady(void)
 444                         {
 445                                 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint | ENDPOINT_DIR_IN);
 446
 447                                 return ((USB_Endpoint_SelectedHandle->STATUS & USB_EP_BUSNACK0_bm) ? true : false);
 448                         }
 449
 450                         /** Determines if the selected OUT endpoint has received new packet from the host.
 451                          *
 452                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 453                          *
 454                          *  \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.
 455                          */
 456                         static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 457                         static inline bool Endpoint_IsOUTReceived(void)
 458                         {
 459                                 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint & ~ENDPOINT_DIR_IN);
 460
 461                                 if (USB_Endpoint_SelectedHandle->STATUS & USB_EP_TRNCOMPL0_bm)
 462                                 {
 463                                         USB_Endpoint_SelectedFIFO->Length = USB_Endpoint_SelectedHandle->CNT;
 464                                         return true;
 465                                 }
 466
 467                                 return false;
 468                         }
 469
 470                         /** Determines if the current CONTROL type endpoint has received a SETUP packet.
 471                          *
 472                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 473                          *
 474                          *  \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.
 475                          */
 476                         static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 477                         static inline bool Endpoint_IsSETUPReceived(void)
 478                         {
 479                                 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint & ~ENDPOINT_DIR_IN);
 480
 481                                 if (USB_Endpoint_SelectedHandle->STATUS & USB_EP_SETUP_bm)
 482                                 {
 483                                         USB_Endpoint_SelectedFIFO->Length = USB_Endpoint_SelectedHandle->CNT;
 484                                         return true;
 485                                 }
 486
 487                                 return 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_XMEGA
 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                                 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint & ~ENDPOINT_DIR_IN);
 501                                 USB_Endpoint_SelectedHandle->STATUS &= ~(USB_EP_SETUP_bm | USB_EP_TRNCOMPL0_bm | USB_EP_BUSNACK0_bm | USB_EP_OVF_bm);
 502                                 USB_Endpoint_SelectedHandle->STATUS |= USB_EP_TOGGLE_bm;
 503                                 USB_Endpoint_SelectedFIFO->Position  = 0;
 504
 505                                 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint | ENDPOINT_DIR_IN);
 506                                 USB_Endpoint_SelectedHandle->STATUS |= USB_EP_TOGGLE_bm;
 507                                 USB_Endpoint_SelectedFIFO->Position  = 0;
 508                         }
 509
 510                         /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
 511                          *  next packet and switching to the alternative endpoint bank if double banked.
 512                          *
 513                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 514                          */
 515                         static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
 516                         static inline void Endpoint_ClearIN(void)
 517                         {
 518                                 USB_Endpoint_SelectedHandle->CNT     = USB_Endpoint_SelectedFIFO->Position;
 519                                 USB_Endpoint_SelectedHandle->STATUS &= ~(USB_EP_TRNCOMPL0_bm | USB_EP_BUSNACK0_bm | USB_EP_OVF_bm);
 520                                 USB_Endpoint_SelectedFIFO->Position  = 0;
 521                         }
 522
 523                         /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
 524                          *  for the next packet and switching to the alternative endpoint bank if double banked.
 525                          *
 526                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 527                          */
 528                         static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
 529                         static inline void Endpoint_ClearOUT(void)
 530                         {
 531                                 USB_Endpoint_SelectedHandle->STATUS &= ~(USB_EP_TRNCOMPL0_bm | USB_EP_BUSNACK0_bm | USB_EP_OVF_bm);
 532                                 USB_Endpoint_SelectedFIFO->Position  = 0;
 533                         }
 534
 535                         /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
 536                          *  indicated endpoint and that the current transfer sequence should be aborted. This provides a
 537                          *  way for devices to indicate invalid commands to the host so that the current transfer can be
 538                          *  aborted and the host can begin its own recovery sequence.
 539                          *
 540                          *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
 541                          *  is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
 542                          *  endpoint.
 543                          *
 544                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 545                          */
 546                         static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
 547                         static inline void Endpoint_StallTransaction(void)
 548                         {
 549                                 USB_Endpoint_SelectedHandle->CTRL |= USB_EP_STALL_bm;
 550
 551                                 if ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_TYPE_gm) == USB_EP_TYPE_CONTROL_gc)
 552                                 {
 553                                         Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint ^ ENDPOINT_DIR_IN);
 554                                         USB_Endpoint_SelectedHandle->CTRL |= USB_EP_STALL_bm;
 555                                 }
 556                         }
 557
 558                         /** Clears the STALL condition on the currently selected endpoint.
 559                          *
 560                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 561                          */
 562                         static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
 563                         static inline void Endpoint_ClearStall(void)
 564                         {
 565                                 USB_Endpoint_SelectedHandle->CTRL &= ~USB_EP_STALL_bm;
 566                         }
 567
 568                         /** Determines if the currently selected endpoint is stalled, false otherwise.
 569                          *
 570                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 571                          *
 572                          *  \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.
 573                          */
 574                         static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 575                         static inline bool Endpoint_IsStalled(void)
 576                         {
 577                                 return ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_STALL_bm) ? true : false);
 578                         }
 579
 580                         /** Resets the data toggle of the currently selected endpoint. */
 581                         static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
 582                         static inline void Endpoint_ResetDataToggle(void)
 583                         {
 584                                 USB_Endpoint_SelectedHandle->STATUS &= ~USB_EP_TOGGLE_bm;
 585                         }
 586
 587                         /** Determines the currently selected endpoint's direction.
 588                          *
 589                          *  \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.
 590                          */
 591                         static inline uint8_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 592                         static inline uint8_t Endpoint_GetEndpointDirection(void)
 593                         {
 594                                 return (USB_Endpoint_SelectedEndpoint & ENDPOINT_DIR_IN);
 595                         }
 596
 597                         /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 598                          *
 599                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 600                          *
 601                          *  \return Next byte in the currently selected endpoint's FIFO buffer.
 602                          */
 603                         static inline uint8_t Endpoint_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 604                         static inline uint8_t Endpoint_Read_8(void)
 605                         {
 606                                 return USB_Endpoint_SelectedFIFO->Data[USB_Endpoint_SelectedFIFO->Position++];
 607                         }
 608
 609                         /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
 610                          *
 611                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 612                          *
 613                          *  \param[in] Data  Data to write into the the currently selected endpoint's FIFO buffer.
 614                          */
 615                         static inline void Endpoint_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
 616                         static inline void Endpoint_Write_8(const uint8_t Data)
 617                         {
 618                                 USB_Endpoint_SelectedFIFO->Data[USB_Endpoint_SelectedFIFO->Position++] = Data;
 619                         }
 620
 621                         /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 622                          *
 623                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 624                          */
 625                         static inline void Endpoint_Discard_8(void) ATTR_ALWAYS_INLINE;
 626                         static inline void Endpoint_Discard_8(void)
 627                         {
 628                                 USB_Endpoint_SelectedFIFO->Position++;
 629                         }
 630
 631                         /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
 632                          *  direction endpoints.
 633                          *
 634                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 635                          *
 636                          *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
 637                          */
 638                         static inline uint16_t Endpoint_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 639                         static inline uint16_t Endpoint_Read_16_LE(void)
 640                         {
 641                                 uint16_t Byte0 = Endpoint_Read_8();
 642                                 uint16_t Byte1 = Endpoint_Read_8();
 643
 644                                 return ((Byte1 << 8) | Byte0);
 645                         }
 646
 647                         /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
 648                          *  direction endpoints.
 649                          *
 650                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 651                          *
 652                          *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
 653                          */
 654                         static inline uint16_t Endpoint_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 655                         static inline uint16_t Endpoint_Read_16_BE(void)
 656                         {
 657                                 uint16_t Byte0 = Endpoint_Read_8();
 658                                 uint16_t Byte1 = Endpoint_Read_8();
 659
 660                                 return ((Byte0 << 8) | Byte1);
 661                         }
 662
 663                         /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
 664                          *  direction endpoints.
 665                          *
 666                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 667                          *
 668                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 669                          */
 670                         static inline void Endpoint_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 671                         static inline void Endpoint_Write_16_LE(const uint16_t Data)
 672                         {
 673                                 Endpoint_Write_8(Data & 0xFF);
 674                                 Endpoint_Write_8(Data >> 8);
 675                         }
 676
 677                         /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
 678                          *  direction endpoints.
 679                          *
 680                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 681                          *
 682                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 683                          */
 684                         static inline void Endpoint_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 685                         static inline void Endpoint_Write_16_BE(const uint16_t Data)
 686                         {
 687                                 Endpoint_Write_8(Data >> 8);
 688                                 Endpoint_Write_8(Data & 0xFF);
 689                         }
 690
 691                         /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 692                          *
 693                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 694                          */
 695                         static inline void Endpoint_Discard_16(void) ATTR_ALWAYS_INLINE;
 696                         static inline void Endpoint_Discard_16(void)
 697                         {
 698                                 Endpoint_Discard_8();
 699                                 Endpoint_Discard_8();
 700                         }
 701
 702                         /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
 703                          *  direction endpoints.
 704                          *
 705                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 706                          *
 707                          *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
 708                          */
 709                         static inline uint32_t Endpoint_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 710                         static inline uint32_t Endpoint_Read_32_LE(void)
 711                         {
 712                                 uint32_t Byte0 = Endpoint_Read_8();
 713                                 uint32_t Byte1 = Endpoint_Read_8();
 714                                 uint32_t Byte2 = Endpoint_Read_8();
 715                                 uint32_t Byte3 = Endpoint_Read_8();
 716
 717                                 return ((Byte3 << 24) | (Byte2 << 16) | (Byte1 << 8) | Byte0);
 718                         }
 719
 720                         /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
 721                          *  direction endpoints.
 722                          *
 723                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 724                          *
 725                          *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
 726                          */
 727                         static inline uint32_t Endpoint_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 728                         static inline uint32_t Endpoint_Read_32_BE(void)
 729                         {
 730                                 uint32_t Byte0 = Endpoint_Read_8();
 731                                 uint32_t Byte1 = Endpoint_Read_8();
 732                                 uint32_t Byte2 = Endpoint_Read_8();
 733                                 uint32_t Byte3 = Endpoint_Read_8();
 734
 735                                 return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
 736                         }
 737
 738                         /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
 739                          *  direction endpoints.
 740                          *
 741                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 742                          *
 743                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 744                          */
 745                         static inline void Endpoint_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 746                         static inline void Endpoint_Write_32_LE(const uint32_t Data)
 747                         {
 748                                 Endpoint_Write_8(Data & 0xFF);
 749                                 Endpoint_Write_8(Data >> 8);
 750                                 Endpoint_Write_8(Data >> 16);
 751                                 Endpoint_Write_8(Data >> 24);
 752                         }
 753
 754                         /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
 755                          *  direction endpoints.
 756                          *
 757                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 758                          *
 759                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 760                          */
 761                         static inline void Endpoint_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 762                         static inline void Endpoint_Write_32_BE(const uint32_t Data)
 763                         {
 764                                 Endpoint_Write_8(Data >> 24);
 765                                 Endpoint_Write_8(Data >> 16);
 766                                 Endpoint_Write_8(Data >> 8);
 767                                 Endpoint_Write_8(Data & 0xFF);
 768                         }
 769
 770                         /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 771                          *
 772                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 773                          */
 774                         static inline void Endpoint_Discard_32(void) ATTR_ALWAYS_INLINE;
 775                         static inline void Endpoint_Discard_32(void)
 776                         {
 777                                 Endpoint_Discard_8();
 778                                 Endpoint_Discard_8();
 779                                 Endpoint_Discard_8();
 780                                 Endpoint_Discard_8();
 781                         }
 782
 783                 /* External Variables: */
 784                         /** Global indicating the maximum packet size of the default control endpoint located at address
 785                          *  0 in the device. This value is set to the value indicated in the device descriptor in the user
 786                          *  project once the USB interface is initialized into device mode.
 787                          *
 788                          *  If space is an issue, it is possible to fix this to a static value by defining the control
 789                          *  endpoint size in the \c FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
 790                          *  via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
 791                          *  read from the descriptors at runtime and instead fixed to the given value. When used, it is
 792                          *  important that the descriptor control endpoint size value matches the size given as the
 793                          *  \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
 794                          *  be used in the device descriptors to ensure this.
 795                          *
 796                          *  \note This variable should be treated as read-only in the user application, and never manually
 797                          *        changed in value.
 798                          */
 799                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 800                                 extern uint8_t USB_Device_ControlEndpointSize;
 801                         #else
 802                                 #define USB_Device_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
 803                         #endif
 804
 805                 /* Function Prototypes: */
 806                         /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
 807                          *  with respect to the data direction. This is a convenience function which can be used to
 808                          *  simplify user control request handling.
 809                          */
 810                         void Endpoint_ClearStatusStage(void);
 811
 812                         /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
 813                          *  to be read or written to it.
 814                          *
 815                          *  \note This routine should not be called on CONTROL type endpoints.
 816                          *
 817                          *  \ingroup Group_EndpointRW_XMEGA
 818                          *
 819                          *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
 820                          */
 821                         uint8_t Endpoint_WaitUntilReady(void);
 822
 823         /* Disable C linkage for C++ Compilers: */
 824                 #if defined(__cplusplus)
 825                         }
 826                 #endif
 827
 828 #endif
 829
 830 /** @} */
 831