tmk_core/protocol/lufa/LUFA-git/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h

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