LUFA/Drivers/USB/LowLevel/Pipe.h

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