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