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