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