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

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