projects / pub / USBasp.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
More AVR32 achitecture ports.
[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Device.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2010.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2010 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 /** \ingroup Group_USB
32 * @defgroup Group_Device Device Management
33 *
34 * USB Device mode related macros and enums. This module contains macros and enums which are used when
35 * the USB controller is initialized in device mode.
36 *
37 * @{
38 */
39
40 #ifndef __USBDEVICE_H__
41 #define __USBDEVICE_H__
42
43 /* Includes: */
44 #if defined(__AVR__)
45 #include <avr/pgmspace.h>
46 #include <avr/eeprom.h>
47 #endif
48
49 #include "../../../Common/Common.h"
50 #include "../HighLevel/StdDescriptors.h"
51 #include "Endpoint.h"
52
53 /* Preprocessor Checks: */
54 #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
55 #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
56 #endif
57
58 #if !defined(__INCLUDE_FROM_USB_DRIVER)
59 #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
60 #endif
61
62 /* Public Interface - May be used in end-application: */
63 /* Macros: */
64 #if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || \
65 defined(USB_SERIES_UC3B_AVR) || defined(__DOXYGEN__))
66 /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
67 * USB interface should be initialized in low speed (1.5Mb/s) mode.
68 *
69 * \note Low Speed mode is not available on all USB AVR models.
70 *
71 * \note Restrictions apply on the number, size and type of endpoints which can be used
72 * when running in low speed mode -- refer to the USB 2.0 standard.
73 */
74 #define USB_DEVICE_OPT_LOWSPEED (1 << 0)
75 #endif
76
77 /** Mask for the Options parameter of the USB_Init() function. This indicates that the
78 * USB interface should be initialized in full speed (12Mb/s) mode.
79 */
80 #define USB_DEVICE_OPT_FULLSPEED (0 << 0)
81
82 /* Pseudo-Function Macros: */
83 #if defined(__DOXYGEN__)
84 /** Sends a Remote Wakeup request to the host. This signals to the host that the device should
85 * be taken out of suspended mode, and communications should resume.
86 *
87 * Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the
88 * host computer when the host has suspended all USB devices to enter a low power state.
89 *
90 * \note This macro should only be used if the device has indicated to the host that it
91 * supports the Remote Wakeup feature in the device descriptors, and should only be
92 * issued if the host is currently allowing remote wakeup events from the device (i.e.,
93 * the \ref USB_RemoteWakeupEnabled flag is set). When the NO_DEVICE_REMOTE_WAKEUP compile
94 * time option is used, this macro is unavailable.
95 *
96 * \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
97 */
98 static inline void USB_Device_SendRemoteWakeup(void);
99
100 /** Indicates if a Remote Wakeup request is being sent to the host. This returns true if a
101 * remote wakeup is currently being sent, false otherwise.
102 *
103 * This can be used in conjunction with the \ref USB_Device_IsUSBSuspended() macro to determine if
104 * a sent RMWAKEUP request was accepted or rejected by the host.
105 *
106 * \note This macro should only be used if the device has indicated to the host that it
107 * supports the Remote Wakeup feature in the device descriptors. When the NO_DEVICE_REMOTE_WAKEUP
108 * compile time option is used, this macro is unavailable.
109 *
110 * \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
111 *
112 * \return Boolean true if no Remote Wakeup request is currently being sent, false otherwise
113 */
114 static inline bool USB_Device_IsRemoteWakeupSent(void);
115
116 /** Indicates if the device is currently suspended by the host. Whilst suspended, the device is
117 * to enter a low power state until resumed by the host. No USB traffic to or from the device
118 * can occur (except for Remote Wakeup requests) during suspension by the host.
119 *
120 * \return Boolean true if the USB communications have been suspended by the host, false otherwise.
121 */
122 static inline bool USB_Device_IsUSBSuspended(void);
123
124 /** Enables the device mode Start Of Frame events. When enabled, this causes the
125 * \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
126 * at the start of each USB frame when enumerated in device mode.
127 */
128 static inline bool USB_Device_EnableSOFEvents(void);
129
130 /** Disables the device mode Start Of Frame events. When disabled, this stop the firing of the
131 * \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
132 */
133 static inline bool USB_Device_DisableSOFEvents(void);
134 #else
135 #if defined(__AVR32__)
136 #if !defined(NO_DEVICE_REMOTE_WAKEUP)
137 #define USB_Device_SendRemoteWakeup() MACROS{ AVR32_USBB.UDCON.rmwkup = true; }MACROE
138
139 #define USB_Device_IsRemoteWakeupSent() AVR32_USBB.UDCON.rmwkup
140 #endif
141
142 #define USB_Device_IsUSBSuspended() AVR32_USBB.UDINT.susp
143 #elif defined(__AVR__)
144 #if !defined(NO_DEVICE_REMOTE_WAKEUP)
145 #define USB_Device_SendRemoteWakeup() MACROS{ UDCON |= (1 << RMWKUP); }MACROE
146
147 #define USB_Device_IsRemoteWakeupSent() ((UDCON & (1 << RMWKUP)) ? false : true)
148 #endif
149
150 #define USB_Device_IsUSBSuspended() ((UDINT & (1 << SUSPI)) ? true : false)
151 #endif
152
153 #define USB_Device_EnableSOFEvents() MACROS{ USB_INT_Enable(USB_INT_SOFI); }MACROE
154 #define USB_Device_DisableSOFEvents() MACROS{ USB_INT_Disable(USB_INT_SOFI); }MACROE
155 #endif
156
157 /* Type Defines: */
158 enum USB_Device_States_t
159 {
160 DEVICE_STATE_Unattached = 0, /**< Internally implemented by the library. This state indicates
161 * that the device is not currently connected to a host.
162 */
163 DEVICE_STATE_Powered = 1, /**< Internally implemented by the library. This state indicates
164 * that the device is connected to a host, but enumeration has not
165 * yet begun.
166 */
167 DEVICE_STATE_Default = 2, /**< Internally implemented by the library. This state indicates
168 * that the device's USB bus has been reset by the host and it is
169 * now waiting for the host to begin the enumeration process.
170 */
171 DEVICE_STATE_Addressed = 3, /**< Internally implemented by the library. This state indicates
172 * that the device has been addressed by the USB Host, but is not
173 * yet configured.
174 */
175 DEVICE_STATE_Configured = 4, /**< May be implemented by the user project. This state indicates
176 * that the device has been enumerated by the host and is ready
177 * for USB communications to begin.
178 */
179 DEVICE_STATE_Suspended = 5, /**< May be implemented by the user project. This state indicates
180 * that the USB bus has been suspended by the host, and the device
181 * should power down to a minimal power level until the bus is
182 * resumed.
183 */
184 };
185
186 /* Function Prototypes: */
187 /** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,
188 * index and language ID. This function MUST be overridden in the user application (added with full, identical
189 * prototype and name so that the library can call it to retrieve descriptor data.
190 *
191 * \param[in] wValue The type of the descriptor to retrieve in the upper byte, and the index in the
192 * lower byte (when more than one descriptor of the given type exists, such as the
193 * case of string descriptors). The type may be one of the standard types defined
194 * in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.
195 * \param[in] wIndex The language ID of the string to return if the wValue type indicates DTYPE_String,
196 * otherwise zero for standard descriptors, or as defined in a class-specific
197 * standards.
198 * \param[out] DescriptorAddress Pointer to the descriptor in memory. This should be set by the routine to
199 * the address of the descriptor.
200 * \param[out] MemoryAddressSpace A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
201 * space in which the descriptor is stored. This parameter does not exist when one
202 * of the USE_*_DESCRIPTORS compile time options is used.
203 *
204 * \note By default, the library expects all descriptors to be located in flash memory via the PROGMEM attribute.
205 * If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
206 * allow the descriptors to be changed dynamically at runtime) either the USE_RAM_DESCRIPTORS or the
207 * USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D
208 * switch.
209 *
210 * \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise
211 */
212 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress
213 #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
214 , uint8_t* MemoryAddressSpace
215 #endif
216 )
217 ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
218
219 /* Private Interface - For use in library only: */
220 #if !defined(__DOXYGEN__)
221 /* Macros: */
222 #if defined(__AVR32__)
223 #define USB_Device_SetLowSpeed() MACROS{ AVR32_USBB.UDCON.ls = true; }MACROE
224 #define USB_Device_SetFullSpeed() MACROS{ AVR32_USBB.UDCON.ls = false; }MACROE
225
226 #define USB_Device_SetDeviceAddress(addr) MACROS{ AVR32_USBB.UDCON.uadd = DeviceAddress; AVR32_USBB.UDCON.adden = true; }MACROE
227 #elif defined(__AVR__)
228 #define USB_Device_SetLowSpeed() MACROS{ UDCON |= (1 << LSM); }MACROE
229 #define USB_Device_SetFullSpeed() MACROS{ UDCON &= ~(1 << LSM); }MACROE
230
231 #define USB_Device_SetDeviceAddress(addr) MACROS{ UDADDR = ((1 << ADDEN) | DeviceAddress); }MACROE
232 #endif
233 #endif
234
235 #endif
236
237 /** @} */
USB isp AVR programmer