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

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