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