LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h

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