LUFA/Drivers/USB/LowLevel/Pipe.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 host pipe management definitions.
  33  *
  34  *  This file contains structures, function prototypes and macros related to the management of the device's
  35  *  data pipes when the library is initialized in USB host 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_PipeManagement
  42  *  @defgroup Group_PipeRW Pipe Data Reading and Writing
  43  *
  44  *  Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
  45  */
  46
  47 /** \ingroup Group_PipeRW
  48  *  @defgroup Group_PipePrimitiveRW 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 pipes.
  52  */
  53
  54 /** \ingroup Group_PipeManagement
  55  *  @defgroup Group_PipePacketManagement Pipe Packet Management
  56  *
  57  *  Functions, macros, variables, enums and types related to packet management of pipes.
  58  */
  59
  60 /** \ingroup Group_PipeManagement
  61  *  @defgroup Group_PipeControlReq Pipe Control Request Management
  62  *
  63  *  Module for host mode request processing. This module allows for the transmission of standard, class and
  64  *  vendor control requests to the default control endpoint of an attached device while in host mode.
  65  *
  66  *  \see Chapter 9 of the USB 2.0 specification.
  67  */
  68
  69 /** \ingroup Group_USB
  70  *  @defgroup Group_PipeManagement Pipe Management
  71  *
  72  *  This module contains functions, macros and enums related to pipe management when in USB Host mode. This
  73  *  module contains the pipe management macros, as well as pipe interrupt and data send/receive functions
  74  *  for various data types.
  75  *
  76  *  @{
  77  */
  78
  79 #ifndef __PIPE_H__
  80 #define __PIPE_H__
  81
  82         /* Includes: */
  83                 #include <avr/io.h>
  84                 #include <stdbool.h>
  85
  86                 #include "../../../Common/Common.h"
  87                 #include "../HighLevel/USBTask.h"
  88
  89         /* Enable C linkage for C++ Compilers: */
  90                 #if defined(__cplusplus)
  91                         extern "C" {
  92                 #endif
  93
  94         /* Preprocessor Checks: */
  95                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  96                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  97                 #endif
  98
  99         /* Public Interface - May be used in end-application: */
 100                 /* Macros: */
 101                         /** \name Pipe Error Flag Masks */
 102                         //@{
 103                         /** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */
 104                         #define PIPE_ERRORFLAG_OVERFLOW         (1 << 6)
 105
 106                         /** Mask for \ref Pipe_GetErrorFlags(), indicating that an underflow error occurred in the pipe on the received data. */
 107                         #define PIPE_ERRORFLAG_UNDERFLOW        (1 << 5)
 108
 109                         /** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */
 110                         #define PIPE_ERRORFLAG_CRC16            (1 << 4)
 111
 112                         /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */
 113                         #define PIPE_ERRORFLAG_TIMEOUT          (1 << 3)
 114
 115                         /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */
 116                         #define PIPE_ERRORFLAG_PID              (1 << 2)
 117
 118                         /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */
 119                         #define PIPE_ERRORFLAG_DATAPID          (1 << 1)
 120
 121                         /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */
 122                         #define PIPE_ERRORFLAG_DATATGL          (1 << 0)
 123                         //@}
 124
 125                         /** \name Pipe Token Masks */
 126                         //@{
 127                         /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes),
 128                          *  which will trigger a control request on the attached device when data is written to the pipe.
 129                          */
 130                         #define PIPE_TOKEN_SETUP                (0 << PTOKEN0)
 131
 132                         /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),
 133                          *  indicating that the pipe data will flow from device to host.
 134                          */
 135                         #define PIPE_TOKEN_IN                   (1 << PTOKEN0)
 136
 137                         /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a OUT token (for non-CONTROL type pipes),
 138                          *  indicating that the pipe data will flow from host to device.
 139                          */
 140                         #define PIPE_TOKEN_OUT                  (2 << PTOKEN0)
 141                         //@}
 142
 143                         /** \name Pipe Bank Mode Masks */
 144                         //@{
 145                         /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe
 146                          *  should have one single bank, which requires less USB FIFO memory but results in slower transfers as
 147                          *  only one USB device (the AVR or the attached device) can access the pipe's bank at the one time.
 148                          */
 149                         #define PIPE_BANK_SINGLE                (0 << EPBK0)
 150
 151                         /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe
 152                          *  should have two banks, which requires more USB FIFO memory but results in faster transfers as one
 153                          *  USB device (the AVR or the attached device) can access one bank while the other accesses the second
 154                          *  bank.
 155                          */
 156                         #define PIPE_BANK_DOUBLE                (1 << EPBK0)
 157                         //@}
 158
 159                         /** Pipe address for the default control pipe, which always resides in address 0. This is
 160                          *  defined for convenience to give more readable code when used with the pipe macros.
 161                          */
 162                         #define PIPE_CONTROLPIPE                0
 163
 164                         /** Default size of the default control pipe's bank, until altered by the Endpoint0Size value
 165                          *  in the device descriptor of the attached device.
 166                          */
 167                         #define PIPE_CONTROLPIPE_DEFAULT_SIZE   64
 168
 169                         /** Pipe number mask, for masking against pipe addresses to retrieve the pipe's numerical address
 170                          *  in the device.
 171                          */
 172                         #define PIPE_PIPENUM_MASK               0x07
 173
 174                         /** Total number of pipes (including the default control pipe at address 0) which may be used in
 175                          *  the device. Different USB AVR models support different amounts of pipes, this value reflects
 176                          *  the maximum number of pipes for the currently selected AVR model.
 177                          */
 178                         #define PIPE_TOTAL_PIPES                7
 179
 180                         /** Size in bytes of the largest pipe bank size possible in the device. Not all banks on each AVR
 181                          *  model supports the largest bank size possible on the device; different pipe numbers support
 182                          *  different maximum bank sizes. This value reflects the largest possible bank of any pipe on the
 183                          *  currently selected USB AVR model.
 184                          */
 185                         #define PIPE_MAX_SIZE                   256
 186
 187                         /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
 188                          *  numerical address in the attached device.
 189                          */
 190                         #define PIPE_EPNUM_MASK                 0x0F
 191
 192                         /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's
 193                          *  direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks.
 194                          */
 195                         #define PIPE_EPDIR_MASK                 0x80
 196
 197                 /* Enums: */
 198                         /** Enum for the possible error return codes of the Pipe_WaitUntilReady function.
 199                          *
 200                          *  \ingroup Group_PipeRW
 201                          */
 202                         enum Pipe_WaitUntilReady_ErrorCodes_t
 203                         {
 204                                 PIPE_READYWAIT_NoError                 = 0, /**< Pipe ready for next packet, no error. */
 205                                 PIPE_READYWAIT_PipeStalled             = 1,     /**< The device stalled the pipe while waiting. */
 206                                 PIPE_READYWAIT_DeviceDisconnected      = 2,     /**< Device was disconnected from the host while waiting. */
 207                                 PIPE_READYWAIT_Timeout                 = 3, /**< The device failed to accept or send the next packet
 208                                                                              *   within the software timeout period set by the
 209                                                                              *   \ref USB_STREAM_TIMEOUT_MS macro.
 210                                                                              */
 211                         };
 212
 213                 /* Inline Functions: */
 214                         /** Indicates the number of bytes currently stored in the current pipes's selected bank.
 215                          *
 216                          *  \note The return width of this function may differ, depending on the maximum pipe bank size
 217                          *        of the selected AVR model.
 218                          *
 219                          *  \ingroup Group_PipeRW
 220                          *
 221                          *  \return Total number of bytes in the currently selected Pipe's FIFO buffer.
 222                          */
 223                         static inline uint16_t Pipe_BytesInPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 224                         static inline uint16_t Pipe_BytesInPipe(void)
 225                         {
 226                                 return UPBCX;
 227                         }
 228
 229                         /** Returns the pipe address of the currently selected pipe. This is typically used to save the
 230                          *  currently selected pipe number so that it can be restored after another pipe has been manipulated.
 231                          *
 232                          *  \return Index of the currently selected pipe.
 233                          */
 234                         static inline uint8_t Pipe_GetCurrentPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 235                         static inline uint8_t Pipe_GetCurrentPipe(void)
 236                         {
 237                                 return (UPNUM & PIPE_PIPENUM_MASK);
 238                         }
 239
 240                         /** Selects the given pipe number. Any pipe operations which do not require the pipe number to be
 241                          *  indicated will operate on the currently selected pipe.
 242                          *
 243                          *  \param[in] PipeNumber  Index of the pipe to select.
 244                          */
 245                         static inline void Pipe_SelectPipe(const uint8_t PipeNumber) ATTR_ALWAYS_INLINE;
 246                         static inline void Pipe_SelectPipe(const uint8_t PipeNumber)
 247                         {
 248                                 UPNUM = PipeNumber;
 249                         }
 250
 251                         /** Resets the desired pipe, including the pipe banks and flags.
 252                          *
 253                          *  \param[in] PipeNumber  Index of the pipe to reset.
 254                          */
 255                         static inline void Pipe_ResetPipe(const uint8_t PipeNumber) ATTR_ALWAYS_INLINE;
 256                         static inline void Pipe_ResetPipe(const uint8_t PipeNumber)
 257                         {
 258                                 UPRST = (1 << PipeNumber);
 259                                 UPRST = 0;
 260                         }
 261
 262                         /** Enables the currently selected pipe so that data can be sent and received through it to and from
 263                          *  an attached device.
 264                          *
 265                          *  \pre The currently selected pipe must first be configured properly via \ref Pipe_ConfigurePipe().
 266                          */
 267                         static inline void Pipe_EnablePipe(void) ATTR_ALWAYS_INLINE;
 268                         static inline void Pipe_EnablePipe(void)
 269                         {
 270                                 UPCONX |= (1 << PEN);
 271                         }
 272
 273                         /** Disables the currently selected pipe so that data cannot be sent and received through it to and
 274                          *  from an attached device.
 275                          */
 276                         static inline void Pipe_DisablePipe(void) ATTR_ALWAYS_INLINE;
 277                         static inline void Pipe_DisablePipe(void)
 278                         {
 279                                 UPCONX &= ~(1 << PEN);
 280                         }
 281
 282                         /** Determines if the currently selected pipe is enabled, but not necessarily configured.
 283                          *
 284                          * \return Boolean True if the currently selected pipe is enabled, false otherwise.
 285                          */
 286                         static inline bool Pipe_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 287                         static inline bool Pipe_IsEnabled(void)
 288                         {
 289                                 return ((UPCONX & (1 << PEN)) ? true : false);
 290                         }
 291
 292                         /** Gets the current pipe token, indicating the pipe's data direction and type.
 293                          *
 294                          *  \return The current pipe token, as a PIPE_TOKEN_* mask.
 295                          */
 296                         static inline uint8_t Pipe_GetPipeToken(void) ATTR_ALWAYS_INLINE;
 297                         static inline uint8_t Pipe_GetPipeToken(void)
 298                         {
 299                                 return (UPCFG0X & (0x03 << PTOKEN0));
 300                         }
 301
 302                         /** Sets the token for the currently selected pipe to one of the tokens specified by the PIPE_TOKEN_*
 303                          *  masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during
 304                          *  control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices
 305                          *  which have two endpoints of opposite direction sharing the same endpoint address within the device.
 306                          *
 307                          *  \param[in] Token  New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask.
 308                          */
 309                         static inline void Pipe_SetPipeToken(const uint8_t Token) ATTR_ALWAYS_INLINE;
 310                         static inline void Pipe_SetPipeToken(const uint8_t Token)
 311                         {
 312                                 UPCFG0X = ((UPCFG0X & ~(0x03 << PTOKEN0)) | Token);
 313                         }
 314
 315                         /** Configures the currently selected pipe to allow for an unlimited number of IN requests. */
 316                         static inline void Pipe_SetInfiniteINRequests(void) ATTR_ALWAYS_INLINE;
 317                         static inline void Pipe_SetInfiniteINRequests(void)
 318                         {
 319                                 UPCONX |= (1 << INMODE);
 320                         }
 321
 322                         /** Configures the currently selected pipe to only allow the specified number of IN requests to be
 323                          *  accepted by the pipe before it is automatically frozen.
 324                          *
 325                          *  \param[in] TotalINRequests  Total number of IN requests that the pipe may receive before freezing.
 326                          */
 327                         static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests) ATTR_ALWAYS_INLINE;
 328                         static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests)
 329                         {
 330                                 UPCONX &= ~(1 << INMODE);
 331                                 UPINRQX = TotalINRequests;
 332                         }
 333
 334                         /** Determines if the currently selected pipe is configured.
 335                          *
 336                          *  \return Boolean true if the selected pipe is configured, false otherwise.
 337                          */
 338                         static inline bool Pipe_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 339                         static inline bool Pipe_IsConfigured(void)
 340                         {
 341                                 return ((UPSTAX & (1 << CFGOK)) ? true : false);
 342                         }
 343
 344                         /** Retrieves the endpoint number of the endpoint within the attached device that the currently selected
 345                          *  pipe is bound to.
 346                          *
 347                          *  \return Endpoint number the currently selected pipe is bound to.
 348                          */
 349                         static inline uint8_t Pipe_BoundEndpointNumber(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 350                         static inline uint8_t Pipe_BoundEndpointNumber(void)
 351                         {
 352                                 return ((UPCFG0X >> PEPNUM0) & PIPE_EPNUM_MASK);
 353                         }
 354
 355                         /** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.
 356                          *
 357                          *  \param[in] Milliseconds  Number of milliseconds between each pipe poll.
 358                          */
 359                         static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds) ATTR_ALWAYS_INLINE;
 360                         static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds)
 361                         {
 362                                 UPCFG2X = Milliseconds;
 363                         }
 364
 365                         /** Returns a mask indicating which pipe's interrupt periods have elapsed, indicating that the pipe should
 366                          *  be serviced.
 367                          *
 368                          *  \return Mask whose bits indicate which pipes have interrupted.
 369                          */
 370                         static inline uint8_t Pipe_GetPipeInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 371                         static inline uint8_t Pipe_GetPipeInterrupts(void)
 372                         {
 373                                 return UPINT;
 374                         }
 375
 376                         /** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type
 377                          *  pipes).
 378                          *
 379                          *  \param[in] PipeNumber  Index of the pipe whose interrupt flag should be tested.
 380                          *
 381                          *  \return Boolean true if the specified pipe has interrupted, false otherwise.
 382                          */
 383                         static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 384                         static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber)
 385                         {
 386                                 return ((UPINT & (1 << PipeNumber)) ? true : false);
 387                         }
 388
 389                         /** Unfreezes the selected pipe, allowing it to communicate with an attached device. */
 390                         static inline void Pipe_Unfreeze(void) ATTR_ALWAYS_INLINE;
 391                         static inline void Pipe_Unfreeze(void)
 392                         {
 393                                 UPCONX &= ~(1 << PFREEZE);
 394                         }
 395
 396                         /** Freezes the selected pipe, preventing it from communicating with an attached device. */
 397                         static inline void Pipe_Freeze(void) ATTR_ALWAYS_INLINE;
 398                         static inline void Pipe_Freeze(void)
 399                         {
 400                                 UPCONX |= (1 << PFREEZE);
 401                         }
 402
 403                         /** Determines if the currently selected pipe is frozen, and not able to accept data.
 404                          *
 405                          *  \return Boolean true if the currently selected pipe is frozen, false otherwise.
 406                          */
 407                         static inline bool Pipe_IsFrozen(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 408                         static inline bool Pipe_IsFrozen(void)
 409                         {
 410                                 return ((UPCONX & (1 << PFREEZE)) ? true : false);
 411                         }
 412
 413                         /** Clears the master pipe error flag. */
 414                         static inline void Pipe_ClearError(void) ATTR_ALWAYS_INLINE;
 415                         static inline void Pipe_ClearError(void)
 416                         {
 417                                 UPINTX &= ~(1 << PERRI);
 418                         }
 419
 420                         /** Determines if the master pipe error flag is set for the currently selected pipe, indicating that
 421                          *  some sort of hardware error has occurred on the pipe.
 422                          *
 423                          *  \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.
 424                          *
 425                          *  \return Boolean true if an error has occurred on the selected pipe, false otherwise.
 426                          */
 427                         static inline bool Pipe_IsError(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 428                         static inline bool Pipe_IsError(void)
 429                         {
 430                                 return ((UPINTX & (1 << PERRI)) ? true : false);
 431                         }
 432
 433                         /** Clears all the currently selected pipe's hardware error flags, but does not clear the master error
 434                          *  flag for the pipe.
 435                          */
 436                         static inline void Pipe_ClearErrorFlags(void) ATTR_ALWAYS_INLINE;
 437                         static inline void Pipe_ClearErrorFlags(void)
 438                         {
 439                                 UPERRX = 0;
 440                         }
 441
 442                         /** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This
 443                          *  value can then be masked against the PIPE_ERRORFLAG_* masks to determine what error has occurred.
 444                          *
 445                          *  \return  Mask comprising of PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe.
 446                          */
 447                         static inline uint8_t Pipe_GetErrorFlags(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 448                         static inline uint8_t Pipe_GetErrorFlags(void)
 449                         {
 450                                 return ((UPERRX & (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT |
 451                                                    PIPE_ERRORFLAG_PID   | PIPE_ERRORFLAG_DATAPID |
 452                                                    PIPE_ERRORFLAG_DATATGL)) |
 453                                         (UPSTAX & (PIPE_ERRORFLAG_OVERFLOW | PIPE_ERRORFLAG_UNDERFLOW)));
 454                         }
 455
 456                         /** Determines if the currently selected pipe may be read from (if data is waiting in the pipe
 457                          *  bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT
 458                          *  direction). This function will return false if an error has occurred in the pipe, or if the pipe
 459                          *  is an IN direction and no packet (or an empty packet) has been received, or if the pipe is an OUT
 460                          *  direction and the pipe bank is full.
 461                          *
 462                          *  \note This function is not valid on CONTROL type pipes.
 463                          *
 464                          *  \ingroup Group_PipePacketManagement
 465                          *
 466                          *  \return Boolean true if the currently selected pipe may be read from or written to, depending on its direction.
 467                          */
 468                         static inline bool Pipe_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 469                         static inline bool Pipe_IsReadWriteAllowed(void)
 470                         {
 471                                 return ((UPINTX & (1 << RWAL)) ? true : false);
 472                         }
 473
 474                         /** Determines if a packet has been received on the currently selected IN pipe from the attached device.
 475                          *
 476                          *  \ingroup Group_PipePacketManagement
 477                          *
 478                          *  \return Boolean true if the current pipe has received an IN packet, false otherwise.
 479                          */
 480                         static inline bool Pipe_IsINReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 481                         static inline bool Pipe_IsINReceived(void)
 482                         {
 483                                 return ((UPINTX & (1 << RXINI)) ? true : false);
 484                         }
 485
 486                         /** Determines if the currently selected OUT pipe is ready to send an OUT packet to the attached device.
 487                          *
 488                          *  \ingroup Group_PipePacketManagement
 489                          *
 490                          *  \return Boolean true if the current pipe is ready for an OUT packet, false otherwise.
 491                          */
 492                         static inline bool Pipe_IsOUTReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 493                         static inline bool Pipe_IsOUTReady(void)
 494                         {
 495                                 return ((UPINTX & (1 << TXOUTI)) ? true : false);
 496                         }
 497
 498                         /** Determines if no SETUP request is currently being sent to the attached device on the selected
 499                          *  CONTROL type pipe.
 500                          *
 501                          *  \ingroup Group_PipePacketManagement
 502                          *
 503                          *  \return Boolean true if the current pipe is ready for a SETUP packet, false otherwise.
 504                          */
 505                         static inline bool Pipe_IsSETUPSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 506                         static inline bool Pipe_IsSETUPSent(void)
 507                         {
 508                                 return ((UPINTX & (1 << TXSTPI)) ? true : false);
 509                         }
 510
 511                         /** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.
 512                          *
 513                          *  \ingroup Group_PipePacketManagement
 514                          */
 515                         static inline void Pipe_ClearSETUP(void) ATTR_ALWAYS_INLINE;
 516                         static inline void Pipe_ClearSETUP(void)
 517                         {
 518                                 UPINTX &= ~((1 << TXSTPI) | (1 << FIFOCON));
 519                         }
 520
 521                         /** Acknowledges the reception of a setup IN request from the attached device on the currently selected
 522                          *  pipe, freeing the bank ready for the next packet.
 523                          *
 524                          *  \ingroup Group_PipePacketManagement
 525                          */
 526                         static inline void Pipe_ClearIN(void) ATTR_ALWAYS_INLINE;
 527                         static inline void Pipe_ClearIN(void)
 528                         {
 529                                 UPINTX &= ~((1 << RXINI) | (1 << FIFOCON));
 530                         }
 531
 532                         /** Sends the currently selected pipe's contents to the device as an OUT packet on the selected pipe, freeing
 533                          *  the bank ready for the next packet.
 534                          *
 535                          *  \ingroup Group_PipePacketManagement
 536                          */
 537                         static inline void Pipe_ClearOUT(void) ATTR_ALWAYS_INLINE;
 538                         static inline void Pipe_ClearOUT(void)
 539                         {
 540                                 UPINTX &= ~((1 << TXOUTI) | (1 << FIFOCON));
 541                         }
 542
 543                         /** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on
 544                          *  the currently selected pipe. This occurs when the host sends a packet to the device, but the device
 545                          *  is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been
 546                          *  received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet
 547                          *  can be re-sent.
 548                          *
 549                          *  \ingroup Group_PipePacketManagement
 550                          *
 551                          *  \return Boolean true if an NAK has been received on the current pipe, false otherwise.
 552                          */
 553                         static inline bool Pipe_IsNAKReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 554                         static inline bool Pipe_IsNAKReceived(void)
 555                         {
 556                                 return ((UPINTX & (1 << NAKEDI)) ? true : false);
 557                         }
 558
 559                         /** Clears the NAK condition on the currently selected pipe.
 560                          *
 561                          *  \ingroup Group_PipePacketManagement
 562                          *
 563                          *  \see \ref Pipe_IsNAKReceived() for more details.
 564                          */
 565                         static inline void Pipe_ClearNAKReceived(void) ATTR_ALWAYS_INLINE;
 566                         static inline void Pipe_ClearNAKReceived(void)
 567                         {
 568                                 UPINTX &= ~(1 << NAKEDI);
 569                         }
 570
 571                         /** Determines if the currently selected pipe has had the STALL condition set by the attached device.
 572                          *
 573                          *  \ingroup Group_PipePacketManagement
 574                          *
 575                          *  \return Boolean true if the current pipe has been stalled by the attached device, false otherwise.
 576                          */
 577                         static inline bool Pipe_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 578                         static inline bool Pipe_IsStalled(void)
 579                         {
 580                                 return ((UPINTX & (1 << RXSTALLI)) ? true : false);
 581                         }
 582
 583                         /** Clears the STALL condition detection flag on the currently selected pipe, but does not clear the
 584                          *  STALL condition itself (this must be done via a ClearFeature control request to the device).
 585                          *
 586                          *  \ingroup Group_PipePacketManagement
 587                          */
 588                         static inline void Pipe_ClearStall(void) ATTR_ALWAYS_INLINE;
 589                         static inline void Pipe_ClearStall(void)
 590                         {
 591                                 UPINTX &= ~(1 << RXSTALLI);
 592                         }
 593
 594                         /** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.
 595                          *
 596                          *  \ingroup Group_PipePrimitiveRW
 597                          *
 598                          *  \return Next byte in the currently selected pipe's FIFO buffer.
 599                          */
 600                         static inline uint8_t Pipe_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 601                         static inline uint8_t Pipe_Read_Byte(void)
 602                         {
 603                                 return UPDATX;
 604                         }
 605
 606                         /** Writes one byte from the currently selected pipe's bank, for IN direction pipes.
 607                          *
 608                          *  \ingroup Group_PipePrimitiveRW
 609                          *
 610                          *  \param[in] Byte  Next byte to write into the the currently selected pipe's FIFO buffer.
 611                          */
 612                         static inline void Pipe_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 613                         static inline void Pipe_Write_Byte(const uint8_t Byte)
 614                         {
 615                                 UPDATX = Byte;
 616                         }
 617
 618                         /** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.
 619                          *
 620                          *  \ingroup Group_PipePrimitiveRW
 621                          */
 622                         static inline void Pipe_Discard_Byte(void) ATTR_ALWAYS_INLINE;
 623                         static inline void Pipe_Discard_Byte(void)
 624                         {
 625                                 uint8_t Dummy;
 626
 627                                 Dummy = UPDATX;
 628                         }
 629
 630                         /** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT
 631                          *  direction pipes.
 632                          *
 633                          *  \ingroup Group_PipePrimitiveRW
 634                          *
 635                          *  \return Next word in the currently selected pipe's FIFO buffer.
 636                          */
 637                         static inline uint16_t Pipe_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 638                         static inline uint16_t Pipe_Read_Word_LE(void)
 639                         {
 640                                 union
 641                                 {
 642                                         uint16_t Word;
 643                                         uint8_t  Bytes[2];
 644                                 } Data;
 645
 646                                 Data.Bytes[0] = UPDATX;
 647                                 Data.Bytes[1] = UPDATX;
 648
 649                                 return Data.Word;
 650                         }
 651
 652                         /** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT
 653                          *  direction pipes.
 654                          *
 655                          *  \ingroup Group_PipePrimitiveRW
 656                          *
 657                          *  \return Next word in the currently selected pipe's FIFO buffer.
 658                          */
 659                         static inline uint16_t Pipe_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 660                         static inline uint16_t Pipe_Read_Word_BE(void)
 661                         {
 662                                 union
 663                                 {
 664                                         uint16_t Word;
 665                                         uint8_t  Bytes[2];
 666                                 } Data;
 667
 668                                 Data.Bytes[1] = UPDATX;
 669                                 Data.Bytes[0] = UPDATX;
 670
 671                                 return Data.Word;
 672                         }
 673
 674                         /** Writes two bytes to the currently selected pipe's bank in little endian format, for IN
 675                          *  direction pipes.
 676                          *
 677                          *  \ingroup Group_PipePrimitiveRW
 678                          *
 679                          *  \param[in] Word  Next word to write to the currently selected pipe's FIFO buffer.
 680                          */
 681                         static inline void Pipe_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
 682                         static inline void Pipe_Write_Word_LE(const uint16_t Word)
 683                         {
 684                                 UPDATX = (Word & 0xFF);
 685                                 UPDATX = (Word >> 8);
 686                         }
 687
 688                         /** Writes two bytes to the currently selected pipe's bank in big endian format, for IN
 689                          *  direction pipes.
 690                          *
 691                          *  \ingroup Group_PipePrimitiveRW
 692                          *
 693                          *  \param[in] Word  Next word to write to the currently selected pipe's FIFO buffer.
 694                          */
 695                         static inline void Pipe_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
 696                         static inline void Pipe_Write_Word_BE(const uint16_t Word)
 697                         {
 698                                 UPDATX = (Word >> 8);
 699                                 UPDATX = (Word & 0xFF);
 700                         }
 701
 702                         /** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.
 703                          *
 704                          *  \ingroup Group_PipePrimitiveRW
 705                          */
 706                         static inline void Pipe_Discard_Word(void) ATTR_ALWAYS_INLINE;
 707                         static inline void Pipe_Discard_Word(void)
 708                         {
 709                                 uint8_t Dummy;
 710
 711                                 Dummy = UPDATX;
 712                                 Dummy = UPDATX;
 713                         }
 714
 715                         /** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT
 716                          *  direction pipes.
 717                          *
 718                          *  \ingroup Group_PipePrimitiveRW
 719                          *
 720                          *  \return Next double word in the currently selected pipe's FIFO buffer.
 721                          */
 722                         static inline uint32_t Pipe_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 723                         static inline uint32_t Pipe_Read_DWord_LE(void)
 724                         {
 725                                 union
 726                                 {
 727                                         uint32_t DWord;
 728                                         uint8_t  Bytes[4];
 729                                 } Data;
 730
 731                                 Data.Bytes[0] = UPDATX;
 732                                 Data.Bytes[1] = UPDATX;
 733                                 Data.Bytes[2] = UPDATX;
 734                                 Data.Bytes[3] = UPDATX;
 735
 736                                 return Data.DWord;
 737                         }
 738
 739                         /** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT
 740                          *  direction pipes.
 741                          *
 742                          *  \ingroup Group_PipePrimitiveRW
 743                          *
 744                          *  \return Next double word in the currently selected pipe's FIFO buffer.
 745                          */
 746                         static inline uint32_t Pipe_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 747                         static inline uint32_t Pipe_Read_DWord_BE(void)
 748                         {
 749                                 union
 750                                 {
 751                                         uint32_t DWord;
 752                                         uint8_t  Bytes[4];
 753                                 } Data;
 754
 755                                 Data.Bytes[3] = UPDATX;
 756                                 Data.Bytes[2] = UPDATX;
 757                                 Data.Bytes[1] = UPDATX;
 758                                 Data.Bytes[0] = UPDATX;
 759
 760                                 return Data.DWord;
 761                         }
 762
 763                         /** Writes four bytes to the currently selected pipe's bank in little endian format, for IN
 764                          *  direction pipes.
 765                          *
 766                          *  \ingroup Group_PipePrimitiveRW
 767                          *
 768                          *  \param[in] DWord  Next double word to write to the currently selected pipe's FIFO buffer.
 769                          */
 770                         static inline void Pipe_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
 771                         static inline void Pipe_Write_DWord_LE(const uint32_t DWord)
 772                         {
 773                                 UPDATX = (DWord &  0xFF);
 774                                 UPDATX = (DWord >> 8);
 775                                 UPDATX = (DWord >> 16);
 776                                 UPDATX = (DWord >> 24);
 777                         }
 778
 779                         /** Writes four bytes to the currently selected pipe's bank in big endian format, for IN
 780                          *  direction pipes.
 781                          *
 782                          *  \ingroup Group_PipePrimitiveRW
 783                          *
 784                          *  \param[in] DWord  Next double word to write to the currently selected pipe's FIFO buffer.
 785                          */
 786                         static inline void Pipe_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
 787                         static inline void Pipe_Write_DWord_BE(const uint32_t DWord)
 788                         {
 789                                 UPDATX = (DWord >> 24);
 790                                 UPDATX = (DWord >> 16);
 791                                 UPDATX = (DWord >> 8);
 792                                 UPDATX = (DWord &  0xFF);
 793                         }
 794
 795                         /** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.
 796                          *
 797                          *  \ingroup Group_PipePrimitiveRW
 798                          */
 799                         static inline void Pipe_Discard_DWord(void) ATTR_ALWAYS_INLINE;
 800                         static inline void Pipe_Discard_DWord(void)
 801                         {
 802                                 uint8_t Dummy;
 803
 804                                 Dummy = UPDATX;
 805                                 Dummy = UPDATX;
 806                                 Dummy = UPDATX;
 807                                 Dummy = UPDATX;
 808                         }
 809
 810                 /* External Variables: */
 811                         /** Global indicating the maximum packet size of the default control pipe located at address
 812                          *  0 in the device. This value is set to the value indicated in the attached device's device
 813                      *  descriptor once the USB interface is initialized into host mode and a device is attached
 814                          *  to the USB bus.
 815                          *
 816                          *  \note This variable should be treated as read-only in the user application, and never manually
 817                          *        changed in value.
 818                          */
 819                         extern uint8_t USB_ControlPipeSize;
 820
 821                 /* Function Prototypes: */
 822                         /** Configures the specified pipe number with the given pipe type, token, target endpoint number in the
 823                          *  attached device, bank size and banking mode.
 824                          *
 825                          *  A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()
 826                          *  before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or
 827                          *  sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite
 828                          *  numbers of IN requests without automatic freezing - this can be overridden by a call to
 829                          *  \ref Pipe_SetFiniteINRequests().
 830                          *
 831                          *  \param[in] Number          Pipe number to configure. This must be more than 0 and less than \ref PIPE_TOTAL_PIPES.
 832                          *
 833                          *  \param[in] Type            Type of pipe to configure, a EP_TYPE_* mask. Not all pipe types are available on Low
 834                          *                             Speed USB devices - refer to the USB 2.0 specification.
 835                          *
 836                          *  \param[in] Token           Pipe data token, either \ref PIPE_TOKEN_SETUP, \ref PIPE_TOKEN_OUT or \ref PIPE_TOKEN_IN.
 837                          *                             All pipes (except Control type) are unidirectional - data may only be read from or
 838                          *                             written to the pipe bank based on its direction, not both.
 839                          *
 840                          *  \param[in] EndpointNumber  Endpoint index within the attached device that the pipe should interface to.
 841                          *
 842                          *  \param[in] Size            Size of the pipe's bank, where packets are stored before they are transmitted to
 843                          *                             the USB device, or after they have been received from the USB device (depending on
 844                          *                             the pipe's data direction). The bank size must indicate the maximum packet size that
 845                          *                             the pipe can handle.
 846                          *
 847                          *  \param[in] Banks           Number of banks to use for the pipe being configured, a PIPE_BANK_* mask. More banks
 848                          *                             uses more USB DPRAM, but offers better performance. Isochronous type pipes <b>must</b>
 849                          *                             have at least two banks.
 850                          *
 851                          *  \note Endpoints <b>must</b> be configured in ascending order, or bank corruption will occur.
 852                          *        \n\n
 853                          *
 854                          *  \note Certain models of USB AVR's pipes may have different maximum packet sizes based on the pipe's
 855                          *        index - refer to the chosen USB AVR's datasheet to determine the maximum bank size for each pipe.
 856                          *        \n\n
 857                          *
 858                          *  \note The default control pipe should not be manually configured by the user application, as it is
 859                          *        automatically configured by the library internally.
 860                          *        \n\n
 861                          *
 862                          *  \note This routine will automatically select the specified pipe upon success. Upon failure, the pipe which
 863                          *        failed to reconfigure correctly will be selected.
 864                          *
 865                          *  \return Boolean true if the configuration succeeded, false otherwise.
 866                          */
 867                         bool Pipe_ConfigurePipe(const uint8_t Number,
 868                                                 const uint8_t Type,
 869                                                 const uint8_t Token,
 870                                                 const uint8_t EndpointNumber,
 871                                                 const uint16_t Size,
 872                                                 const uint8_t Banks);
 873
 874                         /** Spin-loops until the currently selected non-control pipe is ready for the next packed of data to be read
 875                          *  or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).
 876                          *
 877                          *  \ingroup Group_PipeRW
 878                          *
 879                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 880                          */
 881                         uint8_t Pipe_WaitUntilReady(void);
 882
 883                         /** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given
 884                          *  endpoint is found, it is automatically selected.
 885                          *
 886                          *  \param[in] EndpointAddress Address and direction mask of the endpoint within the attached device to check.
 887                          *
 888                          *  \return Boolean true if a pipe bound to the given endpoint address of the specified direction is found, false
 889                          *          otherwise.
 890                          */
 891                         bool Pipe_IsEndpointBound(const uint8_t EndpointAddress);
 892
 893         /* Private Interface - For use in library only: */
 894         #if !defined(__DOXYGEN__)
 895                 /* Macros: */
 896                         #if !defined(ENDPOINT_CONTROLEP)
 897                                 #define ENDPOINT_CONTROLEP          0
 898                         #endif
 899
 900                 /* Inline Functions: */
 901                         static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
 902                         static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes)
 903                         {
 904                                 uint8_t  MaskVal    = 0;
 905                                 uint16_t CheckBytes = 8;
 906
 907                                 while ((CheckBytes < Bytes) && (CheckBytes < PIPE_MAX_SIZE))
 908                                 {
 909                                         MaskVal++;
 910                                         CheckBytes <<= 1;
 911                                 }
 912
 913                                 return (MaskVal << EPSIZE0);
 914                         }
 915
 916                 /* Function Prototypes: */
 917                         void Pipe_ClearPipes(void);
 918         #endif
 919
 920         /* Disable C linkage for C++ Compilers: */
 921                 #if defined(__cplusplus)
 922                         }
 923                 #endif
 924
 925 #endif
 926
 927 /** @} */
 928