LUFA/Drivers/USB/LowLevel/Endpoint.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief USB device endpoint management definitions.
  33  *
  34  *  This file contains structures, function prototypes and macros related to the management of the device's
  35  *  data endpoints when the library is initialized in USB device mode.
  36  *
  37  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  38  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  39  */
  40
  41 /** \ingroup Group_EndpointManagement
  42  *  @defgroup Group_EndpointRW Endpoint Data Reading and Writing
  43  *
  44  *  Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
  45  */
  46
  47 /** \ingroup Group_EndpointRW
  48  *  @defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types
  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_EndpointManagement
  55  *  @defgroup Group_EndpointPacketManagement Endpoint Packet Management
  56  *
  57  *  Functions, macros, variables, enums and types related to packet management of endpoints.
  58  */
  59
  60 /** \ingroup Group_USB
  61  *  @defgroup Group_EndpointManagement Endpoint Management
  62  *
  63  *  Functions, macros and enums related to endpoint management when in USB Device mode. This
  64  *  module contains the endpoint management macros, as well as endpoint interrupt and data
  65  *  send/receive functions for various data types.
  66  *
  67  *  @{
  68  */
  69
  70 #ifndef __ENDPOINT_H__
  71 #define __ENDPOINT_H__
  72
  73         /* Includes: */
  74                 #include <avr/io.h>
  75                 #include <stdbool.h>
  76
  77                 #include "../../../Common/Common.h"
  78                 #include "../HighLevel/USBTask.h"
  79                 #include "USBInterrupt.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         /* Private Interface - For use in library only: */
  92         #if !defined(__DOXYGEN__)
  93                 /* Macros: */
  94                         #define _ENDPOINT_GET_MAXSIZE(EPIndex)         _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## EPIndex)
  95                         #define _ENDPOINT_GET_MAXSIZE2(EPDetails)      _ENDPOINT_GET_MAXSIZE3(EPDetails)
  96                         #define _ENDPOINT_GET_MAXSIZE3(MaxSize, Banks) (MaxSize)
  97
  98                         #define _ENDPOINT_GET_BANKS(EPIndex)           _ENDPOINT_GET_BANKS2(ENDPOINT_DETAILS_EP ## EPIndex)
  99                         #define _ENDPOINT_GET_BANKS2(EPDetails)        _ENDPOINT_GET_BANKS3(EPDetails)
 100                         #define _ENDPOINT_GET_BANKS3(MaxSize, Banks)   (Banks)
 101
 102                         #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
 103                                 #define ENDPOINT_DETAILS_MAXEP             7
 104
 105                                 #define ENDPOINT_DETAILS_EP0               64,  2
 106                                 #define ENDPOINT_DETAILS_EP1               256, 2
 107                                 #define ENDPOINT_DETAILS_EP2               64,  2
 108                                 #define ENDPOINT_DETAILS_EP3               64,  2
 109                                 #define ENDPOINT_DETAILS_EP4               64,  2
 110                                 #define ENDPOINT_DETAILS_EP5               64,  2
 111                                 #define ENDPOINT_DETAILS_EP6               64,  2
 112                         #else
 113                                 #define ENDPOINT_DETAILS_MAXEP             5
 114
 115                                 #define ENDPOINT_DETAILS_EP0               64,  2
 116                                 #define ENDPOINT_DETAILS_EP1               64,  1
 117                                 #define ENDPOINT_DETAILS_EP2               64,  1
 118                                 #define ENDPOINT_DETAILS_EP3               64,  2
 119                                 #define ENDPOINT_DETAILS_EP4               64,  2
 120                         #endif
 121
 122                 /* Inline Functions: */
 123                         static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST
 124                                                                                                ATTR_ALWAYS_INLINE;
 125                         static inline uint8_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
 126                         {
 127                                 uint8_t  MaskVal    = 0;
 128                                 uint16_t CheckBytes = 8;
 129
 130                                 while (CheckBytes < Bytes)
 131                                 {
 132                                         MaskVal++;
 133                                         CheckBytes <<= 1;
 134                                 }
 135
 136                                 return (MaskVal << EPSIZE0);
 137                         }
 138
 139                 /* Function Prototypes: */
 140                         void Endpoint_ClearEndpoints(void);
 141                         bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,
 142                                                             const uint8_t UECFG0XData,
 143                                                             const uint8_t UECFG1XData);
 144
 145         #endif
 146
 147         /* Public Interface - May be used in end-application: */
 148                 /* Macros: */
 149                         /** \name Endpoint Direction Masks */
 150                         //@{
 151                         /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
 152                          *  should be initialized in the OUT direction - i.e. data flows from host to device.
 153                          */
 154                         #define ENDPOINT_DIR_OUT                        (0 << EPDIR)
 155
 156                         /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint
 157                          *  should be initialized in the IN direction - i.e. data flows from device to host.
 158                          */
 159                         #define ENDPOINT_DIR_IN                         (1 << EPDIR)
 160                         //@}
 161
 162                         /** \name Endpoint Bank Mode Masks */
 163                         //@{
 164                         /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
 165                          *  that the endpoint should have one single bank, which requires less USB FIFO memory but results
 166                          *  in slower transfers as only one USB device (the AVR or the host) can access the endpoint's
 167                          *  bank at the one time.
 168                          */
 169                         #define ENDPOINT_BANK_SINGLE                    (0 << EPBK0)
 170
 171                         /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
 172                          *  that the endpoint should have two banks, which requires more USB FIFO memory but results
 173                          *  in faster transfers as one USB device (the AVR or the host) can access one bank while the other
 174                          *  accesses the second bank.
 175                          */
 176                         #define ENDPOINT_BANK_DOUBLE                    (1 << EPBK0)
 177                         //@}
 178
 179                         /** Endpoint address for the default control endpoint, which always resides in address 0. This is
 180                          *  defined for convenience to give more readable code when used with the endpoint macros.
 181                          */
 182                         #define ENDPOINT_CONTROLEP                      0
 183
 184                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 185                                 /** Default size of the default control endpoint's bank, until altered by the control endpoint bank size
 186                                  *  value in the device descriptor. Not available if the FIXED_CONTROL_ENDPOINT_SIZE token is defined.
 187                                  */
 188                                 #define ENDPOINT_CONTROLEP_DEFAULT_SIZE     8
 189                         #endif
 190
 191                         /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
 192                          *  numerical address in the device.
 193                          */
 194                         #define ENDPOINT_EPNUM_MASK                     0x07
 195
 196                         /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's
 197                          *  direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks.
 198                          */
 199                         #define ENDPOINT_EPDIR_MASK                     0x80
 200
 201                         /** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's
 202                          *  bank size in the device.
 203                          */
 204                         #define ENDPOINT_EPSIZE_MASK                    0x7F
 205
 206                         /** Maximum size in bytes of a given endpoint.
 207                          *
 208                          *  \param[in] EPIndex  Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
 209                          */
 210                         #define ENDPOINT_MAX_SIZE(EPIndex)              _ENDPOINT_GET_MAXSIZE(EPIndex)
 211
 212                         /** Indicates the total number of banks supported by the given endpoint.
 213                          *
 214                          *  \param[in] EPIndex  Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
 215                          */
 216                         #define ENDPOINT_BANKS_SUPPORTED(EPIndex)       _ENDPOINT_GET_BANKS(EPIndex)
 217
 218                         #if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)
 219                                 /** Total number of endpoints (including the default control endpoint at address 0) which may
 220                                  *  be used in the device. Different USB AVR models support different amounts of endpoints,
 221                                  *  this value reflects the maximum number of endpoints for the currently selected AVR model.
 222                                  */
 223                                 #define ENDPOINT_TOTAL_ENDPOINTS            ENDPOINT_DETAILS_MAXEP
 224                         #else
 225                                 #define ENDPOINT_TOTAL_ENDPOINTS            1
 226                         #endif
 227
 228                 /* Enums: */
 229                         /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
 230                          *
 231                          *  \ingroup Group_EndpointRW
 232                          */
 233                         enum Endpoint_WaitUntilReady_ErrorCodes_t
 234                         {
 235                                 ENDPOINT_READYWAIT_NoError                 = 0, /**< Endpoint is ready for next packet, no error. */
 236                                 ENDPOINT_READYWAIT_EndpointStalled         = 1, /**< The endpoint was stalled during the stream
 237                                                                                  *   transfer by the host or device.
 238                                                                                  */
 239                                 ENDPOINT_READYWAIT_DeviceDisconnected      = 2, /**< Device was disconnected from the host while
 240                                                                                  *   waiting for the endpoint to become ready.
 241                                                                                  */
 242                                 ENDPOINT_READYWAIT_BusSuspended            = 3, /**< The USB bus has been suspended by the host and
 243                                                                                  *   no USB endpoint traffic can occur until the bus
 244                                                                                  *   has resumed.
 245                                                                                  */
 246                                 ENDPOINT_READYWAIT_Timeout                 = 4, /**< The host failed to accept or send the next packet
 247                                                                                  *   within the software timeout period set by the
 248                                                                                  *   \ref USB_STREAM_TIMEOUT_MS macro.
 249                                                                                  */
 250                         };
 251
 252                 /* Inline Functions: */
 253                         /** Configures the specified endpoint number with the given endpoint type, direction, bank size
 254                          *  and banking mode. Once configured, the endpoint may be read from or written to, depending
 255                          *  on its direction.
 256                          *
 257                          *  \param[in] Number     Endpoint number to configure. This must be more than 0 and less than
 258                          *                        \ref ENDPOINT_TOTAL_ENDPOINTS.
 259                          *
 260                          *  \param[in] Type       Type of endpoint to configure, a EP_TYPE_* mask. Not all endpoint types
 261                          *                        are available on Low Speed USB devices - refer to the USB 2.0 specification.
 262                          *
 263                          *  \param[in] Direction  Endpoint data direction, either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
 264                          *                        All endpoints (except Control type) are unidirectional - data may only be read
 265                          *                        from or written to the endpoint bank based on its direction, not both.
 266                          *
 267                          *  \param[in] Size       Size of the endpoint's bank, where packets are stored before they are transmitted
 268                          *                        to the USB host, or after they have been received from the USB host (depending on
 269                          *                        the endpoint's data direction). The bank size must indicate the maximum packet size
 270                          *                        that the endpoint can handle.
 271                          *
 272                          *  \param[in] Banks      Number of banks to use for the endpoint being configured, an ENDPOINT_BANK_* mask.
 273                          *                        More banks uses more USB DPRAM, but offers better performance. Isochronous type
 274                          *                        endpoints <b>must</b> have at least two banks.
 275                          *
 276                          *  \note Endpoints <b>must</b> be configured in ascending order, or bank corruption will occur.
 277                          *        \n\n
 278                          *
 279                          *  \note Certain models of USB AVR's endpoints may have different maximum packet sizes based on the endpoint's
 280                          *        index - refer to the chosen USB AVR's datasheet to determine the maximum bank size for each endpoint.
 281                          *        \n\n
 282                          *
 283                          *  \note The default control endpoint should not be manually configured by the user application, as
 284                          *        it is automatically configured by the library internally.
 285                          *        \n\n
 286                          *
 287                          *  \note This routine will automatically select the specified endpoint upon success. Upon failure, the endpoint
 288                          *        which failed to reconfigure correctly will be selected.
 289                          *
 290                          *  \return Boolean true if the configuration succeeded, false otherwise.
 291                          */
 292                         static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
 293                                                                       const uint8_t Type,
 294                                                                       const uint8_t Direction,
 295                                                                       const uint16_t Size,
 296                                                                       const uint8_t Banks) ATTR_ALWAYS_INLINE;
 297                         static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
 298                                                                       const uint8_t Type,
 299                                                                       const uint8_t Direction,
 300                                                                       const uint16_t Size,
 301                                                                       const uint8_t Banks)
 302                         {
 303                                 return Endpoint_ConfigureEndpoint_Prv(Number, (((Type) << EPTYPE0) | (Direction)),
 304                                                                       ((1 << ALLOC) | Banks | Endpoint_BytesToEPSizeMask(Size)));
 305                         }
 306
 307                         /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
 308                          *
 309                          *  \note The return width of this function may differ, depending on the maximum endpoint bank size
 310                          *        of the selected AVR model.
 311                          *
 312                          *  \ingroup Group_EndpointRW
 313                          *
 314                          *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
 315                          */
 316                         static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 317                         static inline uint16_t Endpoint_BytesInEndpoint(void)
 318                         {
 319                                 #if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
 320                                         return UEBCX;
 321                                 #elif defined(USB_SERIES_4_AVR)
 322                                         return (((uint16_t)UEBCHX << 8) | UEBCLX);
 323                                 #elif defined(USB_SERIES_2_AVR)
 324                                         return UEBCLX;
 325                                 #endif
 326                         }
 327
 328                         /** Get the endpoint address of the currently selected endpoint. This is typically used to save
 329                          *  the currently selected endpoint number so that it can be restored after another endpoint has
 330                          *  been manipulated.
 331                          *
 332                          *  \return Index of the currently selected endpoint.
 333                          */
 334                         static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 335                         static inline uint8_t Endpoint_GetCurrentEndpoint(void)
 336                         {
 337                                 #if !defined(CONTROL_ONLY_DEVICE)
 338                                         return (UENUM & ENDPOINT_EPNUM_MASK);
 339                                 #else
 340                                         return ENDPOINT_CONTROLEP;
 341                                 #endif
 342                         }
 343
 344                         /** Selects the given endpoint number. If the address from the device descriptors is used, the
 345                          *  value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
 346                          *  number (and discarding the endpoint direction bit).
 347                          *
 348                          *  Any endpoint operations which do not require the endpoint number to be indicated will operate on
 349                          *  the currently selected endpoint.
 350                          *
 351                          *  \param[in] EndpointNumber Endpoint number to select.
 352                          */
 353                         static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
 354                         static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber)
 355                         {
 356                                 #if !defined(CONTROL_ONLY_DEVICE)
 357                                         UENUM = EndpointNumber;
 358                                 #endif
 359                         }
 360
 361                         /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
 362                          *  In and Out pointers to the bank's contents.
 363                          *
 364                          *  \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset.
 365                          */
 366                         static inline void Endpoint_ResetFIFO(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
 367                         static inline void Endpoint_ResetFIFO(const uint8_t EndpointNumber)
 368                         {
 369                                 UERST = (1 << EndpointNumber);
 370                                 UERST = 0;
 371                         }
 372
 373                         /** Enables the currently selected endpoint so that data can be sent and received through it to
 374                          *  and from a host.
 375                          *
 376                          *  \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
 377                          */
 378                         static inline void Endpoint_EnableEndpoint(void) ATTR_ALWAYS_INLINE;
 379                         static inline void Endpoint_EnableEndpoint(void)
 380                         {
 381                                 UECONX |= (1 << EPEN);
 382                         }
 383
 384                         /** Disables the currently selected endpoint so that data cannot be sent and received through it
 385                          *  to and from a host.
 386                          */
 387                         static inline void Endpoint_DisableEndpoint(void) ATTR_ALWAYS_INLINE;
 388                         static inline void Endpoint_DisableEndpoint(void)
 389                         {
 390                                 UECONX &= ~(1 << EPEN);
 391                         }
 392
 393                         /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
 394                          *
 395                          * \return Boolean True if the currently selected endpoint is enabled, false otherwise.
 396                          */
 397                         static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 398                         static inline bool Endpoint_IsEnabled(void)
 399                         {
 400                                 return ((UECONX & (1 << EPEN)) ? true : false);
 401                         }
 402
 403                         /** Aborts all pending IN transactions on the currently selected endpoint, once the bank
 404                          *  has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
 405                          *  will terminate all queued transactions, resetting the endpoint banks ready for a new
 406                          *  packet.
 407                          *
 408                          *  \ingroup Group_EndpointPacketManagement
 409                          */
 410                         static inline void Endpoint_AbortPendingIN(void)
 411                         {
 412                                 while (UESTA0X & (0x03 << NBUSYBK0))
 413                                 {
 414                                         UEINTX |= (1 << RXOUTI);
 415                                         while (UEINTX & (1 << RXOUTI));
 416                                 }
 417                         }
 418
 419                         /** Retrieves the number of busy banks in the currently selected endpoint, which have been queued for
 420                          *  transmission via the \ref Endpoint_ClearIN() command, or are awaiting acknowledgement via the
 421                          *  \ref Endpoint_ClearOUT() command.
 422                          *
 423                          *  \ingroup Group_EndpointPacketManagement
 424                          *
 425                          *  \return Total number of busy banks in the selected endpoint.
 426                          */
 427                         static inline uint8_t Endpoint_GetBusyBanks(void)
 428                         {
 429                                 return (UESTA0X & (0x03 << NBUSYBK0));
 430                         }
 431
 432                         /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
 433                          *  bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
 434                          *  direction). This function will return false if an error has occurred in the endpoint, if the endpoint
 435                          *  is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
 436                          *  direction and the endpoint bank is full.
 437                          *
 438                          *  \ingroup Group_EndpointPacketManagement
 439                          *
 440                          *  \return Boolean true if the currently selected endpoint may be read from or written to, depending on its direction.
 441                          */
 442                         static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 443                         static inline bool Endpoint_IsReadWriteAllowed(void)
 444                         {
 445                                 return ((UEINTX & (1 << RWAL)) ? true : false);
 446                         }
 447
 448                         /** Determines if the currently selected endpoint is configured.
 449                          *
 450                          *  \return Boolean true if the currently selected endpoint has been configured, false otherwise.
 451                          */
 452                         static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 453                         static inline bool Endpoint_IsConfigured(void)
 454                         {
 455                                 return ((UESTA0X & (1 << CFGOK)) ? true : false);
 456                         }
 457
 458                         /** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
 459                          *  interrupt duration has elapsed. Which endpoints have interrupted can be determined by
 460                          *  masking the return value against (1 << {Endpoint Number}).
 461                          *
 462                          *  \return Mask whose bits indicate which endpoints have interrupted.
 463                          */
 464                         static inline uint8_t Endpoint_GetEndpointInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 465                         static inline uint8_t Endpoint_GetEndpointInterrupts(void)
 466                         {
 467                                 return UEINT;
 468                         }
 469
 470                         /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
 471                          *  endpoints).
 472                          *
 473                          *  \param[in] EndpointNumber  Index of the endpoint whose interrupt flag should be tested.
 474                          *
 475                          *  \return Boolean true if the specified endpoint has interrupted, false otherwise.
 476                          */
 477                         static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 478                         static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber)
 479                         {
 480                                 return ((UEINT & (1 << EndpointNumber)) ? true : false);
 481                         }
 482
 483                         /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
 484                          *
 485                          *  \ingroup Group_EndpointPacketManagement
 486                          *
 487                          *  \return Boolean true if the current endpoint is ready for an IN packet, false otherwise.
 488                          */
 489                         static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 490                         static inline bool Endpoint_IsINReady(void)
 491                         {
 492                                 return ((UEINTX & (1 << TXINI)) ? true : false);
 493                         }
 494
 495                         /** Determines if the selected OUT endpoint has received new packet from the host.
 496                          *
 497                          *  \ingroup Group_EndpointPacketManagement
 498                          *
 499                          *  \return Boolean true if current endpoint is has received an OUT packet, false otherwise.
 500                          */
 501                         static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 502                         static inline bool Endpoint_IsOUTReceived(void)
 503                         {
 504                                 return ((UEINTX & (1 << RXOUTI)) ? true : false);
 505                         }
 506
 507                         /** Determines if the current CONTROL type endpoint has received a SETUP packet.
 508                          *
 509                          *  \ingroup Group_EndpointPacketManagement
 510                          *
 511                          *  \return Boolean true if the selected endpoint has received a SETUP packet, false otherwise.
 512                          */
 513                         static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 514                         static inline bool Endpoint_IsSETUPReceived(void)
 515                         {
 516                                 return ((UEINTX & (1 << RXSTPI)) ? true : false);
 517                         }
 518
 519                         /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
 520                          *  endpoint for the next packet.
 521                          *
 522                          *  \ingroup Group_EndpointPacketManagement
 523                          *
 524                          *  \note This is not applicable for non CONTROL type endpoints.
 525                          */
 526                         static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;
 527                         static inline void Endpoint_ClearSETUP(void)
 528                         {
 529                                 UEINTX &= ~(1 << RXSTPI);
 530                         }
 531
 532                         /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
 533                          *  next packet and switching to the alternative endpoint bank if double banked.
 534                          *
 535                          *  \ingroup Group_EndpointPacketManagement
 536                          */
 537                         static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
 538                         static inline void Endpoint_ClearIN(void)
 539                         {
 540                                 #if !defined(CONTROL_ONLY_DEVICE)
 541                                         UEINTX &= ~((1 << TXINI) | (1 << FIFOCON));
 542                                 #else
 543                                         UEINTX &= ~(1 << TXINI);
 544                                 #endif
 545                         }
 546
 547                         /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
 548                          *  for the next packet and switching to the alternative endpoint bank if double banked.
 549                          *
 550                          *  \ingroup Group_EndpointPacketManagement
 551                          */
 552                         static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
 553                         static inline void Endpoint_ClearOUT(void)
 554                         {
 555                                 #if !defined(CONTROL_ONLY_DEVICE)
 556                                         UEINTX &= ~((1 << RXOUTI) | (1 << FIFOCON));
 557                                 #else
 558                                         UEINTX &= ~(1 << RXOUTI);
 559                                 #endif
 560                         }
 561
 562                         /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
 563                          *  indicated endpoint and that the current transfer sequence should be aborted. This provides a
 564                          *  way for devices to indicate invalid commands to the host so that the current transfer can be
 565                          *  aborted and the host can begin its own recovery sequence.
 566                          *
 567                          *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
 568                          *  is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
 569                          *  endpoint.
 570                          *
 571                          *  \ingroup Group_EndpointPacketManagement
 572                          */
 573                         static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
 574                         static inline void Endpoint_StallTransaction(void)
 575                         {
 576                                 UECONX |= (1 << STALLRQ);
 577                         }
 578
 579                         /** Clears the STALL condition on the currently selected endpoint.
 580                          *
 581                          *  \ingroup Group_EndpointPacketManagement
 582                          */
 583                         static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
 584                         static inline void Endpoint_ClearStall(void)
 585                         {
 586                                 UECONX |= (1 << STALLRQC);
 587                         }
 588
 589                         /** Determines if the currently selected endpoint is stalled, false otherwise.
 590                          *
 591                          *  \ingroup Group_EndpointPacketManagement
 592                          *
 593                          *  \return Boolean true if the currently selected endpoint is stalled, false otherwise.
 594                          */
 595                         static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 596                         static inline bool Endpoint_IsStalled(void)
 597                         {
 598                                 return ((UECONX & (1 << STALLRQ)) ? true : false);
 599                         }
 600
 601                         /** Resets the data toggle of the currently selected endpoint. */
 602                         static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
 603                         static inline void Endpoint_ResetDataToggle(void)
 604                         {
 605                                 UECONX |= (1 << RSTDT);
 606                         }
 607
 608                         /** Determines the currently selected endpoint's direction.
 609                          *
 610                          *  \return The currently selected endpoint's direction, as a ENDPOINT_DIR_* mask.
 611                          */
 612                         static inline uint8_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 613                         static inline uint8_t Endpoint_GetEndpointDirection(void)
 614                         {
 615                                 return (UECFG0X & ENDPOINT_DIR_IN);
 616                         }
 617
 618                         /** Sets the direction of the currently selected endpoint.
 619                          *
 620                          *  \param[in] DirectionMask  New endpoint direction, as a ENDPOINT_DIR_* mask.
 621                          */
 622                         static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask) ATTR_ALWAYS_INLINE;
 623                         static inline void Endpoint_SetEndpointDirection(const uint8_t DirectionMask)
 624                         {
 625                                 UECFG0X = ((UECFG0X & ~ENDPOINT_DIR_IN) | DirectionMask);
 626                         }
 627
 628                         /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 629                          *
 630                          *  \ingroup Group_EndpointPrimitiveRW
 631                          *
 632                          *  \return Next byte in the currently selected endpoint's FIFO buffer.
 633                          */
 634                         static inline uint8_t Endpoint_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 635                         static inline uint8_t Endpoint_Read_Byte(void)
 636                         {
 637                                 return UEDATX;
 638                         }
 639
 640                         /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
 641                          *
 642                          *  \ingroup Group_EndpointPrimitiveRW
 643                          *
 644                          *  \param[in] Byte  Next byte to write into the the currently selected endpoint's FIFO buffer.
 645                          */
 646                         static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 647                         static inline void Endpoint_Write_Byte(const uint8_t Byte)
 648                         {
 649                                 UEDATX = Byte;
 650                         }
 651
 652                         /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
 653                          *
 654                          *  \ingroup Group_EndpointPrimitiveRW
 655                          */
 656                         static inline void Endpoint_Discard_Byte(void) ATTR_ALWAYS_INLINE;
 657                         static inline void Endpoint_Discard_Byte(void)
 658                         {
 659                                 uint8_t Dummy;
 660
 661                                 Dummy = UEDATX;
 662                         }
 663
 664                         /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
 665                          *  direction endpoints.
 666                          *
 667                          *  \ingroup Group_EndpointPrimitiveRW
 668                          *
 669                          *  \return Next word in the currently selected endpoint's FIFO buffer.
 670                          */
 671                         static inline uint16_t Endpoint_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 672                         static inline uint16_t Endpoint_Read_Word_LE(void)
 673                         {
 674                                 union
 675                                 {
 676                                         uint16_t Word;
 677                                         uint8_t  Bytes[2];
 678                                 } Data;
 679
 680                                 Data.Bytes[0] = UEDATX;
 681                                 Data.Bytes[1] = UEDATX;
 682
 683                                 return Data.Word;
 684                         }
 685
 686                         /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
 687                          *  direction endpoints.
 688                          *
 689                          *  \ingroup Group_EndpointPrimitiveRW
 690                          *
 691                          *  \return Next word in the currently selected endpoint's FIFO buffer.
 692                          */
 693                         static inline uint16_t Endpoint_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 694                         static inline uint16_t Endpoint_Read_Word_BE(void)
 695                         {
 696                                 union
 697                                 {
 698                                         uint16_t Word;
 699                                         uint8_t  Bytes[2];
 700                                 } Data;
 701
 702                                 Data.Bytes[1] = UEDATX;
 703                                 Data.Bytes[0] = UEDATX;
 704
 705                                 return Data.Word;
 706                         }
 707
 708                         /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
 709                          *  direction endpoints.
 710                          *
 711                          *  \ingroup Group_EndpointPrimitiveRW
 712                          *
 713                          *  \param[in] Word  Next word to write to the currently selected endpoint's FIFO buffer.
 714                          */
 715                         static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
 716                         static inline void Endpoint_Write_Word_LE(const uint16_t Word)
 717                         {
 718                                 UEDATX = (Word & 0xFF);
 719                                 UEDATX = (Word >> 8);
 720                         }
 721
 722                         /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
 723                          *  direction endpoints.
 724                          *
 725                          *  \ingroup Group_EndpointPrimitiveRW
 726                          *
 727                          *  \param[in] Word  Next word to write to the currently selected endpoint's FIFO buffer.
 728                          */
 729                         static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
 730                         static inline void Endpoint_Write_Word_BE(const uint16_t Word)
 731                         {
 732                                 UEDATX = (Word >> 8);
 733                                 UEDATX = (Word & 0xFF);
 734                         }
 735
 736                         /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 737                          *
 738                          *  \ingroup Group_EndpointPrimitiveRW
 739                          */
 740                         static inline void Endpoint_Discard_Word(void) ATTR_ALWAYS_INLINE;
 741                         static inline void Endpoint_Discard_Word(void)
 742                         {
 743                                 uint8_t Dummy;
 744
 745                                 Dummy = UEDATX;
 746                                 Dummy = UEDATX;
 747                         }
 748
 749                         /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
 750                          *  direction endpoints.
 751                          *
 752                          *  \ingroup Group_EndpointPrimitiveRW
 753                          *
 754                          *  \return Next double word in the currently selected endpoint's FIFO buffer.
 755                          */
 756                         static inline uint32_t Endpoint_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 757                         static inline uint32_t Endpoint_Read_DWord_LE(void)
 758                         {
 759                                 union
 760                                 {
 761                                         uint32_t DWord;
 762                                         uint8_t  Bytes[4];
 763                                 } Data;
 764
 765                                 Data.Bytes[0] = UEDATX;
 766                                 Data.Bytes[1] = UEDATX;
 767                                 Data.Bytes[2] = UEDATX;
 768                                 Data.Bytes[3] = UEDATX;
 769
 770                                 return Data.DWord;
 771                         }
 772
 773                         /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
 774                          *  direction endpoints.
 775                          *
 776                          *  \ingroup Group_EndpointPrimitiveRW
 777                          *
 778                          *  \return Next double word in the currently selected endpoint's FIFO buffer.
 779                          */
 780                         static inline uint32_t Endpoint_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 781                         static inline uint32_t Endpoint_Read_DWord_BE(void)
 782                         {
 783                                 union
 784                                 {
 785                                         uint32_t DWord;
 786                                         uint8_t  Bytes[4];
 787                                 } Data;
 788
 789                                 Data.Bytes[3] = UEDATX;
 790                                 Data.Bytes[2] = UEDATX;
 791                                 Data.Bytes[1] = UEDATX;
 792                                 Data.Bytes[0] = UEDATX;
 793
 794                                 return Data.DWord;
 795                         }
 796
 797                         /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
 798                          *  direction endpoints.
 799                          *
 800                          *  \ingroup Group_EndpointPrimitiveRW
 801                          *
 802                          *  \param[in] DWord  Next double word to write to the currently selected endpoint's FIFO buffer.
 803                          */
 804                         static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
 805                         static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
 806                         {
 807                                 UEDATX = (DWord &  0xFF);
 808                                 UEDATX = (DWord >> 8);
 809                                 UEDATX = (DWord >> 16);
 810                                 UEDATX = (DWord >> 24);
 811                         }
 812
 813                         /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
 814                          *  direction endpoints.
 815                          *
 816                          *  \ingroup Group_EndpointPrimitiveRW
 817                          *
 818                          *  \param[in] DWord  Next double word to write to the currently selected endpoint's FIFO buffer.
 819                          */
 820                         static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
 821                         static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
 822                         {
 823                                 UEDATX = (DWord >> 24);
 824                                 UEDATX = (DWord >> 16);
 825                                 UEDATX = (DWord >> 8);
 826                                 UEDATX = (DWord &  0xFF);
 827                         }
 828
 829                         /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
 830                          *
 831                          *  \ingroup Group_EndpointPrimitiveRW
 832                          */
 833                         static inline void Endpoint_Discard_DWord(void) ATTR_ALWAYS_INLINE;
 834                         static inline void Endpoint_Discard_DWord(void)
 835                         {
 836                                 uint8_t Dummy;
 837
 838                                 Dummy = UEDATX;
 839                                 Dummy = UEDATX;
 840                                 Dummy = UEDATX;
 841                                 Dummy = UEDATX;
 842                         }
 843
 844                 /* External Variables: */
 845                         /** Global indicating the maximum packet size of the default control endpoint located at address
 846                          *  0 in the device. This value is set to the value indicated in the device descriptor in the user
 847                          *  project once the USB interface is initialized into device mode.
 848                          *
 849                          *  If space is an issue, it is possible to fix this to a static value by defining the control
 850                          *  endpoint size in the FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
 851                          *  via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
 852                          *  read from the descriptors at runtime and instead fixed to the given value. When used, it is
 853                          *  important that the descriptor control endpoint size value matches the size given as the
 854                          *  FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the FIXED_CONTROL_ENDPOINT_SIZE token
 855                          *  be used in the descriptors to ensure this.
 856                          *
 857                          *  \note This variable should be treated as read-only in the user application, and never manually
 858                          *        changed in value.
 859                          */
 860                         #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
 861                                 extern uint8_t USB_ControlEndpointSize;
 862                         #else
 863                                 #define USB_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
 864                         #endif
 865
 866                 /* Function Prototypes: */
 867                         /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
 868                          *  with respect to the data direction. This is a convenience function which can be used to
 869                          *  simplify user control request handling.
 870                          */
 871                         void Endpoint_ClearStatusStage(void);
 872
 873                         /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
 874                          *  to be read or written to it.
 875                          *
 876                          *  \note This routine should not be called on CONTROL type endpoints.
 877                          *
 878                          *  \ingroup Group_EndpointRW
 879                          *
 880                          *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
 881                          */
 882                         uint8_t Endpoint_WaitUntilReady(void);
 883
 884         /* Disable C linkage for C++ Compilers: */
 885                 #if defined(__cplusplus)
 886                         }
 887                 #endif
 888
 889 #endif
 890
 891 /** @} */
 892