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