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