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, bank size and number of hardware
 198                          *  banks. Once configured, the endpoint may be read from or written to, depending on its direction.
 199                          *
 200                          *  \param[in] Address    Endpoint address to configure.
 201                          *
 202                          *  \param[in] Type       Type of endpoint to configure, a \c EP_TYPE_* mask. Not all endpoint types
 203                          *                        are available on Low Speed USB devices - refer to the USB 2.0 specification.
 204                          *
 205                          *  \param[in] Size       Size of the endpoint's bank, where packets are stored before they are transmitted
 206                          *                        to the USB host, or after they have been received from the USB host (depending on
 207                          *                        the endpoint's data direction). The bank size must indicate the maximum packet size
 208                          *                        that the endpoint can handle.
 209                          *
 210                          *  \param[in] Banks      Number of hardware banks to use for the endpoint being configured.
 211                          *
 212                          *  \note The default control endpoint should not be manually configured by the user application, as
 213                          *        it is automatically configured by the library internally.
 214                          *        \n\n
 215                          *
 216                          *  \note This routine will automatically select the specified endpoint.
 217                          *
 218                          *  \return Boolean \c true if the configuration succeeded, \c false otherwise.
 219                          */
 220                         static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,
 221                                                                       const uint8_t Type,
 222                                                                       const uint16_t Size,
 223                                                                       const uint8_t Banks) ATTR_ALWAYS_INLINE;
 224                         static inline bool Endpoint_ConfigureEndpoint(const uint8_t Address,
 225                                                                       const uint8_t Type,
 226                                                                       const uint16_t Size,
 227                                                                       const uint8_t Banks)
 228                         {
 229                                 uint8_t EPConfigMask = (USB_EP_INTDSBL_bm | ((Banks > 1) ? USB_EP_PINGPONG_bm : 0) | Endpoint_BytesToEPSizeMask(Size));
 230
 231                                 if ((Address & ENDPOINT_EPNUM_MASK) >= ENDPOINT_TOTAL_ENDPOINTS)
 232                                   return false;
 233
 234                                 // TODO - Fix once limitations are lifted
 235                                 EPConfigMask &= ~USB_EP_PINGPONG_bm;
 236                                 if (Size > 64)
 237                                   return false;
 238
 239                                 switch (Type)
 240                                 {
 241                                         case EP_TYPE_CONTROL:
 242                                                 EPConfigMask |= USB_EP_TYPE_CONTROL_gc;
 243                                                 break;
 244                                         case EP_TYPE_ISOCHRONOUS:
 245                                                 EPConfigMask |= USB_EP_TYPE_ISOCHRONOUS_gc;
 246                                                 break;
 247                                         default:
 248                                                 EPConfigMask |= USB_EP_TYPE_BULK_gc;
 249                                                 break;
 250                                 }
 251
 252                                 if (Type == EP_TYPE_CONTROL)
 253                                   Endpoint_ConfigureEndpoint_PRV(Address ^ ENDPOINT_DIR_IN, EPConfigMask, Size);
 254
 255                                 return Endpoint_ConfigureEndpoint_PRV(Address, EPConfigMask, Size);
 256                         }
 257
 258                         /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
 259                          *
 260                          *  \ingroup Group_EndpointRW_XMEGA
 261                          *
 262                          *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
 263                          */
 264                         static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 265                         static inline uint16_t Endpoint_BytesInEndpoint(void)
 266                         {
 267                                 if (USB_Endpoint_SelectedEndpoint & ENDPOINT_DIR_IN)
 268                                   return USB_Endpoint_SelectedFIFO->Position;
 269                                 else
 270                                   return (USB_Endpoint_SelectedFIFO->Length - USB_Endpoint_SelectedFIFO->Position);
 271                         }
 272
 273                         /** Get the endpoint address of the currently selected endpoint. This is typically used to save
 274                          *  the currently selected endpoint so that it can be restored after another endpoint has been
 275                          *  manipulated.
 276                          *
 277                          *  \return Index of the currently selected endpoint.
 278                          */
 279                         static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 280                         static inline uint8_t Endpoint_GetCurrentEndpoint(void)
 281                         {
 282                                 return USB_Endpoint_SelectedEndpoint;
 283                         }
 284
 285                         /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
 286                          *  data In and Out pointers to the bank's contents.
 287                          *
 288                          *  \param[in] Address  Endpoint address whose FIFO buffers are to be reset.
 289                          */
 290                         static inline void Endpoint_ResetEndpoint(const uint8_t Address) ATTR_ALWAYS_INLINE;
 291                         static inline void Endpoint_ResetEndpoint(const uint8_t Address)
 292                         {
 293                                 if (Address & ENDPOINT_DIR_IN)
 294                                   USB_Endpoint_FIFOs[Address & ENDPOINT_EPNUM_MASK].IN.Position  = 0;
 295                                 else
 296                                   USB_Endpoint_FIFOs[Address & ENDPOINT_EPNUM_MASK].OUT.Position = 0;
 297                         }
 298
 299                         /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
 300                          *
 301                          * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.
 302                          */
 303                         static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 304                         static inline bool Endpoint_IsEnabled(void)
 305                         {
 306                                 return true;
 307                         }
 308
 309                         /** Aborts all pending IN transactions on the currently selected endpoint, once the bank
 310                          *  has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
 311                          *  will terminate all queued transactions, resetting the endpoint banks ready for a new
 312                          *  packet.
 313                          *
 314                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 315                          */
 316                         static inline void Endpoint_AbortPendingIN(void)
 317                         {
 318                                 USB_Endpoint_SelectedHandle->STATUS |= USB_EP_BUSNACK0_bm;
 319                         }
 320
 321                         /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
 322                          *  bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
 323                          *  direction). This function will return false if an error has occurred in the endpoint, if the endpoint
 324                          *  is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
 325                          *  direction and the endpoint bank is full.
 326                          *
 327                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 328                          *
 329                          *  \return Boolean \c true if the currently selected endpoint may be read from or written to, depending
 330                          *          on its direction.
 331                          */
 332                         static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 333                         static inline bool Endpoint_IsReadWriteAllowed(void)
 334                         {
 335                                 return (USB_Endpoint_SelectedFIFO->Position < USB_Endpoint_SelectedFIFO->Length);
 336                         }
 337
 338                         /** Determines if the currently selected endpoint is configured.
 339                          *
 340                          *  \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.
 341                          */
 342                         static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 343                         static inline bool Endpoint_IsConfigured(void)
 344                         {
 345                                 return ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_TYPE_gm) ? true : false);
 346                         }
 347
 348                         /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
 349                          *
 350                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 351                          *
 352                          *  \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.
 353                          */
 354                         bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT;
 355
 356                         /** Determines if the selected OUT endpoint has received new packet from the host.
 357                          *
 358                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 359                          *
 360                          *  \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.
 361                          */
 362                         bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT;
 363
 364                         /** Determines if the current CONTROL type endpoint has received a SETUP packet.
 365                          *
 366                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 367                          *
 368                          *  \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.
 369                          */
 370                         bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT;
 371
 372                         /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
 373                          *  endpoint for the next packet.
 374                          *
 375                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 376                          *
 377                          *  \note This is not applicable for non CONTROL type endpoints.
 378                          */
 379                         void Endpoint_ClearSETUP(void);
 380
 381                         /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
 382                          *  next packet and switching to the alternative endpoint bank if double banked.
 383                          *
 384                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 385                          */
 386                         void Endpoint_ClearIN(void);
 387
 388                         /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
 389                          *  for the next packet and switching to the alternative endpoint bank if double banked.
 390                          *
 391                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 392                          */
 393                         void Endpoint_ClearOUT(void);
 394
 395                         /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
 396                          *  indicated endpoint and that the current transfer sequence should be aborted. This provides a
 397                          *  way for devices to indicate invalid commands to the host so that the current transfer can be
 398                          *  aborted and the host can begin its own recovery sequence.
 399                          *
 400                          *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
 401                          *  is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
 402                          *  endpoint.
 403                          *
 404                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 405                          */
 406                         void Endpoint_StallTransaction(void);
 407
 408                         /** Clears the STALL condition on the currently selected endpoint.
 409                          *
 410                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 411                          */
 412                         static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
 413                         static inline void Endpoint_ClearStall(void)
 414                         {
 415                                 USB_Endpoint_SelectedHandle->CTRL &= ~USB_EP_STALL_bm;
 416                         }
 417
 418                         /** Determines if the currently selected endpoint is stalled, \c false otherwise.
 419                          *
 420                          *  \ingroup Group_EndpointPacketManagement_XMEGA
 421                          *
 422                          *  \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.
 423                          */
 424                         static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 425                         static inline bool Endpoint_IsStalled(void)
 426                         {
 427                                 return ((USB_Endpoint_SelectedHandle->CTRL & USB_EP_STALL_bm) ? true : false);
 428                         }
 429
 430                         /** Resets the data toggle of the currently selected endpoint. */
 431                         static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
 432                         static inline void Endpoint_ResetDataToggle(void)
 433                         {
 434                                 USB_Endpoint_SelectedHandle->STATUS &= ~USB_EP_TOGGLE_bm;
 435                         }
 436
 437                         /** Determines the currently selected endpoint's direction.
 438                          *
 439                          *  \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.
 440                          */
 441                         static inline uint8_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 442                         static inline uint8_t Endpoint_GetEndpointDirection(void)
 443                         {
 444                                 return (USB_Endpoint_SelectedEndpoint & ENDPOINT_DIR_IN);
 445                         }
 446
 447                         /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 448                          *
 449                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 450                          *
 451                          *  \return Next byte in the currently selected endpoint's FIFO buffer.
 452                          */
 453                         uint8_t Endpoint_Read_8(void) ATTR_WARN_UNUSED_RESULT;
 454
 455                         /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
 456                          *
 457                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 458                          *
 459                          *  \param[in] Data  Data to write into the the currently selected endpoint's FIFO buffer.
 460                          */
 461                         void Endpoint_Write_8(const uint8_t Data);
 462
 463                         /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 464                          *
 465                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 466                          */
 467                         static inline void Endpoint_Discard_8(void) ATTR_ALWAYS_INLINE;
 468                         static inline void Endpoint_Discard_8(void)
 469                         {
 470                                 USB_Endpoint_SelectedFIFO->Position++;
 471                         }
 472
 473                         /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
 474                          *  direction endpoints.
 475                          *
 476                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 477                          *
 478                          *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
 479                          */
 480                         static inline uint16_t Endpoint_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 481                         static inline uint16_t Endpoint_Read_16_LE(void)
 482                         {
 483                                 uint16_t Byte0 = Endpoint_Read_8();
 484                                 uint16_t Byte1 = Endpoint_Read_8();
 485
 486                                 return ((Byte1 << 8) | Byte0);
 487                         }
 488
 489                         /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
 490                          *  direction endpoints.
 491                          *
 492                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 493                          *
 494                          *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
 495                          */
 496                         static inline uint16_t Endpoint_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 497                         static inline uint16_t Endpoint_Read_16_BE(void)
 498                         {
 499                                 uint16_t Byte0 = Endpoint_Read_8();
 500                                 uint16_t Byte1 = Endpoint_Read_8();
 501
 502                                 return ((Byte0 << 8) | Byte1);
 503                         }
 504
 505                         /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
 506                          *  direction endpoints.
 507                          *
 508                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 509                          *
 510                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 511                          */
 512                         static inline void Endpoint_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 513                         static inline void Endpoint_Write_16_LE(const uint16_t Data)
 514                         {
 515                                 Endpoint_Write_8(Data & 0xFF);
 516                                 Endpoint_Write_8(Data >> 8);
 517                         }
 518
 519                         /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
 520                          *  direction endpoints.
 521                          *
 522                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 523                          *
 524                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 525                          */
 526                         static inline void Endpoint_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 527                         static inline void Endpoint_Write_16_BE(const uint16_t Data)
 528                         {
 529                                 Endpoint_Write_8(Data >> 8);
 530                                 Endpoint_Write_8(Data & 0xFF);
 531                         }
 532
 533                         /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 534                          *
 535                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 536                          */
 537                         static inline void Endpoint_Discard_16(void) ATTR_ALWAYS_INLINE;
 538                         static inline void Endpoint_Discard_16(void)
 539                         {
 540                                 Endpoint_Discard_8();
 541                                 Endpoint_Discard_8();
 542                         }
 543
 544                         /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
 545                          *  direction endpoints.
 546                          *
 547                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 548                          *
 549                          *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
 550                          */
 551                         static inline uint32_t Endpoint_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 552                         static inline uint32_t Endpoint_Read_32_LE(void)
 553                         {
 554                                 uint32_t Byte0 = Endpoint_Read_8();
 555                                 uint32_t Byte1 = Endpoint_Read_8();
 556                                 uint32_t Byte2 = Endpoint_Read_8();
 557                                 uint32_t Byte3 = Endpoint_Read_8();
 558
 559                                 return ((Byte3 << 24) | (Byte2 << 16) | (Byte1 << 8) | Byte0);
 560                         }
 561
 562                         /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
 563                          *  direction endpoints.
 564                          *
 565                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 566                          *
 567                          *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
 568                          */
 569                         static inline uint32_t Endpoint_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 570                         static inline uint32_t Endpoint_Read_32_BE(void)
 571                         {
 572                                 uint32_t Byte0 = Endpoint_Read_8();
 573                                 uint32_t Byte1 = Endpoint_Read_8();
 574                                 uint32_t Byte2 = Endpoint_Read_8();
 575                                 uint32_t Byte3 = Endpoint_Read_8();
 576
 577                                 return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
 578                         }
 579
 580                         /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
 581                          *  direction endpoints.
 582                          *
 583                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 584                          *
 585                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 586                          */
 587                         static inline void Endpoint_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 588                         static inline void Endpoint_Write_32_LE(const uint32_t Data)
 589                         {
 590                                 Endpoint_Write_8(Data & 0xFF);
 591                                 Endpoint_Write_8(Data >> 8);
 592                                 Endpoint_Write_8(Data >> 16);
 593                                 Endpoint_Write_8(Data >> 24);
 594                         }
 595
 596                         /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
 597                          *  direction endpoints.
 598                          *
 599                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 600                          *
 601                          *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
 602                          */
 603                         static inline void Endpoint_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 604                         static inline void Endpoint_Write_32_BE(const uint32_t Data)
 605                         {
 606                                 Endpoint_Write_8(Data >> 24);
 607                                 Endpoint_Write_8(Data >> 16);
 608                                 Endpoint_Write_8(Data >> 8);
 609                                 Endpoint_Write_8(Data & 0xFF);
 610                         }
 611
 612                         /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 613                          *
 614                          *  \ingroup Group_EndpointPrimitiveRW_XMEGA
 615                          */
 616                         static inline void Endpoint_Discard_32(void) ATTR_ALWAYS_INLINE;
 617                         static inline void Endpoint_Discard_32(void)
 618                         {
 619                                 Endpoint_Discard_8();
 620                                 Endpoint_Discard_8();
 621                                 Endpoint_Discard_8();
 622                                 Endpoint_Discard_8();
 623                         }
 624
 625                 /* External Variables: */
 626                         /** Global indicating the maximum packet size of the default control endpoint located at address
 627                          *  0 in the device. This value is set to the value indicated in the device descriptor in the user
 628                          *  project once the USB interface is initialized into device mode.
 629                          *
 630                          *  If space is an issue, it is possible to fix this to a static value by defining the control
 631                          *  endpoint size in the \c FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
 632                          *  via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
 633                          *  read from the descriptors at runtime and instead fixed to the given value. When used, it is
 634                          *  important that the descriptor control endpoint size value matches the size given as the
 635                          *  \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
 636                          *  be used in the device descriptors to ensure this.
 637                          *
 638                          *  \attention This variable should be treated as read-only in the user application, and never manually
 639                          *             changed in value.
 640                          */
 641                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 642                                 extern uint8_t USB_Device_ControlEndpointSize;
 643                         #else
 644                                 #define USB_Device_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
 645                         #endif
 646
 647                 /* Function Prototypes: */
 648                         /** Configures a table of endpoint descriptions, in sequence. This function can be used to configure multiple
 649                          *  endpoints at the same time.
 650                          *
 651                          *  \note Endpoints with a zero address will be ignored, thus this function cannot be used to configure the
 652                          *        control endpoint.
 653                          *
 654                          *  \param[in] Table    Pointer to a table of endpoint descriptions.
 655                          *  \param[in] Entries  Number of entries in the endpoint table to configure.
 656                          *
 657                          *  \return Boolean \c true if all endpoints configured successfully, \c false otherwise.
 658                          */
 659                         bool Endpoint_ConfigureEndpointTable(const USB_Endpoint_Table_t* const Table,
 660                                                              const uint8_t Entries);
 661
 662                         /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
 663                          *  with respect to the data direction. This is a convenience function which can be used to
 664                          *  simplify user control request handling.
 665                          *
 666                          *  \note This routine should not be called on non CONTROL type endpoints.
 667                          */
 668                         void Endpoint_ClearStatusStage(void);
 669
 670                         /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
 671                          *  to be read or written to it.
 672                          *
 673                          *  \note This routine should not be called on CONTROL type endpoints.
 674                          *
 675                          *  \ingroup Group_EndpointRW_XMEGA
 676                          *
 677                          *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
 678                          */
 679                         uint8_t Endpoint_WaitUntilReady(void);
 680
 681         /* Disable C linkage for C++ Compilers: */
 682                 #if defined(__cplusplus)
 683                         }
 684                 #endif
 685
 686 #endif
 687
 688 /** @} */
 689