Device_AVR8.h 10.9 KB
Newer Older
 Dean Camera committed May 08, 2010 1 2 /* LUFA Library  Dean Camera committed Jan 01, 2011 3  Copyright (C) Dean Camera, 2011.  4   Dean Camera committed May 08, 2010 5  dean [at] fourwalledcubicle [dot] com  Dean Camera committed Oct 28, 2010 6  www.lufa-lib.org  Dean Camera committed May 08, 2010 7 8 9 */ /*  Dean Camera committed Jan 01, 2011 10  Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)  Dean Camera committed May 08, 2010 11   12  Permission to use, copy, modify, distribute, and sell this  Dean Camera committed May 08, 2010 13  software and its documentation for any purpose is hereby granted  14  without fee, provided that the above copyright notice appear in  Dean Camera committed May 08, 2010 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  Dean Camera committed May 08, 2010 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  Dean Camera committed Feb 20, 2011 32 33  * \brief USB Device definitions for the AVR8 microcontrollers. * \copydetails Group_Device_AVR8  Dean Camera committed May 08, 2010 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. */  Dean Camera committed Feb 19, 2011 39 40 /** \ingroup Group_Device * \defgroup Group_Device_AVR8 Device Management (AVR8)  Dean Camera committed Feb 20, 2011 41  * \brief USB Device definitions for the AVR8 microcontrollers.  Dean Camera committed May 08, 2010 42  *  Dean Camera committed Feb 20, 2011 43  * Architecture specific USB Device definitions for the Atmel 8-bit AVR microcontrollers.  Dean Camera committed May 08, 2010 44 45 46 47  * * @{ */  Dean Camera committed Feb 19, 2011 48 49 #ifndef __USBDEVICE_AVR8_H__ #define __USBDEVICE_AVR8_H__  Dean Camera committed May 08, 2010 50 51  /* Includes: */  Dean Camera committed Feb 19, 2011 52 53 54 55 56  #include "../../../../Common/Common.h" #include "../StdDescriptors.h" #include "../USBInterrupt.h" #include "../Endpoint.h"  Dean Camera committed May 08, 2010 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   Dean Camera committed Feb 20, 2011 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  Dean Camera committed May 08, 2010 66 67  /* Public Interface - May be used in end-application: */ /* Macros: */  Dean Camera committed Oct 28, 2010 68 69  /** \name USB Device Mode Option Masks */ //@{  Dean Camera committed May 08, 2010 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 committed Aug 24, 2010 75  * \n  Dean Camera committed May 08, 2010 76 77  * * \note Restrictions apply on the number, size and type of endpoints which can be used  Dean Camera committed Aug 24, 2010 78  * when running in low speed mode - refer to the USB 2.0 specification.  Dean Camera committed May 08, 2010 79 80 81  */ #define USB_DEVICE_OPT_LOWSPEED (1 << 0) #endif  82   Dean Camera committed Jun 03, 2010 83  /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the  Dean Camera committed May 08, 2010 84 85 86  * USB interface should be initialized in full speed (12Mb/s) mode. */ #define USB_DEVICE_OPT_FULLSPEED (0 << 0)  Dean Camera committed Oct 28, 2010 87 88  //@}  Dean Camera committed Feb 19, 2011 89 90 91 92 93 94 95 96 97 98  #if (!defined(NO_INTERNAL_SERIAL) && \ (defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1287__) || \ defined(__AVR_ATmega32U6__) || defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__) || \ defined(__AVR_ATmega32U2__) || defined(__AVR_ATmega16U2__) || defined(__AVR_ATmega8U2__))) /** 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 * number allocations) to a device regardless of the port it is plugged in to on the host. Some USB AVRs contain * 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. *  Dean Camera committed Feb 27, 2011 99  * On unsupported devices, this will evaluate to \ref NO_DESCRIPTOR and so will force the host to create a pseudo-serial  Dean Camera committed Feb 19, 2011 100 101 102 103 104 105 106  * number for the device. */ #define USE_INTERNAL_SERIAL 0xDC #else #define USE_INTERNAL_SERIAL NO_DESCRIPTOR #endif  Dean Camera committed Jul 02, 2010 107 108 109 110 111 112 113 114 115 116  /* 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.,  Dean Camera committed Jan 08, 2011 117  * the \ref USB_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP compile  Dean Camera committed Jul 02, 2010 118  * time option is used, this macro is unavailable.  119  * \n\n  Dean Camera committed Jul 15, 2010 120 121 122 123  * * \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.  Dean Camera committed Jul 02, 2010 124  *  Dean Camera committed Feb 20, 2011 125  * \see \ref Group_StdDescriptors for more information on the RMWAKEUP feature and device descriptors.  Dean Camera committed Jul 02, 2010 126 127  */ void USB_Device_SendRemoteWakeup(void);  128   Dean Camera committed May 08, 2010 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156  /* Type Defines: */ enum USB_Device_States_t { DEVICE_STATE_Unattached = 0, /**< Internally implemented by the library. This state indicates * that the device is not currently connected to a host. */ DEVICE_STATE_Powered = 1, /**< Internally implemented by the library. This state indicates * that the device is connected to a host, but enumeration has not * yet begun. */ DEVICE_STATE_Default = 2, /**< Internally implemented by the library. This state indicates * that the device's USB bus has been reset by the host and it is * now waiting for the host to begin the enumeration process. */ DEVICE_STATE_Addressed = 3, /**< Internally implemented by the library. This state indicates * that the device has been addressed by the USB Host, but is not * yet configured. */ DEVICE_STATE_Configured = 4, /**< May be implemented by the user project. This state indicates * that the device has been enumerated by the host and is ready * for USB communications to begin. */ DEVICE_STATE_Suspended = 5, /**< May be implemented by the user project. This state indicates * that the USB bus has been suspended by the host, and the device * should power down to a minimal power level until the bus is * resumed. */ };  157   Dean Camera committed Jul 22, 2010 158  /* Inline Functions: */  Dean Camera committed Sep 05, 2010 159 160 161 162 163 164 165  /** 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; }  166   Dean Camera committed Oct 07, 2010 167 168 169 170 171  #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. *  Dean Camera committed Jan 08, 2011 172  * \note Not available when the \c NO_SOF_EVENTS compile time token is defined.  Dean Camera committed Oct 07, 2010 173 174 175 176 177 178  */ static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE; static inline void USB_Device_EnableSOFEvents(void) { USB_INT_Enable(USB_INT_SOFI); }  179   Dean Camera committed Oct 07, 2010 180 181 182  /** 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. *  Dean Camera committed Jan 08, 2011 183  * \note Not available when the \c NO_SOF_EVENTS compile time token is defined.  Dean Camera committed Oct 07, 2010 184 185 186 187 188 189 190  */ static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE; static inline void USB_Device_DisableSOFEvents(void) { USB_INT_Disable(USB_INT_SOFI); } #endif  191   Dean Camera committed May 08, 2010 192 193  /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__)  Dean Camera committed Jul 22, 2010 194 195 196 197 198 199 200  /* 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); }  201   Dean Camera committed Jul 22, 2010 202 203 204 205 206 207  static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE; static inline void USB_Device_SetFullSpeed(void) { UDCON &= ~(1 << LSM); } #endif  208   Dean Camera committed Jul 22, 2010 209 210 211  static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE; static inline void USB_Device_SetDeviceAddress(const uint8_t Address) {  212 213  UDADDR = ((UDADDR & (1 << ADDEN)) | (Address & 0x7F)); UDADDR |= (1 << ADDEN);  Dean Camera committed Sep 29, 2010 214 215 216 217 218 219 220  } static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE; static inline bool USB_Device_IsAddressSet(void) { return (UDADDR & (1 << ADDEN)); }  Dean Camera committed Feb 19, 2011 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252  static inline uint8_t USB_Device_GetSerialString(wchar_t* UnicodeString, const uint8_t MaxLen) { uint8_t SerialCharNum = 0; ATOMIC_BLOCK(ATOMIC_RESTORESTATE) { uint8_t SigReadAddress = 0x0E; for (SerialCharNum = 0; SerialCharNum < MIN(MaxLen, 20); SerialCharNum++) { if (SerialCharNum == MaxLen) break; uint8_t SerialByte = boot_signature_byte_get(SigReadAddress); if (SerialCharNum & 0x01) { SerialByte >>= 4; SigReadAddress++; } SerialByte &= 0x0F; UnicodeString[SerialCharNum] = (SerialByte >= 10) ? (('A' - 10) + SerialByte) : ('0' + SerialByte); } } return SerialCharNum; }  Dean Camera committed May 08, 2010 253 254 255 256 257  #endif #endif /** @} */  258