3 Copyright (C) Dean Camera, 2010.
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
10 Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
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.
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
32 * \brief USB low level USB controller definitions.
34 * This file contains structures, function prototypes and macros related to the low level configuration of the
35 * USB controller, to start, stop and reset the USB library core.
37 * \note This file should not be included directly. It is automatically included as needed by the USB driver
38 * dispatch header located in LUFA/Drivers/USB/USB.h.
41 /** \ingroup Group_USB
42 * @defgroup Group_USBManagement USB Interface Management
44 * Functions, macros, variables, enums and types related to the setup and management of the USB interface.
49 #ifndef __USBCONTROLLER_H__
50 #define __USBCONTROLLER_H__
54 #include <avr/interrupt.h>
57 #include "../HighLevel/USBMode.h"
59 #include "../../../Common/Common.h"
60 #include "../HighLevel/USBMode.h"
61 #include "../HighLevel/Events.h"
62 #include "../HighLevel/USBTask.h"
63 #include "USBInterrupt.h"
65 #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)
69 #include "../HighLevel/HostStandardReq.h"
72 #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)
75 #include "../HighLevel/DeviceStandardReq.h"
78 /* Enable C linkage for C++ Compilers: */
79 #if defined(__cplusplus)
83 /* Preprocessor Checks and Defines: */
84 #if !defined(__INCLUDE_FROM_USB_DRIVER)
85 #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
89 #error F_CLOCK is not defined. You must define F_CLOCK to the frequency of the unprescaled input clock in your project makefile.
92 #if (F_CLOCK == 8000000)
93 #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
94 defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
95 defined(__AVR_ATmega32U2__))
97 #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
99 #elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__) || defined(__AVR_ATmega32U6__))
100 #define USB_PLL_PSC ((1 << PLLP1) | (1 << PLLP0))
101 #elif (defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1287__))
102 #define USB_PLL_PSC ((1 << PLLP1) | (1 << PLLP0))
104 #elif (F_CLOCK == 16000000)
105 #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__) || \
106 defined(__AVR_ATmega8U2__) || defined(__AVR_ATmega16U2__) || \
107 defined(__AVR_ATmega32U2__))
108 #define USB_PLL_PSC (1 << PLLP0)
109 #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
110 #define USB_PLL_PSC (1 << PINDIV)
111 #elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_ATmega32U6__))
112 #define USB_PLL_PSC ((1 << PLLP2) | (1 << PLLP1))
113 #elif (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__))
114 #define USB_PLL_PSC ((1 << PLLP2) | (1 << PLLP0))
118 #if !defined(USB_PLL_PSC)
119 #error No PLL prescale value available for chosen F_CPU value and AVR model.
122 /* Public Interface - May be used in end-application: */
124 /** Mode mask for the \ref USB_CurrentMode global. This indicates that the USB interface is currently not
125 * initialized into any mode.
127 #define USB_MODE_NONE 0
129 /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the
130 * USB interface is or should be initialized in the USB device mode.
132 #define USB_MODE_DEVICE 1
134 /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the
135 * USB interface is or should be initialized in the USB host mode.
137 #define USB_MODE_HOST 2
139 #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
140 /** Mode mask for the the \ref USB_Init() function. This indicates that the USB interface should be
141 * initialized into whatever mode the UID pin of the USB AVR indicates, and that the device
142 * should swap over its mode when the level of the UID pin changes during operation.
144 * \note This token is not available on AVR models which do not support both host and device modes.
146 #define USB_MODE_UID 3
149 /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
150 * regulator should be enabled to regulate the data pin voltages to within the USB standard.
152 * \note See USB AVR data sheet for more information on the internal pad regulator.
154 #define USB_OPT_REG_DISABLED (1 << 1)
156 /** Regulator enable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad
157 * regulator should be disabled and the AVR's VCC level used for the data pads.
159 * \note See USB AVR data sheet for more information on the internal pad regulator.
161 #define USB_OPT_REG_ENABLED (0 << 1)
163 /** Manual PLL control option mask for \ref USB_Init(). This indicates to the library that the user application
164 * will take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
165 * that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
167 #define USB_OPT_MANUAL_PLL (1 << 2)
169 /** Automatic PLL control option mask for \ref USB_Init(). This indicates to the library that the library should
170 * take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock
171 * that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.
173 #define USB_OPT_AUTO_PLL (0 << 2)
175 /** Mask for a CONTROL type endpoint or pipe.
177 * \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
179 #define EP_TYPE_CONTROL 0x00
181 /** Mask for an ISOCHRONOUS type endpoint or pipe.
183 * \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
185 #define EP_TYPE_ISOCHRONOUS 0x01
187 /** Mask for a BULK type endpoint or pipe.
189 * \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
191 #define EP_TYPE_BULK 0x02
193 /** Mask for an INTERRUPT type endpoint or pipe.
195 * \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
197 #define EP_TYPE_INTERRUPT 0x03
199 #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__)
200 /** Constant for the maximum software timeout period of the USB data stream transfer functions
201 * (both control and standard) when in either device or host mode. If the next packet of a stream
202 * is not received or acknowledged within this time period, the stream function will fail.
204 * This value may be overridden in the user project makefile as the value of the
205 * \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.
207 #define USB_STREAM_TIMEOUT_MS 100
210 /* Inline Functions: */
211 #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
212 /** Returns boolean true if the VBUS line is currently high (i.e. the USB host is supplying power),
213 * otherwise returns false.
215 * \note This function is not available on some AVR models which do not support hardware VBUS monitoring.
217 static inline bool USB_VBUS_GetStatus(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
;
218 static inline bool USB_VBUS_GetStatus(void)
220 return ((USBSTA
& (1 << VBUS
)) ?
true : false);
224 /** Detaches the device from the USB bus. This has the effect of removing the device from any
225 * attached host, ceasing USB communications. If no host is present, this prevents any host from
226 * enumerating the device once attached until \ref USB_Attach() is called.
228 static inline void USB_Detach(void) ATTR_ALWAYS_INLINE
;
229 static inline void USB_Detach(void)
231 UDCON
|= (1 << DETACH
);
234 /** Attaches the device to the USB bus. This announces the device's presence to any attached
235 * USB host, starting the enumeration process. If no host is present, attaching the device
236 * will allow for enumeration once a host is connected to the device.
238 * This is inexplicably also required for proper operation while in host mode, to enable the
239 * attachment of a device to the host. This is despite the bit being located in the device-mode
240 * register and despite the datasheet making no mention of its requirement in host mode.
242 static inline void USB_Attach(void) ATTR_ALWAYS_INLINE
;
243 static inline void USB_Attach(void)
245 UDCON
&= ~(1 << DETACH
);
248 /* Function Prototypes: */
249 /** Main function to initialize and start the USB interface. Once active, the USB interface will
250 * allow for device connection to a host when in device mode, or for device enumeration while in
253 * As the USB library relies on interrupts for the device and host mode enumeration processes,
254 * the user must enable global interrupts before or shortly after this function is called. In
255 * device mode, interrupts must be enabled within 500ms of this function being called to ensure
256 * that the host does not time out whilst enumerating the device. In host mode, interrupts may be
257 * enabled at the application's leisure however enumeration will not begin of an attached device
258 * until after this has occurred.
260 * Calling this function when the USB interface is already initialized will cause a complete USB
261 * interface reset and re-enumeration.
263 * \param[in] Mode This is a mask indicating what mode the USB interface is to be initialized to.
264 * Valid mode masks are \ref USB_MODE_DEVICE, \ref USB_MODE_HOST or \ref USB_MODE_UID.
266 * \param[in] Options Mask indicating the options which should be used when initializing the USB
267 * interface to control the USB interface's behaviour. This should be comprised of
268 * a USB_OPT_REG_* mask to control the regulator, a USB_OPT_*_PLL mask to control the
269 * PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device
272 * \note To reduce the FLASH requirements of the library if only device or host mode is required,
273 * the mode can be statically set in the project makefile by defining the token USB_DEVICE_ONLY
274 * (for device mode) or USB_HOST_ONLY (for host mode), passing the token to the compiler
275 * via the -D switch. If the mode is statically set, this parameter does not exist in the
276 * function prototype.
279 * \note To reduce the FLASH requirements of the library if only fixed settings are are required,
280 * the options may be set statically in the same manner as the mode (see the Mode parameter of
281 * this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token,
282 * defined to the appropriate options masks. When the options are statically set, this
283 * parameter does not exist in the function prototype.
286 * \note The mode parameter does not exist on devices where only one mode is possible, such as USB
287 * AVR models which only implement the USB device mode in hardware.
289 * \see Device.h for the USB_DEVICE_OPT_* masks.
292 #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
296 #if (defined(USB_CAN_BE_BOTH) && !defined(USE_STATIC_OPTIONS)) || defined(__DOXYGEN__)
298 #elif (!defined(USB_CAN_BE_BOTH) && defined(USE_STATIC_OPTIONS))
302 #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
303 const uint8_t Options
307 /** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO
308 * memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface
309 * is restarted with the \ref USB_Init() function.
311 void USB_ShutDown(void);
313 /** Resets the interface, when already initialized. This will re-enumerate the device if already connected
314 * to a host, or re-enumerate an already attached device when in host mode.
316 void USB_ResetInterface(void);
319 /** Enum for error codes relating to the powering on of the USB interface. These error codes are
320 * used in the ErrorCode parameter value of the \ref EVENT_USB_InitFailure() event.
322 enum USB_InitErrorCodes_t
324 USB_INITERROR_NoUSBModeSpecified
= 0, /**< Indicates that \ref USB_Init() was called with an
325 * invalid or missing Mode parameter.
329 /* Global Variables: */
330 #if (!defined(USB_HOST_ONLY) && !defined(USB_DEVICE_ONLY)) || defined(__DOXYGEN__)
331 /** Indicates the mode that the USB interface is currently initialized to. This value will be
332 * one of the USB_MODE_* masks defined elsewhere in this module.
334 * \note This variable should be treated as read-only in the user application, and never manually
337 extern volatile uint8_t USB_CurrentMode
;
338 #elif defined(USB_HOST_ONLY)
339 #define USB_CurrentMode USB_MODE_HOST
340 #elif defined(USB_DEVICE_ONLY)
341 #define USB_CurrentMode USB_MODE_DEVICE
344 #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
345 /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
346 * was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module.
348 * \note This variable should be treated as read-only in the user application, and never manually
351 extern volatile uint8_t USB_Options
;
352 #elif defined(USE_STATIC_OPTIONS)
353 #define USB_Options USE_STATIC_OPTIONS
356 /* Private Interface - For use in library only: */
357 #if !defined(__DOXYGEN__)
358 /* Inline Functions: */
359 static inline void USB_PLL_On(void) ATTR_ALWAYS_INLINE
;
360 static inline void USB_PLL_On(void)
362 PLLCSR
= USB_PLL_PSC
;
363 PLLCSR
|= (1 << PLLE
);
366 static inline void USB_PLL_Off(void) ATTR_ALWAYS_INLINE
;
367 static inline void USB_PLL_Off(void)
372 static inline bool USB_PLL_IsReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
;
373 static inline bool USB_PLL_IsReady(void)
375 return ((PLLCSR
& (1 << PLOCK
)) ?
true : false);
378 static inline void USB_REG_On(void) ATTR_ALWAYS_INLINE
;
379 static inline void USB_REG_On(void)
381 #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
382 UHWCON
|= (1 << UVREGE
);
384 REGCR
&= ~(1 << REGDIS
);
388 static inline void USB_REG_Off(void) ATTR_ALWAYS_INLINE
;
389 static inline void USB_REG_Off(void)
391 #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
392 UHWCON
&= ~(1 << UVREGE
);
394 REGCR
|= (1 << REGDIS
);
398 #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)
399 static inline void USB_OTGPAD_On(void) ATTR_ALWAYS_INLINE
;
400 static inline void USB_OTGPAD_On(void)
402 USBCON
|= (1 << OTGPADE
);
405 static inline void USB_OTGPAD_Off(void) ATTR_ALWAYS_INLINE
;
406 static inline void USB_OTGPAD_Off(void)
408 USBCON
&= ~(1 << OTGPADE
);
412 static inline void USB_CLK_Freeze(void) ATTR_ALWAYS_INLINE
;
413 static inline void USB_CLK_Freeze(void)
415 USBCON
|= (1 << FRZCLK
);
418 static inline void USB_CLK_Unfreeze(void) ATTR_ALWAYS_INLINE
;
419 static inline void USB_CLK_Unfreeze(void)
421 USBCON
&= ~(1 << FRZCLK
);
424 static inline void USB_Controller_Enable(void) ATTR_ALWAYS_INLINE
;
425 static inline void USB_Controller_Enable(void)
427 USBCON
|= (1 << USBE
);
430 static inline void USB_Controller_Disable(void) ATTR_ALWAYS_INLINE
;
431 static inline void USB_Controller_Disable(void)
433 USBCON
&= ~(1 << USBE
);
436 static inline void USB_Controller_Reset(void) ATTR_ALWAYS_INLINE
;
437 static inline void USB_Controller_Reset(void)
439 const uint8_t Temp
= USBCON
;
441 USBCON
= (Temp
& ~(1 << USBE
));
442 USBCON
= (Temp
| (1 << USBE
));
445 #if defined(USB_CAN_BE_BOTH)
446 static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE
;
447 static inline uint8_t USB_GetUSBModeFromUID(void)
449 if (USBSTA
& (1 << ID
))
450 return USB_MODE_DEVICE
;
452 return USB_MODE_HOST
;
458 /* Disable C linkage for C++ Compilers: */
459 #if defined(__cplusplus)