LUFA/Drivers/USB/LowLevel/Pipe.h

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