Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Core / UC3 / Pipe_UC3.h @ 978b99e5

History | View | Annotate | Download (39.5 KB)

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
                        #if defined(USB_SERIES_UC3A3_AVR32) || defined(USB_SERIES_UC3A4_AVR32) || defined(__DOXYGEN__)
166
                                /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the
167
                                 *  pipe should have three banks, which requires more USB FIFO memory but results in faster transfers
168
                                 *  as one USB device (the AVR or the attached device) can access one bank while the other accesses the
169
                                 *  remaining banks.
170
                                 *
171
                                 *  \note Not available on all AVR models.
172
                                 */
173
                                #define PIPE_BANK_TRIPLE           AVR32_USBB_UPCFG0_PBK_TRIPLE
174
                        #endif
175
                        //@}
176

    
177
                        /** Default size of the default control pipe's bank, until altered by the Endpoint0Size value
178
                         *  in the device descriptor of the attached device.
179
                         */
180
                        #define PIPE_CONTROLPIPE_DEFAULT_SIZE   64
181

    
182
                        #if defined(USB_SERIES_UC3A3_AVR32) || defined(USB_SERIES_UC3A4_AVR32) || defined(__DOXYGEN__)
183
                                /** Total number of pipes (including the default control pipe at address 0) which may be used in
184
                                 *  the device.
185
                                 */
186
                                #define PIPE_TOTAL_PIPES            8
187
                        #else
188
                                #define PIPE_TOTAL_PIPES            7                        
189
                        #endif
190

    
191
                        /** Size in bytes of the largest pipe bank size possible in the device. Not all banks on each AVR
192
                         *  model supports the largest bank size possible on the device; different pipe numbers support
193
                         *  different maximum bank sizes. This value reflects the largest possible bank of any pipe on the
194
                         *  currently selected UC3 AVR model.
195
                         */
196
                        #define PIPE_MAX_SIZE                   256
197

    
198
                /* Enums: */
199
                        /** Enum for the possible error return codes of the \ref Pipe_WaitUntilReady() function.
200
                         *
201
                         *  \ingroup Group_PipeRW_UC3
202
                         */
203
                        enum Pipe_WaitUntilReady_ErrorCodes_t
204
                        {
205
                                PIPE_READYWAIT_NoError                 = 0, /**< Pipe ready for next packet, no error. */
206
                                PIPE_READYWAIT_PipeStalled             = 1,        /**< The device stalled the pipe while waiting. */
207
                                PIPE_READYWAIT_DeviceDisconnected      = 2,        /**< Device was disconnected from the host while waiting. */
208
                                PIPE_READYWAIT_Timeout                 = 3, /**< The device failed to accept or send the next packet
209
                                                                             *   within the software timeout period set by the
210
                                                                             *   \ref USB_STREAM_TIMEOUT_MS macro.
211
                                                                             */
212
                        };
213

    
214
                /* Inline Functions: */
215
                        /** Indicates the number of bytes currently stored in the current pipes's selected bank.
216
                         *
217
                         *  \note The return width of this function may differ, depending on the maximum pipe bank size
218
                         *        of the selected AVR model.
219
                         *
220
                         *  \ingroup Group_PipeRW_UC3
221
                         *
222
                         *  \return Total number of bytes in the currently selected pipe's FIFO buffer.
223
                         */
224
                        static inline uint16_t Pipe_BytesInPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
225
                        static inline uint16_t Pipe_BytesInPipe(void)
226
                        {
227
                                return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].pbyct;
228
                        }
229

    
230
                        /** Returns the pipe address of the currently selected pipe. This is typically used to save the
231
                         *  currently selected pipe number so that it can be restored after another pipe has been manipulated.
232
                         *
233
                         *  \return Index of the currently selected pipe.
234
                         */
235
                        static inline uint8_t Pipe_GetCurrentPipe(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
236
                        static inline uint8_t Pipe_GetCurrentPipe(void)
237
                        {
238
                                return USB_SelectedPipe;
239
                        }
240

    
241
                        /** Selects the given pipe number. Any pipe operations which do not require the pipe number to be
242
                         *  indicated will operate on the currently selected pipe.
243
                         *
244
                         *  \param[in] PipeNumber  Index of the pipe to select.
245
                         */
246
                        static inline void Pipe_SelectPipe(const uint8_t PipeNumber) ATTR_ALWAYS_INLINE;
247
                        static inline void Pipe_SelectPipe(const uint8_t PipeNumber)
248
                        {
249
                                USB_SelectedPipe = PipeNumber;
250
                        }
251

    
252
                        /** Resets the desired pipe, including the pipe banks and flags.
253
                         *
254
                         *  \param[in] PipeNumber  Index of the pipe to reset.
255
                         */
256
                        static inline void Pipe_ResetPipe(const uint8_t PipeNumber) ATTR_ALWAYS_INLINE;
257
                        static inline void Pipe_ResetPipe(const uint8_t PipeNumber)
258
                        {
259
                                AVR32_USBB.uprst |=  (AVR32_USBB_PRST0_MASK << PipeNumber);
260
                                AVR32_USBB.uprst &= ~(AVR32_USBB_PRST0_MASK << PipeNumber);
261
                                USB_PipeFIFOPos[USB_SelectedPipe] = &AVR32_USBB_SLAVE[USB_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
262
                        }
263

    
264
                        /** Enables the currently selected pipe so that data can be sent and received through it to and from
265
                         *  an attached device.
266
                         *
267
                         *  \pre The currently selected pipe must first be configured properly via \ref Pipe_ConfigurePipe().
268
                         */
269
                        static inline void Pipe_EnablePipe(void) ATTR_ALWAYS_INLINE;
270
                        static inline void Pipe_EnablePipe(void)
271
                        {
272
                                AVR32_USBB.uprst |=  (AVR32_USBB_PEN0_MASK << USB_SelectedPipe);
273
                        }
274

    
275
                        /** Disables the currently selected pipe so that data cannot be sent and received through it to and
276
                         *  from an attached device.
277
                         */
278
                        static inline void Pipe_DisablePipe(void) ATTR_ALWAYS_INLINE;
279
                        static inline void Pipe_DisablePipe(void)
280
                        {
281
                                AVR32_USBB.uprst &= ~(AVR32_USBB_PEN0_MASK << USB_SelectedPipe);
282
                        }
283

    
284
                        /** Determines if the currently selected pipe is enabled, but not necessarily configured.
285
                         *
286
                         * \return Boolean \c true if the currently selected pipe is enabled, \c false otherwise.
287
                         */
288
                        static inline bool Pipe_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
289
                        static inline bool Pipe_IsEnabled(void)
290
                        {
291
                                return ((AVR32_USBB.uprst & (AVR32_USBB_PEN0_MASK << USB_SelectedPipe)) ? true : false);
292
                        }
293

    
294
                        /** Gets the current pipe token, indicating the pipe's data direction and type.
295
                         *
296
                         *  \return The current pipe token, as a \c PIPE_TOKEN_* mask.
297
                         */
298
                        static inline uint8_t Pipe_GetPipeToken(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
299
                        static inline uint8_t Pipe_GetPipeToken(void)
300
                        {
301
                                return (&AVR32_USBB.UPCFG0)[USB_SelectedPipe].ptoken;
302
                        }
303

    
304
                        /** Sets the token for the currently selected pipe to one of the tokens specified by the \c PIPE_TOKEN_*
305
                         *  masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during
306
                         *  control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices
307
                         *  which have two endpoints of opposite direction sharing the same endpoint address within the device.
308
                         *
309
                         *  \param[in] Token  New pipe token to set the selected pipe to, as a \c PIPE_TOKEN_* mask.
310
                         */
311
                        static inline void Pipe_SetPipeToken(const uint8_t Token) ATTR_ALWAYS_INLINE;
312
                        static inline void Pipe_SetPipeToken(const uint8_t Token)
313
                        {
314
                                (&AVR32_USBB.UPCFG0)[USB_SelectedPipe].ptoken = Token;
315
                        }
316

    
317
                        /** Configures the currently selected pipe to allow for an unlimited number of IN requests. */
318
                        static inline void Pipe_SetInfiniteINRequests(void) ATTR_ALWAYS_INLINE;
319
                        static inline void Pipe_SetInfiniteINRequests(void)
320
                        {
321
                                (&AVR32_USBB.UPINRQ0)[USB_SelectedPipe].inmode = true;
322
                        }
323

    
324
                        /** Configures the currently selected pipe to only allow the specified number of IN requests to be
325
                         *  accepted by the pipe before it is automatically frozen.
326
                         *
327
                         *  \param[in] TotalINRequests  Total number of IN requests that the pipe may receive before freezing.
328
                         */
329
                        static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests) ATTR_ALWAYS_INLINE;
330
                        static inline void Pipe_SetFiniteINRequests(const uint8_t TotalINRequests)
331
                        {
332
                                (&AVR32_USBB.UPINRQ0)[USB_SelectedPipe].inmode = false;
333
                                (&AVR32_USBB.UPINRQ0)[USB_SelectedPipe].inrq   = TotalINRequests;
334
                        }
335

    
336
                        /** Determines if the currently selected pipe is configured.
337
                         *
338
                         *  \return Boolean \c true if the selected pipe is configured, \c false otherwise.
339
                         */
340
                        static inline bool Pipe_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
341
                        static inline bool Pipe_IsConfigured(void)
342
                        {
343
                                return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].cfgok;
344
                        }
345

    
346
                        /** Retrieves the endpoint address of the endpoint within the attached device that the currently selected
347
                         *  pipe is bound to.
348
                         *
349
                         *  \return Endpoint address the currently selected pipe is bound to.
350
                         */
351
                        static inline uint8_t Pipe_GetBoundEndpointAddress(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
352
                        static inline uint8_t Pipe_GetBoundEndpointAddress(void)
353
                        {
354
                                return ((&AVR32_USBB.UPCFG0)[USB_SelectedPipe].pepnum |
355
                                        ((Pipe_GetPipeToken() == PIPE_TOKEN_IN) ? PIPE_EPDIR_MASK : 0));
356
                        }
357

    
358
                        /** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.
359
                         *
360
                         *  \param[in] Milliseconds  Number of milliseconds between each pipe poll.
361
                         */
362
                        static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds) ATTR_ALWAYS_INLINE;
363
                        static inline void Pipe_SetInterruptPeriod(const uint8_t Milliseconds)
364
                        {
365
                                (&AVR32_USBB.UPCFG0)[USB_SelectedPipe].intfrq = Milliseconds;
366
                        }
367

    
368
                        /** Returns a mask indicating which pipe's interrupt periods have elapsed, indicating that the pipe should
369
                         *  be serviced.
370
                         *
371
                         *  \return Mask whose bits indicate which pipes have interrupted.
372
                         */
373
                        static inline uint8_t Pipe_GetPipeInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
374
                        static inline uint8_t Pipe_GetPipeInterrupts(void)
375
                        {
376
                                return ((AVR32_USBB.uhint & (AVR32_USBB_P6INT_MASK | AVR32_USBB_P5INT_MASK |
377
                                                             AVR32_USBB_P4INT_MASK | AVR32_USBB_P3INT_MASK |
378
                                                             AVR32_USBB_P2INT_MASK | AVR32_USBB_P1INT_MASK |
379
                                                             AVR32_USBB_P0INT_MASK)) >> AVR32_USBB_P0INT_OFFSET);
380
                        }
381

    
382
                        /** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type
383
                         *  pipes).
384
                         *
385
                         *  \param[in] PipeNumber  Index of the pipe whose interrupt flag should be tested.
386
                         *
387
                         *  \return Boolean \c true if the specified pipe has interrupted, \c false otherwise.
388
                         */
389
                        static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
390
                        static inline bool Pipe_HasPipeInterrupted(const uint8_t PipeNumber)
391
                        {
392
                                return ((AVR32_USBB.uhint & (AVR32_USBB_P0INTES_MASK << USB_SelectedPipe)) ? true : false);
393
                        }
394

    
395
                        /** Unfreezes the selected pipe, allowing it to communicate with an attached device. */
396
                        static inline void Pipe_Unfreeze(void) ATTR_ALWAYS_INLINE;
397
                        static inline void Pipe_Unfreeze(void)
398
                        {
399
                                (&AVR32_USBB.UPCON0CLR)[USB_SelectedPipe].pfreezec = true;
400
                        }
401

    
402
                        /** Freezes the selected pipe, preventing it from communicating with an attached device. */
403
                        static inline void Pipe_Freeze(void) ATTR_ALWAYS_INLINE;
404
                        static inline void Pipe_Freeze(void)
405
                        {
406
                                (&AVR32_USBB.UPCON0SET)[USB_SelectedPipe].pfreezes = true;
407
                        }
408

    
409
                        /** Determines if the currently selected pipe is frozen, and not able to accept data.
410
                         *
411
                         *  \return Boolean \c true if the currently selected pipe is frozen, \c false otherwise.
412
                         */
413
                        static inline bool Pipe_IsFrozen(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
414
                        static inline bool Pipe_IsFrozen(void)
415
                        {
416
                                return (((&AVR32_USBB.UPCON0)[USB_SelectedPipe].pfreeze) ? true : false);
417
                        }
418

    
419
                        /** Clears the error flags for the currently selected pipe. */
420
                        static inline void Pipe_ClearError(void) ATTR_ALWAYS_INLINE;
421
                        static inline void Pipe_ClearError(void)
422
                        {
423
                                (&AVR32_USBB.uperr0)[USB_SelectedPipe] = 0;
424
                                (&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].overfic  = true;
425
                        }
426

    
427
                        /** Determines if the master pipe error flag is set for the currently selected pipe, indicating that
428
                         *  some sort of hardware error has occurred on the pipe.
429
                         *
430
                         *  \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.
431
                         *
432
                         *  \return Boolean \c true if an error has occurred on the selected pipe, \c false otherwise.
433
                         */
434
                        static inline bool Pipe_IsError(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
435
                        static inline bool Pipe_IsError(void)
436
                        {
437
                                return (((&AVR32_USBB.upsta0)[USB_SelectedPipe] &
438
                                        (AVR32_USBB_PERRI_MASK | AVR32_USBB_OVERFI_MASK)) ? true : false);
439
                        }
440

    
441
                        /** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This
442
                         *  value can then be masked against the \c PIPE_ERRORFLAG_* masks to determine what error has occurred.
443
                         *
444
                         *  \return  Mask comprising of \c PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe.
445
                         */
446
                        static inline uint8_t Pipe_GetErrorFlags(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
447
                        static inline uint8_t Pipe_GetErrorFlags(void)
448
                        {
449
                                
450
                                return (((&AVR32_USBB.uperr0)[USB_SelectedPipe] &
451
                                        (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT |
452
                                         PIPE_ERRORFLAG_PID   | PIPE_ERRORFLAG_DATAPID |
453
                                         PIPE_ERRORFLAG_DATATGL)) |
454
                                        (((&AVR32_USBB.upsta0)[USB_SelectedPipe] << 8) &
455
                                                 PIPE_ERRORFLAG_OVERFLOW));
456
                        }
457
                        
458
                        /** Retrieves the number of busy banks in the currently selected pipe, which have been queued for
459
                         *  transmission via the \ref Pipe_ClearOUT() command, or are awaiting acknowledgement via the
460
                         *  \ref Pipe_ClearIN() command.
461
                         *
462
                         *  \ingroup Group_PipePacketManagement_UC3
463
                         *
464
                         *  \return Total number of busy banks in the selected pipe.
465
                         */
466
                        static inline uint8_t Pipe_GetBusyBanks(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
467
                        static inline uint8_t Pipe_GetBusyBanks(void)
468
                        {
469
                                return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].nbusybk;
470
                        }
471

    
472
                        /** Determines if the currently selected pipe may be read from (if data is waiting in the pipe
473
                         *  bank and the pipe is an IN direction, or if the bank is not yet full if the pipe is an OUT
474
                         *  direction). This function will return false if an error has occurred in the pipe, or if the pipe
475
                         *  is an IN direction and no packet (or an empty packet) has been received, or if the pipe is an OUT
476
                         *  direction and the pipe bank is full.
477
                         *
478
                         *  \note This function is not valid on CONTROL type pipes.
479
                         *
480
                         *  \ingroup Group_PipePacketManagement_UC3
481
                         *
482
                         *  \return Boolean \c true if the currently selected pipe may be read from or written to, depending
483
                         *          on its direction.
484
                         */
485
                        static inline bool Pipe_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
486
                        static inline bool Pipe_IsReadWriteAllowed(void)
487
                        {
488
                                return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].rwall;
489
                        }
490

    
491
                        /** Determines if a packet has been received on the currently selected IN pipe from the attached device.
492
                         *
493
                         *  \ingroup Group_PipePacketManagement_UC3
494
                         *
495
                         *  \return Boolean \c true if the current pipe has received an IN packet, \c false otherwise.
496
                         */
497
                        static inline bool Pipe_IsINReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
498
                        static inline bool Pipe_IsINReceived(void)
499
                        {
500
                                return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].rxini;
501
                        }
502

    
503
                        /** Determines if the currently selected OUT pipe is ready to send an OUT packet to the attached device.
504
                         *
505
                         *  \ingroup Group_PipePacketManagement_UC3
506
                         *
507
                         *  \return Boolean \c true if the current pipe is ready for an OUT packet, \c false otherwise.
508
                         */
509
                        static inline bool Pipe_IsOUTReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
510
                        static inline bool Pipe_IsOUTReady(void)
511
                        {
512
                                return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].txouti;
513
                        }
514

    
515
                        /** Determines if no SETUP request is currently being sent to the attached device on the selected
516
                         *  CONTROL type pipe.
517
                         *
518
                         *  \ingroup Group_PipePacketManagement_UC3
519
                         *
520
                         *  \return Boolean \c true if the current pipe is ready for a SETUP packet, \c false otherwise.
521
                         */
522
                        static inline bool Pipe_IsSETUPSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
523
                        static inline bool Pipe_IsSETUPSent(void)
524
                        {
525
                                return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].txstpi;
526
                        }
527

    
528
                        /** Sends the currently selected CONTROL type pipe's contents to the device as a SETUP packet.
529
                         *
530
                         *  \ingroup Group_PipePacketManagement_UC3
531
                         */
532
                        static inline void Pipe_ClearSETUP(void) ATTR_ALWAYS_INLINE;
533
                        static inline void Pipe_ClearSETUP(void)
534
                        {
535
                                (&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].txstpic = true;
536
                                USB_PipeFIFOPos[USB_SelectedPipe] = &AVR32_USBB_SLAVE[USB_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
537
                        }
538

    
539
                        /** Acknowledges the reception of a setup IN request from the attached device on the currently selected
540
                         *  pipe, freeing the bank ready for the next packet.
541
                         *
542
                         *  \ingroup Group_PipePacketManagement_UC3
543
                         */
544
                        static inline void Pipe_ClearIN(void) ATTR_ALWAYS_INLINE;
545
                        static inline void Pipe_ClearIN(void)
546
                        {
547
                                (&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].rxinic   = true;
548
                                (&AVR32_USBB.UPCON0CLR)[USB_SelectedPipe].fifoconc = true;
549
                                USB_PipeFIFOPos[USB_SelectedPipe] = &AVR32_USBB_SLAVE[USB_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
550
                        }
551

    
552
                        /** Sends the currently selected pipe's contents to the device as an OUT packet on the selected pipe, freeing
553
                         *  the bank ready for the next packet.
554
                         *
555
                         *  \ingroup Group_PipePacketManagement_UC3
556
                         */
557
                        static inline void Pipe_ClearOUT(void) ATTR_ALWAYS_INLINE;
558
                        static inline void Pipe_ClearOUT(void)
559
                        {
560
                                (&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].txoutic  = true;
561
                                (&AVR32_USBB.UPCON0CLR)[USB_SelectedPipe].fifoconc = true;
562
                                USB_PipeFIFOPos[USB_SelectedPipe] = &AVR32_USBB_SLAVE[USB_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
563
                        }
564

    
565
                        /** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on
566
                         *  the currently selected pipe. This occurs when the host sends a packet to the device, but the device
567
                         *  is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been
568
                         *  received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet
569
                         *  can be re-sent.
570
                         *
571
                         *  \ingroup Group_PipePacketManagement_UC3
572
                         *
573
                         *  \return Boolean \c true if an NAK has been received on the current pipe, \c false otherwise.
574
                         */
575
                        static inline bool Pipe_IsNAKReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
576
                        static inline bool Pipe_IsNAKReceived(void)
577
                        {
578
                                return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].nakedi;
579
                        }
580

    
581
                        /** Clears the NAK condition on the currently selected pipe.
582
                         *
583
                         *  \ingroup Group_PipePacketManagement_UC3
584
                         *
585
                         *  \see \ref Pipe_IsNAKReceived() for more details.
586
                         */
587
                        static inline void Pipe_ClearNAKReceived(void) ATTR_ALWAYS_INLINE;
588
                        static inline void Pipe_ClearNAKReceived(void)
589
                        {
590
                                (&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].nakedic = true;
591
                        }
592

    
593
                        /** Determines if the currently selected pipe has had the STALL condition set by the attached device.
594
                         *
595
                         *  \ingroup Group_PipePacketManagement_UC3
596
                         *
597
                         *  \return Boolean \c true if the current pipe has been stalled by the attached device, \c false otherwise.
598
                         */
599
                        static inline bool Pipe_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
600
                        static inline bool Pipe_IsStalled(void)
601
                        {
602
                                return (&AVR32_USBB.UPSTA0)[USB_SelectedPipe].rxstalldi;
603
                        }
604

    
605
                        /** Clears the STALL condition detection flag on the currently selected pipe, but does not clear the
606
                         *  STALL condition itself (this must be done via a ClearFeature control request to the device).
607
                         *
608
                         *  \ingroup Group_PipePacketManagement_UC3
609
                         */
610
                        static inline void Pipe_ClearStall(void) ATTR_ALWAYS_INLINE;
611
                        static inline void Pipe_ClearStall(void)
612
                        {
613
                                (&AVR32_USBB.UPSTA0CLR)[USB_SelectedPipe].rxstalldic = true;
614
                                USB_PipeFIFOPos[USB_SelectedPipe] = &AVR32_USBB_SLAVE[USB_SelectedPipe * PIPE_HSB_ADDRESS_SPACE_SIZE];
615
                        }
616

    
617
                        /** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.
618
                         *
619
                         *  \ingroup Group_PipePrimitiveRW_UC3
620
                         *
621
                         *  \return Next byte in the currently selected pipe's FIFO buffer.
622
                         */
623
                        static inline uint8_t Pipe_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
624
                        static inline uint8_t Pipe_Read_8(void)
625
                        {
626
                                return *(USB_PipeFIFOPos[USB_SelectedPipe]++);
627
                        }
628

    
629
                        /** Writes one byte to the currently selected pipe's bank, for IN direction pipes.
630
                         *
631
                         *  \ingroup Group_PipePrimitiveRW_UC3
632
                         *
633
                         *  \param[in] Data  Data to write into the the currently selected pipe's FIFO buffer.
634
                         */
635
                        static inline void Pipe_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
636
                        static inline void Pipe_Write_8(const uint8_t Data)
637
                        {
638
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = Data;
639
                        }
640

    
641
                        /** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.
642
                         *
643
                         *  \ingroup Group_PipePrimitiveRW_UC3
644
                         */
645
                        static inline void Pipe_Discard_8(void) ATTR_ALWAYS_INLINE;
646
                        static inline void Pipe_Discard_8(void)
647
                        {
648
                                uint8_t Dummy;
649

    
650
                                Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
651

    
652
                                (void)Dummy;
653
                        }
654

    
655
                        /** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT
656
                         *  direction pipes.
657
                         *
658
                         *  \ingroup Group_PipePrimitiveRW_UC3
659
                         *
660
                         *  \return Next two bytes in the currently selected pipe's FIFO buffer.
661
                         */
662
                        static inline uint16_t Pipe_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
663
                        static inline uint16_t Pipe_Read_16_LE(void)
664
                        {
665
                                uint16_t Byte1 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
666
                                uint16_t Byte0 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
667

    
668
                                return ((Byte0 << 8) | Byte1);
669
                        }
670

    
671
                        /** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT
672
                         *  direction pipes.
673
                         *
674
                         *  \ingroup Group_PipePrimitiveRW_UC3
675
                         *
676
                         *  \return Next two bytes in the currently selected pipe's FIFO buffer.
677
                         */
678
                        static inline uint16_t Pipe_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
679
                        static inline uint16_t Pipe_Read_16_BE(void)
680
                        {
681
                                uint16_t Byte0 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
682
                                uint16_t Byte1 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
683

    
684
                                return ((Byte0 << 8) | Byte1);
685
                        }
686

    
687
                        /** Writes two bytes to the currently selected pipe's bank in little endian format, for IN
688
                         *  direction pipes.
689
                         *
690
                         *  \ingroup Group_PipePrimitiveRW_UC3
691
                         *
692
                         *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
693
                         */
694
                        static inline void Pipe_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
695
                        static inline void Pipe_Write_16_LE(const uint16_t Data)
696
                        {
697
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 8);
698
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data & 0xFF);
699
                        }
700

    
701
                        /** Writes two bytes to the currently selected pipe's bank in big endian format, for IN
702
                         *  direction pipes.
703
                         *
704
                         *  \ingroup Group_PipePrimitiveRW_UC3
705
                         *
706
                         *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
707
                         */
708
                        static inline void Pipe_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
709
                        static inline void Pipe_Write_16_BE(const uint16_t Data)
710
                        {
711
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data & 0xFF);
712
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 8);
713
                        }
714

    
715
                        /** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.
716
                         *
717
                         *  \ingroup Group_PipePrimitiveRW_UC3
718
                         */
719
                        static inline void Pipe_Discard_16(void) ATTR_ALWAYS_INLINE;
720
                        static inline void Pipe_Discard_16(void)
721
                        {
722
                                uint8_t Dummy;
723

    
724
                                Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
725
                                Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
726

    
727
                                (void)Dummy;
728
                        }
729

    
730
                        /** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT
731
                         *  direction pipes.
732
                         *
733
                         *  \ingroup Group_PipePrimitiveRW_UC3
734
                         *
735
                         *  \return Next four bytes in the currently selected pipe's FIFO buffer.
736
                         */
737
                        static inline uint32_t Pipe_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
738
                        static inline uint32_t Pipe_Read_32_LE(void)
739
                        {
740
                                uint32_t Byte3 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
741
                                uint32_t Byte2 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
742
                                uint32_t Byte1 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
743
                                uint32_t Byte0 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
744

    
745
                                return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
746
                        }
747

    
748
                        /** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT
749
                         *  direction pipes.
750
                         *
751
                         *  \ingroup Group_PipePrimitiveRW_UC3
752
                         *
753
                         *  \return Next four bytes in the currently selected pipe's FIFO buffer.
754
                         */
755
                        static inline uint32_t Pipe_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
756
                        static inline uint32_t Pipe_Read_32_BE(void)
757
                        {
758
                                uint32_t Byte0 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
759
                                uint32_t Byte1 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
760
                                uint32_t Byte2 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
761
                                uint32_t Byte3 = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
762

    
763
                                return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
764
                        }
765

    
766
                        /** Writes four bytes to the currently selected pipe's bank in little endian format, for IN
767
                         *  direction pipes.
768
                         *
769
                         *  \ingroup Group_PipePrimitiveRW_UC3
770
                         *
771
                         *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
772
                         */
773
                        static inline void Pipe_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
774
                        static inline void Pipe_Write_32_LE(const uint32_t Data)
775
                        {
776
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 24);
777
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 16);
778
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 8);
779
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data &  0xFF);
780
                        }
781

    
782
                        /** Writes four bytes to the currently selected pipe's bank in big endian format, for IN
783
                         *  direction pipes.
784
                         *
785
                         *  \ingroup Group_PipePrimitiveRW_UC3
786
                         *
787
                         *  \param[in] Data  Data to write to the currently selected pipe's FIFO buffer.
788
                         */
789
                        static inline void Pipe_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
790
                        static inline void Pipe_Write_32_BE(const uint32_t Data)
791
                        {
792
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data &  0xFF);
793
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 8);
794
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 16);
795
                                *(USB_PipeFIFOPos[USB_SelectedPipe]++) = (Data >> 24);
796
                        }
797

    
798
                        /** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.
799
                         *
800
                         *  \ingroup Group_PipePrimitiveRW_UC3
801
                         */
802
                        static inline void Pipe_Discard_32(void) ATTR_ALWAYS_INLINE;
803
                        static inline void Pipe_Discard_32(void)
804
                        {
805
                                uint8_t Dummy;
806

    
807
                                Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
808
                                Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
809
                                Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
810
                                Dummy = *(USB_PipeFIFOPos[USB_SelectedPipe]++);
811

    
812
                                (void)Dummy;
813
                        }
814

    
815
                /* External Variables: */
816
                        /** Global indicating the maximum packet size of the default control pipe located at address
817
                         *  0 in the device. This value is set to the value indicated in the attached device's device
818
                     *  descriptor once the USB interface is initialized into host mode and a device is attached
819
                         *  to the USB bus.
820
                         *
821
                         *  \note This variable should be treated as read-only in the user application, and never manually
822
                         *        changed in value.
823
                         */
824
                        extern uint8_t USB_Host_ControlPipeSize;
825

    
826
                /* Function Prototypes: */
827
                        /** Configures the specified pipe number with the given pipe type, token, target endpoint number in the
828
                         *  attached device, bank size and banking mode.
829
                         *
830
                         *  A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()
831
                         *  before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or
832
                         *  sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite
833
                         *  numbers of IN requests without automatic freezing - this can be overridden by a call to
834
                         *  \ref Pipe_SetFiniteINRequests().
835
                         *
836
                         *  \param[in] Number          Pipe number to configure. This must be more than 0 and less than \ref PIPE_TOTAL_PIPES.
837
                         *
838
                         *  \param[in] Type            Type of pipe to configure, an \c EP_TYPE_* mask. Not all pipe types are available on Low
839
                         *                             Speed USB devices - refer to the USB 2.0 specification.
840
                         *
841
                         *  \param[in] Token           Pipe data token, either \ref PIPE_TOKEN_SETUP, \ref PIPE_TOKEN_OUT or \ref PIPE_TOKEN_IN.
842
                         *                             All pipes (except Control type) are unidirectional - data may only be read from or
843
                         *                             written to the pipe bank based on its direction, not both.
844
                         *
845
                         *  \param[in] EndpointNumber  Endpoint index within the attached device that the pipe should interface to.
846
                         *
847
                         *  \param[in] Size            Size of the pipe's bank, where packets are stored before they are transmitted to
848
                         *                             the USB device, or after they have been received from the USB device (depending on
849
                         *                             the pipe's data direction). The bank size must indicate the maximum packet size that
850
                         *                             the pipe can handle.
851
                         *
852
                         *  \param[in] Banks           Number of banks to use for the pipe being configured, a \c PIPE_BANK_* mask. More banks
853
                         *                             uses more USB DPRAM, but offers better performance. Isochronous type pipes <b>must</b>
854
                         *                             have at least two banks.
855
                         *
856
                         *  \note When the \c ORDERED_EP_CONFIG compile time option is used, Pipes <b>must</b> be configured in ascending order,
857
                         *        or bank corruption will occur.
858
                         *        \n\n
859
                         *
860
                         *  \note Certain microcontroller model's pipes may have different maximum packet sizes based on the pipe's
861
                         *        index - refer to the chosen microcontroller's datasheet to determine the maximum bank size for each pipe.
862
                         *        \n\n
863
                         *
864
                         *  \note The default control pipe should not be manually configured by the user application, as it is
865
                         *        automatically configured by the library internally.
866
                         *        \n\n
867
                         *
868
                         *  \note This routine will automatically select the specified pipe upon success. Upon failure, the pipe which
869
                         *        failed to reconfigure correctly will be selected.
870
                         *
871
                         *  \return Boolean \c true if the configuration succeeded, \c false otherwise.
872
                         */
873
                        bool Pipe_ConfigurePipe(const uint8_t Number,
874
                                                const uint8_t Type,
875
                                                const uint8_t Token,
876
                                                const uint8_t EndpointNumber,
877
                                                const uint16_t Size,
878
                                                const uint8_t Banks);
879

    
880
                        /** Spin-loops until the currently selected non-control pipe is ready for the next packet of data to be read
881
                         *  or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).
882
                         *
883
                         *  \ingroup Group_PipeRW_UC3
884
                         *
885
                         *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
886
                         */
887
                        uint8_t Pipe_WaitUntilReady(void);
888

    
889
                        /** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given
890
                         *  endpoint is found, it is automatically selected.
891
                         *
892
                         *  \param[in] EndpointAddress Address and direction mask of the endpoint within the attached device to check.
893
                         *
894
                         *  \return Boolean \c true if a pipe bound to the given endpoint address of the specified direction is found,
895
                         *          \c false otherwise.
896
                         */
897
                        bool Pipe_IsEndpointBound(const uint8_t EndpointAddress) ATTR_WARN_UNUSED_RESULT;
898

    
899
        /* Private Interface - For use in library only: */
900
        #if !defined(__DOXYGEN__)
901
                /* Macros: */
902
                        #if !defined(ENDPOINT_CONTROLEP)
903
                                #define ENDPOINT_CONTROLEP          0
904
                        #endif
905
                        
906
                /* Inline Functions: */
907
                        static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST ATTR_ALWAYS_INLINE;
908
                        static inline uint8_t Pipe_BytesToEPSizeMask(const uint16_t Bytes)
909
                        {
910
                                uint8_t  MaskVal    = 0;
911
                                uint16_t CheckBytes = 8;
912

    
913
                                while ((CheckBytes < Bytes) && (CheckBytes < PIPE_MAX_SIZE))
914
                                {
915
                                        MaskVal++;
916
                                        CheckBytes <<= 1;
917
                                }
918

    
919
                                return (MaskVal << AVR32_USBB_PSIZE_OFFSET);
920
                        }
921

    
922
                /* Function Prototypes: */
923
                        void Pipe_ClearPipes(void);
924
        #endif
925

    
926
        /* Disable C linkage for C++ Compilers: */
927
                #if defined(__cplusplus)
928
                        }
929
                #endif
930

    
931
#endif
932

    
933
/** @} */
934