LUFA/Drivers/USB/LowLevel/Pipe.h

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