LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h

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