USBController_AVR8.h 17.7 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2012.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
10
  Copyright 2012  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
17
18
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
19
20
21
22
23
24
25
26
27
28
29
30
31
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
32
33
 *  \brief USB Controller definitions for the AVR8 microcontrollers.
 *  \copydetails Group_USBManagement_AVR8
34
35
36
37
 *
 *  \note This file should not be included directly. It is automatically included as needed by the USB driver
 *        dispatch header located in LUFA/Drivers/USB/USB.h.
 */
38

39
40
/** \ingroup Group_USBManagement
 *  \defgroup Group_USBManagement_AVR8 USB Interface Management (AVR8)
41
 *  \brief USB Controller definitions for the AVR8 microcontrollers.
42
43
44
45
46
47
 *
 *  Functions, macros, variables, enums and types related to the setup and management of the USB interface.
 *
 *  @{
 */

48
49
#ifndef __USBCONTROLLER_AVR8_H__
#define __USBCONTROLLER_AVR8_H__
50
51

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

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

66
		#if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
67
68
69
70
			#include "../Device.h"
			#include "../Endpoint.h"
			#include "../DeviceStandardReq.h"
			#include "../EndpointStream.h"
71
72
73
74
75
76
77
78
79
80
81
82
		#endif

	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

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

83
84
		#if !defined(F_USB)
			#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
89
			#if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
			     defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
90
			     defined(__AVR_ATmega32U2__))
91
92
93
94
95
96
97
98
				#define USB_PLL_PSC                0
			#elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
				#define USB_PLL_PSC                0
			#elif (defined(__AVR_AT90USB646__)  || defined(__AVR_AT90USB1286__) || defined(__AVR_ATmega32U6__))
				#define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))
			#elif (defined(__AVR_AT90USB647__)  || defined(__AVR_AT90USB1287__))
				#define USB_PLL_PSC                ((1 << PLLP1) | (1 << PLLP0))
			#endif
99
		#elif (F_USB == 16000000)
100
101
			#if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
			     defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
102
			     defined(__AVR_ATmega32U2__))
103
104
105
106
107
108
109
110
111
				#define USB_PLL_PSC                (1 << PLLP0)
			#elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
				#define USB_PLL_PSC                (1 << PINDIV)
			#elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_ATmega32U6__))
				#define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP1))
			#elif (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__))
				#define USB_PLL_PSC                ((1 << PLLP2) | (1 << PLLP0))
			#endif
		#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
120
			/** \name USB Controller Option Masks */
			//@{
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
125
126
127
128
			 *
			 *  \note See USB AVR data sheet for more information on the internal pad regulator.
			 */
			#define USB_OPT_REG_DISABLED               (1 << 1)

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

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

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

149
150
151
152
153
			#if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__)
				/** Constant for the maximum software timeout period of the USB data stream transfer functions
				 *  (both control and standard) when in either device or host mode. If the next packet of a stream
				 *  is not received or acknowledged within this time period, the stream function will fail.
				 *
154
				 *  This value may be overridden in the user project makefile as the value of the
155
156
157
158
				 *  \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.
				 */
				#define USB_STREAM_TIMEOUT_MS       100
			#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
169
170
171
172
				static inline bool USB_VBUS_GetStatus(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
				static inline bool USB_VBUS_GetStatus(void)
				{
					return ((USBSTA & (1 << VBUS)) ? true : false);
				}
173
174
175
176
177
178
			#endif

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

			/** Attaches the device to the USB bus. This announces the device's presence to any attached
			 *  USB host, starting the enumeration process. If no host is present, attaching the device
			 *  will allow for enumeration once a host is connected to the device.
			 *
			 *  This is inexplicably also required for proper operation while in host mode, to enable the
			 *  attachment of a device to the host. This is despite the bit being located in the device-mode
			 *  register and despite the datasheet making no mention of its requirement in host mode.
			 */
193
194
195
196
197
			static inline void USB_Attach(void) ATTR_ALWAYS_INLINE;
			static inline void USB_Attach(void)
			{
				UDCON  &= ~(1 << DETACH);
			}
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

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

			               #if (defined(USB_CAN_BE_BOTH) && !defined(USE_STATIC_OPTIONS)) || defined(__DOXYGEN__)
			               ,
251
252
			               #elif (!defined(USB_CAN_BE_BOTH) && defined(USE_STATIC_OPTIONS))
			               void
253
			               #endif
254

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

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

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

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

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

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

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

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

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

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

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

			static inline void USB_REG_On(void) ATTR_ALWAYS_INLINE;
			static inline void USB_REG_On(void)
			{
			#if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
Dean Camera's avatar
Dean Camera committed
356
				UHWCON |=  (1 << UVREGE);
357
			#else
Dean Camera's avatar
Dean Camera committed
358
				REGCR  &= ~(1 << REGDIS);
359
			#endif
360
			}
361

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

372
373
374
375
			#if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
			static inline void USB_OTGPAD_On(void) ATTR_ALWAYS_INLINE;
			static inline void USB_OTGPAD_On(void)
			{
Dean Camera's avatar
Dean Camera committed
376
				USBCON |=  (1 << OTGPADE);
377
378
379
380
381
			}

			static inline void USB_OTGPAD_Off(void) ATTR_ALWAYS_INLINE;
			static inline void USB_OTGPAD_Off(void)
			{
Dean Camera's avatar
Dean Camera committed
382
				USBCON &= ~(1 << OTGPADE);
383
			}
384
			#endif
385
386
387
388

			static inline void USB_CLK_Freeze(void) ATTR_ALWAYS_INLINE;
			static inline void USB_CLK_Freeze(void)
			{
Dean Camera's avatar
Dean Camera committed
389
				USBCON |=  (1 << FRZCLK);
390
			}
391

392
393
394
			static inline void USB_CLK_Unfreeze(void) ATTR_ALWAYS_INLINE;
			static inline void USB_CLK_Unfreeze(void)
			{
Dean Camera's avatar
Dean Camera committed
395
				USBCON &= ~(1 << FRZCLK);
396
			}
397

398
399
400
			static inline void USB_Controller_Enable(void) ATTR_ALWAYS_INLINE;
			static inline void USB_Controller_Enable(void)
			{
Dean Camera's avatar
Dean Camera committed
401
				USBCON |=  (1 << USBE);
402
			}
403

404
405
406
			static inline void USB_Controller_Disable(void) ATTR_ALWAYS_INLINE;
			static inline void USB_Controller_Disable(void)
			{
Dean Camera's avatar
Dean Camera committed
407
				USBCON &= ~(1 << USBE);
408
			}
409

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

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

428
	#endif
429

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

435
436
437
#endif

/** @} */
438