LowLevel.h 16.6 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 30 /* 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 31 32 33 34 35 36 37 38 /** \ingroup Group_USB * @defgroup Group_USBManagement USB Interface Management * * Functions, macros, variables, enums and types related to the setup and management of the USB interface. * * @{ */  Dean Camera committed Feb 23, 2009 39 40 41 42 43 44 45 46 #ifndef __USBLOWLEVEL_H__ #define __USBLOWLEVEL_H__ /* Includes: */ #include #include #include  Dean Camera committed Apr 05, 2009 47 48  #include "../HighLevel/USBMode.h"  Dean Camera committed Feb 23, 2009 49  #include "../../../Common/Common.h"  Dean Camera committed Apr 05, 2009 50  #include "../HighLevel/USBMode.h"  Dean Camera committed Feb 23, 2009 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72  #include "../HighLevel/Events.h" #include "../HighLevel/USBTask.h" #include "../HighLevel/USBInterrupt.h" #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__) #include "Host.h" #include "Pipe.h" #include "OTG.h" #endif #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__) #include "Device.h" #include "Endpoint.h" #include "DevChapter9.h" #endif /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* Preprocessor Checks and Defines: */  Dean Camera committed Feb 26, 2009 73 74 75 76 77  #if !defined(F_CLOCK) #error F_CLOCK is not defined. You must device F_CLOCK to the frequency of the unprescaled input clock in your project makefile. #endif #if (F_CLOCK == 8000000)  Dean Camera committed Feb 23, 2009 78 79 80 81  #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__)) #define USB_PLL_PSC 0 #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__)) #define USB_PLL_PSC 0  Dean Camera committed Jun 14, 2009 82 83 84 85  #elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__) || defined(__AVR_ATmega32U6__)) #define USB_PLL_PSC ((1 << PLLP1) | (1 << PLLP0)) #elif (defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1287__)) #define USB_PLL_PSC ((1 << PLLP1) | (1 << PLLP0))  Dean Camera committed Feb 23, 2009 86  #endif  Dean Camera committed Feb 26, 2009 87  #elif (F_CLOCK == 16000000)  Dean Camera committed Jun 14, 2009 88  #if (defined(__AVR_AT90USB82__) || defined(__AVR_AT90USB162__))  Dean Camera committed Feb 23, 2009 89 90 91  #define USB_PLL_PSC (1 << PLLP0) #elif (defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__)) #define USB_PLL_PSC (1 << PINDIV)  Dean Camera committed Jun 14, 2009 92 93 94 95  #elif (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_ATmega32U6__)) #define USB_PLL_PSC ((1 << PLLP2) | (1 << PLLP1)) #elif (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__)) #define USB_PLL_PSC ((1 << PLLP2) | (1 << PLLP0))  Dean Camera committed Feb 23, 2009 96 97 98 99 100 101 102 103 104  #endif #endif #if !defined(USB_PLL_PSC) #error No PLL prescale value available for chosen F_CPU value and AVR model. #endif /* Public Interface - May be used in end-application: */ /* Macros: */  Dean Camera committed Apr 22, 2009 105  /** Mode mask for the \ref USB_CurrentMode global. This indicates that the USB interface is currently not  Dean Camera committed Feb 23, 2009 106 107 108 109  * initialized into any mode. */ #define USB_MODE_NONE 0  Dean Camera committed Jun 14, 2009 110 111 112 113  /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the * USB interface is or should be initialized in the USB device mode. */ #define USB_MODE_DEVICE 1  Dean Camera committed Jun 14, 2009 114   Dean Camera committed Mar 31, 2009 115  #if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)  Dean Camera committed Apr 22, 2009 116  /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the  Dean Camera committed Mar 31, 2009 117 118 119 120  * USB interface is or should be initialized in the USB host mode. * * \note This token is not available on AVR models which do not support host mode. */  Dean Camera committed May 04, 2009 121  #define USB_MODE_HOST 2  Dean Camera committed Mar 31, 2009 122 123 124  #endif #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)  Dean Camera committed Apr 22, 2009 125  /** Mode mask for the the \ref USB_Init() function. This indicates that the USB interface should be  Dean Camera committed Mar 31, 2009 126 127 128 129 130 131 132  * initialized into whatever mode the UID pin of the USB AVR indicates, and that the device * should swap over its mode when the level of the UID pin changes during operation. * * \note This token is not available on AVR models which do not support both host and device modes. */ #define USB_MODE_UID 3 #endif  Dean Camera committed Feb 23, 2009 133   Dean Camera committed Apr 22, 2009 134  /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad  Dean Camera committed Feb 23, 2009 135 136 137 138 139 140  * regulator should be enabled to regulate the data pin voltages to within the USB standard. * * \note See USB AVR data sheet for more information on the internal pad regulator. */ #define USB_OPT_REG_DISABLED (1 << 1)  Dean Camera committed Apr 22, 2009 141  /** Regulator enable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad  Dean Camera committed Feb 23, 2009 142 143 144 145 146 147  * regulator should be disabled and the AVR's VCC level used for the data pads. * * \note See USB AVR data sheet for more information on the internal pad regulator. */ #define USB_OPT_REG_ENABLED (0 << 1)  Dean Camera committed Apr 22, 2009 148  /** Manual PLL control option mask for \ref USB_Init(). This indicates to the library that the user application  Dean Camera committed Feb 23, 2009 149 150 151 152 153  * will take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock * that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations. */ #define USB_OPT_MANUAL_PLL (1 << 2)  Dean Camera committed Apr 22, 2009 154  /** Automatic PLL control option mask for \ref USB_Init(). This indicates to the library that the library should  Dean Camera committed Feb 23, 2009 155 156 157 158 159 160 161  * take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock * that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations. */ #define USB_OPT_AUTO_PLL (0 << 2) /** Mask for a CONTROL type endpoint or pipe. *  Dean Camera committed May 04, 2009 162  * \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.  Dean Camera committed Feb 23, 2009 163  */  Dean Camera committed Apr 05, 2009 164  #define EP_TYPE_CONTROL 0x00  Dean Camera committed Feb 23, 2009 165 166 167  /** Mask for an ISOCHRONOUS type endpoint or pipe. *  Dean Camera committed May 04, 2009 168  * \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.  Dean Camera committed Feb 23, 2009 169  */  Dean Camera committed Apr 05, 2009 170  #define EP_TYPE_ISOCHRONOUS 0x01  Dean Camera committed Feb 23, 2009 171 172 173  /** Mask for a BULK type endpoint or pipe. *  Dean Camera committed May 04, 2009 174  * \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.  Dean Camera committed Feb 23, 2009 175  */  Dean Camera committed Apr 05, 2009 176  #define EP_TYPE_BULK 0x02  Dean Camera committed Feb 23, 2009 177 178 179  /** Mask for an INTERRUPT type endpoint or pipe. *  Dean Camera committed May 04, 2009 180  * \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.  Dean Camera committed Feb 23, 2009 181  */  Dean Camera committed Apr 05, 2009 182  #define EP_TYPE_INTERRUPT 0x03  Dean Camera committed Feb 23, 2009 183   Dean Camera committed Jun 14, 2009 184  #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)  Dean Camera committed Mar 31, 2009 185 186 187 188 189 190 191  /** Returns boolean true if the VBUS line is currently high (i.e. the USB host is supplying power), * otherwise returns false. * * \note This token is not available on some AVR models which do not support hardware VBUS monitoring. */ #define USB_VBUS_GetStatus() ((USBSTA & (1 << VBUS)) ? true : false) #endif  Dean Camera committed Feb 23, 2009 192 193 194  /** Detaches the device from the USB bus. This has the effect of removing the device from any * host if, ceasing USB communications. If no host is present, this prevents any host from  Dean Camera committed Apr 22, 2009 195  * enumerating the device once attached until \ref USB_Attach() is called.  Dean Camera committed Feb 23, 2009 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211  */ #define USB_Detach() MACROS{ UDCON |= (1 << DETACH); }MACROE /** Attaches the device to the USB bus. This announces the device's presence to any attached * USB host, starting the enumeration process. If no host is present, attaching the device * will allow for enumeration once a host is connected to the device. * * This is inexplicably also required for proper operation while in host mode, to enable the * attachment of a device to the host. This is despite the bit being located in the device-mode * register and despite the datasheet making no mention of its requirement in host mode. */ #define USB_Attach() MACROS{ UDCON &= ~(1 << DETACH); }MACROE #if !defined(USB_STREAM_TIMEOUT_MS) || defined(__DOXYGEN__) /** Constant for the maximum software timeout period of the USB data stream transfer functions * (both control and standard) when in either device or host mode. If the next packet of a stream  Dean Camera committed Mar 10, 2009 212  * is not received or acknowledged within this time period, the stream function will fail.  Dean Camera committed Feb 23, 2009 213 214  * * This value may be overridden in the user project makefile as the value of the  Dean Camera committed Apr 22, 2009 215  * \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.  Dean Camera committed Feb 23, 2009 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231  */ #define USB_STREAM_TIMEOUT_MS 100 #endif /* Function Prototypes: */ /** Main function to initialize and start the USB interface. Once active, the USB interface will * allow for device connection to a host when in device mode, or for device enumeration while in * host mode. * * As the USB library relies on USB interrupts for some of its functionality, this routine will * enable global interrupts. * * Calling this function when the USB interface is already initialized will cause a complete USB * interface reset and re-enumeration. * * \param Mode This is a mask indicating what mode the USB interface is to be initialized to.  Dean Camera committed Apr 22, 2009 232  * Valid mode masks are \ref USB_MODE_DEVICE, \ref USB_MODE_HOST or \ref USB_MODE_UID.  Dean Camera committed Feb 23, 2009 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274  * * \param Options Mask indicating the options which should be used when initializing the USB * interface to control the USB interface's behaviour. This should be comprised of * a USB_OPT_REG_* mask to control the regulator, a USB_OPT_*_PLL mask to control the * PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device * mode speed. * * \note To reduce the FLASH requirements of the library if only device or host mode is required, * this can be statically set via defining the token USB_DEVICE_ONLY for device mode or * USB_HOST_ONLY for host mode in the use project makefile, passing the token to the compiler * via the -D switch. If the mode is statically set, this parameter does not exist in the * function prototype. * * \note To reduce the FLASH requirements of the library if only fixed settings are are required, * the options may be set statically in the same manner as the mode (see the Mode parameter of * this function). To statically set the USB options, pass in the USE_STATIC_OPTIONS token, * defined to the appropriate options masks. When the options are statically set, this * parameter does not exist in the function prototype. * * \note The mode parameter does not exist on devices where only one mode is possible, such as USB * AVR models which only implement the USB device mode in hardware. * * \see Device.h for the USB_DEVICE_OPT_* masks. */ void USB_Init( #if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__) const uint8_t Mode #endif #if (defined(USB_CAN_BE_BOTH) && !defined(USE_STATIC_OPTIONS)) || defined(__DOXYGEN__) , #elif (!defined(USB_CAN_BE_BOTH) && defined(USE_STATIC_OPTIONS)) void #endif #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__) const uint8_t Options #endif ); /** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO * memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface  Dean Camera committed Apr 22, 2009 275  * is restarted with the \ref USB_Init() function.  Dean Camera committed Feb 23, 2009 276 277 278 279 280 281 282 283 284 285  */ void USB_ShutDown(void); /** Resets the interface, when already initialized. This will re-enumerate the device if already connected * to a host, or re-enumerate an already attached device when in host mode. */ void USB_ResetInterface(void); /* Enums: */ /** Enum for error codes relating to the powering on of the USB interface. These error codes are  Dean Camera committed May 18, 2009 286  * used in the ErrorCode parameter value of the \ref EVENT_USB_InitFailure() event.  Dean Camera committed Feb 23, 2009 287  */  288  enum USB_InitErrorCodes_t  Dean Camera committed Feb 23, 2009 289  {  290  USB_INITERROR_NoUSBModeSpecified = 0, /**< Indicates that \ref USB_Init() was called with an  Dean Camera committed Feb 23, 2009 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306  * invalid or missing Mode parameter. */ }; /* Global Variables: */ #if (!defined(USB_HOST_ONLY) && !defined(USB_DEVICE_ONLY)) || defined(__DOXYGEN__) /** Indicates the mode that the USB interface is currently initialized to. This value will be * one of the USB_MODE_* masks defined elsewhere in this module. * * \note This variable should be treated as read-only in the user application, and never manually * changed in value. */ extern volatile uint8_t USB_CurrentMode; #endif #if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)  Dean Camera committed Apr 22, 2009 307  /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()  Dean Camera committed Feb 23, 2009 308 309 310 311 312  * was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module. * * \note This variable should be treated as read-only in the user application, and never manually * changed in value. */  Dean Camera committed May 04, 2009 313  extern volatile uint8_t USB_Options;  Dean Camera committed Feb 23, 2009 314 315 316 317 318 319 320 321 322  #endif /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */ #define USB_PLL_On() MACROS{ PLLCSR = USB_PLL_PSC; PLLCSR |= (1 << PLLE); }MACROE #define USB_PLL_Off() MACROS{ PLLCSR = 0; }MACROE #define USB_PLL_IsReady() ((PLLCSR & (1 << PLOCK)) ? true : false)  Dean Camera committed Jun 14, 2009 323  #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)  Dean Camera committed Feb 23, 2009 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341  #define USB_REG_On() MACROS{ UHWCON |= (1 << UVREGE); }MACROE #define USB_REG_Off() MACROS{ UHWCON &= ~(1 << UVREGE); }MACROE #else #define USB_REG_On() MACROS{ REGCR &= ~(1 << REGDIS); }MACROE #define USB_REG_Off() MACROS{ REGCR |= (1 << REGDIS); }MACROE #endif #define USB_OTGPAD_On() MACROS{ USBCON |= (1 << OTGPADE); }MACROE #define USB_OTGPAD_Off() MACROS{ USBCON &= ~(1 << OTGPADE); }MACROE #define USB_CLK_Freeze() MACROS{ USBCON |= (1 << FRZCLK); }MACROE #define USB_CLK_Unfreeze() MACROS{ USBCON &= ~(1 << FRZCLK); }MACROE #define USB_Interface_Enable() MACROS{ USBCON |= (1 << USBE); }MACROE #define USB_Interface_Disable() MACROS{ USBCON &= ~(1 << USBE); }MACROE #define USB_Interface_Reset() MACROS{ uint8_t Temp = USBCON; USBCON = (Temp & ~(1 << USBE)); \ USBCON = (Temp | (1 << USBE)); }MACROE  Dean Camera committed Mar 31, 2009 342 343  /* Inline Functions: */ #if defined(USB_CAN_BE_BOTH)  Dean Camera committed May 13, 2009 344  static inline uint8_t USB_GetUSBModeFromUID(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;  Dean Camera committed Feb 23, 2009 345 346 347 348 349 350 351  static inline uint8_t USB_GetUSBModeFromUID(void) { if (USBSTA & (1 << ID)) return USB_MODE_DEVICE; else return USB_MODE_HOST; }  Dean Camera committed Mar 31, 2009 352 353  #endif  Dean Camera committed Feb 23, 2009 354 355 356 357 358 359 360 361  #endif /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif  Dean Camera committed Apr 16, 2009 362 363  /** @} */