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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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                          *  \ingroup Group_PipeRW_AVR8
 197                          *
 198                          *  \return Total number of bytes in the currently selected pipe's FIFO buffer.
 199                          */
 200                         static inline uint16_t Pipe_BytesInPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 201                         static inline uint16_t Pipe_BytesInPipe(void)
 202                         {
 203                                 return UPBCX;
 204                         }
 205
 206                         /** Returns the pipe address of the currently selected pipe. This is typically used to save the
 207                          *  currently selected pipe number so that it can be restored after another pipe has been manipulated.
 208                          *
 209                          *  \return Index of the currently selected pipe.
 210                          */
 211                         static inline uint8_t Pipe_GetCurrentPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 212                         static inline uint8_t Pipe_GetCurrentPipe(void)
 213                         {
 214                                 return (UPNUM & PIPE_PIPENUM_MASK);
 215                         }
 216
 217                         /** Selects the given pipe number. Any pipe operations which do not require the pipe number to be
 218                          *  indicated will operate on the currently selected pipe.
 219                          *
 220                          *  \param[in] PipeNumber  Index of the pipe to select.
 221                          */
 222                         static inline void Pipe_SelectPipe(const uint8_t PipeNumber) ATTR_ALWAYS_INLINE;
 223                         static inline void Pipe_SelectPipe(const uint8_t PipeNumber)
 224                         {
 225                                 UPNUM = PipeNumber;
 226                         }
 227
 228                         /** Resets the desired pipe, including the pipe banks and flags.
 229                          *
 230                          *  \param[in] PipeNumber  Index of the pipe to reset.
 231                          */
 232                         static inline void Pipe_ResetPipe(const uint8_t PipeNumber) ATTR_ALWAYS_INLINE;
 233                         static inline void Pipe_ResetPipe(const uint8_t PipeNumber)
 234                         {
 235                                 UPRST = (1 << PipeNumber);
 236                                 UPRST = 0;
 237                         }
 238
 239                         /** Enables the currently selected pipe so that data can be sent and received through it to and from
 240                          *  an attached device.
 241                          *
 242                          *  \pre The currently selected pipe must first be configured properly via \ref Pipe_ConfigurePipe().
 243                          */
 244                         static inline void Pipe_EnablePipe(void) ATTR_ALWAYS_INLINE;
 245                         static inline void Pipe_EnablePipe(void)
 246                         {
 247                                 UPCONX |= (1 << PEN);
 248                         }
 249
 250                         /** Disables the currently selected pipe so that data cannot be sent and received through it to and
 251                          *  from an attached device.
 252                          */
 253                         static inline void Pipe_DisablePipe(void) ATTR_ALWAYS_INLINE;
 254                         static inline void Pipe_DisablePipe(void)
 255                         {
 256                                 UPCONX &= ~(1 << PEN);
 257                         }
 258
 259                         /** Determines if the currently selected pipe is enabled, but not necessarily configured.
 260                          *
 261                          * \return Boolean \c true if the currently selected pipe is enabled, \c false otherwise.
 262                          */
 263                         static inline bool Pipe_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 264                         static inline bool Pipe_IsEnabled(void)
 265                         {
 266                                 return ((UPCONX & (1 << PEN)) ? true : false);
 267                         }
 268
 269                         /** Gets the current pipe token, indicating the pipe's data direction and type.
 270                          *
 271                          *  \return The current pipe token, as a \c PIPE_TOKEN_* mask.
 272                          */
 273                         static inline uint8_t Pipe_GetPipeToken(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 274                         static inline uint8_t Pipe_GetPipeToken(void)
 275                         {
 276                                 return (UPCFG0X & (0x03 << PTOKEN0));
 277                         }
 278
 279                         /** Sets the token for the currently selected pipe to one of the tokens specified by the \c PIPE_TOKEN_*
 280                          *  masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during
 281                          *  control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices
 282                          *  which have two endpoints of opposite direction sharing the same endpoint address within the device.
 283                          *
 284                          *  \param[in] Token  New pipe token to set the selected pipe to, as a \c PIPE_TOKEN_* mask.
 285                          */
 286                         static inline void Pipe_SetPipeToken(const uint8_t Token) ATTR_ALWAYS_INLINE;
 287                         static inline void Pipe_SetPipeToken(const uint8_t Token)
 288                         {
 289                                 UPCFG0X = ((UPCFG0X & ~(0x03 << PTOKEN0)) | Token);
 290                         }
 291
 292                         /** Configures the currently selected pipe to allow for an unlimited number of IN requests. */
 293                         static inline void Pipe_SetInfiniteINRequests(void) ATTR_ALWAYS_INLINE;
 294                         static inline void Pipe_SetInfiniteINRequests(void)
 295                         {
 296                                 UPCONX |= (1 << INMODE);
 297                         }
 298
 299                         /** Configures the currently selected pipe to only allow the specified number of IN requests to be
 300                          *  accepted by the pipe before it is automatically frozen.
 301                          *
 302                          *  \param[in] TotalINRequests  Total number of IN requests that the pipe may receive before freezing.
 303                          */
 304                         static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests) ATTR_ALWAYS_INLINE;
 305                         static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests)
 306                         {
 307                                 UPCONX &= ~(1 << INMODE);
 308                                 UPINRQX = TotalINRequests;
 309                         }
 310
 311                         /** Determines if the currently selected pipe is configured.
 312                          *
 313                          *  \return Boolean \c true if the selected pipe is configured, \c false otherwise.
 314                          */
 315                         static inline bool Pipe_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 316                         static inline bool Pipe_IsConfigured(void)
 317                         {
 318                                 return ((UPSTAX & (1 << CFGOK)) ? true : false);
 319                         }
 320
 321                         /** Retrieves the endpoint address of the endpoint within the attached device that the currently selected
 322                          *  pipe is bound to.
 323                          *
 324                          *  \return Endpoint address the currently selected pipe is bound to.
 325                          */
 326                         static inline uint8_t Pipe_GetBoundEndpointAddress(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 327                         static inline uint8_t Pipe_GetBoundEndpointAddress(void)
 328                         {
 329                                 return (((UPCFG0X >> PEPNUM0) & PIPE_EPNUM_MASK) |
 330                                         ((Pipe_GetPipeToken() == PIPE_TOKEN_IN) ? PIPE_EPDIR_MASK : 0));
 331                         }
 332
 333                         /** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.
 334                          *
 335                          *  \param[in] Milliseconds  Number of milliseconds between each pipe poll.
 336                          */
 337                         static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds) ATTR_ALWAYS_INLINE;
 338                         static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds)
 339                         {
 340                                 UPCFG2X = Milliseconds;
 341                         }
 342
 343                         /** Returns a mask indicating which pipe's interrupt periods have elapsed, indicating that the pipe should
 344                          *  be serviced.
 345                          *
 346                          *  \return Mask whose bits indicate which pipes have interrupted.
 347                          */
 348                         static inline uint8_t Pipe_GetPipeInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 349                         static inline uint8_t Pipe_GetPipeInterrupts(void)
 350                         {
 351                                 return UPINT;
 352                         }
 353
 354                         /** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type
 355                          *  pipes).
 356                          *
 357                          *  \param[in] PipeNumber  Index of the pipe whose interrupt flag should be tested.
 358                          *
 359                          *  \return Boolean \c true if the specified pipe has interrupted, \c false otherwise.
 360                          */
 361                         static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 362                         static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber)
 363                         {
 364                                 return ((UPINT & (1 << PipeNumber)) ? true : false);
 365                         }
 366
 367                         /** Unfreezes the selected pipe, allowing it to communicate with an attached device. */
 368                         static inline void Pipe_Unfreeze(void) ATTR_ALWAYS_INLINE;
 369                         static inline void Pipe_Unfreeze(void)
 370                         {
 371                                 UPCONX &= ~(1 << PFREEZE);
 372                         }
 373
 374                         /** Freezes the selected pipe, preventing it from communicating with an attached device. */
 375                         static inline void Pipe_Freeze(void) ATTR_ALWAYS_INLINE;
 376                         static inline void Pipe_Freeze(void)
 377                         {
 378                                 UPCONX |= (1 << PFREEZE);
 379                         }
 380
 381                         /** Determines if the currently selected pipe is frozen, and not able to accept data.
 382                          *
 383                          *  \return Boolean \c true if the currently selected pipe is frozen, \c false otherwise.
 384                          */
 385                         static inline bool Pipe_IsFrozen(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 386                         static inline bool Pipe_IsFrozen(void)
 387                         {
 388                                 return ((UPCONX & (1 << PFREEZE)) ? true : false);
 389                         }
 390
 391                         /** Clears the error flags for the currently selected pipe. */
 392                         static inline void Pipe_ClearError(void) ATTR_ALWAYS_INLINE;
 393                         static inline void Pipe_ClearError(void)
 394                         {
 395                                 UPERRX = 0;
 396                                 UPINTX &= ~(1 << PERRI);
 397                         }
 398
 399                         /** Determines if the master pipe error flag is set for the currently selected pipe, indicating that
 400                          *  some sort of hardware error has occurred on the pipe.
 401                          *
 402                          *  \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.
 403                          *
 404                          *  \return Boolean \c true if an error has occurred on the selected pipe, \c false otherwise.
 405                          */
 406                         static inline bool Pipe_IsError(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 407                         static inline bool Pipe_IsError(void)
 408                         {
 409                                 return ((UPINTX & (1 << PERRI)) ? true : false);
 410                         }
 411
 412                         /** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This
 413                          *  value can then be masked against the \c PIPE_ERRORFLAG_* masks to determine what error has occurred.
 414                          *
 415                          *  \return  Mask comprising of \c PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe.
 416                          */
 417                         static inline uint8_t Pipe_GetErrorFlags(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 418                         static inline uint8_t Pipe_GetErrorFlags(void)
 419                         {
 420                                 return ((UPERRX & (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT |
 421                                                    PIPE_ERRORFLAG_PID   | PIPE_ERRORFLAG_DATAPID |
 422                                                    PIPE_ERRORFLAG_DATATGL)) |
 423                                         (UPSTAX & (PIPE_ERRORFLAG_OVERFLOW | PIPE_ERRORFLAG_UNDERFLOW)));
 424                         }
 425
 426                         /** Retrieves the number of busy banks in the currently selected pipe, which have been queued for
 427                          *  transmission via the \ref Pipe_ClearOUT() command, or are awaiting acknowledgement via the
 428                          *  \ref Pipe_ClearIN() command.
 429                          *
 430                          *  \ingroup Group_PipePacketManagement_AVR8
 431                          *
 432                          *  \return Total number of busy banks in the selected pipe.
 433                          */
 434                         static inline uint8_t Pipe_GetBusyBanks(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 435                         static inline uint8_t Pipe_GetBusyBanks(void)
 436                         {
 437                                 return (UPSTAX & (0x03 << NBUSYBK0));
 438                         }
 439
 440                         /** Determines if the currently selected pipe may be read from (if data is waiting in the pipe
 441                          *  bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT
 442                          *  direction). This function will return false if an error has occurred in the pipe, or if the pipe
 443                          *  is an IN direction and no packet (or an empty packet) has been received, or if the pipe is an OUT
 444                          *  direction and the pipe bank is full.
 445                          *
 446                          *  \note This function is not valid on CONTROL type pipes.
 447                          *
 448                          *  \ingroup Group_PipePacketManagement_AVR8
 449                          *
 450                          *  \return Boolean \c true if the currently selected pipe may be read from or written to, depending
 451                          *          on its direction.
 452                          */
 453                         static inline bool Pipe_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 454                         static inline bool Pipe_IsReadWriteAllowed(void)
 455                         {
 456                                 return ((UPINTX & (1 << RWAL)) ? true : false);
 457                         }
 458
 459                         /** Determines if a packet has been received on the currently selected IN pipe from the attached device.
 460                          *
 461                          *  \ingroup Group_PipePacketManagement_AVR8
 462                          *
 463                          *  \return Boolean \c true if the current pipe has received an IN packet, \c false otherwise.
 464                          */
 465                         static inline bool Pipe_IsINReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 466                         static inline bool Pipe_IsINReceived(void)
 467                         {
 468                                 return ((UPINTX & (1 << RXINI)) ? true : false);
 469                         }
 470
 471                         /** Determines if the currently selected OUT pipe is ready to send an OUT packet to the attached device.
 472                          *
 473                          *  \ingroup Group_PipePacketManagement_AVR8
 474                          *
 475                          *  \return Boolean \c true if the current pipe is ready for an OUT packet, \c false otherwise.
 476                          */
 477                         static inline bool Pipe_IsOUTReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 478                         static inline bool Pipe_IsOUTReady(void)
 479                         {
 480                                 return ((UPINTX & (1 << TXOUTI)) ? true : false);
 481                         }
 482
 483                         /** Determines if no SETUP request is currently being sent to the attached device on the selected
 484                          *  CONTROL type pipe.
 485                          *
 486                          *  \ingroup Group_PipePacketManagement_AVR8
 487                          *
 488                          *  \return Boolean \c true if the current pipe is ready for a SETUP packet, \c false otherwise.
 489                          */
 490                         static inline bool Pipe_IsSETUPSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 491                         static inline bool Pipe_IsSETUPSent(void)
 492                         {
 493                                 return ((UPINTX & (1 << TXSTPI)) ? true : false);
 494                         }
 495
 496                         /** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.
 497                          *
 498                          *  \ingroup Group_PipePacketManagement_AVR8
 499                          */
 500                         static inline void Pipe_ClearSETUP(void) ATTR_ALWAYS_INLINE;
 501                         static inline void Pipe_ClearSETUP(void)
 502                         {
 503                                 UPINTX &= ~((1 << TXSTPI) | (1 << FIFOCON));
 504                         }
 505
 506                         /** Acknowledges the reception of a setup IN request from the attached device on the currently selected
 507                          *  pipe, freeing the bank ready for the next packet.
 508                          *
 509                          *  \ingroup Group_PipePacketManagement_AVR8
 510                          */
 511                         static inline void Pipe_ClearIN(void) ATTR_ALWAYS_INLINE;
 512                         static inline void Pipe_ClearIN(void)
 513                         {
 514                                 UPINTX &= ~((1 << RXINI) | (1 << FIFOCON));
 515                         }
 516
 517                         /** Sends the currently selected pipe's contents to the device as an OUT packet on the selected pipe, freeing
 518                          *  the bank ready for the next packet.
 519                          *
 520                          *  \ingroup Group_PipePacketManagement_AVR8
 521                          */
 522                         static inline void Pipe_ClearOUT(void) ATTR_ALWAYS_INLINE;
 523                         static inline void Pipe_ClearOUT(void)
 524                         {
 525                                 UPINTX &= ~((1 << TXOUTI) | (1 << FIFOCON));
 526                         }
 527
 528                         /** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on
 529                          *  the currently selected pipe. This occurs when the host sends a packet to the device, but the device
 530                          *  is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been
 531                          *  received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet
 532                          *  can be re-sent.
 533                          *
 534                          *  \ingroup Group_PipePacketManagement_AVR8
 535                          *
 536                          *  \return Boolean \c true if an NAK has been received on the current pipe, \c false otherwise.
 537                          */
 538                         static inline bool Pipe_IsNAKReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 539                         static inline bool Pipe_IsNAKReceived(void)
 540                         {
 541                                 return ((UPINTX & (1 << NAKEDI)) ? true : false);
 542                         }
 543
 544                         /** Clears the NAK condition on the currently selected pipe.
 545                          *
 546                          *  \ingroup Group_PipePacketManagement_AVR8
 547                          *
 548                          *  \see \ref Pipe_IsNAKReceived() for more details.
 549                          */
 550                         static inline void Pipe_ClearNAKReceived(void) ATTR_ALWAYS_INLINE;
 551                         static inline void Pipe_ClearNAKReceived(void)
 552                         {
 553                                 UPINTX &= ~(1 << NAKEDI);
 554                         }
 555
 556                         /** Determines if the currently selected pipe has had the STALL condition set by the attached device.
 557                          *
 558                          *  \ingroup Group_PipePacketManagement_AVR8
 559                          *
 560                          *  \return Boolean \c true if the current pipe has been stalled by the attached device, \c false otherwise.
 561                          */
 562                         static inline bool Pipe_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 563                         static inline bool Pipe_IsStalled(void)
 564                         {
 565                                 return ((UPINTX & (1 << RXSTALLI)) ? true : false);
 566                         }
 567
 568                         /** Clears the STALL condition detection flag on the currently selected pipe, but does not clear the
 569                          *  STALL condition itself (this must be done via a ClearFeature control request to the device).
 570                          *
 571                          *  \ingroup Group_PipePacketManagement_AVR8
 572                          */
 573                         static inline void Pipe_ClearStall(void) ATTR_ALWAYS_INLINE;
 574                         static inline void Pipe_ClearStall(void)
 575                         {
 576                                 UPINTX &= ~(1 << RXSTALLI);
 577                         }
 578
 579                         /** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.
 580                          *
 581                          *  \ingroup Group_PipePrimitiveRW_AVR8
 582                          *
 583                          *  \return Next byte in the currently selected pipe's FIFO buffer.
 584                          */
 585                         static inline uint8_t Pipe_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 586                         static inline uint8_t Pipe_Read_8(void)
 587                         {
 588                                 return UPDATX;
 589                         }
 590
 591                         /** Writes one byte to the currently selected pipe's bank, for IN direction pipes.
 592                          *
 593                          *  \ingroup Group_PipePrimitiveRW_AVR8
 594                          *
 595                          *  \param[in] Data  Data to write into the the currently selected pipe's FIFO buffer.
 596                          */
 597                         static inline void Pipe_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
 598                         static inline void Pipe_Write_8(const uint8_t Data)
 599                         {
 600                                 UPDATX = Data;
 601                         }
 602
 603                         /** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.
 604                          *
 605                          *  \ingroup Group_PipePrimitiveRW_AVR8
 606                          */
 607                         static inline void Pipe_Discard_8(void) ATTR_ALWAYS_INLINE;
 608                         static inline void Pipe_Discard_8(void)
 609                         {
 610                                 uint8_t Dummy;
 611
 612                                 Dummy = UPDATX;
 613
 614                                 (void)Dummy;
 615                         }
 616
 617                         /** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT
 618                          *  direction pipes.
 619                          *
 620                          *  \ingroup Group_PipePrimitiveRW_AVR8
 621                          *
 622                          *  \return Next two bytes in the currently selected pipe's FIFO buffer.
 623                          */
 624                         static inline uint16_t Pipe_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 625                         static inline uint16_t Pipe_Read_16_LE(void)
 626                         {
 627                                 union
 628                                 {
 629                                         uint16_t Value;
 630                                         uint8_t  Bytes[2];
 631                                 } Data;
 632
 633                                 Data.Bytes[0] = UPDATX;
 634                                 Data.Bytes[1] = UPDATX;
 635
 636                                 return Data.Value;
 637                         }
 638
 639                         /** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT
 640                          *  direction pipes.
 641                          *
 642                          *  \ingroup Group_PipePrimitiveRW_AVR8
 643                          *
 644                          *  \return Next two bytes in the currently selected pipe's FIFO buffer.
 645                          */
 646                         static inline uint16_t Pipe_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 647                         static inline uint16_t Pipe_Read_16_BE(void)
 648                         {
 649                                 union
 650                                 {
 651                                         uint16_t Value;
 652                                         uint8_t  Bytes[2];
 653                                 } Data;
 654
 655                                 Data.Bytes[1] = UPDATX;
 656                                 Data.Bytes[0] = UPDATX;
 657
 658                                 return Data.Value;
 659                         }
 660
 661                         /** Writes two bytes to the currently selected pipe's bank in little endian format, for IN
 662                          *  direction pipes.
 663                          *
 664                          *  \ingroup Group_PipePrimitiveRW_AVR8
 665                          *
 666                          *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
 667                          */
 668                         static inline void Pipe_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 669                         static inline void Pipe_Write_16_LE(const uint16_t Data)
 670                         {
 671                                 UPDATX = (Data & 0xFF);
 672                                 UPDATX = (Data >> 8);
 673                         }
 674
 675                         /** Writes two bytes to the currently selected pipe's bank in big endian format, for IN
 676                          *  direction pipes.
 677                          *
 678                          *  \ingroup Group_PipePrimitiveRW_AVR8
 679                          *
 680                          *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
 681                          */
 682                         static inline void Pipe_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
 683                         static inline void Pipe_Write_16_BE(const uint16_t Data)
 684                         {
 685                                 UPDATX = (Data >> 8);
 686                                 UPDATX = (Data & 0xFF);
 687                         }
 688
 689                         /** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.
 690                          *
 691                          *  \ingroup Group_PipePrimitiveRW_AVR8
 692                          */
 693                         static inline void Pipe_Discard_16(void) ATTR_ALWAYS_INLINE;
 694                         static inline void Pipe_Discard_16(void)
 695                         {
 696                                 uint8_t Dummy;
 697
 698                                 Dummy = UPDATX;
 699                                 Dummy = UPDATX;
 700
 701                                 (void)Dummy;
 702                         }
 703
 704                         /** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT
 705                          *  direction pipes.
 706                          *
 707                          *  \ingroup Group_PipePrimitiveRW_AVR8
 708                          *
 709                          *  \return Next four bytes in the currently selected pipe's FIFO buffer.
 710                          */
 711                         static inline uint32_t Pipe_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 712                         static inline uint32_t Pipe_Read_32_LE(void)
 713                         {
 714                                 union
 715                                 {
 716                                         uint32_t Value;
 717                                         uint8_t  Bytes[4];
 718                                 } Data;
 719
 720                                 Data.Bytes[0] = UPDATX;
 721                                 Data.Bytes[1] = UPDATX;
 722                                 Data.Bytes[2] = UPDATX;
 723                                 Data.Bytes[3] = UPDATX;
 724
 725                                 return Data.Value;
 726                         }
 727
 728                         /** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT
 729                          *  direction pipes.
 730                          *
 731                          *  \ingroup Group_PipePrimitiveRW_AVR8
 732                          *
 733                          *  \return Next four bytes in the currently selected pipe's FIFO buffer.
 734                          */
 735                         static inline uint32_t Pipe_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
 736                         static inline uint32_t Pipe_Read_32_BE(void)
 737                         {
 738                                 union
 739                                 {
 740                                         uint32_t DWord;
 741                                         uint8_t  Bytes[4];
 742                                 } Data;
 743
 744                                 Data.Bytes[3] = UPDATX;
 745                                 Data.Bytes[2] = UPDATX;
 746                                 Data.Bytes[1] = UPDATX;
 747                                 Data.Bytes[0] = UPDATX;
 748
 749                                 return Data.DWord;
 750                         }
 751
 752                         /** Writes four bytes to the currently selected pipe's bank in little endian format, for IN
 753                          *  direction pipes.
 754                          *
 755                          *  \ingroup Group_PipePrimitiveRW_AVR8
 756                          *
 757                          *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
 758                          */
 759                         static inline void Pipe_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 760                         static inline void Pipe_Write_32_LE(const uint32_t Data)
 761                         {
 762                                 UPDATX = (Data &  0xFF);
 763                                 UPDATX = (Data >> 8);
 764                                 UPDATX = (Data >> 16);
 765                                 UPDATX = (Data >> 24);
 766                         }
 767
 768                         /** Writes four bytes to the currently selected pipe's bank in big endian format, for IN
 769                          *  direction pipes.
 770                          *
 771                          *  \ingroup Group_PipePrimitiveRW_AVR8
 772                          *
 773                          *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
 774                          */
 775                         static inline void Pipe_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
 776                         static inline void Pipe_Write_32_BE(const uint32_t Data)
 777                         {
 778                                 UPDATX = (Data >> 24);
 779                                 UPDATX = (Data >> 16);
 780                                 UPDATX = (Data >> 8);
 781                                 UPDATX = (Data &  0xFF);
 782                         }
 783
 784                         /** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.
 785                          *
 786                          *  \ingroup Group_PipePrimitiveRW_AVR8
 787                          */
 788                         static inline void Pipe_Discard_32(void) ATTR_ALWAYS_INLINE;
 789                         static inline void Pipe_Discard_32(void)
 790                         {
 791                                 uint8_t Dummy;
 792
 793                                 Dummy = UPDATX;
 794                                 Dummy = UPDATX;
 795                                 Dummy = UPDATX;
 796                                 Dummy = UPDATX;
 797
 798                                 (void)Dummy;
 799                         }
 800
 801                 /* External Variables: */
 802                         /** Global indicating the maximum packet size of the default control pipe located at address
 803                          *  0 in the device. This value is set to the value indicated in the attached device's device
 804                      *  descriptor once the USB interface is initialized into host mode and a device is attached
 805                          *  to the USB bus.
 806                          *
 807                          *  \attention This variable should be treated as read-only in the user application, and never manually
 808                          *             changed in value.
 809                          */
 810                         extern uint8_t USB_Host_ControlPipeSize;
 811
 812                 /* Function Prototypes: */
 813                         /** Configures the specified pipe number with the given pipe type, token, target endpoint number in the
 814                          *  attached device, bank size and banking mode.
 815                          *
 816                          *  A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()
 817                          *  before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or
 818                          *  sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite
 819                          *  numbers of IN requests without automatic freezing - this can be overridden by a call to
 820                          *  \ref Pipe_SetFiniteINRequests().
 821                          *
 822                          *  \param[in] Number          Pipe number to configure. This must be more than 0 and less than \ref PIPE_TOTAL_PIPES.
 823                          *
 824                          *  \param[in] Type            Type of pipe to configure, an \c EP_TYPE_* mask. Not all pipe types are available on Low
 825                          *                             Speed USB devices - refer to the USB 2.0 specification.
 826                          *
 827                          *  \param[in] Token           Pipe data token, either \ref PIPE_TOKEN_SETUP, \ref PIPE_TOKEN_OUT or \ref PIPE_TOKEN_IN.
 828                          *                             All pipes (except Control type) are unidirectional - data may only be read from or
 829                          *                             written to the pipe bank based on its direction, not both.
 830                          *
 831                          *  \param[in] EndpointNumber  Endpoint index within the attached device that the pipe should interface to.
 832                          *
 833                          *  \param[in] Size            Size of the pipe's bank, where packets are stored before they are transmitted to
 834                          *                             the USB device, or after they have been received from the USB device (depending on
 835                          *                             the pipe's data direction). The bank size must indicate the maximum packet size that
 836                          *                             the pipe can handle.
 837                          *
 838                          *  \param[in] Banks           Number of banks to use for the pipe being configured, a \c PIPE_BANK_* mask. More banks
 839                          *                             uses more USB DPRAM, but offers better performance. Isochronous type pipes <b>must</b>
 840                          *                             have at least two banks.
 841                          *
 842                          *  \attention When the \c ORDERED_EP_CONFIG compile time option is used, Pipes <b>must</b> be configured in ascending order,
 843                          *             or bank corruption will occur.
 844                          *
 845                          *  \note Certain microcontroller model's pipes may have different maximum packet sizes based on the pipe's
 846                          *        index - refer to the chosen microcontroller's datasheet to determine the maximum bank size for each pipe.
 847                          *        \n\n
 848                          *
 849                          *  \note The default control pipe should not be manually configured by the user application, as it is
 850                          *        automatically configured by the library internally.
 851                          *        \n\n
 852                          *
 853                          *  \note This routine will automatically select the specified pipe upon success. Upon failure, the pipe which
 854                          *        failed to reconfigure correctly will be selected.
 855                          *
 856                          *  \return Boolean \c true if the configuration succeeded, \c false otherwise.
 857                          */
 858                         bool Pipe_ConfigurePipe(const uint8_t Number,
 859                                                 const uint8_t Type,
 860                                                 const uint8_t Token,
 861                                                 const uint8_t EndpointNumber,
 862                                                 const uint16_t Size,
 863                                                 const uint8_t Banks);
 864
 865                         /** Spin-loops until the currently selected non-control pipe is ready for the next packet of data to be read
 866                          *  or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).
 867                          *
 868                          *  \ingroup Group_PipeRW_AVR8
 869                          *
 870                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 871                          */
 872                         uint8_t Pipe_WaitUntilReady(void);
 873
 874                         /** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given
 875                          *  endpoint is found, it is automatically selected.
 876                          *
 877                          *  \param[in] EndpointAddress Address and direction mask of the endpoint within the attached device to check.
 878                          *
 879                          *  \return Boolean \c true if a pipe bound to the given endpoint address of the specified direction is found,
 880                          *          \c false otherwise.
 881                          */
 882                         bool Pipe_IsEndpointBound(const uint8_t EndpointAddress) ATTR_WARN_UNUSED_RESULT;
 883
 884         /* Private Interface - For use in library only: */
 885         #if !defined(__DOXYGEN__)
 886                 /* Macros: */
 887                         #if !defined(ENDPOINT_CONTROLEP)
 888                                 #define ENDPOINT_CONTROLEP          0
 889                         #endif
 890
 891                 /* Inline Functions: */
 892                         static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
 893                         static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes)
 894                         {
 895                                 uint8_t  MaskVal    = 0;
 896                                 uint16_t CheckBytes = 8;
 897
 898                                 while ((CheckBytes < Bytes) && (CheckBytes < PIPE_MAX_SIZE))
 899                                 {
 900                                         MaskVal++;
 901                                         CheckBytes <<= 1;
 902                                 }
 903
 904                                 return (MaskVal << EPSIZE0);
 905                         }
 906
 907                 /* Function Prototypes: */
 908                         void Pipe_ClearPipes(void);
 909         #endif
 910
 911         /* Disable C linkage for C++ Compilers: */
 912                 #if defined(__cplusplus)
 913                         }
 914                 #endif
 915
 916 #endif
 917
 918 /** @} */
 919