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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief USB Endpoint definitions for the AVR XMEGA microcontrollers.
  33  *  \copydetails Group_EndpointManagement_XMEGA
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  36  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  37  */
  38
  39 /** \ingroup Group_EndpointRW
  40  *  \defgroup Group_EndpointRW_XMEGA Endpoint Data Reading and Writing (XMEGA)
  41  *  \brief Endpoint data read/write definitions for the Atmel AVR XMEGA architecture.
  42  *
  43  *  Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
  44  */
  45
  46 /** \ingroup Group_EndpointPrimitiveRW
  47  *  \defgroup Group_EndpointPrimitiveRW_XMEGA Read/Write of Primitive Data Types (XMEGA)
  48  *  \brief Endpoint primitive read/write definitions for the Atmel AVR XMEGA architecture.
  49  *
  50  *  Functions, macros, variables, enums and types related to data reading and writing of primitive data types
  51  *  from and to endpoints.
  52  */
  53
  54 /** \ingroup Group_EndpointPacketManagement
  55  *  \defgroup Group_EndpointPacketManagement_XMEGA Endpoint Packet Management (XMEGA)
  56  *  \brief Endpoint packet management definitions for the Atmel AVR XMEGA architecture.
  57  *
  58  *  Functions, macros, variables, enums and types related to packet management of endpoints.
  59  */
  60
  61 /** \ingroup Group_EndpointManagement
  62  *  \defgroup Group_EndpointManagement_XMEGA Endpoint Management (XMEGA)
  63  *  \brief Endpoint management definitions for the Atmel AVR XMEGA architecture.
  64  *
  65  *  Functions, macros and enums related to endpoint management when in USB Device mode. This
  66  *  module contains the endpoint management macros, as well as endpoint interrupt and data
  67  *  send/receive functions for various data types.
  68  *
  69  *  @{
  70  */
  71
  72 #ifndef __ENDPOINT_XMEGA_H__
  73 #define __ENDPOINT_XMEGA_H__
  74
  75         /* Includes: */
  76                 #include "../../../../Common/Common.h"
  77                 #include "../USBTask.h"
  78                 #include "../USBInterrupt.h"
  79                 #include "../USBController.h"
  80
  81         /* Enable C linkage for C++ Compilers: */
  82                 #if defined(__cplusplus)
  83                         extern "C" {
  84                 #endif
  85
  86         /* Preprocessor Checks: */
  87                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  88                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  89                 #endif
  90
  91         /* Public Interface - May be used in end-application: */
  92                 /* Macros: */
  93                         #if (!defined(MAX_ENDPOINT_INDEX) && !defined(CONTROL_ONLY_DEVICE)) || defined(__DOXYGEN__)
  94                                 /** Total number of endpoints (including the default control endpoint at address 0) which may
  95                                  *  be used in the device. Different USB AVR models support different amounts of endpoints,
  96                                  *  this value reflects the maximum number of endpoints for the currently selected AVR model.
  97                                  */
  98                                 #define ENDPOINT_TOTAL_ENDPOINTS            16
  99                         #else
 100                                 #if defined(CONTROL_ONLY_DEVICE)
 101                                         #define ENDPOINT_TOTAL_ENDPOINTS        1
 102                                 #else
 103                                         #define ENDPOINT_TOTAL_ENDPOINTS        (MAX_ENDPOINT_INDEX + 1)
 104                                 #endif
 105                         #endif
 106
 107         /* Private Interface - For use in library only: */
 108         #if !defined(__DOXYGEN__)
 109                 /* Type Defines: */
 110                         typedef struct
 111                         {
 112                                 uint8_t Data[64];
 113
 114                                 uint8_t Length;
 115                                 uint8_t Position;
 116                         } Endpoint_FIFO_t;
 117
 118                         typedef struct
 119                         {
 120                                 Endpoint_FIFO_t OUT;
 121                                 Endpoint_FIFO_t IN;
 122                         } Endpoint_FIFOPair_t;
 123
 124                 /* External Variables: */
 125                         extern Endpoint_FIFOPair_t       USB_Endpoint_FIFOs[ENDPOINT_TOTAL_ENDPOINTS];
 126                         extern volatile uint8_t          USB_Endpoint_SelectedEndpoint;
 127                         extern volatile USB_EP_t*        USB_Endpoint_SelectedHandle;
 128                         extern volatile Endpoint_FIFO_t* USB_Endpoint_SelectedFIFO;
 129
 130                 /* Inline Functions: */
 131                         static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST
 132                                                                                                ATTR_ALWAYS_INLINE;
 133                         static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
 134                         {
 135                                 uint8_t  MaskVal    = 0;
 136                                 uint16_t CheckBytes = 8;
 137
 138                                 while (CheckBytes < Bytes)
 139                                 {
 140                                         MaskVal++;
 141                                         CheckBytes <<= 1;
 142                                 }
 143
 144                                 return (MaskVal << USB_EP_BUFSIZE_gp);
 145                         }
 146
 147                 /* Function Prototypes: */
 148                         bool Endpoint_ConfigureEndpoint_PRV(const uint8_t Address,
 149                                                             const uint8_t Config,
 150                                                             const uint8_t Size);
 151                         void Endpoint_ClearEndpoints(void);
 152         #endif
 153
 154         /* Public Interface - May be used in end-application: */
 155                 /* Macros: */
 156                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 157                                 /** Default size of the default control endpoint's bank, until altered by the control endpoint bank size
 158                                  *  value in the device descriptor. Not available if the \c FIXED_CONTROL_ENDPOINT_SIZE token is defined.
 159                                  */
 160                                 #define ENDPOINT_CONTROLEP_DEFAULT_SIZE     8
 161                         #endif
 162
 163                 /* Enums: */
 164                         /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
 165                          *
 166                          *  \ingroup Group_EndpointRW_XMEGA
 167                          */
 168                         enum Endpoint_WaitUntilReady_ErrorCodes_t
 169                         {
 170                                 ENDPOINT_READYWAIT_NoError                 = 0, /**< Endpoint is ready for next packet, no error. */
 171                                 ENDPOINT_READYWAIT_EndpointStalled         = 1, /**< The endpoint was stalled during the stream
 172                                                                                  *   transfer by the host or device.
 173                                                                                  */
 174                                 ENDPOINT_READYWAIT_DeviceDisconnected      = 2, /**< Device was disconnected from the host while
 175                                                                                  *   waiting for the endpoint to become ready.
 176                                                                                  */
 177                                 ENDPOINT_READYWAIT_BusSuspended            = 3, /**< The USB bus has been suspended by the host and
 178                                                                                  *   no USB endpoint traffic can occur until the bus
 179                                                                                  *   has resumed.
 180                                                                                  */
 181                                 ENDPOINT_READYWAIT_Timeout                 = 4, /**< The host failed to accept or send the next packet
 182                                                                                  *   within the software timeout period set by the
 183                                                                                  *   \ref USB_STREAM_TIMEOUT_MS macro.
 184                                                                                  */
 185                         };
 186
 187                 /* Inline Functions: */
 188                         /** Selects the given endpoint address.
 189                          *
 190                          *  Any endpoint operations which do not require the endpoint address to be indicated will operate on
 191                          *  the currently selected endpoint.
 192                          *
 193                          *  \param[in] Address  Endpoint address to select.
 194                          */
 195                         static inline void Endpoint_SelectEndpoint(const uint8_t Address);
 196                         static inline void Endpoint_SelectEndpoint(const uint8_t Address)
 197                         {
 198                                 uint8_t EndpointNumber = (Address & ENDPOINT_EPNUM_MASK);
 199
 200                                 USB_Endpoint_SelectedEndpoint = Address;
 201
 202                                 if (Address & ENDPOINT_DIR_IN)
 203                                 {
 204                                         USB_Endpoint_SelectedFIFO   = &USB_Endpoint_FIFOs[EndpointNumber].IN;
 205                                         USB_Endpoint_SelectedHandle = &((USB_EndpointTable_t*)USB.EPPTR)->Endpoints[EndpointNumber].IN;
 206                                 }
 207                                 else
 208                                 {
 209                                         USB_Endpoint_SelectedFIFO   = &USB_Endpoint_FIFOs[EndpointNumber].OUT;
 210                                         USB_Endpoint_SelectedHandle = &((USB_EndpointTable_t*)USB.EPPTR)->Endpoints[EndpointNumber].OUT;
 211                                 }
 212                         }
 213
 214                         /** Configures the specified endpoint address with the given endpoint type, direction, bank size
 215                          *  and banking mode. Once configured, the endpoint may be read from or written to, depending
 216                          *  on its direction.
 217                          *
 218                          *  \param[in] Address    Endpoint address to configure.
 219                          *
 220                          *  \param[in] Type       Type of endpoint to configure, a \c EP_TYPE_* mask. Not all endpoint types
 221                          *                        are available on Low Speed USB devices - refer to the USB 2.0 specification.
 222                          *
 223                          *  \param[in] Size       Size of the endpoint's bank, where packets are stored before they are transmitted
 224                          *                        to the USB host, or after they have been received from the USB host (depending on
 225                          *                        the endpoint's data direction). The bank size must indicate the maximum packet size
 226                          *                        that the endpoint can handle.
 227                          *
 228                          *  \param[in] Banks      Number of hardware banks to use for the endpoint being configured.
 229                          *
 230                          *  \note The default control endpoint should not be manually configured by the user application, as
 231                          *        it is automatically configured by the library internally.
 232                          *        \n\n
 233                          *
 234                          *  \note This routine will automatically select the specified endpoint.
 235                          *
 236                          *  \return Boolean \c true if the configuration succeeded, \c false otherwise.
 237                          */
 238                         static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,
 239                                                                       const uint8_t Type,
 240                                                                       const uint16_t Size,
 241                                                                       const uint8_t Banks) ATTR_ALWAYS_INLINE;
 242                         static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,
 243                                                                       const uint8_t Type,
 244                                                                       const uint16_t Size,
 245                                                                       const uint8_t Banks)
 246                         {
 247                                 uint8_t EPConfigMask = (USB_EP_INTDSBL_bm | ((Banks > 1) ? USB_EP_PINGPONG_bm : 0) | Endpoint_BytesToEPSizeMask(Size));
 248
 249                                 // TODO - Fix once limitations are lifted
 250                                 if ((Banks > 1) || (Size > 64))
 251                                   return false;
 252
 253                                 switch (Type)
 254                                 {
 255                                         case EP_TYPE_CONTROL:
 256                                                 EPConfigMask |= USB_EP_TYPE_CONTROL_gc;
 257                                                 break;
 258                                         case EP_TYPE_ISOCHRONOUS:
 259                                                 EPConfigMask |= USB_EP_TYPE_ISOCHRONOUS_gc;
 260                                                 break;
 261                                         default:
 262                                                 EPConfigMask |= USB_EP_TYPE_BULK_gc;
 263                                                 break;
 264                                 }
 265
 266                                 if (Type == EP_TYPE_CONTROL)
 267                                   Endpoint_ConfigureEndpoint_PRV(Address ^ ENDPOINT_DIR_IN, EPConfigMask, Size);
 268
 269                                 return Endpoint_ConfigureEndpoint_PRV(Address, EPConfigMask, Size);
 270                         }
 271
 272                         /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
 273                          *
 274                          *  \ingroup Group_EndpointRW_XMEGA
 275                          *
 276                          *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
 277                          */
 278                         static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 279                         static inline uint16_t Endpoint_BytesInEndpoint(void)
 280                         {
 281                                 if (USB_Endpoint_SelectedEndpoint & ENDPOINT_DIR_IN)
 282                                   return USB_Endpoint_SelectedFIFO->Position;
 283                                 else
 284                                   return (USB_Endpoint_SelectedFIFO->Length - USB_Endpoint_SelectedFIFO->Position);
 285                         }
 286
 287                         /** Get the endpoint address of the currently selected endpoint. This is typically used to save
 288                          *  the currently selected endpoint so that it can be restored after another endpoint has been
 289                          *  manipulated.
 290                          *
 291                          *  \return Index of the currently selected endpoint.
 292                          */
 293                         static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 294                         static inline uint8_t Endpoint_GetCurrentEndpoint(void)
 295                         {
 296                                 return USB_Endpoint_SelectedEndpoint;
 297                         }
 298
 299                         /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
 300                          *  data In and Out pointers to the bank's contents.
 301                          *
 302                          *  \param[in] Address  Endpoint address whose FIFO buffers are to be reset.
 303                          */
 304                         static inline void Endpoint_ResetEndpoint(const uint8_t Address) ATTR_ALWAYS_INLINE;
 305                         static inline void Endpoint_ResetEndpoint(const uint8_t Address)
 306                         {
 307                                 if (Address & ENDPOINT_DIR_IN)
 308                                   USB_Endpoint_FIFOs[Address & ENDPOINT_EPNUM_MASK].IN.Position  = 0;
 309                                 else
 310                                   USB_Endpoint_FIFOs[Address & ENDPOINT_EPNUM_MASK].OUT.Position = 0;
 311                         }
 312
 313                         /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
 314                          *
 315                          * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.
 316                          */
 317                         static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 318                         static inline bool Endpoint_IsEnabled(void)
 319                         {
 320                                 return true;
 321                         }
 322
 323                         /** Aborts all pending IN transactions on the currently selected endpoint, once the bank
 324                          *  has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
 325                          *  will terminate all queued transactions, resetting the endpoint banks ready for a new
 326                          *  packet.
 327                          *
 328                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 329                          */
 330                         static inline void Endpoint_AbortPendingIN(void)
 331                         {
 332                                 USB_Endpoint_SelectedHandle->STATUS |= USB_EP_BUSNACK0_bm;
 333                         }
 334
 335                         /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
 336                          *  bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
 337                          *  direction). This function will return false if an error has occurred in the endpoint, if the endpoint
 338                          *  is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
 339                          *  direction and the endpoint bank is full.
 340                          *
 341                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 342                          *
 343                          *  \return Boolean \c true if the currently selected endpoint may be read from or written to, depending
 344                          *          on its direction.
 345                          */
 346                         static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 347                         static inline bool Endpoint_IsReadWriteAllowed(void)
 348                         {
 349                                 return (USB_Endpoint_SelectedFIFO->Position < USB_Endpoint_SelectedFIFO->Length);
 350                         }
 351
 352                         /** Determines if the currently selected endpoint is configured.
 353                          *
 354                          *  \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.
 355                          */
 356                         static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 357                         static inline bool Endpoint_IsConfigured(void)
 358                         {
 359                                 return ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_TYPE_gm) ? true : false);
 360                         }
 361
 362                         /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
 363                          *
 364                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 365                          *
 366                          *  \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.
 367                          */
 368                         static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 369                         static inline bool Endpoint_IsINReady(void)
 370                         {
 371                                 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint | ENDPOINT_DIR_IN);
 372
 373                                 return ((USB_Endpoint_SelectedHandle->STATUS & USB_EP_BUSNACK0_bm) ? true : false);
 374                         }
 375
 376                         /** Determines if the selected OUT endpoint has received new packet from the host.
 377                          *
 378                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 379                          *
 380                          *  \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.
 381                          */
 382                         static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 383                         static inline bool Endpoint_IsOUTReceived(void)
 384                         {
 385                                 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint & ~ENDPOINT_DIR_IN);
 386
 387                                 if (USB_Endpoint_SelectedHandle->STATUS & USB_EP_TRNCOMPL0_bm)
 388                                 {
 389                                         USB_Endpoint_SelectedFIFO->Length = USB_Endpoint_SelectedHandle->CNT;
 390                                         return true;
 391                                 }
 392
 393                                 return false;
 394                         }
 395
 396                         /** Determines if the current CONTROL type endpoint has received a SETUP packet.
 397                          *
 398                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 399                          *
 400                          *  \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.
 401                          */
 402                         static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 403                         static inline bool Endpoint_IsSETUPReceived(void)
 404                         {
 405                                 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint & ~ENDPOINT_DIR_IN);
 406
 407                                 if (USB_Endpoint_SelectedHandle->STATUS & USB_EP_SETUP_bm)
 408                                 {
 409                                         USB_Endpoint_SelectedFIFO->Length = USB_Endpoint_SelectedHandle->CNT;
 410                                         return true;
 411                                 }
 412
 413                                 return false;
 414                         }
 415
 416                         /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
 417                          *  endpoint for the next packet.
 418                          *
 419                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 420                          *
 421                          *  \note This is not applicable for non CONTROL type endpoints.
 422                          */
 423                         static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;
 424                         static inline void Endpoint_ClearSETUP(void)
 425                         {
 426                                 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint & ~ENDPOINT_DIR_IN);
 427                                 USB_Endpoint_SelectedHandle->STATUS &= ~(USB_EP_SETUP_bm | USB_EP_TRNCOMPL0_bm | USB_EP_BUSNACK0_bm | USB_EP_OVF_bm);
 428                                 USB_Endpoint_SelectedHandle->STATUS |= USB_EP_TOGGLE_bm;
 429                                 USB_Endpoint_SelectedFIFO->Position  = 0;
 430
 431                                 Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint | ENDPOINT_DIR_IN);
 432                                 USB_Endpoint_SelectedHandle->STATUS |= USB_EP_TOGGLE_bm;
 433                                 USB_Endpoint_SelectedFIFO->Position  = 0;
 434                         }
 435
 436                         /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
 437                          *  next packet and switching to the alternative endpoint bank if double banked.
 438                          *
 439                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 440                          */
 441                         static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
 442                         static inline void Endpoint_ClearIN(void)
 443                         {
 444                                 USB_Endpoint_SelectedHandle->CNT     = USB_Endpoint_SelectedFIFO->Position;
 445                                 USB_Endpoint_SelectedHandle->STATUS &= ~(USB_EP_TRNCOMPL0_bm | USB_EP_BUSNACK0_bm | USB_EP_OVF_bm);
 446                                 USB_Endpoint_SelectedFIFO->Position  = 0;
 447                         }
 448
 449                         /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
 450                          *  for the next packet and switching to the alternative endpoint bank if double banked.
 451                          *
 452                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 453                          */
 454                         static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
 455                         static inline void Endpoint_ClearOUT(void)
 456                         {
 457                                 USB_Endpoint_SelectedHandle->STATUS &= ~(USB_EP_TRNCOMPL0_bm | USB_EP_BUSNACK0_bm | USB_EP_OVF_bm);
 458                                 USB_Endpoint_SelectedFIFO->Position  = 0;
 459                         }
 460
 461                         /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
 462                          *  indicated endpoint and that the current transfer sequence should be aborted. This provides a
 463                          *  way for devices to indicate invalid commands to the host so that the current transfer can be
 464                          *  aborted and the host can begin its own recovery sequence.
 465                          *
 466                          *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
 467                          *  is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
 468                          *  endpoint.
 469                          *
 470                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 471                          */
 472                         static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
 473                         static inline void Endpoint_StallTransaction(void)
 474                         {
 475                                 USB_Endpoint_SelectedHandle->CTRL |= USB_EP_STALL_bm;
 476
 477                                 if ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_TYPE_gm) == USB_EP_TYPE_CONTROL_gc)
 478                                 {
 479                                         Endpoint_SelectEndpoint(USB_Endpoint_SelectedEndpoint ^ ENDPOINT_DIR_IN);
 480                                         USB_Endpoint_SelectedHandle->CTRL |= USB_EP_STALL_bm;
 481                                 }
 482                         }
 483
 484                         /** Clears the STALL condition on the currently selected endpoint.
 485                          *
 486                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 487                          */
 488                         static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
 489                         static inline void Endpoint_ClearStall(void)
 490                         {
 491                                 USB_Endpoint_SelectedHandle->CTRL &= ~USB_EP_STALL_bm;
 492                         }
 493
 494                         /** Determines if the currently selected endpoint is stalled, false otherwise.
 495                          *
 496                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 497                          *
 498                          *  \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.
 499                          */
 500                         static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 501                         static inline bool Endpoint_IsStalled(void)
 502                         {
 503                                 return ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_STALL_bm) ? true : false);
 504                         }
 505
 506                         /** Resets the data toggle of the currently selected endpoint. */
 507                         static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
 508                         static inline void Endpoint_ResetDataToggle(void)
 509                         {
 510                                 USB_Endpoint_SelectedHandle->STATUS &= ~USB_EP_TOGGLE_bm;
 511                         }
 512
 513                         /** Determines the currently selected endpoint's direction.
 514                          *
 515                          *  \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.
 516                          */
 517                         static inline uint8_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 518                         static inline uint8_t Endpoint_GetEndpointDirection(void)
 519                         {
 520                                 return (USB_Endpoint_SelectedEndpoint & ENDPOINT_DIR_IN);
 521                         }
 522
 523                         /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 524                          *
 525                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 526                          *
 527                          *  \return Next byte in the currently selected endpoint's FIFO buffer.
 528                          */
 529                         static inline uint8_t Endpoint_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 530                         static inline uint8_t Endpoint_Read_8(void)
 531                         {
 532                                 return USB_Endpoint_SelectedFIFO->Data[USB_Endpoint_SelectedFIFO->Position++];
 533                         }
 534
 535                         /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
 536                          *
 537                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 538                          *
 539                          *  \param[in] Data  Data to write into the the currently selected endpoint's FIFO buffer.
 540                          */
 541                         static inline void Endpoint_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
 542                         static inline void Endpoint_Write_8(const uint8_t Data)
 543                         {
 544                                 USB_Endpoint_SelectedFIFO->Data[USB_Endpoint_SelectedFIFO->Position++] = Data;
 545                         }
 546
 547                         /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 548                          *
 549                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 550                          */
 551                         static inline void Endpoint_Discard_8(void) ATTR_ALWAYS_INLINE;
 552                         static inline void Endpoint_Discard_8(void)
 553                         {
 554                                 USB_Endpoint_SelectedFIFO->Position++;
 555                         }
 556
 557                         /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
 558                          *  direction endpoints.
 559                          *
 560                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 561                          *
 562                          *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
 563                          */
 564                         static inline uint16_t Endpoint_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 565                         static inline uint16_t Endpoint_Read_16_LE(void)
 566                         {
 567                                 uint16_t Byte0 = Endpoint_Read_8();
 568                                 uint16_t Byte1 = Endpoint_Read_8();
 569
 570                                 return ((Byte1 << 8) | Byte0);
 571                         }
 572
 573                         /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
 574                          *  direction endpoints.
 575                          *
 576                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 577                          *
 578                          *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
 579                          */
 580                         static inline uint16_t Endpoint_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 581                         static inline uint16_t Endpoint_Read_16_BE(void)
 582                         {
 583                                 uint16_t Byte0 = Endpoint_Read_8();
 584                                 uint16_t Byte1 = Endpoint_Read_8();
 585
 586                                 return ((Byte0 << 8) | Byte1);
 587                         }
 588
 589                         /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
 590                          *  direction endpoints.
 591                          *
 592                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 593                          *
 594                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 595                          */
 596                         static inline void Endpoint_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 597                         static inline void Endpoint_Write_16_LE(const uint16_t Data)
 598                         {
 599                                 Endpoint_Write_8(Data & 0xFF);
 600                                 Endpoint_Write_8(Data >> 8);
 601                         }
 602
 603                         /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
 604                          *  direction endpoints.
 605                          *
 606                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 607                          *
 608                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 609                          */
 610                         static inline void Endpoint_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 611                         static inline void Endpoint_Write_16_BE(const uint16_t Data)
 612                         {
 613                                 Endpoint_Write_8(Data >> 8);
 614                                 Endpoint_Write_8(Data & 0xFF);
 615                         }
 616
 617                         /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 618                          *
 619                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 620                          */
 621                         static inline void Endpoint_Discard_16(void) ATTR_ALWAYS_INLINE;
 622                         static inline void Endpoint_Discard_16(void)
 623                         {
 624                                 Endpoint_Discard_8();
 625                                 Endpoint_Discard_8();
 626                         }
 627
 628                         /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
 629                          *  direction endpoints.
 630                          *
 631                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 632                          *
 633                          *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
 634                          */
 635                         static inline uint32_t Endpoint_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 636                         static inline uint32_t Endpoint_Read_32_LE(void)
 637                         {
 638                                 uint32_t Byte0 = Endpoint_Read_8();
 639                                 uint32_t Byte1 = Endpoint_Read_8();
 640                                 uint32_t Byte2 = Endpoint_Read_8();
 641                                 uint32_t Byte3 = Endpoint_Read_8();
 642
 643                                 return ((Byte3 << 24) | (Byte2 << 16) | (Byte1 << 8) | Byte0);
 644                         }
 645
 646                         /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
 647                          *  direction endpoints.
 648                          *
 649                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 650                          *
 651                          *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
 652                          */
 653                         static inline uint32_t Endpoint_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 654                         static inline uint32_t Endpoint_Read_32_BE(void)
 655                         {
 656                                 uint32_t Byte0 = Endpoint_Read_8();
 657                                 uint32_t Byte1 = Endpoint_Read_8();
 658                                 uint32_t Byte2 = Endpoint_Read_8();
 659                                 uint32_t Byte3 = Endpoint_Read_8();
 660
 661                                 return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
 662                         }
 663
 664                         /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
 665                          *  direction endpoints.
 666                          *
 667                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 668                          *
 669                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 670                          */
 671                         static inline void Endpoint_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 672                         static inline void Endpoint_Write_32_LE(const uint32_t Data)
 673                         {
 674                                 Endpoint_Write_8(Data & 0xFF);
 675                                 Endpoint_Write_8(Data >> 8);
 676                                 Endpoint_Write_8(Data >> 16);
 677                                 Endpoint_Write_8(Data >> 24);
 678                         }
 679
 680                         /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
 681                          *  direction endpoints.
 682                          *
 683                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 684                          *
 685                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 686                          */
 687                         static inline void Endpoint_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 688                         static inline void Endpoint_Write_32_BE(const uint32_t Data)
 689                         {
 690                                 Endpoint_Write_8(Data >> 24);
 691                                 Endpoint_Write_8(Data >> 16);
 692                                 Endpoint_Write_8(Data >> 8);
 693                                 Endpoint_Write_8(Data & 0xFF);
 694                         }
 695
 696                         /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 697                          *
 698                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 699                          */
 700                         static inline void Endpoint_Discard_32(void) ATTR_ALWAYS_INLINE;
 701                         static inline void Endpoint_Discard_32(void)
 702                         {
 703                                 Endpoint_Discard_8();
 704                                 Endpoint_Discard_8();
 705                                 Endpoint_Discard_8();
 706                                 Endpoint_Discard_8();
 707                         }
 708
 709                 /* External Variables: */
 710                         /** Global indicating the maximum packet size of the default control endpoint located at address
 711                          *  0 in the device. This value is set to the value indicated in the device descriptor in the user
 712                          *  project once the USB interface is initialized into device mode.
 713                          *
 714                          *  If space is an issue, it is possible to fix this to a static value by defining the control
 715                          *  endpoint size in the \c FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
 716                          *  via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
 717                          *  read from the descriptors at runtime and instead fixed to the given value. When used, it is
 718                          *  important that the descriptor control endpoint size value matches the size given as the
 719                          *  \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
 720                          *  be used in the device descriptors to ensure this.
 721                          *
 722                          *  \attention This variable should be treated as read-only in the user application, and never manually
 723                          *             changed in value.
 724                          */
 725                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 726                                 extern uint8_t USB_Device_ControlEndpointSize;
 727                         #else
 728                                 #define USB_Device_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
 729                         #endif
 730
 731                 /* Function Prototypes: */
 732                         /** Configures a table of endpoint descriptions, in sequence. This function can be used to configure multiple
 733                          *  endpoints at the same time.
 734                          *
 735                          *  \note Endpoints with a zero address will be ignored, thus this function cannot be used to configure the
 736                          *        control endpoint.
 737                          *
 738                          *  \param[in] Table    Pointer to a table of endpoint descriptions.
 739                          *  \param[in] Entries  Number of entries in the endpoint table to configure.
 740                          *
 741                          *  \return Boolean \c true if all endpoints configured successfully, \c false otherwise.
 742                          */
 743                         bool Endpoint_ConfigureEndpointTable(const USB_Endpoint_Table_t* const Table,
 744                                                              const uint8_t Entries);
 745
 746                         /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
 747                          *  with respect to the data direction. This is a convenience function which can be used to
 748                          *  simplify user control request handling.
 749                          *
 750                          *  \note This routine should not be called on non CONTROL type endpoints.
 751                          */
 752                         void Endpoint_ClearStatusStage(void);
 753
 754                         /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
 755                          *  to be read or written to it.
 756                          *
 757                          *  \note This routine should not be called on CONTROL type endpoints.
 758                          *
 759                          *  \ingroup Group_EndpointRW_XMEGA
 760                          *
 761                          *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
 762                          */
 763                         uint8_t Endpoint_WaitUntilReady(void);
 764
 765         /* Disable C linkage for C++ Compilers: */
 766                 #if defined(__cplusplus)
 767                         }
 768                 #endif
 769
 770 #endif
 771
 772 /** @} */
 773