Statistics
| Branch: | Tag: | Revision:

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

History | View | Annotate | Download (38.8 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 Endpoint definitions for the AVR32 UC3 microcontrollers.
33
 *  \copydetails Group_EndpointManagement_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_EndpointRW
40
 *  \defgroup Group_EndpointRW_UC3 Endpoint Data Reading and Writing (UC3)
41
 *  \brief Endpoint 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 endpoints.
44
 */
45

    
46
/** \ingroup Group_EndpointPrimitiveRW
47
 *  \defgroup Group_EndpointPrimitiveRW_UC3 Read/Write of Primitive Data Types (UC3)
48
 *  \brief Endpoint primitive 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 endpoints.
52
 */
53

    
54
/** \ingroup Group_EndpointPacketManagement
55
 *  \defgroup Group_EndpointPacketManagement_UC3 Endpoint Packet Management (UC3)
56
 *  \brief Endpoint packet management definitions for the Atmel AVR32 UC3 architecture.
57
 *
58
 *  Functions, macros, variables, enums and types related to packet management of endpoints.
59
 */
60

    
61
/** \ingroup Group_EndpointManagement
62
 *  \defgroup Group_EndpointManagement_UC3 Endpoint Management (UC3)
63
 *  \brief Endpoint management definitions for the Atmel AVR32 UC3 architecture.
64
 *
65
 *  Functions, macros and enums related to endpoint management when in USB Device mode. This
66
 *  module contains the endpoint management macros, as well as endpoint interrupt and data
67
 *  send/receive functions for various data types.
68
 *
69
 *  @{
70
 */
71

    
72
#ifndef __ENDPOINT_UC3_H__
73
#define __ENDPOINT_UC3_H__
74

    
75
        /* Includes: */
76
                #include "../../../../Common/Common.h"
77
                #include "../USBTask.h"
78
                #include "../USBInterrupt.h"
79

    
80
        /* Enable C linkage for C++ Compilers: */
81
                #if defined(__cplusplus)
82
                        extern "C" {
83
                #endif
84

    
85
        /* Preprocessor Checks: */
86
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
87
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
88
                #endif
89

    
90
        /* Private Interface - For use in library only: */
91
        #if !defined(__DOXYGEN__)
92
                /* Macros: */
93
                        #define _ENDPOINT_GET_MAXSIZE(EPIndex)            _ENDPOINT_GET_MAXSIZE2(ENDPOINT_DETAILS_EP ## EPIndex)
94
                        #define _ENDPOINT_GET_MAXSIZE2(EPDetails)         _ENDPOINT_GET_MAXSIZE3(EPDetails)
95
                        #define _ENDPOINT_GET_MAXSIZE3(MaxSize, Banks)    (MaxSize)
96

    
97
                        #define _ENDPOINT_GET_BANKS(EPIndex)              _ENDPOINT_GET_BANKS2(ENDPOINT_DETAILS_EP ## EPIndex)
98
                        #define _ENDPOINT_GET_BANKS2(EPDetails)           _ENDPOINT_GET_BANKS3(EPDetails)
99
                        #define _ENDPOINT_GET_BANKS3(MaxSize, Banks)      (Banks)
100

    
101
                        #if defined(USB_SERIES_UC3A0_AVR32) || defined(USB_SERIES_UC3A1_AVR32)
102
                                #define ENDPOINT_DETAILS_MAXEP                 7
103

    
104
                                #define ENDPOINT_DETAILS_EP0                   64,  1
105
                                #define ENDPOINT_DETAILS_EP1                   256, 2
106
                                #define ENDPOINT_DETAILS_EP2                   256, 2
107
                                #define ENDPOINT_DETAILS_EP3                   64,  2
108
                                #define ENDPOINT_DETAILS_EP4                   64,  2
109
                                #define ENDPOINT_DETAILS_EP5                   256, 2
110
                                #define ENDPOINT_DETAILS_EP6                   256, 2
111
                        #elif defined(USB_SERIES_UC3A3_AVR32) || defined(USB_SERIES_UC3A4_AVR32)
112
                                #define ENDPOINT_DETAILS_MAXEP                 8
113

    
114
                                #define ENDPOINT_DETAILS_EP0                   64,  1
115
                                #define ENDPOINT_DETAILS_EP1                   512, 3
116
                                #define ENDPOINT_DETAILS_EP2                   512, 3
117
                                #define ENDPOINT_DETAILS_EP3                   512, 3
118
                                #define ENDPOINT_DETAILS_EP4                   512, 3
119
                                #define ENDPOINT_DETAILS_EP5                   512, 3
120
                                #define ENDPOINT_DETAILS_EP6                   512, 3
121
                                #define ENDPOINT_DETAILS_EP7                   512, 3
122
                        #elif defined(USB_SERIES_UC3B0_AVR32) || defined(USB_SERIES_UC3B1_AVR32) 
123
                                #define ENDPOINT_DETAILS_MAXEP                 7
124

    
125
                                #define ENDPOINT_DETAILS_EP0                   64,  1
126
                                #define ENDPOINT_DETAILS_EP1                   64,  2
127
                                #define ENDPOINT_DETAILS_EP2                   64,  2
128
                                #define ENDPOINT_DETAILS_EP3                   64,  2
129
                                #define ENDPOINT_DETAILS_EP4                   64,  2
130
                                #define ENDPOINT_DETAILS_EP5                   256, 2
131
                                #define ENDPOINT_DETAILS_EP6                   256, 2
132
                        #endif
133

    
134
                        #define ENDPOINT_HSB_ADDRESS_SPACE_SIZE            (64 * 1024UL)
135

    
136
                /* Inline Functions: */
137
                        static inline uint32_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes) ATTR_WARN_UNUSED_RESULT ATTR_CONST
138
                                                                                                ATTR_ALWAYS_INLINE;
139
                        static inline uint32_t Endpoint_BytesToEPSizeMask(const uint16_t Bytes)
140
                        {
141
                                uint8_t  MaskVal    = 0;
142
                                uint16_t CheckBytes = 8;
143

    
144
                                while (CheckBytes < Bytes)
145
                                {
146
                                        MaskVal++;
147
                                        CheckBytes <<= 1;
148
                                }
149

    
150
                                return (MaskVal << AVR32_USBB_EPSIZE_OFFSET);
151
                        }
152

    
153
                /* Function Prototypes: */
154
                        void Endpoint_ClearEndpoints(void);
155
                        bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number,
156
                                                            const uint32_t UECFGXData);
157
                
158
                /* External Variables: */
159
                        extern volatile uint32_t USB_SelectedEndpoint;
160
                        extern volatile uint8_t* USB_EndpointFIFOPos[];
161
        #endif
162

    
163
        /* Public Interface - May be used in end-application: */
164
                /* Macros: */                        
165
                        /** \name Endpoint Bank Mode Masks */
166
                        //@{
167
                        /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
168
                         *  that the endpoint should have one single bank, which requires less USB FIFO memory but results
169
                         *  in slower transfers as only one USB device (the AVR or the host) can access the endpoint's
170
                         *  bank at the one time.
171
                         */
172
                        #define ENDPOINT_BANK_SINGLE                    AVR32_USBB_UECFG0_EPBK_SINGLE
173

    
174
                        /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
175
                         *  that the endpoint should have two banks, which requires more USB FIFO memory but results
176
                         *  in faster transfers as one USB device (the AVR or the host) can access one bank while the other
177
                         *  accesses the second bank.
178
                         */
179
                        #define ENDPOINT_BANK_DOUBLE                    AVR32_USBB_UECFG0_EPBK_DOUBLE
180

    
181
                        #if defined(USB_SERIES_UC3A3_AVR32) || defined(USB_SERIES_UC3A4_AVR32) || defined(__DOXYGEN__)
182
                                /** Mask for the bank mode selection for the \ref Endpoint_ConfigureEndpoint() macro. This indicates
183
                                 *  that the endpoint should have three banks, which requires more USB FIFO memory but results
184
                                 *  in faster transfers as one USB device (the AVR or the host) can access one bank while the other
185
                                 *  accesses the remaining banks.
186
                                 *
187
                                 *  \note Not available on all AVR models.
188
                                 */
189
                                #define ENDPOINT_BANK_TRIPLE                AVR32_USBB_UECFG0_EPBK_TRIPLE
190
                        #endif
191
                        //@}
192

    
193
                        #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
194
                                /** Default size of the default control endpoint's bank, until altered by the control endpoint bank size
195
                                 *  value in the device descriptor. Not available if the \c FIXED_CONTROL_ENDPOINT_SIZE token is defined.
196
                                 */
197
                                #define ENDPOINT_CONTROLEP_DEFAULT_SIZE     8
198
                        #endif
199

    
200
                        /** Retrieves the maximum bank size in bytes of a given endpoint.
201
                         *
202
                         *  \note This macro will only work correctly on endpoint indexes that are compile-time constants
203
                         *        defined by the preprocessor.
204
                         *
205
                         *  \param[in] EPIndex  Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
206
                         */
207
                        #define ENDPOINT_MAX_SIZE(EPIndex)              _ENDPOINT_GET_MAXSIZE(EPIndex)
208

    
209
                        /** Retrieves the total number of banks supported by the given endpoint.
210
                         *
211
                         *  \note This macro will only work correctly on endpoint indexes that are compile-time constants
212
                         *        defined by the preprocessor.
213
                         *
214
                         *  \param[in] EPIndex  Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
215
                         */
216
                        #define ENDPOINT_BANKS_SUPPORTED(EPIndex)       _ENDPOINT_GET_BANKS(EPIndex)
217

    
218
                        #if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)
219
                                /** Total number of endpoints (including the default control endpoint at address 0) which may
220
                                 *  be used in the device. Different AVR models support different amounts of endpoints,
221
                                 *  this value reflects the maximum number of endpoints for the currently selected AVR model.
222
                                 */
223
                                #define ENDPOINT_TOTAL_ENDPOINTS            ENDPOINT_DETAILS_MAXEP
224
                        #else
225
                                #define ENDPOINT_TOTAL_ENDPOINTS            1
226
                        #endif
227

    
228
                /* Enums: */
229
                        /** Enum for the possible error return codes of the \ref Endpoint_WaitUntilReady() function.
230
                         *
231
                         *  \ingroup Group_EndpointRW_UC3
232
                         */
233
                        enum Endpoint_WaitUntilReady_ErrorCodes_t
234
                        {
235
                                ENDPOINT_READYWAIT_NoError                 = 0, /**< Endpoint is ready for next packet, no error. */
236
                                ENDPOINT_READYWAIT_EndpointStalled         = 1, /**< The endpoint was stalled during the stream
237
                                                                                 *   transfer by the host or device.
238
                                                                                 */
239
                                ENDPOINT_READYWAIT_DeviceDisconnected      = 2,        /**< Device was disconnected from the host while
240
                                                                                 *   waiting for the endpoint to become ready.
241
                                                                                 */
242
                                ENDPOINT_READYWAIT_BusSuspended            = 3, /**< The USB bus has been suspended by the host and
243
                                                                                 *   no USB endpoint traffic can occur until the bus
244
                                                                                 *   has resumed.
245
                                                                                 */
246
                                ENDPOINT_READYWAIT_Timeout                 = 4, /**< The host failed to accept or send the next packet
247
                                                                                 *   within the software timeout period set by the
248
                                                                                 *   \ref USB_STREAM_TIMEOUT_MS macro.
249
                                                                                 */
250
                        };
251

    
252
                /* Inline Functions: */
253
                        /** Configures the specified endpoint number with the given endpoint type, direction, bank size
254
                         *  and banking mode. Once configured, the endpoint may be read from or written to, depending
255
                         *  on its direction.
256
                         *
257
                         *  \param[in] Number     Endpoint number to configure. This must be more than 0 and less than
258
                         *                        \ref ENDPOINT_TOTAL_ENDPOINTS.
259
                         *
260
                         *  \param[in] Type       Type of endpoint to configure, a \c EP_TYPE_* mask. Not all endpoint types
261
                         *                        are available on Low Speed USB devices - refer to the USB 2.0 specification.
262
                         *
263
                         *  \param[in] Direction  Endpoint data direction, either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
264
                         *                        All endpoints (except Control type) are unidirectional - data may only be read
265
                         *                        from or written to the endpoint bank based on its direction, not both.
266
                         *
267
                         *  \param[in] Size       Size of the endpoint's bank, where packets are stored before they are transmitted
268
                         *                        to the USB host, or after they have been received from the USB host (depending on
269
                         *                        the endpoint's data direction). The bank size must indicate the maximum packet size
270
                         *                        that the endpoint can handle.
271
                         *
272
                         *  \param[in] Banks      Number of banks to use for the endpoint being configured, an \c ENDPOINT_BANK_* mask.
273
                         *                        More banks uses more USB DPRAM, but offers better performance. Isochronous type
274
                         *                        endpoints <b>must</b> have at least two banks.
275
                         *
276
                         *  \note When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in
277
                         *        ascending order, or bank corruption will occur.
278
                         *        \n\n
279
                         *
280
                         *  \note Different endpoints may have different maximum packet sizes based on the endpoint's index - refer to
281
                         *        the chosen microcontroller model's datasheet to determine the maximum bank size for each endpoint.
282
                         *        \n\n
283
                         *
284
                         *  \note The default control endpoint should not be manually configured by the user application, as
285
                         *        it is automatically configured by the library internally.
286
                         *        \n\n
287
                         *
288
                         *  \note This routine will automatically select the specified endpoint upon success. Upon failure, the endpoint
289
                         *        which failed to reconfigure correctly will be selected.
290
                         *
291
                         *  \return Boolean \c true if the configuration succeeded, \c false otherwise.
292
                         */
293
                        static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
294
                                                                      const uint8_t Type,
295
                                                                      const uint8_t Direction,
296
                                                                      const uint16_t Size,
297
                                                                      const uint8_t Banks) ATTR_ALWAYS_INLINE;
298
                        static inline bool Endpoint_ConfigureEndpoint(const uint8_t Number,
299
                                                                      const uint8_t Type,
300
                                                                      const uint8_t Direction,
301
                                                                      const uint16_t Size,
302
                                                                      const uint8_t Banks)
303
                        {
304
                                return Endpoint_ConfigureEndpoint_Prv(Number, (AVR32_USBB_ALLOC_MASK |
305
                                                                               ((uint32_t)Type      << AVR32_USBB_EPTYPE_OFFSET) | 
306
                                                                               ((uint32_t)(Direction ? AVR32_USBB_UECFG0_EPDIR_MASK : 0) |
307
                                                                               ((uint32_t)Banks     << AVR32_USBB_EPBK_OFFSET)   |
308
                                                                               Endpoint_BytesToEPSizeMask(Size))));
309
                        }
310

    
311
                        /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
312
                         *
313
                         *  \note The return width of this function may differ, depending on the maximum endpoint bank size
314
                         *        of the selected AVR model.
315
                         *
316
                         *  \ingroup Group_EndpointRW_UC3
317
                         *
318
                         *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
319
                         */
320
                        static inline uint16_t Endpoint_BytesInEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
321
                        static inline uint16_t Endpoint_BytesInEndpoint(void)
322
                        {
323
                                return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].byct;
324
                        }
325

    
326
                        /** Get the endpoint address of the currently selected endpoint. This is typically used to save
327
                         *  the currently selected endpoint number so that it can be restored after another endpoint has
328
                         *  been manipulated.
329
                         *
330
                         *  \return Index of the currently selected endpoint.
331
                         */
332
                        static inline uint8_t Endpoint_GetCurrentEndpoint(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
333
                        static inline uint8_t Endpoint_GetCurrentEndpoint(void)
334
                        {
335
                                return USB_SelectedEndpoint;
336
                        }
337

    
338
                        /** Selects the given endpoint number. If the address from the device descriptors is used, the
339
                         *  value should be masked with the \ref ENDPOINT_EPNUM_MASK constant to extract only the endpoint
340
                         *  number (and discarding the endpoint direction bit).
341
                         *
342
                         *  Any endpoint operations which do not require the endpoint number to be indicated will operate on
343
                         *  the currently selected endpoint.
344
                         *
345
                         *  \param[in] EndpointNumber Endpoint number to select.
346
                         */
347
                        static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
348
                        static inline void Endpoint_SelectEndpoint(const uint8_t EndpointNumber)
349
                        {
350
                                USB_SelectedEndpoint = EndpointNumber;
351
                        }
352

    
353
                        /** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
354
                         *  data In and Out pointers to the bank's contents.
355
                         *
356
                         *  \param[in] EndpointNumber Endpoint number whose FIFO buffers are to be reset.
357
                         */
358
                        static inline void Endpoint_ResetEndpoint(const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;
359
                        static inline void Endpoint_ResetEndpoint(const uint8_t EndpointNumber)
360
                        {
361
                                AVR32_USBB.uerst |=  (AVR32_USBB_EPRST0_MASK << EndpointNumber);
362
                                AVR32_USBB.uerst &= ~(AVR32_USBB_EPRST0_MASK << EndpointNumber);
363
                                USB_EndpointFIFOPos[EndpointNumber] = &AVR32_USBB_SLAVE[EndpointNumber * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
364
                        }
365

    
366
                        /** Enables the currently selected endpoint so that data can be sent and received through it to
367
                         *  and from a host.
368
                         *
369
                         *  \note Endpoints must first be configured properly via \ref Endpoint_ConfigureEndpoint().
370
                         */
371
                        static inline void Endpoint_EnableEndpoint(void) ATTR_ALWAYS_INLINE;
372
                        static inline void Endpoint_EnableEndpoint(void)
373
                        {
374
                                AVR32_USBB.uerst |=  (AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint);
375
                        }
376

    
377
                        /** Disables the currently selected endpoint so that data cannot be sent and received through it
378
                         *  to and from a host.
379
                         */
380
                        static inline void Endpoint_DisableEndpoint(void) ATTR_ALWAYS_INLINE;
381
                        static inline void Endpoint_DisableEndpoint(void)
382
                        {
383
                                AVR32_USBB.uerst &= ~(AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint);
384
                        }
385

    
386
                        /** Determines if the currently selected endpoint is enabled, but not necessarily configured.
387
                         *
388
                         * \return Boolean \c true if the currently selected endpoint is enabled, \c false otherwise.
389
                         */
390
                        static inline bool Endpoint_IsEnabled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
391
                        static inline bool Endpoint_IsEnabled(void)
392
                        {
393
                                return ((AVR32_USBB.uerst & (AVR32_USBB_EPEN0_MASK << USB_SelectedEndpoint)) ? true : false);
394
                        }
395

    
396
                        /** Retrieves the number of busy banks in the currently selected endpoint, which have been queued for
397
                         *  transmission via the \ref Endpoint_ClearIN() command, or are awaiting acknowledgement via the
398
                         *  \ref Endpoint_ClearOUT() command.
399
                         *
400
                         *  \ingroup Group_EndpointPacketManagement_UC3
401
                         *
402
                         *  \return Total number of busy banks in the selected endpoint.
403
                         */
404
                        static inline uint8_t Endpoint_GetBusyBanks(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
405
                        static inline uint8_t Endpoint_GetBusyBanks(void)
406
                        {
407
                                return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].nbusybk;
408
                        }
409

    
410
                        /** Aborts all pending IN transactions on the currently selected endpoint, once the bank
411
                         *  has been queued for transmission to the host via \ref Endpoint_ClearIN(). This function
412
                         *  will terminate all queued transactions, resetting the endpoint banks ready for a new
413
                         *  packet.
414
                         *
415
                         *  \ingroup Group_EndpointPacketManagement_UC3
416
                         */
417
                        static inline void Endpoint_AbortPendingIN(void)
418
                        {
419
                                while (Endpoint_GetBusyBanks() != 0)
420
                                {
421
                                        (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].killbks = true;
422
                                        while ((&AVR32_USBB.UECON0)[USB_SelectedEndpoint].killbk);
423
                                }
424
                        }
425
                        
426
                        /** Determines if the currently selected endpoint may be read from (if data is waiting in the endpoint
427
                         *  bank and the endpoint is an OUT direction, or if the bank is not yet full if the endpoint is an IN
428
                         *  direction). This function will return false if an error has occurred in the endpoint, if the endpoint
429
                         *  is an OUT direction and no packet (or an empty packet) has been received, or if the endpoint is an IN
430
                         *  direction and the endpoint bank is full.
431
                         *
432
                         *  \ingroup Group_EndpointPacketManagement_UC3
433
                         *
434
                         *  \return Boolean \c true if the currently selected endpoint may be read from or written to, depending
435
                         *          on its direction.
436
                         */
437
                        static inline bool Endpoint_IsReadWriteAllowed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
438
                        static inline bool Endpoint_IsReadWriteAllowed(void)
439
                        {
440
                                return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rwall;
441
                        }
442

    
443
                        /** Determines if the currently selected endpoint is configured.
444
                         *
445
                         *  \return Boolean \c true if the currently selected endpoint has been configured, \c false otherwise.
446
                         */
447
                        static inline bool Endpoint_IsConfigured(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
448
                        static inline bool Endpoint_IsConfigured(void)
449
                        {
450
                                return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].cfgok;
451
                        }
452

    
453
                        /** Returns a mask indicating which INTERRUPT type endpoints have interrupted - i.e. their
454
                         *  interrupt duration has elapsed. Which endpoints have interrupted can be determined by
455
                         *  masking the return value against <tt>(1 << <i>{Endpoint Number}</i>)</tt>.
456
                         *
457
                         *  \return Mask whose bits indicate which endpoints have interrupted.
458
                         */
459
                        static inline uint8_t Endpoint_GetEndpointInterrupts(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
460
                        static inline uint8_t Endpoint_GetEndpointInterrupts(void)
461
                        {
462
                                return ((AVR32_USBB.udint & (AVR32_USBB_EP6INT_MASK | AVR32_USBB_EP5INT_MASK |
463
                                                             AVR32_USBB_EP4INT_MASK | AVR32_USBB_EP3INT_MASK |
464
                                                             AVR32_USBB_EP2INT_MASK | AVR32_USBB_EP1INT_MASK |
465
                                                             AVR32_USBB_EP0INT_MASK)) >> AVR32_USBB_EP0INT_OFFSET);
466
                        }
467

    
468
                        /** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
469
                         *  endpoints).
470
                         *
471
                         *  \param[in] EndpointNumber  Index of the endpoint whose interrupt flag should be tested.
472
                         *
473
                         *  \return Boolean \c true if the specified endpoint has interrupted, \c false otherwise.
474
                         */
475
                        static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
476
                        static inline bool Endpoint_HasEndpointInterrupted(const uint8_t EndpointNumber)
477
                        {
478
                                return ((Endpoint_GetEndpointInterrupts() & (AVR32_USBB_EP0INT_MASK << EndpointNumber)) ? true : false);
479
                        }
480

    
481
                        /** Determines if the selected IN endpoint is ready for a new packet to be sent to the host.
482
                         *
483
                         *  \ingroup Group_EndpointPacketManagement_UC3
484
                         *
485
                         *  \return Boolean \c true if the current endpoint is ready for an IN packet, \c false otherwise.
486
                         */
487
                        static inline bool Endpoint_IsINReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
488
                        static inline bool Endpoint_IsINReady(void)
489
                        {
490
                                return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].txini;
491
                        }
492

    
493
                        /** Determines if the selected OUT endpoint has received new packet from the host.
494
                         *
495
                         *  \ingroup Group_EndpointPacketManagement_UC3
496
                         *
497
                         *  \return Boolean \c true if current endpoint is has received an OUT packet, \c false otherwise.
498
                         */
499
                        static inline bool Endpoint_IsOUTReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
500
                        static inline bool Endpoint_IsOUTReceived(void)
501
                        {
502
                                return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rxouti;
503
                        }
504

    
505
                        /** Determines if the current CONTROL type endpoint has received a SETUP packet.
506
                         *
507
                         *  \ingroup Group_EndpointPacketManagement_UC3
508
                         *
509
                         *  \return Boolean \c true if the selected endpoint has received a SETUP packet, \c false otherwise.
510
                         */
511
                        static inline bool Endpoint_IsSETUPReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
512
                        static inline bool Endpoint_IsSETUPReceived(void)
513
                        {
514
                                return (&AVR32_USBB.UESTA0)[USB_SelectedEndpoint].rxstpi;
515
                        }
516

    
517
                        /** Clears a received SETUP packet on the currently selected CONTROL type endpoint, freeing up the
518
                         *  endpoint for the next packet.
519
                         *
520
                         *  \ingroup Group_EndpointPacketManagement_UC3
521
                         *
522
                         *  \note This is not applicable for non CONTROL type endpoints.
523
                         */
524
                        static inline void Endpoint_ClearSETUP(void) ATTR_ALWAYS_INLINE;
525
                        static inline void Endpoint_ClearSETUP(void)
526
                        {
527
                                (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].rxstpic = true;
528
                                USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
529
                        }
530

    
531
                        /** Sends an IN packet to the host on the currently selected endpoint, freeing up the endpoint for the
532
                         *  next packet and switching to the alternative endpoint bank if double banked.
533
                         *
534
                         *  \ingroup Group_EndpointPacketManagement_UC3
535
                         */
536
                        static inline void Endpoint_ClearIN(void) ATTR_ALWAYS_INLINE;
537
                        static inline void Endpoint_ClearIN(void)
538
                        {
539
                                (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].txinic   = true;
540
                                (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].fifoconc = true;
541
                                USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
542
                        }
543

    
544
                        /** Acknowledges an OUT packet to the host on the currently selected endpoint, freeing up the endpoint
545
                         *  for the next packet and switching to the alternative endpoint bank if double banked.
546
                         *
547
                         *  \ingroup Group_EndpointPacketManagement_UC3
548
                         */
549
                        static inline void Endpoint_ClearOUT(void) ATTR_ALWAYS_INLINE;
550
                        static inline void Endpoint_ClearOUT(void)
551
                        {
552
                                (&AVR32_USBB.UESTA0CLR)[USB_SelectedEndpoint].rxoutic  = true;
553
                                (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].fifoconc = true;
554
                                USB_EndpointFIFOPos[USB_SelectedEndpoint] = &AVR32_USBB_SLAVE[USB_SelectedEndpoint * ENDPOINT_HSB_ADDRESS_SPACE_SIZE];
555
                        }
556

    
557
                        /** Stalls the current endpoint, indicating to the host that a logical problem occurred with the
558
                         *  indicated endpoint and that the current transfer sequence should be aborted. This provides a
559
                         *  way for devices to indicate invalid commands to the host so that the current transfer can be
560
                         *  aborted and the host can begin its own recovery sequence.
561
                         *
562
                         *  The currently selected endpoint remains stalled until either the \ref Endpoint_ClearStall() macro
563
                         *  is called, or the host issues a CLEAR FEATURE request to the device for the currently selected
564
                         *  endpoint.
565
                         *
566
                         *  \ingroup Group_EndpointPacketManagement_UC3
567
                         */
568
                        static inline void Endpoint_StallTransaction(void) ATTR_ALWAYS_INLINE;
569
                        static inline void Endpoint_StallTransaction(void)
570
                        {
571
                                (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].stallrqs = true;
572
                        }
573

    
574
                        /** Clears the STALL condition on the currently selected endpoint.
575
                         *
576
                         *  \ingroup Group_EndpointPacketManagement_UC3
577
                         */
578
                        static inline void Endpoint_ClearStall(void) ATTR_ALWAYS_INLINE;
579
                        static inline void Endpoint_ClearStall(void)
580
                        {
581
                                (&AVR32_USBB.UECON0CLR)[USB_SelectedEndpoint].stallrqc = true;
582
                        }
583

    
584
                        /** Determines if the currently selected endpoint is stalled, false otherwise.
585
                         *
586
                         *  \ingroup Group_EndpointPacketManagement_UC3
587
                         *
588
                         *  \return Boolean \c true if the currently selected endpoint is stalled, \c false otherwise.
589
                         */
590
                        static inline bool Endpoint_IsStalled(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
591
                        static inline bool Endpoint_IsStalled(void)
592
                        {
593
                                return (&AVR32_USBB.UECON0)[USB_SelectedEndpoint].stallrq;
594
                        }
595

    
596
                        /** Resets the data toggle of the currently selected endpoint. */
597
                        static inline void Endpoint_ResetDataToggle(void) ATTR_ALWAYS_INLINE;
598
                        static inline void Endpoint_ResetDataToggle(void)
599
                        {
600
                                (&AVR32_USBB.UECON0SET)[USB_SelectedEndpoint].rstdts = true;
601
                        }
602

    
603
                        /** Determines the currently selected endpoint's direction.
604
                         *
605
                         *  \return The currently selected endpoint's direction, as a \c ENDPOINT_DIR_* mask.
606
                         */
607
                        static inline uint32_t Endpoint_GetEndpointDirection(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
608
                        static inline uint32_t Endpoint_GetEndpointDirection(void)
609
                        {
610
                                return ((&AVR32_USBB.UECFG0)[USB_SelectedEndpoint].epdir ? ENDPOINT_DIR_IN : ENDPOINT_DIR_OUT);
611
                        }
612

    
613
                        /** Sets the direction of the currently selected endpoint.
614
                         *
615
                         *  \param[in] DirectionMask  New endpoint direction, as a \c ENDPOINT_DIR_* mask.
616
                         */
617
                        static inline void Endpoint_SetEndpointDirection(const uint32_t DirectionMask) ATTR_ALWAYS_INLINE;
618
                        static inline void Endpoint_SetEndpointDirection(const uint32_t DirectionMask)
619
                        {
620
                                (&AVR32_USBB.UECFG0)[USB_SelectedEndpoint].epdir = (DirectionMask == ENDPOINT_DIR_IN);
621
                        }
622

    
623
                        /** Reads one byte from the currently selected endpoint's bank, for OUT direction endpoints.
624
                         *
625
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
626
                         *
627
                         *  \return Next byte in the currently selected endpoint's FIFO buffer.
628
                         */
629
                        static inline uint8_t Endpoint_Read_8(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
630
                        static inline uint8_t Endpoint_Read_8(void)
631
                        {
632
                                return *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
633
                        }
634

    
635
                        /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
636
                         *
637
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
638
                         *
639
                         *  \param[in] Data  Data to write into the the currently selected endpoint's FIFO buffer.
640
                         */
641
                        static inline void Endpoint_Write_8(const uint8_t Data) ATTR_ALWAYS_INLINE;
642
                        static inline void Endpoint_Write_8(const uint8_t Data)
643
                        {
644
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = Data;
645
                        }
646

    
647
                        /** Discards one byte from the currently selected endpoint's bank, for OUT direction endpoints.
648
                         *
649
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
650
                         */
651
                        static inline void Endpoint_Discard_8(void) ATTR_ALWAYS_INLINE;
652
                        static inline void Endpoint_Discard_8(void)
653
                        {
654
                                uint8_t Dummy;
655

    
656
                                Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
657

    
658
                                (void)Dummy;
659
                        }
660

    
661
                        /** Reads two bytes from the currently selected endpoint's bank in little endian format, for OUT
662
                         *  direction endpoints.
663
                         *
664
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
665
                         *
666
                         *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
667
                         */
668
                        static inline uint16_t Endpoint_Read_16_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
669
                        static inline uint16_t Endpoint_Read_16_LE(void)
670
                        {
671
                                uint16_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
672
                                uint16_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
673

    
674
                                return ((Byte0 << 8) | Byte1);
675
                        }
676

    
677
                        /** Reads two bytes from the currently selected endpoint's bank in big endian format, for OUT
678
                         *  direction endpoints.
679
                         *
680
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
681
                         *
682
                         *  \return Next two bytes in the currently selected endpoint's FIFO buffer.
683
                         */
684
                        static inline uint16_t Endpoint_Read_16_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
685
                        static inline uint16_t Endpoint_Read_16_BE(void)
686
                        {
687
                                uint16_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
688
                                uint16_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
689

    
690
                                return ((Byte0 << 8) | Byte1);
691
                        }
692

    
693
                        /** Writes two bytes to the currently selected endpoint's bank in little endian format, for IN
694
                         *  direction endpoints.
695
                         *
696
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
697
                         *
698
                         *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
699
                         */
700
                        static inline void Endpoint_Write_16_LE(const uint16_t Data) ATTR_ALWAYS_INLINE;
701
                        static inline void Endpoint_Write_16_LE(const uint16_t Data)
702
                        {
703
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
704
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);
705
                        }
706

    
707
                        /** Writes two bytes to the currently selected endpoint's bank in big endian format, for IN
708
                         *  direction endpoints.
709
                         *
710
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
711
                         *
712
                         *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
713
                         */
714
                        static inline void Endpoint_Write_16_BE(const uint16_t Data) ATTR_ALWAYS_INLINE;
715
                        static inline void Endpoint_Write_16_BE(const uint16_t Data)
716
                        {
717
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data & 0xFF);
718
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
719
                        }
720

    
721
                        /** Discards two bytes from the currently selected endpoint's bank, for OUT direction endpoints.
722
                         *
723
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
724
                         */
725
                        static inline void Endpoint_Discard_16(void) ATTR_ALWAYS_INLINE;
726
                        static inline void Endpoint_Discard_16(void)
727
                        {
728
                                uint8_t Dummy;
729

    
730
                                Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
731
                                Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
732

    
733
                                (void)Dummy;
734
                        }
735

    
736
                        /** Reads four bytes from the currently selected endpoint's bank in little endian format, for OUT
737
                         *  direction endpoints.
738
                         *
739
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
740
                         *
741
                         *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
742
                         */
743
                        static inline uint32_t Endpoint_Read_32_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
744
                        static inline uint32_t Endpoint_Read_32_LE(void)
745
                        {
746
                                uint32_t Byte3 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
747
                                uint32_t Byte2 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
748
                                uint32_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
749
                                uint32_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
750

    
751
                                return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
752
                        }
753

    
754
                        /** Reads four bytes from the currently selected endpoint's bank in big endian format, for OUT
755
                         *  direction endpoints.
756
                         *
757
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
758
                         *
759
                         *  \return Next four bytes in the currently selected endpoint's FIFO buffer.
760
                         */
761
                        static inline uint32_t Endpoint_Read_32_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
762
                        static inline uint32_t Endpoint_Read_32_BE(void)
763
                        {
764
                                uint32_t Byte0 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
765
                                uint32_t Byte1 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
766
                                uint32_t Byte2 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
767
                                uint32_t Byte3 = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
768

    
769
                                return ((Byte0 << 24) | (Byte1 << 16) | (Byte2 << 8) | Byte3);
770
                        }
771

    
772
                        /** Writes four bytes to the currently selected endpoint's bank in little endian format, for IN
773
                         *  direction endpoints.
774
                         *
775
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
776
                         *
777
                         *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
778
                         */
779
                        static inline void Endpoint_Write_32_LE(const uint32_t Data) ATTR_ALWAYS_INLINE;
780
                        static inline void Endpoint_Write_32_LE(const uint32_t Data)
781
                        {
782
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 24);
783
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 16);
784
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
785
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data &  0xFF);
786
                        }
787

    
788
                        /** Writes four bytes to the currently selected endpoint's bank in big endian format, for IN
789
                         *  direction endpoints.
790
                         *
791
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
792
                         *
793
                         *  \param[in] Data  Data to write to the currently selected endpoint's FIFO buffer.
794
                         */
795
                        static inline void Endpoint_Write_32_BE(const uint32_t Data) ATTR_ALWAYS_INLINE;
796
                        static inline void Endpoint_Write_32_BE(const uint32_t Data)
797
                        {
798
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data &  0xFF);
799
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 8);
800
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 16);
801
                                *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++) = (Data >> 24);
802
                        }
803

    
804
                        /** Discards four bytes from the currently selected endpoint's bank, for OUT direction endpoints.
805
                         *
806
                         *  \ingroup Group_EndpointPrimitiveRW_UC3
807
                         */
808
                        static inline void Endpoint_Discard_32(void) ATTR_ALWAYS_INLINE;
809
                        static inline void Endpoint_Discard_32(void)
810
                        {
811
                                uint8_t Dummy;
812

    
813
                                Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
814
                                Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
815
                                Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
816
                                Dummy = *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
817

    
818
                                (void)Dummy;
819
                        }
820

    
821
                /* External Variables: */
822
                        /** Global indicating the maximum packet size of the default control endpoint located at address
823
                         *  0 in the device. This value is set to the value indicated in the device descriptor in the user
824
                         *  project once the USB interface is initialized into device mode.
825
                         *
826
                         *  If space is an issue, it is possible to fix this to a static value by defining the control
827
                         *  endpoint size in the \c FIXED_CONTROL_ENDPOINT_SIZE token passed to the compiler in the makefile
828
                         *  via the -D switch. When a fixed control endpoint size is used, the size is no longer dynamically
829
                         *  read from the descriptors at runtime and instead fixed to the given value. When used, it is
830
                         *  important that the descriptor control endpoint size value matches the size given as the
831
                         *  \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
832
                         *  be used in the device descriptors to ensure this.
833
                         *
834
                         *  \note This variable should be treated as read-only in the user application, and never manually
835
                         *        changed in value.
836
                         */
837
                        #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
838
                                extern uint8_t USB_Device_ControlEndpointSize;
839
                        #else
840
                                #define USB_Device_ControlEndpointSize FIXED_CONTROL_ENDPOINT_SIZE
841
                        #endif
842

    
843
                /* Function Prototypes: */
844
                        /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
845
                         *  with respect to the data direction. This is a convenience function which can be used to
846
                         *  simplify user control request handling.
847
                         */
848
                        void Endpoint_ClearStatusStage(void);
849

    
850
                        /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data
851
                         *  to be read or written to it.
852
                         *
853
                         *  \note This routine should not be called on CONTROL type endpoints.
854
                         *
855
                         *  \ingroup Group_EndpointRW_UC3
856
                         *
857
                         *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
858
                         */
859
                        uint8_t Endpoint_WaitUntilReady(void);
860

    
861
        /* Disable C linkage for C++ Compilers: */
862
                #if defined(__cplusplus)
863
                        }
864
                #endif
865

    
866
#endif
867

    
868
/** @} */
869