LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h

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