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