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                 0x0F
 177
 178                 /* Pseudo-Function Macros: */
 179                         #if defined(__DOXYGEN__)
 180                                 /** Indicates the number of bytes currently stored in the current pipes's selected bank.
 181                                  *
 182                                  *  \note The return width of this function may differ, depending on the maximum pipe bank size
 183                                  *        of the selected AVR model.
 184                                  *
 185                                  *  \ingroup Group_PipeRW
 186                                  *
 187                                  *  \return Total number of bytes in the currently selected Pipe's FIFO buffer
 188                                  */
 189                                 static inline uint16_t Pipe_BytesInPipe(void);
 190
 191                                 /** Returns the pipe address of the currently selected pipe. This is typically used to save the
 192                                  *  currently selected pipe number so that it can be restored after another pipe has been manipulated.
 193                                  *
 194                                  *  \return Index of the currently selected pipe
 195                                  */
 196                                 static inline uint8_t Pipe_GetCurrentPipe(void);
 197
 198                                 /** Selects the given pipe number. Any pipe operations which do not require the pipe number to be
 199                                  *  indicated will operate on the currently selected pipe.
 200                                  *
 201                                  *  \param[in] PipeNumber  Index of the pipe to select
 202                                  */
 203                                 static inline void Pipe_SelectPipe(uint8_t PipeNumber);
 204
 205                                 /** Resets the desired pipe, including the pipe banks and flags.
 206                                  *
 207                                  *  \param[in] PipeNumber  Index of the pipe to reset
 208                                  */
 209                                 static inline void Pipe_ResetPipe(uint8_t PipeNumber);
 210
 211                                 /** Enables the currently selected pipe so that data can be sent and received through it to and from
 212                                  *  an attached device.
 213                                  *
 214                                  *  \note Pipes must first be configured properly via \ref Pipe_ConfigurePipe().
 215                                  */
 216                                 static inline void Pipe_EnablePipe(void);
 217
 218                                 /** Disables the currently selected pipe so that data cannot be sent and received through it to and
 219                                  *  from an attached device.
 220                                  */
 221                                 static inline void Pipe_DisablePipe(void);
 222
 223                                 /** Determines if the currently selected pipe is enabled, but not necessarily configured.
 224                                  *
 225                                  * \return Boolean True if the currently selected pipe is enabled, false otherwise
 226                                  */
 227                                 static inline bool Pipe_IsEnabled(void);
 228
 229                                 /** Gets the current pipe token, indicating the pipe's data direction and type.
 230                                  *
 231                                  *  \return The current pipe token, as a PIPE_TOKEN_* mask
 232                                  */
 233                                 static inline uint8_t Pipe_GetPipeToken(void);
 234
 235                                 /** Sets the token for the currently selected pipe to one of the tokens specified by the PIPE_TOKEN_*
 236                                  *  masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during
 237                                  *  control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices
 238                                  *  which have two endpoints of opposite direction sharing the same endpoint address within the device.
 239                                  *
 240                                  *  \param[in] Token  New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask
 241                                  */
 242                                 static inline void Pipe_SetPipeToken(uint8_t Token);
 243
 244                                 /** Configures the currently selected pipe to allow for an unlimited number of IN requests. */
 245                                 static inline void Pipe_SetInfiniteINRequests(void);
 246
 247                                 /** Configures the currently selected pipe to only allow the specified number of IN requests to be
 248                                  *  accepted by the pipe before it is automatically frozen.
 249                                  *
 250                                  *  \param[in] TotalINRequests  Total number of IN requests that the pipe may receive before freezing
 251                                  */
 252                                 static inline void Pipe_SetFiniteINRequests(uint8_t TotalINRequests);
 253
 254                                 /** Determines if the currently selected pipe is configured.
 255                                  *
 256                                  *  \return Boolean true if the selected pipe is configured, false otherwise
 257                                  */
 258                                 static inline bool Pipe_IsConfigured(void);
 259
 260                                 /** Retrieves the endpoint number of the endpoint within the attached device that the currently selected
 261                                  *  pipe is bound to.
 262                                  *
 263                                  *  \return Endpoint number the currently selected pipe is bound to
 264                                  */
 265                                 static inline uint8_t Pipe_BoundEndpointNumber(void);
 266
 267                                 /** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.
 268                                  *
 269                                  *  \param[in] Milliseconds  Number of milliseconds between each pipe poll
 270                                  */
 271                                 static inline void Pipe_SetInterruptPeriod(uint8_t Milliseconds);
 272
 273                                 /** Returns a mask indicating which pipe's interrupt periods have elapsed, indicating that the pipe should
 274                                  *  be serviced.
 275                                  *
 276                                  *  \return Mask whose bits indicate which pipes have interrupted
 277                                  */
 278                                 static inline uint8_t Pipe_GetPipeInterrupts(void);
 279
 280                                 /** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type
 281                                  *  pipes).
 282                                  *
 283                                  *  \param[in] PipeNumber  Index of the pipe whose interrupt flag should be tested
 284                                  *
 285                                  *  \return Boolean true if the specified pipe has interrupted, false otherwise
 286                                  */
 287                                 static inline bool Pipe_HasPipeInterrupted(uint8_t PipeNumber);
 288
 289                                 /** Unfreezes the selected pipe, allowing it to communicate with an attached device. */
 290                                 static inline void Pipe_Unfreeze(void);
 291
 292                                 /** Freezes the selected pipe, preventing it from communicating with an attached device. */
 293                                 static inline void Pipe_Freeze(void);
 294
 295                                 /** Clears the master pipe error flag. */
 296                                 static inline void Pipe_ClearError(void);
 297
 298                                 /** Determines if the master pipe error flag is set for the currently selected pipe, indicating that
 299                                  *  some sort of hardware error has occurred on the pipe.
 300                                  *
 301                                  *  \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.
 302                                  *
 303                                  *  \return Boolean true if an error has occurred on the selected pipe, false otherwise
 304                                  */
 305                                 static inline bool Pipe_IsError(void);
 306
 307                                 /** Clears all the currently selected pipe's hardware error flags, but does not clear the master error
 308                                  *  flag for the pipe.
 309                                  */
 310                                 static inline void Pipe_ClearErrorFlags(void);
 311
 312                                 /** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This
 313                                  *  value can then be masked against the PIPE_ERRORFLAG_* masks to determine what error has occurred.
 314                                  *
 315                                  *  \return  Mask comprising of PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe
 316                                  */
 317                                 static inline uint8_t Pipe_GetErrorFlags(void);
 318
 319                                 /** Determines if the currently selected pipe may be read from (if data is waiting in the pipe
 320                                  *  bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT
 321                                  *  direction). This function will return false if an error has occurred in the pipe, or if the pipe
 322                                  *  is an IN direction and no packet (or an empty packet) has been received, or if the pipe is an OUT
 323                                  *  direction and the pipe bank is full.
 324                                  *
 325                                  *  \note This function is not valid on CONTROL type pipes.
 326                                  *
 327                                  *  \ingroup Group_PipePacketManagement
 328                                  *
 329                                  *  \return Boolean true if the currently selected pipe may be read from or written to, depending on its direction
 330                                  */
 331                                 static inline bool Pipe_IsReadWriteAllowed(void);
 332
 333                                 /** Determines if an IN request has been received on the currently selected pipe.
 334                                  *
 335                                  *  \ingroup Group_PipePacketManagement
 336                                  *
 337                                  *  \return Boolean true if the current pipe has received an IN packet, false otherwise.
 338                                  */
 339                                 static inline bool Pipe_IsINReceived(void);
 340
 341                                 /** Determines if the currently selected pipe is ready to send an OUT request.
 342                                  *
 343                                  *  \ingroup Group_PipePacketManagement
 344                                  *
 345                                  *  \return Boolean true if the current pipe is ready for an OUT packet, false otherwise.
 346                                  */
 347                                 static inline bool Pipe_IsOUTReady(void);
 348
 349                                 /** Determines if no SETUP request is currently being sent to the attached device on the selected
 350                                  *  CONTROL type pipe.
 351                                  *
 352                                  *  \ingroup Group_PipePacketManagement
 353                                  *
 354                                  *  \return Boolean true if the current pipe is ready for a SETUP packet, false otherwise.
 355                                  */
 356                                 static inline bool Pipe_IsSETUPSent(void);
 357
 358                                 /** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.
 359                                  *
 360                                  *  \ingroup Group_PipePacketManagement
 361                                  */
 362                                 static inline void Pipe_ClearSETUP(void);
 363
 364                                 /** Acknowledges the reception of a setup IN request from the attached device on the currently selected
 365                                  *  pipe, freeing the bank ready for the next packet.
 366                                  *
 367                                  *  \ingroup Group_PipePacketManagement
 368                                  */
 369                                 static inline void Pipe_ClearIN(void);
 370
 371                                 /** Sends the currently selected pipe's contents to the device as an OUT packet on the selected pipe, freeing
 372                                  *  the bank ready for the next packet.
 373                                  *
 374                                  *  \ingroup Group_PipePacketManagement
 375                                  */
 376                                 static inline void Pipe_ClearOUT(void);
 377
 378                                 /** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on
 379                                  *  the currently selected pipe. This occurs when the host sends a packet to the device, but the device
 380                                  *  is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been
 381                                  *  received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet
 382                                  *  can be re-sent.
 383                                  *
 384                                  *  \ingroup Group_PipePacketManagement
 385                                  *
 386                                  *  \return Boolean true if an NAK has been received on the current pipe, false otherwise
 387                                  */
 388                                 static inline bool Pipe_IsNAKReceived(void);
 389
 390                                 /** Clears the NAK condition on the currently selected pipe.
 391                                  *
 392                                  *  \ingroup Group_PipePacketManagement
 393                                  *
 394                                  *  \see \ref Pipe_IsNAKReceived() for more details.
 395                                  */
 396                                 static inline void Pipe_ClearNAKReceived(void);
 397
 398                                 /** Determines if the currently selected pipe has had the STALL condition set by the attached device.
 399                                  *
 400                                  *  \ingroup Group_PipePacketManagement
 401                                  *
 402                                  *  \return Boolean true if the current pipe has been stalled by the attached device, false otherwise
 403                                 */
 404                                 static inline bool Pipe_IsStalled(void);
 405
 406                                 /** Clears the STALL condition detection flag on the currently selected pipe, but does not clear the
 407                                  *  STALL condition itself (this must be done via a ClearFeature control request to the device).
 408                                  *
 409                                  *  \ingroup Group_PipePacketManagement
 410                                  */
 411                                 static inline void Pipe_ClearStall(void);
 412                         #else
 413                                 #define Pipe_BytesInPipe()             UPBCX
 414
 415                                 #define Pipe_GetCurrentPipe()          (UPNUM & PIPE_PIPENUM_MASK)
 416
 417                                 #define Pipe_SelectPipe(pipenum)       MACROS{ UPNUM = pipenum; }MACROE
 418
 419                                 #define Pipe_ResetPipe(pipenum)        MACROS{ UPRST = (1 << pipenum); UPRST = 0; }MACROE
 420
 421                                 #define Pipe_EnablePipe()              MACROS{ UPCONX |= (1 << PEN); }MACROE
 422
 423                                 #define Pipe_DisablePipe()             MACROS{ UPCONX &= ~(1 << PEN); }MACROE
 424
 425                                 #define Pipe_IsEnabled()               ((UPCONX & (1 << PEN)) ? true : false)
 426
 427                                 #define Pipe_GetPipeToken()            (UPCFG0X & PIPE_TOKEN_MASK)
 428
 429                                 #define Pipe_SetToken(token)           MACROS{ UPCFG0X = ((UPCFG0X & ~PIPE_TOKEN_MASK) | token); }MACROE
 430
 431                                 #define Pipe_SetInfiniteINRequests()   MACROS{ UPCONX |= (1 << INMODE); }MACROE
 432
 433                                 #define Pipe_SetFiniteINRequests(n)    MACROS{ UPCONX &= ~(1 << INMODE); UPINRQX = n; }MACROE
 434
 435                                 #define Pipe_IsConfigured()            ((UPSTAX  & (1 << CFGOK)) ? true : false)
 436
 437                                 #define Pipe_BoundEndpointNumber()     ((UPCFG0X >> PEPNUM0) & PIPE_EPNUM_MASK)
 438
 439                                 #define Pipe_SetInterruptPeriod(ms)    MACROS{ UPCFG2X = ms; }MACROE
 440
 441                                 #define Pipe_GetPipeInterrupts()       UPINT
 442
 443                                 #define Pipe_HasPipeInterrupted(n)     ((UPINT & (1 << n)) ? true : false)
 444
 445                                 #define Pipe_Unfreeze()                MACROS{ UPCONX &= ~(1 << PFREEZE); }MACROE
 446
 447                                 #define Pipe_Freeze()                  MACROS{ UPCONX |= (1 << PFREEZE); }MACROE
 448
 449                                 #define Pipe_ClearError()              MACROS{ UPINTX &= ~(1 << PERRI); }MACROE
 450
 451                                 #define Pipe_IsError()                 ((UPINTX & (1 << PERRI)) ? true : false)
 452
 453                                 #define Pipe_ClearErrorFlags()         MACROS{ UPERRX = 0; }MACROE
 454
 455                                 #define Pipe_GetErrorFlags()           ((UPERRX & (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT | \
 456                                                                                    PIPE_ERRORFLAG_PID   | PIPE_ERRORFLAG_DATAPID | \
 457                                                                                    PIPE_ERRORFLAG_DATATGL))                      | \
 458                                                                         (UPSTAX & PIPE_ERRORFLAG_OVERFLOW | PIPE_ERRORFLAG_UNDERFLOW))
 459
 460                                 #define Pipe_IsReadWriteAllowed()      ((UPINTX & (1 << RWAL)) ? true : false)
 461
 462                                 #define Pipe_IsINReceived()            ((UPINTX & (1 << RXINI)) ? true : false)
 463
 464                                 #define Pipe_IsOUTReady()              ((UPINTX & (1 << TXOUTI)) ? true : false)
 465
 466                                 #define Pipe_IsSETUPSent()             ((UPINTX & (1 << TXSTPI)) ? true : false)
 467
 468                                 #define Pipe_ClearIN()                 MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << RXINI)); \
 469                                                                                UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE
 470
 471                                 #define Pipe_ClearOUT()                MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << TXOUTI)); \
 472                                                                                UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE
 473
 474                                 #define Pipe_ClearSETUP()              MACROS{ uint8_t Temp = UPINTX; UPINTX = (Temp & ~(1 << TXSTPI)); \
 475                                                                                UPINTX = (Temp & ~(1 << FIFOCON)); }MACROE
 476
 477                                 #define Pipe_IsNAKReceived()           ((UPINTX & (1 << NAKEDI)) ? true : false)
 478
 479                                 #define Pipe_ClearNAKReceived()        MACROS{ UPINTX &= ~(1 << NAKEDI); }MACROE
 480
 481                                 #define Pipe_IsStalled()               ((UPINTX & (1 << RXSTALLI)) ? true : false)
 482
 483                                 #define Pipe_ClearStall()              MACROS{ UPINTX &= ~(1 << RXSTALLI); }MACROE
 484                         #endif
 485
 486                 /* Enums: */
 487                         /** Enum for the possible error return codes of the Pipe_WaitUntilReady function
 488                          *
 489                          *  \ingroup Group_PipeRW
 490                          */
 491                         enum Pipe_WaitUntilReady_ErrorCodes_t
 492                         {
 493                                 PIPE_READYWAIT_NoError                 = 0, /**< Pipe ready for next packet, no error */
 494                                 PIPE_READYWAIT_PipeStalled             = 1,     /**< The device stalled the pipe while waiting. */
 495                                 PIPE_READYWAIT_DeviceDisconnected      = 2,     /**< Device was disconnected from the host while waiting. */
 496                                 PIPE_READYWAIT_Timeout                 = 3, /**< The device failed to accept or send the next packet
 497                                                                              *   within the software timeout period set by the
 498                                                                              *   \ref USB_STREAM_TIMEOUT_MS macro.
 499                                                                              */
 500                         };
 501
 502                         /** Enum for the possible error return codes of the Pipe_*_Stream_* functions.
 503                          *
 504                          *  \ingroup Group_PipeRW
 505                          */
 506                         enum Pipe_Stream_RW_ErrorCodes_t
 507                         {
 508                                 PIPE_RWSTREAM_NoError            = 0, /**< Command completed successfully, no error. */
 509                                 PIPE_RWSTREAM_PipeStalled        = 1, /**< The device stalled the pipe during the transfer. */
 510                                 PIPE_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
 511                                                                    *   the transfer.
 512                                                                    */
 513                                 PIPE_RWSTREAM_Timeout            = 3, /**< The device failed to accept or send the next packet
 514                                                                        *   within the software timeout period set by the
 515                                                                        *   \ref USB_STREAM_TIMEOUT_MS macro.
 516                                                                        */
 517                                 PIPE_RWSTREAM_CallbackAborted    = 4, /**< Indicates that the stream's callback function aborted
 518                                                                    *   the transfer early.
 519                                                                        */
 520                         };
 521
 522                 /* Inline Functions: */
 523                         /** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.
 524                          *
 525                          *  \ingroup Group_PipePrimitiveRW
 526                          *
 527                          *  \return Next byte in the currently selected pipe's FIFO buffer
 528                          */
 529                         static inline uint8_t Pipe_Read_Byte(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 530                         static inline uint8_t Pipe_Read_Byte(void)
 531                         {
 532                                 return UPDATX;
 533                         }
 534
 535                         /** Writes one byte from the currently selected pipe's bank, for IN direction pipes.
 536                          *
 537                          *  \ingroup Group_PipePrimitiveRW
 538                          *
 539                          *  \param[in] Byte  Next byte to write into the the currently selected pipe's FIFO buffer
 540                          */
 541                         static inline void Pipe_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 542                         static inline void Pipe_Write_Byte(const uint8_t Byte)
 543                         {
 544                                 UPDATX = Byte;
 545                         }
 546
 547                         /** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.
 548                          *
 549                          *  \ingroup Group_PipePrimitiveRW
 550                          */
 551                         static inline void Pipe_Discard_Byte(void) ATTR_ALWAYS_INLINE;
 552                         static inline void Pipe_Discard_Byte(void)
 553                         {
 554                                 uint8_t Dummy;
 555
 556                                 Dummy = UPDATX;
 557                         }
 558
 559                         /** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT
 560                          *  direction pipes.
 561                          *
 562                          *  \ingroup Group_PipePrimitiveRW
 563                          *
 564                          *  \return Next word in the currently selected pipe's FIFO buffer
 565                          */
 566                         static inline uint16_t Pipe_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 567                         static inline uint16_t Pipe_Read_Word_LE(void)
 568                         {
 569                                 union
 570                                 {
 571                                         uint16_t Word;
 572                                         uint8_t  Bytes[2];
 573                                 } Data;
 574
 575                                 Data.Bytes[0] = UPDATX;
 576                                 Data.Bytes[1] = UPDATX;
 577
 578                                 return Data.Word;
 579                         }
 580
 581                         /** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT
 582                          *  direction pipes.
 583                          *
 584                          *  \ingroup Group_PipePrimitiveRW
 585                          *
 586                          *  \return Next word in the currently selected pipe's FIFO buffer
 587                          */
 588                         static inline uint16_t Pipe_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 589                         static inline uint16_t Pipe_Read_Word_BE(void)
 590                         {
 591                                 union
 592                                 {
 593                                         uint16_t Word;
 594                                         uint8_t  Bytes[2];
 595                                 } Data;
 596
 597                                 Data.Bytes[1] = UPDATX;
 598                                 Data.Bytes[0] = UPDATX;
 599
 600                                 return Data.Word;
 601                         }
 602
 603                         /** Writes two bytes to the currently selected pipe's bank in little endian format, for IN
 604                          *  direction pipes.
 605                          *
 606                          *  \ingroup Group_PipePrimitiveRW
 607                          *
 608                          *  \param[in] Word  Next word to write to the currently selected pipe's FIFO buffer
 609                          */
 610                         static inline void Pipe_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
 611                         static inline void Pipe_Write_Word_LE(const uint16_t Word)
 612                         {
 613                                 UPDATX = (Word & 0xFF);
 614                                 UPDATX = (Word >> 8);
 615                         }
 616
 617                         /** Writes two bytes to the currently selected pipe's bank in big endian format, for IN
 618                          *  direction pipes.
 619                          *
 620                          *  \ingroup Group_PipePrimitiveRW
 621                          *
 622                          *  \param[in] Word  Next word to write to the currently selected pipe's FIFO buffer
 623                          */
 624                         static inline void Pipe_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
 625                         static inline void Pipe_Write_Word_BE(const uint16_t Word)
 626                         {
 627                                 UPDATX = (Word >> 8);
 628                                 UPDATX = (Word & 0xFF);
 629                         }
 630
 631                         /** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.
 632                          *
 633                          *  \ingroup Group_PipePrimitiveRW
 634                          */
 635                         static inline void Pipe_Discard_Word(void) ATTR_ALWAYS_INLINE;
 636                         static inline void Pipe_Discard_Word(void)
 637                         {
 638                                 uint8_t Dummy;
 639
 640                                 Dummy = UPDATX;
 641                                 Dummy = UPDATX;
 642                         }
 643
 644                         /** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT
 645                          *  direction pipes.
 646                          *
 647                          *  \ingroup Group_PipePrimitiveRW
 648                          *
 649                          *  \return Next double word in the currently selected pipe's FIFO buffer
 650                          */
 651                         static inline uint32_t Pipe_Read_DWord_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 652                         static inline uint32_t Pipe_Read_DWord_LE(void)
 653                         {
 654                                 union
 655                                 {
 656                                         uint32_t DWord;
 657                                         uint8_t  Bytes[4];
 658                                 } Data;
 659
 660                                 Data.Bytes[0] = UPDATX;
 661                                 Data.Bytes[1] = UPDATX;
 662                                 Data.Bytes[2] = UPDATX;
 663                                 Data.Bytes[3] = UPDATX;
 664
 665                                 return Data.DWord;
 666                         }
 667
 668                         /** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT
 669                          *  direction pipes.
 670                          *
 671                          *  \ingroup Group_PipePrimitiveRW
 672                          *
 673                          *  \return Next double word in the currently selected pipe's FIFO buffer
 674                          */
 675                         static inline uint32_t Pipe_Read_DWord_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 676                         static inline uint32_t Pipe_Read_DWord_BE(void)
 677                         {
 678                                 union
 679                                 {
 680                                         uint32_t DWord;
 681                                         uint8_t  Bytes[4];
 682                                 } Data;
 683
 684                                 Data.Bytes[3] = UPDATX;
 685                                 Data.Bytes[2] = UPDATX;
 686                                 Data.Bytes[1] = UPDATX;
 687                                 Data.Bytes[0] = UPDATX;
 688
 689                                 return Data.DWord;
 690                         }
 691
 692                         /** Writes four bytes to the currently selected pipe's bank in little endian format, for IN
 693                          *  direction pipes.
 694                          *
 695                          *  \ingroup Group_PipePrimitiveRW
 696                          *
 697                          *  \param[in] DWord  Next double word to write to the currently selected pipe's FIFO buffer
 698                          */
 699                         static inline void Pipe_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
 700                         static inline void Pipe_Write_DWord_LE(const uint32_t DWord)
 701                         {
 702                                 UPDATX = (DWord &  0xFF);
 703                                 UPDATX = (DWord >> 8);
 704                                 UPDATX = (DWord >> 16);
 705                                 UPDATX = (DWord >> 24);
 706                         }
 707
 708                         /** Writes four bytes to the currently selected pipe's bank in big endian format, for IN
 709                          *  direction pipes.
 710                          *
 711                          *  \ingroup Group_PipePrimitiveRW
 712                          *
 713                          *  \param[in] DWord  Next double word to write to the currently selected pipe's FIFO buffer
 714                          */
 715                         static inline void Pipe_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
 716                         static inline void Pipe_Write_DWord_BE(const uint32_t DWord)
 717                         {
 718                                 UPDATX = (DWord >> 24);
 719                                 UPDATX = (DWord >> 16);
 720                                 UPDATX = (DWord >> 8);
 721                                 UPDATX = (DWord &  0xFF);
 722                         }
 723
 724                         /** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.
 725                          *
 726                          *  \ingroup Group_PipePrimitiveRW
 727                          */
 728                         static inline void Pipe_Discard_DWord(void) ATTR_ALWAYS_INLINE;
 729                         static inline void Pipe_Discard_DWord(void)
 730                         {
 731                                 uint8_t Dummy;
 732
 733                                 Dummy = UPDATX;
 734                                 Dummy = UPDATX;
 735                                 Dummy = UPDATX;
 736                                 Dummy = UPDATX;
 737                         }
 738
 739                 /* External Variables: */
 740                         /** Global indicating the maximum packet size of the default control pipe located at address
 741                          *  0 in the device. This value is set to the value indicated in the attached device's device
 742                      *  descriptor once the USB interface is initialized into host mode and a device is attached
 743                          *  to the USB bus.
 744                          *
 745                          *  \note This variable should be treated as read-only in the user application, and never manually
 746                          *        changed in value.
 747                          */
 748                         extern uint8_t USB_ControlPipeSize;
 749
 750                 /* Function Prototypes: */
 751                         #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
 752                                 #define _CALLBACK_PARAM     , StreamCallbackPtr_t Callback
 753                         #else
 754                                 #define _CALLBACK_PARAM
 755                         #endif
 756
 757                         /** Configures the specified pipe number with the given pipe type, token, target endpoint number in the
 758                          *  attached device, bank size and banking mode. Pipes should be allocated in ascending order by their
 759                          *  address in the device (i.e. pipe 1 should be configured before pipe 2 and so on) to prevent fragmentation
 760                          *  of the USB FIFO memory.
 761                          *
 762                          *  The pipe type may be one of the EP_TYPE_* macros listed in LowLevel.h, the token may be one of the
 763                          *  PIPE_TOKEN_* masks.
 764                          *
 765                          *  The bank size must indicate the maximum packet size that the pipe can handle. Different pipe
 766                          *  numbers can handle different maximum packet sizes - refer to the chosen USB AVR's datasheet to
 767                          *  determine the maximum bank size for each pipe.
 768                          *
 769                          *  The banking mode may be either \ref PIPE_BANK_SINGLE or \ref PIPE_BANK_DOUBLE.
 770                          *
 771                          *  A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()
 772                          *  before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or
 773                          *  sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite
 774                          *  numbers of IN requests without automatic freezing - this can be overridden by a call to
 775                          *  \ref Pipe_SetFiniteINRequests().
 776                          *
 777                          *  \note The default control pipe does not have to be manually configured, as it is automatically
 778                          *  configured by the library internally.
 779                          *
 780                          *  \note This routine will select the specified pipe, and the pipe will remain selected once the
 781                          *        routine completes regardless of if the pipe configuration succeeds.
 782                          *
 783                          *  \return Boolean true if the configuration is successful, false otherwise
 784                          */
 785                         bool Pipe_ConfigurePipe(const uint8_t  Number, const uint8_t Type, const uint8_t Token, const uint8_t EndpointNumber,
 786                                                 const uint16_t Size, const uint8_t Banks);
 787
 788                         /** Spinloops until the currently selected non-control pipe is ready for the next packed of data to be read
 789                          *  or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).
 790                          *
 791                          *  \ingroup Group_PipeRW
 792                          *
 793                          *  \return A value from the Pipe_WaitUntilReady_ErrorCodes_t enum.
 794                          */
 795                         uint8_t Pipe_WaitUntilReady(void);
 796
 797                         /** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given
 798                          *  endpoint is found, it is automatically selected.
 799                          *
 800                          *  \param EndpointAddress Address of the endpoint within the attached device to check
 801                          *
 802                          *  \return Boolean true if a pipe bound to the given endpoint address is found, false otherwise
 803                          */
 804                         bool Pipe_IsEndpointBound(uint8_t EndpointAddress);
 805
 806                         /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host
 807                          *  as needed. The last packet is not automatically discarded once the remaining bytes has been read; the
 808                          *  user is responsible for manually discarding the last packet from the device via the \ref Pipe_ClearIN() macro.
 809                          *  Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,
 810                          *  allowing for early aborts of stream transfers.
 811                          *
 812                          *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.
 813                          *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
 814                          *  disabled and this function has the Callback parameter omitted.
 815                          *
 816                          *  The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
 817                          *  having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
 818                          *
 819                          *  \ingroup Group_PipeStreamRW
 820                          *
 821                          *  \param[in] Length  Number of bytes to send via the currently selected pipe.
 822                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 823                          *
 824                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 825                          */
 826                         uint8_t Pipe_Discard_Stream(uint16_t Length _CALLBACK_PARAM);
 827
 828                         /** Writes the given number of bytes to the pipe from the given buffer in little endian,
 829                          *  sending full packets to the device as needed. The last packet filled is not automatically sent;
 830                          *  the user is responsible for manually sending the last written packet to the host via the
 831                          *  \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is
 832                          *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
 833                          *
 834                          *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.
 835                          *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
 836                          *  disabled and this function has the Callback parameter omitted.
 837                          *
 838                          *  The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
 839                          *  having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
 840                          *
 841                          *  \ingroup Group_PipeStreamRW
 842                          *
 843                          *  \param[in] Buffer    Pointer to the source data buffer to read from.
 844                          *  \param[in] Length    Number of bytes to read for the currently selected pipe into the buffer.
 845                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 846                          *
 847                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 848                          */
 849                         uint8_t Pipe_Write_Stream_LE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
 850
 851                         /** EEPROM buffer source version of \ref Pipe_Write_Stream_LE().
 852                          *
 853                          *  \ingroup Group_PipeStreamRW
 854                          *
 855                          *  \param[in] Buffer    Pointer to the source data buffer to read from.
 856                          *  \param[in] Length    Number of bytes to read for the currently selected pipe into the buffer.
 857                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 858                          *
 859                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 860                          */
 861                         uint8_t Pipe_Write_EStream_LE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
 862
 863                         /** FLASH buffer source version of \ref Pipe_Write_Stream_LE().
 864                          *
 865                          *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
 866                          *
 867                          *  \ingroup Group_PipeStreamRW
 868                          *
 869                          *  \param[in] Buffer    Pointer to the source data buffer to read from.
 870                          *  \param[in] Length    Number of bytes to read for the currently selected pipe into the buffer.
 871                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 872                          *
 873                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 874                          */
 875                         uint8_t Pipe_Write_PStream_LE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
 876
 877                         /** Writes the given number of bytes to the pipe from the given buffer in big endian,
 878                          *  sending full packets to the device as needed. The last packet filled is not automatically sent;
 879                          *  the user is responsible for manually sending the last written packet to the host via the
 880                          *  \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is
 881                          *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
 882                          *
 883                          *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.
 884                          *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
 885                          *  disabled and this function has the Callback parameter omitted.
 886                          *
 887                          *  The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
 888                          *  having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
 889                          *
 890                          *  \ingroup Group_PipeStreamRW
 891                          *
 892                          *  \param[in] Buffer    Pointer to the source data buffer to read from.
 893                          *  \param[in] Length    Number of bytes to read for the currently selected pipe into the buffer.
 894                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 895                          *
 896                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 897                          */
 898                         uint8_t Pipe_Write_Stream_BE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
 899
 900                         /** EEPROM buffer source version of \ref Pipe_Write_Stream_BE().
 901                          *
 902                          *  \ingroup Group_PipeStreamRW
 903                          *
 904                          *  \param[in] Buffer    Pointer to the source data buffer to read from.
 905                          *  \param[in] Length    Number of bytes to read for the currently selected pipe into the buffer.
 906                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 907                          *
 908                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 909                          */
 910                         uint8_t Pipe_Write_EStream_BE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
 911
 912                         /** FLASH buffer source version of \ref Pipe_Write_Stream_BE().
 913                          *
 914                          *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
 915                          *
 916                          *  \ingroup Group_PipeStreamRW
 917                          *
 918                          *  \param[in] Buffer    Pointer to the source data buffer to read from.
 919                          *  \param[in] Length    Number of bytes to read for the currently selected pipe into the buffer.
 920                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 921                          *
 922                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 923                          */
 924                         uint8_t Pipe_Write_PStream_BE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
 925
 926                         /** Reads the given number of bytes from the pipe into the given buffer in little endian,
 927                          *  sending full packets to the device as needed. The last packet filled is not automatically sent;
 928                          *  the user is responsible for manually sending the last written packet to the host via the
 929                          *  \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is
 930                          *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
 931                          *
 932                          *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.
 933                          *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
 934                          *  disabled and this function has the Callback parameter omitted.
 935                          *
 936                          *  The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
 937                          *  having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
 938                          *
 939                          *  \ingroup Group_PipeStreamRW
 940                          *
 941                          *  \param[out] Buffer   Pointer to the source data buffer to write to.
 942                          *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
 943                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 944                          *
 945                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 946                          */
 947                         uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
 948
 949                         /** EEPROM buffer source version of \ref Pipe_Read_Stream_LE().
 950                          *
 951                          *  \ingroup Group_PipeStreamRW
 952                          *
 953                          *  \param[out] Buffer   Pointer to the source data buffer to write to.
 954                          *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
 955                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 956                          *
 957                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 958                          */
 959                         uint8_t Pipe_Read_EStream_LE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
 960
 961                         /** Reads the given number of bytes from the pipe into the given buffer in big endian,
 962                          *  sending full packets to the device as needed. The last packet filled is not automatically sent;
 963                          *  the user is responsible for manually sending the last written packet to the host via the
 964                          *  \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is
 965                          *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
 966                          *
 967                          *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.
 968                          *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
 969                          *  disabled and this function has the Callback parameter omitted.
 970                          *
 971                          *  The pipe token is set automatically, thus this can be used on bi-directional pipes directly without
 972                          *  having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().
 973                          *
 974                          *  \ingroup Group_PipeStreamRW
 975                          *
 976                          *  \param[out] Buffer   Pointer to the source data buffer to write to.
 977                          *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
 978                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 979                          *
 980                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 981                          */
 982                         uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
 983
 984                         /** EEPROM buffer source version of \ref Pipe_Read_Stream_BE().
 985                          *
 986                          *  \ingroup Group_PipeStreamRW
 987                          *
 988                          *  \param[out] Buffer   Pointer to the source data buffer to write to.
 989                          *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
 990                          *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 991                          *
 992                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 993                          */
 994                         uint8_t Pipe_Read_EStream_BE(void* Buffer, uint16_t Length _CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);
 995
 996         /* Private Interface - For use in library only: */
 997         #if !defined(__DOXYGEN__)
 998                 /* Macros: */
 999                         #define PIPE_TOKEN_MASK                (0x03 << PTOKEN0)
1000
1001                         #if !defined(ENDPOINT_CONTROLEP)
1002                                 #define ENDPOINT_CONTROLEP         0
1003                         #endif
1004
1005                         #define Pipe_AllocateMemory()          MACROS{ UPCFG1X |=  (1 << ALLOC); }MACROE
1006                         #define Pipe_DeallocateMemory()        MACROS{ UPCFG1X &= ~(1 << ALLOC); }MACROE
1007
1008                 /* Function Prototypes: */
1009                         void Pipe_ClearPipes(void);
1010
1011                 /* Inline Functions: */
1012                         static inline uint8_t Pipe_BytesToEPSizeMask(uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
1013                         static inline uint8_t Pipe_BytesToEPSizeMask(uint16_t Bytes)
1014                         {
1015                                 if (Bytes <= 8)
1016                                   return (0 << EPSIZE0);
1017                                 else if (Bytes <= 16)
1018                                   return (1 << EPSIZE0);
1019                                 else if (Bytes <= 32)
1020                                   return (2 << EPSIZE0);
1021                                 else if (Bytes <= 64)
1022                                   return (3 << EPSIZE0);
1023                                 else if (Bytes <= 128)
1024                                   return (4 << EPSIZE0);
1025                                 else
1026                                   return (5 << EPSIZE0);
1027                         };
1028
1029         #endif
1030
1031         /* Disable C linkage for C++ Compilers: */
1032                 #if defined(__cplusplus)
1033                         }
1034                 #endif
1035
1036 #endif
1037
1038 /** @} */