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