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