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