LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h

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