LUFA/Drivers/USB/LowLevel/Endpoint.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 /** \ingroup Group_USB
  32  *  @defgroup Group_EndpointManagement Endpoint Management
  33  *
  34  *  Functions, macros and enums related to endpoint management when in USB Device mode. This
  35  *  module contains the endpoint management macros, as well as endpoint interrupt and data
  36  *  send/recieve functions for various data types.
  37  *
  38  *  @{
  39  */
  40
  41 /** @defgroup Group_EndpointRW Endpoint Data Reading and Writing
  42  *
  43  *  Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
  44  */
  45
  46 /** @defgroup Group_EndpointPacketManagement Endpoint Packet Management
  47  *
  48  *  Functions, macros, variables, enums and types related to packet management of endpoints.
  49  */
  50
  51 #ifndef __ENDPOINT_H__
  52 #define __ENDPOINT_H__
  53
  54         /* Includes: */
  55                 #include <avr/io.h>
  56                 #include <stdbool.h>
  57
  58                 #include "../../../Common/Common.h"
  59                 #include "../HighLevel/USBTask.h"
  60
  61                 #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
  62                         #include "../HighLevel/StreamCallbacks.h"
  63                 #endif
  64
  65         /* Enable C linkage for C++ Compilers: */
  66                 #if defined(__cplusplus)
  67                         extern "C" {
  68                 #endif
  69
  70         /* Public Interface - May be used in end-application: */
  71                 /* Macros: */
  72                         /** Endpoint data direction mask for Endpoint_ConfigureEndpoint(). This indicates that the endpoint
  73                          *  should be initialized in the OUT direction - i.e. data flows from host to device.
  74                          */
  75                         #define ENDPOINT_DIR_OUT                      (0 << EPDIR)
  76
  77                         /** Endpoint data direction mask for Endpoint_ConfigureEndpoint(). This indicates that the endpoint
  78                          *  should be initialized in the IN direction - i.e. data flows from device to host.
  79                          */
  80                         #define ENDPOINT_DIR_IN                       (1 << EPDIR)
  81
  82                         /** Mask for the bank mode selection for the Endpoint_ConfigureEndpoint() macro. This indicates
  83                          *  that the endpoint should have one single bank, which requires less USB FIFO memory but results
  84                          *  in slower transfers as only one USB device (the AVR or the host) can access the endpoint's
  85                          *  bank at the one time.
  86                          */
  87                         #define ENDPOINT_BANK_SINGLE                  (0 << EPBK0)
  88
  89                         /** Mask for the bank mode selection for the Endpoint_ConfigureEndpoint() macro. This indicates
  90                          *  that the endpoint should have two banks, which requires more USB FIFO memory but results
  91                          *  in faster transfers as one USB device (the AVR or the host) can access one bank while the other
  92                          *  accesses the second bank.
  93                          */
  94                         #define ENDPOINT_BANK_DOUBLE                  (1 << EPBK0)
  95
  96                         /** Endpoint address for the default control endpoint, which always resides in address 0. This is
  97                          *  defined for convenience to give more readable code when used with the endpoint macros.
  98                          */
  99                         #define ENDPOINT_CONTROLEP                    0
 100
 101                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 102                                 /** Default size of the default control endpoint's bank, until altered by the Endpoint0Size value
 103                                  *  in the device descriptor. Not available if the FIXED_CONTROL_ENDPOINT_SIZE token is defined.
 104                                  */
 105                                 #define ENDPOINT_CONTROLEP_DEFAULT_SIZE   8
 106                         #endif
 107
 108                         /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
 109                          *  numerical address in the device.
 110                          */
 111                         #define ENDPOINT_EPNUM_MASK                   0x03
 112
 113                         /** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's
 114                          *  bank size in the device.
 115                          */
 116                         #define ENDPOINT_EPSIZE_MASK                  0x7FF
 117
 118                         /** Maximum size in bytes of a given endpoint.
 119                          *
 120                          *  \param n  Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
 121                          */
 122                         #define ENDPOINT_MAX_SIZE(n)                  _ENDPOINT_GET_MAXSIZE(n)
 123
 124                         /** Indicates if the given endpoint supports double banking.
 125                          *
 126                          *  \param n  Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
 127                          */
 128                         #define ENDPOINT_DOUBLEBANK_SUPPORTED(n)      _ENDPOINT_GET_DOUBLEBANK(n)
 129
 130                         #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)
 131                                 /** Total number of endpoints (including the default control endpoint at address 0) which may
 132                                  *  be used in the device. Different USB AVR models support different amounts of endpoints,
 133                                  *  this value reflects the maximum number of endpoints for the currently selected AVR model.
 134                                  */
 135                                 #define ENDPOINT_TOTAL_ENDPOINTS          7
 136                         #else
 137                                 #define ENDPOINT_TOTAL_ENDPOINTS          5
 138                         #endif
 139
 140                         /** Interrupt definition for the endpoint SETUP interrupt (for CONTROL type endpoints). Should be
 141                          *  used with the USB_INT_* macros located in USBInterrupt.h.
 142                          *
 143                          *  This interrupt will fire if enabled on a CONTROL type endpoint if a new control packet is
 144                          *  received from the host.
 145                          *
 146                          *  \note This interrupt must be enabled and cleared on *each* endpoint which requires it (after the
 147                          *        endpoint is selected), and will fire the common endpoint interrupt vector.
 148                          *
 149                          *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.
 150                          */
 151                         #define ENDPOINT_INT_SETUP                    UEIENX, (1 << RXSTPE), UEINTX, (1 << RXSTPI)
 152
 153                         /** Interrupt definition for the endpoint IN interrupt (for INTERRUPT type endpoints). Should be
 154                          *  used with the USB_INT_* macros located in USBInterrupt.h.
 155                          *
 156                          *  This interrupt will fire if enabled on an INTERRUPT type endpoint if a the endpoint interrupt
 157                          *  period has elapsed and the endpoint is ready for a new packet to be written to its FIFO buffer
 158                          *  (if required).
 159                          *
 160                          *  \note This interrupt must be enabled and cleared on *each* endpoint which requires it (after the
 161                          *        endpoint is selected), and will fire the common endpoint interrupt vector.
 162                          *
 163                          *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.
 164                          */
 165                         #define ENDPOINT_INT_IN                       UEIENX, (1 << TXINE) , UEINTX, (1 << TXINI)
 166
 167                         /** Interrupt definition for the endpoint OUT interrupt (for INTERRUPT type endpoints). Should be
 168                          *  used with the USB_INT_* macros located in USBInterrupt.h.
 169                          *
 170                          *  This interrupt will fire if enabled on an INTERRUPT type endpoint if a the endpoint interrupt
 171                          *  period has elapsed and the endpoint is ready for a packet from the host to be read from its
 172                          *  FIFO buffer (if received).
 173                          *
 174                          *  \note This interrupt must be enabled and cleared on *each* endpoint which requires it (after the
 175                          *        endpoint is selected), and will fire the common endpoint interrupt vector.
 176                          *
 177                          *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.
 178                          */
 179                         #define ENDPOINT_INT_OUT                      UEIENX, (1 << RXOUTE), UEINTX, (1 << RXOUTI)
 180
 181                 /* Pseudo-Function Macros: */
 182                         #if defined(__DOXYGEN__)
 183                                 /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
 184                                  *
 185                                  *  \note The return width of this function may differ, depending on the maximum endpoint bank size
 186                                  *        of the selected AVR model.
 187                                  *
 188                                  *  \ingroup Group_EndpointRW
 189                                  *
 190                                  *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer
 191                                  */
 192                                 static inline uint16_t Endpoint_BytesInEndpoint(void);
 193
 194                                 /** Get the endpoint address of the currently selected endpoint. This is typically used to save
 195                                  *  the currently selected endpoint number so that it can be restored after another endpoint has
 196                                  *  been manipulated.
 197                                  *
 198                                  *  \return Index of the currently selected endpoint
 199                                  */
 200                                 static inline uint8_t Endpoint_GetCurrentEndpoint(void);
 201
 202                                 /** Selects the given endpoint number. If the address from the device descriptors is used, the
 203                                  *  value should be masked with the ENDPOINT_EPNUM_MASK constant to extract only the endpoint
 204                                  *  number (and discarding the endpoint direction bit).
 205                                  *
 206                                  *  Any endpoint operations which do not require the endpoint number to be indicated will operate on
 207                                  *  the currently selected endpoint.
 208                                  *
 209                                  *  \param EndpointNumber Endpoint number to select
 210                                  */
 211                                 static inline void Endpoint_SelectEndpoint(uint8_t EndpointNumber);
 212
 213                                 /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
 214                                  *  In and Out pointers to the bank's contents.
 215                                  *
 216                                  *  \param EndpointNumber Endpoint number whose FIFO buffers are to be reset
 217                                  */
 218                                 static inline void Endpoint_ResetFIFO(uint8_t EndpointNumber);
 219
 220                                 /** Enables the currently selected endpoint so that data can be sent and received through it to
 221                                  *  and from a host.
 222                                  *
 223                                  *  \note Endpoints must first be configured properly rather than just being enabled via the
 224                                  *        Endpoint_ConfigureEndpoint() macro, which calls Endpoint_EnableEndpoint() automatically.
 225                                  */
 226                                 static inline void Endpoint_EnableEndpoint(void);
 227
 228                                 /** Disables the currently selected endpoint so that data cannot be sent and received through it
 229                                  *  to and from a host.
 230                                  */
 231                                 static inline void Endpoint_DisableEndpoint(void);
 232
 233                                 /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
 234                                  *
 235                                  * \return Boolean True if the currently selected endpoint is enabled, false otherwise
 236                                  */
 237                                 static inline bool Endpoint_IsEnabled(void);
 238
 239                                 /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
 240                                  *  bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
 241                                  *  direction). This function will return false if an error has occurred in the endpoint, if the endpoint
 242                                  *  is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
 243                                  *  direction and the endpoint bank is full.
 244                                  *
 245                                  *  \ingroup Group_EndpointPacketManagement
 246                                  *
 247                                  *  \return Boolean true if the currently selected endpoint may be read from or written to, depending on its direction
 248                                  */
 249                                 static inline bool Endpoint_IsReadWriteAllowed(void);
 250
 251                                 /** Determines if the currently selected endpoint is configured.
 252                                  *
 253                                  *  \return Boolean true if the currently selected endpoint has been configured, false otherwise
 254                                  */
 255                                 static inline bool Endpoint_IsConfigured(void);
 256
 257                                 /** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
 258                                  *  interrupt duration has elapsed. Which endpoints have interrupted can be determined by
 259                                  *  masking the return value against (1 << {Endpoint Number}).
 260                                  *
 261                                  *  \return Mask whose bits indicate which endpoints have interrupted
 262                                  */
 263                                 static inline uint8_t Endpoint_GetEndpointInterrupts(void);
 264
 265                                 /** Clears the endpoint interrupt flag. This clears the specified endpoint number's interrupt
 266                                  *  mask in the endpoint interrupt flag register.
 267                                  *
 268                                  *  \param EndpointNumber  Index of the endpoint whose interrupt flag should be cleared
 269                                  */
 270                                 static inline void Endpoint_ClearEndpointInterrupt(uint8_t EndpointNumber);
 271
 272                                 /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
 273                                  *  endpoints).
 274                                  *
 275                                  *  \param EndpointNumber  Index of the endpoint whose interrupt flag should be tested
 276                                  *
 277                                  *  \return Boolean true if the specified endpoint has interrupted, false otherwise
 278                                  */
 279                                 static inline bool Endpoint_HasEndpointInterrupted(uint8_t EndpointNumber);
 280
 281                                 /** Determines if the selected IN endpoint is ready for a new packet.
 282                                  *
 283                                  *  \ingroup Group_EndpointPacketManagement
 284                                  *
 285                                  *  \return Boolean true if the current endpoint is ready for an IN packet, false otherwise.
 286                                  */
 287                                 static inline bool Endpoint_IsINReady(void);
 288
 289                                 /** Determines if the selected OUT endpoint has received new packet.
 290                                  *
 291                                  *  \ingroup Group_EndpointPacketManagement
 292                                  *
 293                                  *  \return Boolean true if current endpoint is has received an OUT packet, false otherwise.
 294                                  */
 295                                 static inline bool Endpoint_IsOUTReceived(void);
 296
 297                                 /** Determines if the current CONTROL type endpoint has received a SETUP packet.
 298                                  *
 299                                  *  \ingroup Group_EndpointPacketManagement
 300                                  *
 301                                  *  \return Boolean true if the selected endpoint has received a SETUP packet, false otherwise.
 302                                  */
 303                                 static inline bool Endpoint_IsSETUPReceived(void);
 304
 305                                 /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
 306                                  *  endpoint for the next packet.
 307                                  *
 308                                  *  \ingroup Group_EndpointPacketManagement
 309                                  *
 310                                  *  \note This is not applicable for non CONTROL type endpoints.
 311                                  */
 312                                 static inline void Endpoint_ClearSETUP(void);
 313
 314                                 /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
 315                                  *  next packet and switching to the alternative endpoint bank if double banked.
 316                                  *
 317                                  *  \ingroup Group_EndpointPacketManagement
 318                                  */
 319                                 static inline void Endpoint_ClearIN(void);
 320
 321                                 /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
 322                                  *  for the next packet and switching to the alternative endpoint bank if double banked.
 323                                  *
 324                                  *  \ingroup Group_EndpointPacketManagement
 325                                  */
 326                                 static inline void Endpoint_ClearOUT(void);
 327
 328                                 /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
 329                                  *  indicated endpoint and that the current transfer sequence should be aborted. This provides a
 330                                  *  way for devices to indicate invalid commands to the host so that the current transfer can be
 331                                  *  aborted and the host can begin its own recovery sequence.
 332                                  *
 333                                  *  The currently selected endpoint remains stalled until either the Endpoint_ClearStall() macro
 334                                  *  is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
 335                                  *  endpoint.
 336                                  *
 337                                  *  \ingroup Group_EndpointPacketManagement
 338                                  */
 339                                 static inline void Endpoint_StallTransaction(void);
 340
 341                                 /** Clears the STALL condition on the currently selected endpoint.
 342                                  *
 343                                  *  \ingroup Group_EndpointPacketManagement
 344                                  */
 345                                 static inline void Endpoint_ClearStall(void);
 346
 347                                 /** Determines if the currently selected endpoint is stalled, false otherwise.
 348                                  *
 349                                  *  \ingroup Group_EndpointPacketManagement
 350                                  *
 351                                  *  \return Boolean true if the currently selected endpoint is stalled, false otherwise
 352                                  */
 353                                 static inline bool Endpoint_IsStalled(void);
 354
 355                                 /** Resets the data toggle of the currently selected endpoint. */
 356                                 static inline void Endpoint_ResetDataToggle(void);
 357
 358                                 /** Determines the currently selected endpoint's direction.
 359                                  *
 360                                  *  \return The currently selected endpoint's direction, as a ENDPOINT_DIR_* mask.
 361                                  */
 362                                 static inline uint8_t Endpoint_GetEndpointDirection(void);
 363                         #else
 364                                 #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)
 365                                         #define Endpoint_BytesInEndpoint()        UEBCX
 366                                 #else
 367                                         #define Endpoint_BytesInEndpoint()        UEBCLX
 368                                 #endif
 369
 370                                 #define Endpoint_GetCurrentEndpoint()         (UENUM & ENDPOINT_EPNUM_MASK)
 371
 372                                 #define Endpoint_SelectEndpoint(epnum)        MACROS{ UENUM = epnum; }MACROE
 373
 374                                 #define Endpoint_ResetFIFO(epnum)             MACROS{ UERST = (1 << epnum); UERST = 0; }MACROE
 375
 376                                 #define Endpoint_EnableEndpoint()             MACROS{ UECONX |= (1 << EPEN); }MACROE
 377
 378                                 #define Endpoint_DisableEndpoint()            MACROS{ UECONX &= ~(1 << EPEN); }MACROE
 379
 380                                 #define Endpoint_IsEnabled()                  ((UECONX & (1 << EPEN)) ? true : false)
 381
 382                                 #define Endpoint_IsReadWriteAllowed()         ((UEINTX & (1 << RWAL)) ? true : false)
 383
 384                                 #define Endpoint_IsConfigured()               ((UESTA0X & (1 << CFGOK)) ? true : false)
 385
 386                                 #define Endpoint_GetEndpointInterrupts()      UEINT
 387
 388                                 #define Endpoint_ClearEndpointInterrupt(n)    MACROS{ UEINT &= ~(1 << n); }MACROE
 389
 390                                 #define Endpoint_HasEndpointInterrupted(n)    ((UEINT & (1 << n)) ? true : false)
 391
 392                                 #define Endpoint_IsINReady()                  ((UEINTX & (1 << TXINI))  ? true : false)
 393
 394                                 #define Endpoint_IsOUTReceived()              ((UEINTX & (1 << RXOUTI)) ? true : false)
 395
 396                                 #define Endpoint_IsSETUPReceived()            ((UEINTX & (1 << RXSTPI)) ? true : false)
 397
 398                                 #define Endpoint_ClearSETUP()                 MACROS{ UEINTX &= ~(1 << RXSTPI); }MACROE
 399
 400                                 #define Endpoint_ClearIN()                    MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << TXINI)); \
 401                                                                                       UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
 402
 403                                 #define Endpoint_ClearOUT()                   MACROS{ uint8_t Temp = UEINTX; UEINTX = (Temp & ~(1 << RXOUTI)); \
 404                                                                                       UEINTX = (Temp & ~(1 << FIFOCON)); }MACROE
 405
 406                                 #define Endpoint_StallTransaction()           MACROS{ UECONX |= (1 << STALLRQ); }MACROE
 407
 408                                 #define Endpoint_ClearStall()                 MACROS{ UECONX |= (1 << STALLRQC); }MACROE
 409
 410                                 #define Endpoint_IsStalled()                  ((UECONX & (1 << STALLRQ)) ? true : false)
 411
 412                                 #define Endpoint_ResetDataToggle()            MACROS{ UECONX |= (1 << RSTDT); }MACROE
 413
 414                                 #define Endpoint_GetEndpointDirection()       (UECFG0X & ENDPOINT_DIR_IN)
 415                         #endif
 416
 417                 /* Enums: */
 418                         /** Enum for the possible error return codes of the Endpoint_WaitUntilReady function.
 419                          *
 420                          *  \ingroup Group_EndpointRW
 421                          */
 422                         enum Endpoint_WaitUntilReady_ErrorCodes_t
 423                         {
 424                                 ENDPOINT_READYWAIT_NoError                 = 0, /**< Endpoint is ready for next packet, no error. */
 425                                 ENDPOINT_READYWAIT_EndpointStalled         = 1, /**< The endpoint was stalled during the stream
 426                                                                                  *   transfer by the host or device.
 427                                                                                  */
 428                                 ENDPOINT_READYWAIT_DeviceDisconnected      = 2, /**< Device was disconnected from the host while
 429                                                                                  *   waiting for the endpoint to become ready.
 430                                                                                  */
 431                                 ENDPOINT_READYWAIT_Timeout                 = 3, /**< The host failed to accept or send the next packet
 432                                                                                  *   within the software timeout period set by the
 433                                                                                  *   USB_STREAM_TIMEOUT_MS macro.
 434                                                                                  */
 435                         };
 436
 437                         /** Enum for the possible error return codes of the Endpoint_*_Stream_* functions.
 438                          *
 439                          *  \ingroup Group_EndpointRW
 440                          */
 441                         enum Endpoint_Stream_RW_ErrorCodes_t
 442                         {
 443                                 ENDPOINT_RWSTREAM_ERROR_NoError            = 0, /**< Command completed successfully, no error. */
 444                                 ENDPOINT_RWSTREAM_ERROR_EndpointStalled    = 1, /**< The endpoint was stalled during the stream
 445                                                                                  *   transfer by the host or device.
 446                                                                                  */
 447                                 ENDPOINT_RWSTREAM_ERROR_DeviceDisconnected = 1, /**< Device was disconnected from the host during
 448                                                                                  *   the transfer.
 449                                                                                  */
 450                                 ENDPOINT_RWSTREAM_ERROR_Timeout            = 2, /**< The host failed to accept or send the next packet
 451                                                                                  *   within the software timeout period set by the
 452                                                                                  *   USB_STREAM_TIMEOUT_MS macro.
 453                                                                                  */
 454                                 ENDPOINT_RWSTREAM_ERROR_CallbackAborted    = 3, /**< Indicates that the stream's callback function
 455                                                                              *   aborted the transfer early.
 456                                                                                  */
 457                         };
 458
 459                         /** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions..
 460                          *
 461                          *  \ingroup Group_EndpointRW
 462                          */
 463                         enum Endpoint_ControlStream_RW_ErrorCodes_t
 464                         {
 465                                 ENDPOINT_RWCSTREAM_ERROR_NoError            = 0, /**< Command completed successfully, no error. */
 466                                 ENDPOINT_RWCSTREAM_ERROR_HostAborted        = 1, /**< The aborted the transfer prematurely. */
 467                         };
 468
 469                 /* Inline Functions: */
 470                         /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 471                          *
 472                          *  \ingroup Group_EndpointRW
 473                          *
 474                          *  \return Next byte in the currently selected endpoint's FIFO buffer
 475                          */
 476                         static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 477                         static inline uint8_t Endpoint_Read_Byte(void)
 478                         {
 479                                 return UEDATX;
 480                         }
 481
 482                         /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
 483                          *
 484                          *  \ingroup Group_EndpointRW
 485                          *
 486                          *  \param Byte  Next byte to write into the the currently selected endpoint's FIFO buffer
 487                          */
 488                         static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 489                         static inline void Endpoint_Write_Byte(const uint8_t Byte)
 490                         {
 491                                 UEDATX = Byte;
 492                         }
 493
 494                         /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 495                          *
 496                          *  \ingroup Group_EndpointRW
 497                          */
 498                         static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
 499                         static inline void Endpoint_Discard_Byte(void)
 500                         {
 501                                 uint8_t Dummy;
 502
 503                                 Dummy = UEDATX;
 504                         }
 505
 506                         /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
 507                          *  direction endpoints.
 508                          *
 509                          *  \ingroup Group_EndpointRW
 510                          *
 511                          *  \return Next word in the currently selected endpoint's FIFO buffer
 512                          */
 513                         static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 514                         static inline uint16_t Endpoint_Read_Word_LE(void)
 515                         {
 516                                 uint16_t Data;
 517
 518                                 Data  = UEDATX;
 519                                 Data |= (((uint16_t)UEDATX) << 8);
 520
 521                                 return Data;
 522                         }
 523
 524                         /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
 525                          *  direction endpoints.
 526                          *
 527                          *  \ingroup Group_EndpointRW
 528                          *
 529                          *  \return Next word in the currently selected endpoint's FIFO buffer
 530                          */
 531                         static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 532                         static inline uint16_t Endpoint_Read_Word_BE(void)
 533                         {
 534                                 uint16_t Data;
 535
 536                                 Data  = (((uint16_t)UEDATX) << 8);
 537                                 Data |= UEDATX;
 538
 539                                 return Data;
 540                         }
 541
 542                         /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
 543                          *  direction endpoints.
 544                          *
 545                          *  \ingroup Group_EndpointRW
 546                          *
 547                          *  \param Word  Next word to write to the currently selected endpoint's FIFO buffer
 548                          */
 549                         static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
 550                         static inline void Endpoint_Write_Word_LE(const uint16_t Word)
 551                         {
 552                                 UEDATX = (Word & 0xFF);
 553                                 UEDATX = (Word >> 8);
 554                         }
 555
 556                         /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
 557                          *  direction endpoints.
 558                          *
 559                          *  \ingroup Group_EndpointRW
 560                          *
 561                          *  \param Word  Next word to write to the currently selected endpoint's FIFO buffer
 562                          */
 563                         static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
 564                         static inline void Endpoint_Write_Word_BE(const uint16_t Word)
 565                         {
 566                                 UEDATX = (Word >> 8);
 567                                 UEDATX = (Word & 0xFF);
 568                         }
 569
 570                         /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 571                          *
 572                          *  \ingroup Group_EndpointRW
 573                          */
 574                         static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
 575                         static inline void Endpoint_Discard_Word(void)
 576                         {
 577                                 uint8_t Dummy;
 578
 579                                 Dummy = UEDATX;
 580                                 Dummy = UEDATX;
 581                         }
 582
 583                         /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
 584                          *  direction endpoints.
 585                          *
 586                          *  \ingroup Group_EndpointRW
 587                          *
 588                          *  \return Next double word in the currently selected endpoint's FIFO buffer
 589                          */
 590                         static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 591                         static inline uint32_t Endpoint_Read_DWord_LE(void)
 592                         {
 593                                 union
 594                                 {
 595                                         uint32_t DWord;
 596                                         uint8_t  Bytes[4];
 597                                 } Data;
 598
 599                                 Data.Bytes[0] = UEDATX;
 600                                 Data.Bytes[1] = UEDATX;
 601                                 Data.Bytes[2] = UEDATX;
 602                                 Data.Bytes[3] = UEDATX;
 603
 604                                 return Data.DWord;
 605                         }
 606
 607                         /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
 608                          *  direction endpoints.
 609                          *
 610                          *  \ingroup Group_EndpointRW
 611                          *
 612                          *  \return Next double word in the currently selected endpoint's FIFO buffer
 613                          */
 614                         static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 615                         static inline uint32_t Endpoint_Read_DWord_BE(void)
 616                         {
 617                                 union
 618                                 {
 619                                         uint32_t DWord;
 620                                         uint8_t  Bytes[4];
 621                                 } Data;
 622
 623                                 Data.Bytes[3] = UEDATX;
 624                                 Data.Bytes[2] = UEDATX;
 625                                 Data.Bytes[1] = UEDATX;
 626                                 Data.Bytes[0] = UEDATX;
 627
 628                                 return Data.DWord;
 629                         }
 630
 631                         /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
 632                          *  direction endpoints.
 633                          *
 634                          *  \ingroup Group_EndpointRW
 635                          *
 636                          *  \param DWord  Next double word to write to the currently selected endpoint's FIFO buffer
 637                          */
 638                         static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
 639                         static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
 640                         {
 641                                 UEDATX = (DWord &  0xFF);
 642                                 UEDATX = (DWord >> 8);
 643                                 UEDATX = (DWord >> 16);
 644                                 UEDATX = (DWord >> 24);
 645                         }
 646
 647                         /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
 648                          *  direction endpoints.
 649                          *
 650                          *  \ingroup Group_EndpointRW
 651                          *
 652                          *  \param DWord  Next double word to write to the currently selected endpoint's FIFO buffer
 653                          */
 654                         static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
 655                         static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
 656                         {
 657                                 UEDATX = (DWord >> 24);
 658                                 UEDATX = (DWord >> 16);
 659                                 UEDATX = (DWord >> 8);
 660                                 UEDATX = (DWord &  0xFF);
 661                         }
 662
 663                         /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 664                          *
 665                          *  \ingroup Group_EndpointRW
 666                          */
 667                         static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
 668                         static inline void Endpoint_Discard_DWord(void)
 669                         {
 670                                 uint8_t Dummy;
 671
 672                                 Dummy = UEDATX;
 673                                 Dummy = UEDATX;
 674                                 Dummy = UEDATX;
 675                                 Dummy = UEDATX;
 676                         }
 677
 678                 /* External Variables: */
 679                         /** Global indicating the maximum packet size of the default control endpoint located at address
 680                          *  0 in the device. This value is set to the value indicated in the device descriptor in the user
 681                          *  project once the USB interface is initialized into device mode.
 682                          *
 683                          *  If space is an issue, it is possible to fix this to a static value by defining the control
 684                          *  endpoint size in the FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
 685                          *  via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
 686                          *  read from the descriptors at runtime and instead fixed to the given value. When used, it is
 687                          *  important that the descriptor control endpoint size value matches the size given as the
 688                          *  FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the FIXED_CONTROL_ENDPOINT_SIZE token
 689                          *  be used in the descriptors to ensure this.
 690                          *
 691                          *  \note This variable should be treated as read-only in the user application, and never manually
 692                          *        changed in value.
 693                          */
 694                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 695                                 extern uint8_t USB_ControlEndpointSize;
 696                         #else
 697                                 #define USB_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
 698                         #endif
 699
 700                 /* Function Prototypes: */
 701                         /** Configures the specified endpoint number with the given endpoint type, direction, bank size
 702                          *  and banking mode. Endpoints should be allocated in ascending order by their address in the
 703                          *  device (i.e. endpoint 1 should be configured before endpoint 2 and so on).
 704                          *
 705                          *  The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction
 706                          *  may be either ENDPOINT_DIR_OUT or ENDPOINT_DIR_IN.
 707                          *
 708                          *  The bank size must indicate the maximum packet size that the endpoint can handle. Different
 709                          *  endpoint numbers can handle different maximum packet sizes - refer to the chosen USB AVR's
 710                          *  datasheet to determine the maximum bank size for each endpoint.
 711                          *
 712                          *  The banking mode may be either ENDPOINT_BANK_SINGLE or ENDPOINT_BANK_DOUBLE.
 713                          *
 714                          *  The success of this routine can be determined via the Endpoint_IsConfigured() macro.
 715                          *
 716                          *  By default, the routine is entirely dynamic, and will accept both constant and variable inputs.
 717                          *  If dynamic configuration is unused, a small space savings can be made by defining the
 718                          *  STATIC_ENDPOINT_CONFIGURATION macro via the -D switch to the compiler, to optimize for constant
 719                          *  input values.
 720                          *
 721                          *  \note This routine will select the specified endpoint, and the endpoint will remain selected
 722                          *        once the routine completes regardless of if the endpoint configuration succeeds.
 723                          *
 724                          *  \return Boolean true if the configuration succeeded, false otherwise
 725                          */
 726                         bool Endpoint_ConfigureEndpoint(const uint8_t  Number, const uint8_t Type, const uint8_t Direction,
 727                                                         const uint16_t Size, const uint8_t Banks);
 728
 729                         /** Spinloops until the currently selected non-control endpoint is ready for the next packet of data
 730                          *  to be read or written to it.
 731                          *
 732                          *  \note This routine should not be called on CONTROL type endpoints.
 733                          *
 734                          *  \ingroup Group_EndpointRW
 735                          *
 736                          *  \return A value from the Endpoint_WaitUntilReady_ErrorCodes_t enum.
 737                          */
 738                         uint8_t Endpoint_WaitUntilReady(void);
 739
 740                         /** Reads and discards the given number of bytes from the endpoint from the given buffer,
 741                          *  discarding fully read packets from the host as needed. The last packet is not automatically
 742                          *  discarded once the remaining bytes has been read; the user is responsible for manually
 743                          *  discarding the last packet from the host via the Endpoint_ClearOUT() macro. Between
 744                          *  each USB packet, the given stream callback function is executed repeatedly until the next
 745                          *  packet is ready, allowing for early aborts of stream transfers.
 746                          *
 747                          *      The callback routine should be created using the STREAM_CALLBACK() macro. If the token
 748                          *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
 749                          *  and this function has the Callback parameter omitted.
 750                          *
 751                          *  \note This routine should not be used on CONTROL type endpoints.
 752                          *
 753                          *  \ingroup Group_EndpointRW
 754                          *
 755                          *  \param Length    Number of bytes to send via the currently selected endpoint.
 756                          *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 757                          *
 758                          *  \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
 759                          */
 760                         uint8_t Endpoint_Discard_Stream(uint16_t Length
 761                         #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
 762                                                         , uint8_t (* const Callback)(void)
 763                         #endif
 764                                                         );
 765
 766                         /** Writes the given number of bytes to the endpoint from the given buffer in little endian,
 767                          *  sending full packets to the host as needed. The last packet filled is not automatically sent;
 768                          *  the user is responsible for manually sending the last written packet to the host via the
 769                          *  Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
 770                          *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
 771                          *  aborts of stream transfers.
 772                          *
 773                          *      The callback routine should be created using the STREAM_CALLBACK() macro. If the token
 774                          *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
 775                          *  and this function has the Callback parameter omitted.
 776                          *
 777                          *  \note This routine should not be used on CONTROL type endpoints.
 778                          *
 779                          *  \ingroup Group_EndpointRW
 780                          *
 781                          *  \param Buffer    Pointer to the source data buffer to read from.
 782                          *  \param Length    Number of bytes to read for the currently selected endpoint into the buffer.
 783                          *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 784                          *
 785                          *  \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
 786                          */
 787                         uint8_t Endpoint_Write_Stream_LE(const void* Buffer, uint16_t Length
 788                         #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
 789                                                          , uint8_t (* const Callback)(void)
 790                         #endif
 791                                                          ) ATTR_NON_NULL_PTR_ARG(1);
 792
 793                         /** Writes the given number of bytes to the endpoint from the given buffer in big endian,
 794                          *  sending full packets to the host as needed. The last packet filled is not automatically sent;
 795                          *  the user is responsible for manually sending the last written packet to the host via the
 796                          *  Endpoint_ClearIN() macro. Between each USB packet, the given stream callback function
 797                          *  is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early
 798                          *  aborts of stream transfers.
 799                          *
 800                          *      The callback routine should be created using the STREAM_CALLBACK() macro. If the token
 801                          *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
 802                          *  and this function has the Callback parameter omitted.
 803                          *
 804                          *  \note This routine should not be used on CONTROL type endpoints.
 805                          *
 806                          *  \ingroup Group_EndpointRW
 807                          *
 808                          *  \param Buffer    Pointer to the source data buffer to read from.
 809                          *  \param Length    Number of bytes to read for the currently selected endpoint into the buffer.
 810                          *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 811                          *
 812                          *  \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
 813                          */
 814                         uint8_t Endpoint_Write_Stream_BE(const void* Buffer, uint16_t Length
 815                         #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
 816                                                          , uint8_t (* const Callback)(void)
 817                         #endif
 818                                                          ) ATTR_NON_NULL_PTR_ARG(1);
 819
 820                         /** Reads the given number of bytes from the endpoint from the given buffer in little endian,
 821                          *  discarding fully read packets from the host as needed. The last packet is not automatically
 822                          *  discarded once the remaining bytes has been read; the user is responsible for manually
 823                          *  discarding the last packet from the host via the Endpoint_ClearOUT() macro. Between
 824                          *  each USB packet, the given stream callback function is executed repeatedly until the endpoint
 825                          *  is ready to accept the next packet, allowing for early aborts of stream transfers.
 826                          *
 827                          *      The callback routine should be created using the STREAM_CALLBACK() macro. If the token
 828                          *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
 829                          *  and this function has the Callback parameter omitted.
 830                          *
 831                          *  \note This routine should not be used on CONTROL type endpoints.
 832                          *
 833                          *  \ingroup Group_EndpointRW
 834                          *
 835                          *  \param Buffer    Pointer to the destination data buffer to write to.
 836                          *  \param Length    Number of bytes to send via the currently selected endpoint.
 837                          *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 838                          *
 839                          *  \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
 840                          */
 841                         uint8_t Endpoint_Read_Stream_LE(void* Buffer, uint16_t Length
 842                         #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
 843                                                         , uint8_t (* const Callback)(void)
 844                         #endif
 845                                                         ) ATTR_NON_NULL_PTR_ARG(1);
 846
 847                         /** Reads the given number of bytes from the endpoint from the given buffer in big endian,
 848                          *  discarding fully read packets from the host as needed. The last packet is not automatically
 849                          *  discarded once the remaining bytes has been read; the user is responsible for manually
 850                          *  discarding the last packet from the host via the Endpoint_ClearOUT() macro. Between
 851                          *  each USB packet, the given stream callback function is executed repeatedly until the endpoint
 852                          *  is ready to accept the next packet, allowing for early aborts of stream transfers.
 853                          *
 854                          *      The callback routine should be created using the STREAM_CALLBACK() macro. If the token
 855                          *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
 856                          *  and this function has the Callback parameter omitted.
 857                          *
 858                          *  \note This routine should not be used on CONTROL type endpoints.
 859                          *
 860                          *  \ingroup Group_EndpointRW
 861                          *
 862                          *  \param Buffer    Pointer to the destination data buffer to write to.
 863                          *  \param Length    Number of bytes to send via the currently selected endpoint.
 864                          *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 865                          *
 866                          *  \return A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
 867                          */
 868                         uint8_t Endpoint_Read_Stream_BE(void* Buffer, uint16_t Length
 869                         #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
 870                                                         , uint8_t (* const Callback)(void)
 871                         #endif
 872                                                         ) ATTR_NON_NULL_PTR_ARG(1);
 873
 874                         /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
 875                          *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
 876                          *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
 877                          *  finalize the transfer via the Endpoint_ClearOUT() macro.
 878                          *
 879                          *  \note This routine should only be used on CONTROL type endpoints.
 880                          *
 881                          *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
 882                          *           together; i.e. the entire stream data must be read or written at the one time.
 883                          *
 884                          *  \ingroup Group_EndpointRW
 885                          *
 886                          *  \param Buffer  Pointer to the source data buffer to read from.
 887                          *  \param Length  Number of bytes to read for the currently selected endpoint into the buffer.
 888                          *
 889                          *  \return A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.
 890                          */
 891                         uint8_t Endpoint_Write_Control_Stream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
 892
 893                         /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
 894                          *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
 895                          *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
 896                          *  finalize the transfer via the Endpoint_ClearOUT() macro.
 897                          *
 898                          *  \note This routine should only be used on CONTROL type endpoints.
 899                          *
 900                          *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
 901                          *           together; i.e. the entire stream data must be read or written at the one time.
 902                          *
 903                          *  \ingroup Group_EndpointRW
 904                          *
 905                          *  \param Buffer  Pointer to the source data buffer to read from.
 906                          *  \param Length  Number of bytes to read for the currently selected endpoint into the buffer.
 907                          *
 908                          *  \return A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.
 909                          */
 910                         uint8_t Endpoint_Write_Control_Stream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
 911
 912                         /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
 913                          *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
 914                          *  automatically sent after success or failure states; the user is responsible for manually sending the
 915                          *  setup IN to finalize the transfer via the Endpoint_ClearIN() macro.
 916                          *
 917                          *  \note This routine should only be used on CONTROL type endpoints.
 918                          *
 919                          *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
 920                          *           together; i.e. the entire stream data must be read or written at the one time.
 921                          *
 922                          *  \ingroup Group_EndpointRW
 923                          *
 924                          *  \param Buffer  Pointer to the destination data buffer to write to.
 925                          *  \param Length  Number of bytes to send via the currently selected endpoint.
 926                          *
 927                          *  \return A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.
 928                          */
 929                         uint8_t Endpoint_Read_Control_Stream_LE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
 930
 931                         /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
 932                          *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
 933                          *  automatically sent after success or failure states; the user is responsible for manually sending the
 934                          *  setup IN to finalize the transfer via the Endpoint_ClearIN() macro.
 935                          *
 936                          *  \note This routine should only be used on CONTROL type endpoints.
 937                          *
 938                          *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
 939                          *           together; i.e. the entire stream data must be read or written at the one time.
 940                          *
 941                          *  \ingroup Group_EndpointRW
 942                          *
 943                          *  \param Buffer  Pointer to the destination data buffer to write to.
 944                          *  \param Length  Number of bytes to send via the currently selected endpoint.
 945                          *
 946                          *  \return A value from the Endpoint_ControlStream_RW_ErrorCodes_t enum.
 947                          */
 948                         uint8_t Endpoint_Read_Control_Stream_BE(void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
 949
 950         /* Private Interface - For use in library only: */
 951         #if !defined(__DOXYGEN__)
 952                 /* Macros: */
 953                         #define Endpoint_AllocateMemory()              MACROS{ UECFG1X |=  (1 << ALLOC); }MACROE
 954                         #define Endpoint_DeallocateMemory()            MACROS{ UECFG1X &= ~(1 << ALLOC); }MACROE
 955
 956                         #define _ENDPOINT_GET_MAXSIZE(n)               _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## n)
 957                         #define _ENDPOINT_GET_MAXSIZE2(details)        _ENDPOINT_GET_MAXSIZE3(details)
 958                         #define _ENDPOINT_GET_MAXSIZE3(maxsize, db)    maxsize
 959
 960                         #define _ENDPOINT_GET_DOUBLEBANK(n)            _ENDPOINT_GET_DOUBLEBANK2(ENDPOINT_DETAILS_EP ## n)
 961                         #define _ENDPOINT_GET_DOUBLEBANK2(details)     _ENDPOINT_GET_DOUBLEBANK3(details)
 962                         #define _ENDPOINT_GET_DOUBLEBANK3(maxsize, db) db
 963
 964                         #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER)
 965                                 #define ENDPOINT_DETAILS_EP0               64,  true
 966                                 #define ENDPOINT_DETAILS_EP1               256, true
 967                                 #define ENDPOINT_DETAILS_EP2               64,  true
 968                                 #define ENDPOINT_DETAILS_EP3               64,  true
 969                                 #define ENDPOINT_DETAILS_EP4               64,  true
 970                                 #define ENDPOINT_DETAILS_EP5               64,  true
 971                                 #define ENDPOINT_DETAILS_EP6               64,  true
 972                         #else
 973                                 #define ENDPOINT_DETAILS_EP0               64,  true
 974                                 #define ENDPOINT_DETAILS_EP1               64,  false
 975                                 #define ENDPOINT_DETAILS_EP2               64,  false
 976                                 #define ENDPOINT_DETAILS_EP3               64,  true
 977                                 #define ENDPOINT_DETAILS_EP4               64,  true
 978                         #endif
 979
 980                         #if defined(STATIC_ENDPOINT_CONFIGURATION)
 981                                 #define Endpoint_ConfigureEndpoint(Number, Type, Direction, Size, Banks)        \
 982                                                                      Endpoint_ConfigureEndpointStatic(Number,   \
 983                                                                               ((Type << EPTYPE0) | Direction),  \
 984                                                                               ((1 << ALLOC) | Banks | Endpoint_BytesToEPSizeMask(Size)));
 985                         #endif
 986
 987                 /* Function Prototypes: */
 988                         void Endpoint_ClearEndpoints(void);
 989                         bool Endpoint_ConfigureEndpointStatic(const uint8_t Number, const uint8_t UECFG0XData, const uint8_t UECFG1XData);
 990
 991                 /* Inline Functions: */
 992                         static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
 993                         static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
 994                         {
 995                                 if (Bytes <= 8)
 996                                   return (0 << EPSIZE0);
 997                                 else if (Bytes <= 16)
 998                                   return (1 << EPSIZE0);
 999                                 else if (Bytes <= 32)
1000                                   return (2 << EPSIZE0);
1001                                 #if defined(USB_LIMITED_CONTROLLER)
1002                                 else
1003                                   return (3 << EPSIZE0);
1004                                 #else
1005                                 else if (Bytes <= 64)
1006                                   return (3 << EPSIZE0);
1007                                 else if (Bytes <= 128)
1008                                   return (4 << EPSIZE0);
1009                                 else
1010                                   return (5 << EPSIZE0);
1011                                 #endif
1012                         };
1013
1014         #endif
1015
1016         /* Disable C linkage for C++ Compilers: */
1017                 #if defined(__cplusplus)
1018                         }
1019                 #endif
1020
1021 #endif
1022
1023 /** @} */