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