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