Device_AVR8.h 8.75 KB
Newer Older
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
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 Device definitions for the AVR8 microcontrollers.
 *  \copydetails Group_Device_AVR8
34
35
36
37
38
 *
 *  \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.
 */

39
40
/** \ingroup Group_Device
 *  \defgroup Group_Device_AVR8 Device Management (AVR8)
41
 *  \brief USB Device definitions for the AVR8 microcontrollers.
42
 *
43
 *  Architecture specific USB Device definitions for the Atmel 8-bit AVR microcontrollers.
44
45
46
47
 *
 *  @{
 */

48
49
#ifndef __USBDEVICE_AVR8_H__
#define __USBDEVICE_AVR8_H__
50
51

	/* Includes: */
52
53
54
55
56
		#include "../../../../Common/Common.h"
		#include "../StdDescriptors.h"
		#include "../USBInterrupt.h"
		#include "../Endpoint.h"
		
57
58
59
60
	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_USB_DRIVER)
			#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
		#endif
61

62
63
64
65
		#if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
			#error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
		#endif

66
67
	/* Public Interface - May be used in end-application: */
		/* Macros: */
68
69
			/** \name USB Device Mode Option Masks */
			//@{
70
71
72
73
74
			#if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
				/** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
				 *  USB interface should be initialized in low speed (1.5Mb/s) mode.
				 *
				 *  \note Low Speed mode is not available on all USB AVR models.
Dean Camera's avatar
Dean Camera committed
75
				 *        \n
76
77
				 *
				 *  \note Restrictions apply on the number, size and type of endpoints which can be used
Dean Camera's avatar
Dean Camera committed
78
				 *        when running in low speed mode - refer to the USB 2.0 specification.
79
80
81
				 */
				#define USB_DEVICE_OPT_LOWSPEED            (1 << 0)
			#endif
82

Dean Camera's avatar
Dean Camera committed
83
			/** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
84
85
86
			 *  USB interface should be initialized in full speed (12Mb/s) mode.
			 */
			#define USB_DEVICE_OPT_FULLSPEED               (0 << 0)
87
88
			//@}
			
89
			#if (!defined(NO_INTERNAL_SERIAL) && \
90
91
92
			     (defined(USB_SERIES_7_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_4_AVR) || \
			      (defined(USB_SERIES_2_AVR) && (!defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__))) || \
				  defined(__DOXYGEN__)))
93
94
				/** String descriptor index for the device's unique serial number string descriptor within the device.
				 *  This unique serial number is used by the host to associate resources to the device (such as drivers or COM port
95
				 *  number allocations) to a device regardless of the port it is plugged in to on the host. Some microcontrollers contain
96
97
98
				 *  a unique serial number internally, and setting the device descriptors serial number string index to this value
				 *  will cause it to use the internal serial number.
				 *
99
				 *  On unsupported devices, this will evaluate to \ref NO_DESCRIPTOR and so will force the host to create a pseudo-serial
100
101
102
				 *  number for the device.
				 */
				#define USE_INTERNAL_SERIAL           0xDC
103
104
105
106
107

				/** Length of the device's unique internal serial number, in bits, if present on the selected microcontroller
				 *  model.
				 */
				#define INTERNAL_SERIAL_LENGTH_BITS   80
108
109
			#else
				#define USE_INTERNAL_SERIAL           NO_DESCRIPTOR
110
111

				#define INTERNAL_SERIAL_LENGTH_BITS   0
112
113
			#endif			
			
114
115
116
117
118
119
120
121
122
123
		/* Function Prototypes: */
			/** Sends a Remote Wakeup request to the host. This signals to the host that the device should
			 *  be taken out of suspended mode, and communications should resume.
			 *
			 *  Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the
			 *  host computer when the host has suspended all USB devices to enter a low power state.
			 *
			 *  \note This macro should only be used if the device has indicated to the host that it
			 *        supports the Remote Wakeup feature in the device descriptors, and should only be
			 *        issued if the host is currently allowing remote wakeup events from the device (i.e.,
124
			 *        the \ref USB_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP compile
125
			 *        time option is used, this macro is unavailable.
126
			 *        \n\n
127
128
129
130
			 *
			 *  \note The USB clock must be running for this function to operate. If the stack is initialized with
			 *        the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running
			 *        before attempting to call this function.
131
			 *
132
			 *  \see \ref Group_StdDescriptors for more information on the RMWAKEUP feature and device descriptors.
133
134
			 */
			void USB_Device_SendRemoteWakeup(void);
135

136
		/* Inline Functions: */
137
138
139
140
141
142
143
			/** Returns the current USB frame number, when in device mode. Every millisecond the USB bus is active (i.e. enumerated to a host)
			 *  the frame number is incremented by one.
			 */
			static inline uint16_t USB_Device_GetFrameNumber(void)
			{
				return UDFNUM;
			}
144

145
146
147
148
149
			#if !defined(NO_SOF_EVENTS)
				/** Enables the device mode Start Of Frame events. When enabled, this causes the
				 *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
				 *  at the start of each USB frame when enumerated in device mode.
				 *
150
				 *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
151
152
153
154
155
156
				 */
				static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
				static inline void USB_Device_EnableSOFEvents(void)
				{
					USB_INT_Enable(USB_INT_SOFI);
				}
157

158
159
160
				/** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
				 *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
				 *
161
				 *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
162
163
164
165
166
167
168
				 */
				static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
				static inline void USB_Device_DisableSOFEvents(void)
				{
					USB_INT_Disable(USB_INT_SOFI);
				}
			#endif
169

170
171
	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
172
173
174
175
176
177
178
		/* Inline Functions: */
			#if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))
			static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
			static inline void USB_Device_SetLowSpeed(void)
			{
				UDCON |=  (1 << LSM);
			}
179

180
181
182
183
184
185
			static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
			static inline void USB_Device_SetFullSpeed(void)
			{
				UDCON &= ~(1 << LSM);
			}
			#endif
186

187
188
189
			static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
			static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
			{
190
191
				UDADDR  = ((UDADDR & (1 << ADDEN)) | (Address & 0x7F));
				UDADDR |= (1 << ADDEN);
192
193
194
195
196
197
198
			}

			static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE;
			static inline bool USB_Device_IsAddressSet(void)
			{
				return (UDADDR & (1 << ADDEN));
			}
199
		
200
			static inline void USB_Device_GetSerialString(uint16_t* UnicodeString)
201
			{
202
203
				uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();
				GlobalInterruptDisable();
204
205
206
207
				
				uint8_t SigReadAddress = 0x0E;

				for (uint8_t SerialCharNum = 0; SerialCharNum < (INTERNAL_SERIAL_LENGTH_BITS / 4); SerialCharNum++)
208
				{
209
					uint8_t SerialByte = boot_signature_byte_get(SigReadAddress);
210

211
					if (SerialCharNum & 0x01)
212
					{
213
214
215
						SerialByte >>= 4;
						SigReadAddress++;
					}
216

217
					SerialByte &= 0x0F;
218

219
220
					UnicodeString[SerialCharNum] = cpu_to_le16((SerialByte >= 10) ?
															   (('A' - 10) + SerialByte) : ('0' + SerialByte));
221
				}
222
				
223
				SetGlobalInterruptMask(CurrentGlobalInt);
224
225
			}
		
226
227
228
229
230
	#endif

#endif

/** @} */
231