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