Device.h 11 KB
 Dean Camera committed May 08, 2010 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 /* LUFA Library Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that the copyright notice and this 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 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 * \brief USB device mode definitions. * * This file contains structures, function prototypes and macros related to USB device mode. * * \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. */ /** \ingroup Group_USB * @defgroup Group_Device Device Management * * USB Device mode related macros and enums. This module contains macros and enums which are used when * the USB controller is initialized in device mode. * * @{ */ #ifndef __USBDEVICE_H__ #define __USBDEVICE_H__ /* Includes: */  Dean Camera committed Jul 22, 2010 53  #include  Dean Camera committed May 08, 2010 54 55 56 57 58  #include #include #include "../../../Common/Common.h" #include "../HighLevel/StdDescriptors.h"  Dean Camera committed Jul 22, 2010 59  #include "USBInterrupt.h"  Dean Camera committed May 08, 2010 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77  #include "Endpoint.h" /* Preprocessor Checks: */ #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)) #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive. #endif #if !defined(__INCLUDE_FROM_USB_DRIVER) #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead. #endif /* Public Interface - May be used in end-application: */ /* Macros: */ #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 78  * \n  Dean Camera committed May 08, 2010 79 80  * * \note Restrictions apply on the number, size and type of endpoints which can be used  Dean Camera committed Aug 24, 2010 81  * when running in low speed mode - refer to the USB 2.0 specification.  Dean Camera committed May 08, 2010 82 83 84 85  */ #define USB_DEVICE_OPT_LOWSPEED (1 << 0) #endif  Dean Camera committed Jun 03, 2010 86  /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the  Dean Camera committed May 08, 2010 87 88 89  * USB interface should be initialized in full speed (12Mb/s) mode. */ #define USB_DEVICE_OPT_FULLSPEED (0 << 0)  Dean Camera committed Jul 02, 2010 90 91 92 93 94 95 96 97 98 99 100 101 102  /* 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., * the \ref USB_RemoteWakeupEnabled flag is set). When the NO_DEVICE_REMOTE_WAKEUP compile * time option is used, this macro is unavailable.  Dean Camera committed Jul 15, 2010 103 104 105 106 107  * \n * * \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 108 109 110 111  * * \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors. */ void USB_Device_SendRemoteWakeup(void);  Dean Camera committed May 08, 2010 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141  /* 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. */ };  Dean Camera committed Jul 22, 2010 142 143 144 145 146  /* Inline Functions: */ /** 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 Jul 23, 2010 147  static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;  Dean Camera committed Jul 22, 2010 148 149 150 151 152  static inline void USB_Device_EnableSOFEvents(void) { USB_INT_Enable(USB_INT_SOFI); }  Dean Camera committed Aug 24, 2010 153  /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the  Dean Camera committed Jul 22, 2010 154 155 156 157 158 159 160 161  * \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode. */ static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE; static inline void USB_Device_DisableSOFEvents(void) { USB_INT_Disable(USB_INT_SOFI); }  Dean Camera committed May 08, 2010 162 163 164 165 166  /* Function Prototypes: */ /** Function to retrieve a given descriptor's size and memory location from the given descriptor type value, * index and language ID. This function MUST be overridden in the user application (added with full, identical * prototype and name so that the library can call it to retrieve descriptor data. *  Dean Camera committed May 29, 2010 167 168 169 170 171 172 173 174 175 176 177 178  * \param[in] wValue The type of the descriptor to retrieve in the upper byte, and the index in the * lower byte (when more than one descriptor of the given type exists, such as the * case of string descriptors). The type may be one of the standard types defined * in the DescriptorTypes_t enum, or may be a class-specific descriptor type value. * \param[in] wIndex The language ID of the string to return if the wValue type indicates DTYPE_String, * otherwise zero for standard descriptors, or as defined in a class-specific * standards. * \param[out] DescriptorAddress Pointer to the descriptor in memory. This should be set by the routine to * the address of the descriptor. * \param[out] MemoryAddressSpace A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory * space in which the descriptor is stored. This parameter does not exist when one * of the USE_*_DESCRIPTORS compile time options is used.  Dean Camera committed May 08, 2010 179 180 181 182 183 184 185  * * \note By default, the library expects all descriptors to be located in flash memory via the PROGMEM attribute. * If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to * allow the descriptors to be changed dynamically at runtime) either the USE_RAM_DESCRIPTORS or the * USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D * switch. *  Dean Camera committed Jun 17, 2010 186  * \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise.  Dean Camera committed May 08, 2010 187  */  Dean Camera committed Jul 21, 2010 188 189 190  uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress  Dean Camera committed May 08, 2010 191 192  #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS) , uint8_t* MemoryAddressSpace  Dean Camera committed Jul 21, 2010 193 194  #endif ) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);  Dean Camera committed May 08, 2010 195 196 197  /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__)  Dean Camera committed Jul 22, 2010 198 199 200 201 202 203 204  /* 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); }  Dean Camera committed Jul 21, 2010 205   Dean Camera committed Jul 22, 2010 206 207 208 209 210 211  static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE; static inline void USB_Device_SetFullSpeed(void) { UDCON &= ~(1 << LSM); } #endif  Dean Camera committed Jul 21, 2010 212   Dean Camera committed Jul 22, 2010 213 214 215 216 217  static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE; static inline void USB_Device_SetDeviceAddress(const uint8_t Address) { UDADDR = ((1 << ADDEN) | (Address & 0x7F)); }  Dean Camera committed May 08, 2010 218 219 220 221 222  #endif #endif /** @} */