projects / pub / USBasp.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Initial restructuring of the core USB driver module to support multiple architectures...
[pub/USBasp.git] / LUFA / Drivers / USB / Core / AVR8 / Device.h
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 device mode definitions (AVR8)
33 *
34 * This file contains structures, function prototypes and macros related to USB device mode.
35 *
36 * \note This file should not be included directly. It is automatically included as needed by the USB driver
37 * dispatch header located in LUFA/Drivers/USB/USB.h.
38 */
39
40 /** \ingroup Group_Device
41 * \defgroup Group_Device_AVR8 Device Management (AVR8)
42 *
43 * USB Device mode related macros and enums. This module contains macros and enums which are used when
44 * the USB controller is initialized in device mode.
45 *
46 * @{
47 */
48
49 #ifndef __USBDEVICE_AVR8_H__
50 #define __USBDEVICE_AVR8_H__
51
52 /* Includes: */
53 #include "../../../../Common/Common.h"
54 #include "../StdDescriptors.h"
55 #include "../USBInterrupt.h"
56 #include "../Endpoint.h"
57
58 #include <avr/boot.h>
59
60 /* Preprocessor Checks: */
61 #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
62 #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
63 #endif
64
65 #if !defined(__INCLUDE_FROM_USB_DRIVER)
66 #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
67 #endif
68
69 /* Public Interface - May be used in end-application: */
70 /* Macros: */
71 /** \name USB Device Mode Option Masks */
72 //@{
73 #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)
74 /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
75 * USB interface should be initialized in low speed (1.5Mb/s) mode.
76 *
77 * \note Low Speed mode is not available on all USB AVR models.
78 * \n
79 *
80 * \note Restrictions apply on the number, size and type of endpoints which can be used
81 * when running in low speed mode - refer to the USB 2.0 specification.
82 */
83 #define USB_DEVICE_OPT_LOWSPEED (1 << 0)
84 #endif
85
86 /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
87 * USB interface should be initialized in full speed (12Mb/s) mode.
88 */
89 #define USB_DEVICE_OPT_FULLSPEED (0 << 0)
90 //@}
91
92 #if (!defined(NO_INTERNAL_SERIAL) && \
93 (defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1287__) || \
94 defined(__AVR_ATmega32U6__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__) || \
95 defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega8U2__)))
96 /** String descriptor index for the device's unique serial number string descriptor within the device.
97 * This unique serial number is used by the host to associate resources to the device (such as drivers or COM port
98 * number allocations) to a device regardless of the port it is plugged in to on the host. Some USB AVRs contain
99 * a unique serial number internally, and setting the device descriptors serial number string index to this value
100 * will cause it to use the internal serial number.
101 *
102 * On unsupported devices, this will evaluate to NO_DESCRIPTOR and so will force the host to create a pseudo-serial
103 * number for the device.
104 */
105 #define USE_INTERNAL_SERIAL 0xDC
106 #else
107 #define USE_INTERNAL_SERIAL NO_DESCRIPTOR
108 #endif
109
110 /* Function Prototypes: */
111 /** Sends a Remote Wakeup request to the host. This signals to the host that the device should
112 * be taken out of suspended mode, and communications should resume.
113 *
114 * Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the
115 * host computer when the host has suspended all USB devices to enter a low power state.
116 *
117 * \note This macro should only be used if the device has indicated to the host that it
118 * supports the Remote Wakeup feature in the device descriptors, and should only be
119 * issued if the host is currently allowing remote wakeup events from the device (i.e.,
120 * the \ref USB_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP compile
121 * time option is used, this macro is unavailable.
122 * \n\n
123 *
124 * \note The USB clock must be running for this function to operate. If the stack is initialized with
125 * the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running
126 * before attempting to call this function.
127 *
128 * \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
129 */
130 void USB_Device_SendRemoteWakeup(void);
131
132 /* Type Defines: */
133 enum USB_Device_States_t
134 {
135 DEVICE_STATE_Unattached = 0, /**< Internally implemented by the library. This state indicates
136 * that the device is not currently connected to a host.
137 */
138 DEVICE_STATE_Powered = 1, /**< Internally implemented by the library. This state indicates
139 * that the device is connected to a host, but enumeration has not
140 * yet begun.
141 */
142 DEVICE_STATE_Default = 2, /**< Internally implemented by the library. This state indicates
143 * that the device's USB bus has been reset by the host and it is
144 * now waiting for the host to begin the enumeration process.
145 */
146 DEVICE_STATE_Addressed = 3, /**< Internally implemented by the library. This state indicates
147 * that the device has been addressed by the USB Host, but is not
148 * yet configured.
149 */
150 DEVICE_STATE_Configured = 4, /**< May be implemented by the user project. This state indicates
151 * that the device has been enumerated by the host and is ready
152 * for USB communications to begin.
153 */
154 DEVICE_STATE_Suspended = 5, /**< May be implemented by the user project. This state indicates
155 * that the USB bus has been suspended by the host, and the device
156 * should power down to a minimal power level until the bus is
157 * resumed.
158 */
159 };
160
161 /* Inline Functions: */
162 /** Returns the current USB frame number, when in device mode. Every millisecond the USB bus is active (i.e. enumerated to a host)
163 * the frame number is incremented by one.
164 */
165 static inline uint16_t USB_Device_GetFrameNumber(void)
166 {
167 return UDFNUM;
168 }
169
170 #if !defined(NO_SOF_EVENTS)
171 /** Enables the device mode Start Of Frame events. When enabled, this causes the
172 * \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
173 * at the start of each USB frame when enumerated in device mode.
174 *
175 * \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
176 */
177 static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
178 static inline void USB_Device_EnableSOFEvents(void)
179 {
180 USB_INT_Enable(USB_INT_SOFI);
181 }
182
183 /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
184 * \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
185 *
186 * \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
187 */
188 static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
189 static inline void USB_Device_DisableSOFEvents(void)
190 {
191 USB_INT_Disable(USB_INT_SOFI);
192 }
193 #endif
194
195 /* Function Prototypes: */
196 /** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,
197 * index and language ID. This function MUST be overridden in the user application (added with full, identical
198 * prototype and name so that the library can call it to retrieve descriptor data.
199 *
200 * \param[in] wValue The type of the descriptor to retrieve in the upper byte, and the index in the
201 * lower byte (when more than one descriptor of the given type exists, such as the
202 * case of string descriptors). The type may be one of the standard types defined
203 * in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.
204 * \param[in] wIndex The language ID of the string to return if the \c wValue type indicates
205 * \ref DTYPE_String, otherwise zero for standard descriptors, or as defined in a
206 * class-specific standards.
207 * \param[out] DescriptorAddress Pointer to the descriptor in memory. This should be set by the routine to
208 * the address of the descriptor.
209 * \param[out] MemoryAddressSpace A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
210 * space in which the descriptor is stored. This parameter does not exist when one
211 * of the \c USE_*_DESCRIPTORS compile time options is used.
212 *
213 * \note By default, the library expects all descriptors to be located in flash memory via the \c PROGMEM attribute.
214 * If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
215 * allow the descriptors to be changed dynamically at runtime) either the \c USE_RAM_DESCRIPTORS or the
216 * \c USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D
217 * switch.
218 *
219 * \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise.
220 */
221 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
222 const uint8_t wIndex,
223 const void** const DescriptorAddress
224 #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
225 , uint8_t* MemoryAddressSpace
226 #endif
227 ) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
228
229 /* Private Interface - For use in library only: */
230 #if !defined(__DOXYGEN__)
231 /* Inline Functions: */
232 #if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))
233 static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE;
234 static inline void USB_Device_SetLowSpeed(void)
235 {
236 UDCON |= (1 << LSM);
237 }
238
239 static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE;
240 static inline void USB_Device_SetFullSpeed(void)
241 {
242 UDCON &= ~(1 << LSM);
243 }
244 #endif
245
246 static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;
247 static inline void USB_Device_SetDeviceAddress(const uint8_t Address)
248 {
249 UDADDR = ((UDADDR & (1 << ADDEN)) | (Address & 0x7F));
250 UDADDR |= (1 << ADDEN);
251 }
252
253 static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE;
254 static inline bool USB_Device_IsAddressSet(void)
255 {
256 return (UDADDR & (1 << ADDEN));
257 }
258
259 static inline uint8_t USB_Device_GetSerialString(wchar_t* UnicodeString, const uint8_t MaxLen)
260 {
261 uint8_t SerialCharNum = 0;
262
263 ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
264 {
265 uint8_t SigReadAddress = 0x0E;
266
267 for (SerialCharNum = 0; SerialCharNum < MIN(MaxLen, 20); SerialCharNum++)
268 {
269 if (SerialCharNum == MaxLen)
270 break;
271
272 uint8_t SerialByte = boot_signature_byte_get(SigReadAddress);
273
274 if (SerialCharNum & 0x01)
275 {
276 SerialByte >>= 4;
277 SigReadAddress++;
278 }
279
280 SerialByte &= 0x0F;
281
282 UnicodeString[SerialCharNum] = (SerialByte >= 10) ?
283 (('A' - 10) + SerialByte) : ('0' + SerialByte);
284 }
285 }
286
287 return SerialCharNum;
288 }
289
290 #endif
291
292 #endif
293
294 /** @} */
295
USB isp AVR programmer