Device.h 7.61 KB
 Dean Camera committed Feb 23, 2009 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 /* LUFA Library Copyright (C) Dean Camera, 2009. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, 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. */  Dean Camera committed Apr 16, 2009 30 31 32 33  /** \ingroup Group_USB * @defgroup Group_Device Device Management *  Dean Camera committed Apr 17, 2009 34 35  * 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.  Dean Camera committed Apr 16, 2009 36 37 38  * * @{ */  Dean Camera committed Feb 23, 2009 39 40 41 42 43 44 45 46 47 48 49 50  #ifndef __USBDEVICE_H__ #define __USBDEVICE_H__ /* Includes: */ #include #include #include "../../../Common/Common.h" #include "../HighLevel/StdDescriptors.h" #include "Endpoint.h"  Dean Camera committed Jun 14, 2009 51 52 53 54 55  /* Preprocessor Checks: */ #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS)) #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive. #endif  Dean Camera committed Feb 23, 2009 56 57  /* Public Interface - May be used in end-application: */ /* Macros: */  Dean Camera committed Jun 14, 2009 58  #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)  Dean Camera committed Apr 22, 2009 59  /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the  Dean Camera committed Feb 23, 2009 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74  * USB interface should be initialized in low speed (1.5Mb/s) mode. * * \note Low Speed mode is not available on all USB AVR models. * * \note Restrictions apply on the number, size and type of endpoints which can be used * when running in low speed mode -- refer to the USB 2.0 standard. */ #define USB_DEVICE_OPT_LOWSPEED (1 << 0) #endif /** Mask for the Options parameter of the USB_Init() function. This indicates that the * USB interface should be initialized in full speed (12Mb/s) mode. */ #define USB_DEVICE_OPT_FULLSPEED (0 << 0)  Dean Camera committed Apr 19, 2009 75  /* Pseudo-Function Macros: */  Dean Camera committed Apr 16, 2009 76 77 78 79 80 81 82 83 84 85  #if defined(__DOXYGEN__) /** 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 Apr 22, 2009 86  * the \ref USB_RemoteWakeupEnabled flag is set).  Dean Camera committed Apr 16, 2009 87  *  Dean Camera committed May 04, 2009 88  * \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.  Dean Camera committed Apr 16, 2009 89 90 91 92 93 94  */ static inline void USB_Device_SendRemoteWakeup(void); /** Indicates if a Remote Wakeup request is being sent to the host. This returns true if a * remote wakeup is currently being sent, false otherwise. *  Dean Camera committed Apr 22, 2009 95  * This can be used in conjunction with the \ref USB_Device_IsUSBSuspended() macro to determine if  Dean Camera committed Apr 16, 2009 96 97 98 99 100  * a sent RMWAKEUP request was accepted or rejected by the host. * * \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. *  Dean Camera committed May 04, 2009 101  * \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.  Dean Camera committed Apr 16, 2009 102 103 104 105 106  * * \return Boolean true if no Remote Wakeup request is currently being sent, false otherwise */ static inline bool USB_Device_IsRemoteWakeupSent(void);  Dean Camera committed Apr 22, 2009 107 108 109  /** Indicates if the device is currently suspended by the host. Whilst suspended, the device is * to enter a low power state until resumed by the host. No USB traffic to or from the device * can occur (except for Remote Wakeup requests) during suspension by the host.  Dean Camera committed Apr 16, 2009 110 111 112 113 114 115  * * \return Boolean true if the USB communications have been suspended by the host, false otherwise. */ static inline bool USB_Device_IsUSBSuspended(void); #else #define USB_Device_SendRemoteWakeup() MACROS{ UDCON |= (1 << RMWKUP); }MACROE  Dean Camera committed Feb 23, 2009 116   Dean Camera committed Apr 16, 2009 117  #define USB_Device_IsRemoteWakeupSent() ((UDCON & (1 << RMWKUP)) ? false : true)  Dean Camera committed Feb 23, 2009 118   Dean Camera committed Apr 16, 2009 119 120  #define USB_Device_IsUSBSuspended() ((UDINT & (1 << SUSPI)) ? true : false) #endif  Dean Camera committed Feb 23, 2009 121   Dean Camera committed May 22, 2009 122 123 124  /* 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  Dean Camera committed May 26, 2009 125  * prototype and name so that the library can call it to retrieve descriptor data.  Dean Camera committed Feb 23, 2009 126  *  Dean Camera committed May 22, 2009 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143  * \param 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 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 DescriptorAddress Pointer to the descriptor in memory. This should be set by the routine to * the address of the descriptor. * * \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. * * \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise  Dean Camera committed Feb 23, 2009 144  */  Dean Camera committed May 22, 2009 145  uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)  Dean Camera committed May 26, 2009 146  ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);  Dean Camera committed Feb 23, 2009 147 148 149 150 151 152 153  /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */ #define USB_Device_SetLowSpeed() MACROS{ UDCON |= (1 << LSM); }MACROE #define USB_Device_SetHighSpeed() MACROS{ UDCON &= ~(1 << LSM); }MACROE #endif  Dean Camera committed Apr 16, 2009 154   Dean Camera committed Feb 23, 2009 155 #endif  Dean Camera committed Apr 16, 2009 156 157  /** @} */