Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Core / AVR8 / USBController_AVR8.h @ 978b99e5

History | View | Annotate | Download (18 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 Controller definitions for the AVR8 microcontrollers.
33
 *  \copydetails Group_USBManagement_AVR8
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_USBManagement
40
 *  \defgroup Group_USBManagement_AVR8 USB Interface Management (AVR8)
41
 *  \brief USB Controller definitions for the AVR8 microcontrollers.
42
 *
43
 *  Functions, macros, variables, enums and types related to the setup and management of the USB interface.
44
 *
45
 *  @{
46
 */
47

    
48
#ifndef __USBCONTROLLER_AVR8_H__
49
#define __USBCONTROLLER_AVR8_H__
50

    
51
        /* Includes: */
52
                #include "../../../../Common/Common.h"
53
                #include "../USBMode.h"
54
                #include "../Events.h"
55
                #include "../USBTask.h"
56
                #include "../USBInterrupt.h"
57

    
58
                #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
59
                        #include "../Host.h"
60
                        #include "../OTG.h"
61
                        #include "../Pipe.h"
62
                        #include "../HostStandardReq.h"
63
                        #include "../PipeStream.h"
64
                #endif
65

    
66
                #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
67
                        #include "../Device.h"
68
                        #include "../Endpoint.h"
69
                        #include "../DeviceStandardReq.h"
70
                        #include "../EndpointStream.h"
71
                #endif
72

    
73
        /* Enable C linkage for C++ Compilers: */
74
                #if defined(__cplusplus)
75
                        extern "C" {
76
                #endif
77

    
78
        /* Preprocessor Checks and Defines: */
79
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
80
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
81
                #endif
82

    
83
                #if !defined(F_USB)
84
                        #error F_USB is not defined. You must define F_USB to the frequency of the unprescaled USB controller clock in your project makefile.
85
                #endif
86

    
87
                #if (F_USB == 8000000)
88
                        #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
89
                             defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
90
                             defined(__AVR_ATmega32U2__))
91
                                #define USB_PLL_PSC                0
92
                        #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
93
                                #define USB_PLL_PSC                0
94
                        #elif (defined(__AVR_AT90USB646__)  || defined(__AVR_AT90USB1286__) || defined(__AVR_ATmega32U6__))
95
                                #define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))
96
                        #elif (defined(__AVR_AT90USB647__)  || defined(__AVR_AT90USB1287__))
97
                                #define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))
98
                        #endif
99
                #elif (F_USB == 16000000)
100
                        #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
101
                             defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
102
                             defined(__AVR_ATmega32U2__))
103
                                #define USB_PLL_PSC                (1 << PLLP0)
104
                        #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
105
                                #define USB_PLL_PSC                (1 << PINDIV)
106
                        #elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_ATmega32U6__))
107
                                #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP1))
108
                        #elif (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__))
109
                                #define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP0))
110
                        #endif
111
                #endif
112

    
113
                #if !defined(USB_PLL_PSC)
114
                        #error No PLL prescale value available for chosen F_USB value and AVR model.
115
                #endif
116

    
117
        /* Public Interface - May be used in end-application: */
118
                /* Macros: */
119
                        /** \name USB Controller Option Masks */
120
                        //@{
121
                        /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
122
                         *  regulator should be disabled and the AVR's VCC level used for the data pads.
123
                         *
124
                         *  \note See USB AVR data sheet for more information on the internal pad regulator.
125
                         */
126
                        #define USB_OPT_REG_DISABLED               (1 << 1)
127

    
128
                        /** Regulator enable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
129
                         *  regulator should be enabled to regulate the data pin voltages from the VBUS level down to a level within
130
                         *  the range allowable by the USB standard.
131
                         *
132
                         *  \note See USB AVR data sheet for more information on the internal pad regulator.
133
                         */
134
                        #define USB_OPT_REG_ENABLED                (0 << 1)
135

    
136
                        /** Manual PLL control option mask for \ref USB_Init(). This indicates to the library that the user application
137
                         *  will take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
138
                         *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
139
                         */
140
                        #define USB_OPT_MANUAL_PLL                 (1 << 2)
141

    
142
                        /** Automatic PLL control option mask for \ref USB_Init(). This indicates to the library that the library should
143
                         *  take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
144
                         *  that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
145
                         */
146
                        #define USB_OPT_AUTO_PLL                   (0 << 2)
147
                        //@}
148

    
149
                        #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__)
150
                                /** Constant for the maximum software timeout period of the USB data stream transfer functions
151
                                 *  (both control and standard) when in either device or host mode. If the next packet of a stream
152
                                 *  is not received or acknowledged within this time period, the stream function will fail.
153
                                 *
154
                                 *  This value may be overridden in the user project makefile as the value of the
155
                                 *  \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.
156
                                 */
157
                                #define USB_STREAM_TIMEOUT_MS       100
158
                        #endif
159

    
160
                /* Inline Functions: */
161
                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
162
                                /** Determines if the VBUS line is currently high (i.e. the USB host is supplying power).
163
                                 *
164
                                 *  \note This function is not available on some AVR models which do not support hardware VBUS monitoring.
165
                                 *
166
                                 *  \return Boolean \c true if the VBUS line is currently detecting power from a host, \c false otherwise.
167
                                 */
168
                                static inline bool USB_VBUS_GetStatus(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
169
                                static inline bool USB_VBUS_GetStatus(void)
170
                                {
171
                                        return ((USBSTA & (1 << VBUS)) ? true : false);
172
                                }
173
                        #endif
174

    
175
                        /** Detaches the device from the USB bus. This has the effect of removing the device from any
176
                         *  attached host, ceasing USB communications. If no host is present, this prevents any host from
177
                         *  enumerating the device once attached until \ref USB_Attach() is called.
178
                         */
179
                        static inline void USB_Detach(void) ATTR_ALWAYS_INLINE;
180
                        static inline void USB_Detach(void)
181
                        {
182
                                UDCON  |=  (1 << DETACH);
183
                        }
184

    
185
                        /** Attaches the device to the USB bus. This announces the device's presence to any attached
186
                         *  USB host, starting the enumeration process. If no host is present, attaching the device
187
                         *  will allow for enumeration once a host is connected to the device.
188
                         *
189
                         *  This is inexplicably also required for proper operation while in host mode, to enable the
190
                         *  attachment of a device to the host. This is despite the bit being located in the device-mode
191
                         *  register and despite the datasheet making no mention of its requirement in host mode.
192
                         */
193
                        static inline void USB_Attach(void) ATTR_ALWAYS_INLINE;
194
                        static inline void USB_Attach(void)
195
                        {
196
                                UDCON  &= ~(1 << DETACH);
197
                        }
198

    
199
                /* Function Prototypes: */
200
                        /** Main function to initialize and start the USB interface. Once active, the USB interface will
201
                         *  allow for device connection to a host when in device mode, or for device enumeration while in
202
                         *  host mode.
203
                         *
204
                         *  As the USB library relies on interrupts for the device and host mode enumeration processes,
205
                         *  the user must enable global interrupts before or shortly after this function is called. In
206
                         *  device mode, interrupts must be enabled within 500ms of this function being called to ensure
207
                         *  that the host does not time out whilst enumerating the device. In host mode, interrupts may be
208
                         *  enabled at the application's leisure however enumeration will not begin of an attached device
209
                         *  until after this has occurred.
210
                         *
211
                         *  Calling this function when the USB interface is already initialized will cause a complete USB
212
                         *  interface reset and re-enumeration.
213
                         *
214
                         *  \param[in] Mode     This is a mask indicating what mode the USB interface is to be initialized to, a value
215
                         *                      from the \ref USB_Modes_t enum.
216
                         *
217
                         *  \param[in] Options  Mask indicating the options which should be used when initializing the USB
218
                         *                      interface to control the USB interface's behaviour. This should be comprised of
219
                         *                      a \c USB_OPT_REG_* mask to control the regulator, a \c USB_OPT_*_PLL mask to control the
220
                         *                      PLL, and a \c USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
221
                         *                      mode speed.
222
                         *
223
                         *  \note To reduce the FLASH requirements of the library if only device or host mode is required,
224
                         *        the mode can be statically set in the project makefile by defining the token \c USB_DEVICE_ONLY
225
                         *        (for device mode) or \c USB_HOST_ONLY (for host mode), passing the token to the compiler
226
                         *        via the -D switch. If the mode is statically set, this parameter does not exist in the
227
                         *        function prototype.
228
                         *        \n\n
229
                         *
230
                         *  \note To reduce the FLASH requirements of the library if only fixed settings are are required,
231
                         *        the options may be set statically in the same manner as the mode (see the Mode parameter of
232
                         *        this function). To statically set the USB options, pass in the \c USE_STATIC_OPTIONS token,
233
                         *        defined to the appropriate options masks. When the options are statically set, this
234
                         *        parameter does not exist in the function prototype.
235
                         *        \n\n
236
                         *
237
                         *  \note The mode parameter does not exist on devices where only one mode is possible, such as USB
238
                         *        AVR models which only implement the USB device mode in hardware.
239
                         *
240
                         *  \see \ref Group_Device for the \c USB_DEVICE_OPT_* masks.
241
                         */
242
                        void USB_Init(
243
                                       #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
244
                                       const uint8_t Mode
245
                                       #endif
246

    
247
                                       #if (defined(USB_CAN_BE_BOTH) && !defined(USE_STATIC_OPTIONS)) || defined(__DOXYGEN__)
248
                                       ,
249
                                       #elif (!defined(USB_CAN_BE_BOTH) && defined(USE_STATIC_OPTIONS))
250
                                       void
251
                                       #endif
252

    
253
                                       #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
254
                                       const uint8_t Options
255
                                       #endif
256
                                       );
257

    
258
                        /** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO
259
                         *  memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface
260
                         *  is restarted with the \ref USB_Init() function.
261
                         */
262
                        void USB_Disable(void);
263

    
264
                        /** Resets the interface, when already initialized. This will re-enumerate the device if already connected
265
                         *  to a host, or re-enumerate an already attached device when in host mode.
266
                         */
267
                        void USB_ResetInterface(void);
268

    
269
                /* Global Variables: */
270
                        #if (!defined(USB_HOST_ONLY) && !defined(USB_DEVICE_ONLY)) || defined(__DOXYGEN__)
271
                                /** Indicates the mode that the USB interface is currently initialized to, a value from the
272
                                 *  \ref USB_Modes_t enum.
273
                                 *
274
                                 *  \note This variable should be treated as read-only in the user application, and never manually
275
                                 *        changed in value.
276
                                 *        \n\n
277
                                 *
278
                                 *  \note When the controller is initialized into UID auto-detection mode, this variable will hold the
279
                                 *        currently selected USB mode (i.e. \ref USB_MODE_Device or \ref USB_MODE_Host). If the controller
280
                                 *        is fixed into a specific mode (either through the \c USB_DEVICE_ONLY or \c USB_HOST_ONLY compile time
281
                                 *        options, or a limitation of the USB controller in the chosen device model) this will evaluate to
282
                                 *        a constant of the appropriate value and will never evaluate to \ref USB_MODE_None even when the
283
                                 *        USB interface is not initialized.
284
                                 */
285
                                extern volatile uint8_t USB_CurrentMode;
286
                        #elif defined(USB_HOST_ONLY)
287
                                #define USB_CurrentMode USB_MODE_Host
288
                        #elif defined(USB_DEVICE_ONLY)
289
                                #define USB_CurrentMode USB_MODE_Device
290
                        #endif
291

    
292
                        #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
293
                                /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
294
                                 *  was called. This value will be one of the \c USB_MODE_* masks defined elsewhere in this module.
295
                                 *
296
                                 *  \note This variable should be treated as read-only in the user application, and never manually
297
                                 *        changed in value.
298
                                 */
299
                                extern volatile uint8_t USB_Options;
300
                        #elif defined(USE_STATIC_OPTIONS)
301
                                #define USB_Options USE_STATIC_OPTIONS
302
                        #endif
303

    
304
                /* Enums: */
305
                        /** Enum for the possible USB controller modes, for initialization via \ref USB_Init() and indication back to the
306
                         *  user application via \ref USB_CurrentMode.
307
                         */
308
                        enum USB_Modes_t
309
                        {
310
                                USB_MODE_None   = 0, /**< Indicates that the controller is currently not initialized in any specific USB mode. */
311
                                USB_MODE_Device = 1, /**< Indicates that the controller is currently initialized in USB Device mode. */
312
                                USB_MODE_Host   = 2, /**< Indicates that the controller is currently initialized in USB Host mode. */
313
                                USB_MODE_UID    = 3, /**< Indicates that the controller should determine the USB mode from the UID pin of the
314
                                                      *   USB connector.
315
                                                      */
316
                        };
317

    
318
        /* Private Interface - For use in library only: */
319
        #if !defined(__DOXYGEN__)
320
                /* Function Prototypes: */
321
                        #if defined(__INCLUDE_FROM_USB_CONTROLLER_C)
322
                                #if defined(USB_CAN_BE_DEVICE)
323
                                static void USB_Init_Device(void);
324
                                #endif
325

    
326
                                #if defined(USB_CAN_BE_HOST)
327
                                static void USB_Init_Host(void);
328
                                #endif
329
                        #endif
330

    
331
                /* Inline Functions: */
332
                        static inline void USB_PLL_On(void) ATTR_ALWAYS_INLINE;
333
                        static inline void USB_PLL_On(void)
334
                        {
335
                                PLLCSR = USB_PLL_PSC;
336
                                PLLCSR = (USB_PLL_PSC | (1 << PLLE));
337
                        }
338

    
339
                        static inline void USB_PLL_Off(void) ATTR_ALWAYS_INLINE;
340
                        static inline void USB_PLL_Off(void)
341
                        {
342
                                PLLCSR = 0;
343
                        }
344

    
345
                        static inline bool USB_PLL_IsReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
346
                        static inline bool USB_PLL_IsReady(void)
347
                        {
348
                                return ((PLLCSR & (1 << PLOCK)) ? true : false);
349
                        }
350

    
351
                        static inline void USB_REG_On(void) ATTR_ALWAYS_INLINE;
352
                        static inline void USB_REG_On(void)
353
                        {
354
                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
355
                                UHWCON  |=  (1 << UVREGE);
356
                        #else
357
                                REGCR   &= ~(1 << REGDIS);
358
                        #endif
359
                        }
360

    
361
                        static inline void USB_REG_Off(void) ATTR_ALWAYS_INLINE;
362
                        static inline void USB_REG_Off(void)
363
                        {
364
                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
365
                                UHWCON  &= ~(1 << UVREGE);
366
                        #else
367
                                REGCR   |=  (1 << REGDIS);
368
                        #endif
369
                        }
370

    
371
                        #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
372
                        static inline void USB_OTGPAD_On(void) ATTR_ALWAYS_INLINE;
373
                        static inline void USB_OTGPAD_On(void)
374
                        {
375
                                USBCON  |=  (1 << OTGPADE);
376
                        }
377

    
378
                        static inline void USB_OTGPAD_Off(void) ATTR_ALWAYS_INLINE;
379
                        static inline void USB_OTGPAD_Off(void)
380
                        {
381
                                USBCON  &= ~(1 << OTGPADE);
382
                        }
383
                        #endif
384

    
385
                        static inline void USB_CLK_Freeze(void) ATTR_ALWAYS_INLINE;
386
                        static inline void USB_CLK_Freeze(void)
387
                        {
388
                                USBCON  |=  (1 << FRZCLK);
389
                        }
390

    
391
                        static inline void USB_CLK_Unfreeze(void) ATTR_ALWAYS_INLINE;
392
                        static inline void USB_CLK_Unfreeze(void)
393
                        {
394
                                USBCON  &= ~(1 << FRZCLK);
395
                        }
396

    
397
                        static inline void USB_Controller_Enable(void) ATTR_ALWAYS_INLINE;
398
                        static inline void USB_Controller_Enable(void)
399
                        {
400
                                USBCON  |=  (1 << USBE);
401
                        }
402

    
403
                        static inline void USB_Controller_Disable(void) ATTR_ALWAYS_INLINE;
404
                        static inline void USB_Controller_Disable(void)
405
                        {
406
                                USBCON  &= ~(1 << USBE);
407
                        }
408

    
409
                        static inline void USB_Controller_Reset(void) ATTR_ALWAYS_INLINE;
410
                        static inline void USB_Controller_Reset(void)
411
                        {
412
                                USBCON &= ~(1 << USBE);
413
                                USBCON |=  (1 << USBE);
414
                        }
415

    
416
                        #if defined(USB_CAN_BE_BOTH)
417
                        static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
418
                        static inline uint8_t USB_GetUSBModeFromUID(void)
419
                        {
420
                                if (USBSTA & (1 << ID))
421
                                  return USB_MODE_Device;
422
                                else
423
                                  return USB_MODE_Host;
424
                        }
425
                        #endif
426

    
427
        #endif
428

    
429
        /* Disable C linkage for C++ Compilers: */
430
                #if defined(__cplusplus)
431
                        }
432
                #endif
433

    
434
#endif
435

    
436
/** @} */
437