Host_AVR8.h 16.8 KB
 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 Host definitions for the AVR8 microcontrollers. * \copydetails Group_Host_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_Host * \defgroup Group_Host_AVR8 Host Management (AVR8)  Dean Camera committed Feb 20, 2011 41  * \brief USB Host definitions for the AVR8 microcontrollers.  Dean Camera committed May 08, 2010 42  *  Dean Camera committed Feb 20, 2011 43  * Architecture specific USB Host 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 __USBHOST_AVR8_H__ #define __USBHOST_AVR8_H__  Dean Camera committed May 08, 2010 50 51  /* Includes: */  Dean Camera committed Feb 19, 2011 52 53 54 55  #include "../../../../Common/Common.h" #include "../StdDescriptors.h" #include "../Pipe.h" #include "../USBInterrupt.h"  Dean Camera committed May 08, 2010 56 57 58 59 60 61 62 63 64 65  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* Preprocessor Checks: */ #if !defined(__INCLUDE_FROM_USB_DRIVER) #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead. #endif  66   Dean Camera committed May 08, 2010 67 68 69 70 71 72 73 74 75 76 77 78 79 80  /* Public Interface - May be used in end-application: */ /* Macros: */ /** Indicates the fixed USB device address which any attached device is enumerated to when in * host mode. As only one USB device may be attached to the AVR in host mode at any one time * and that the address used is not important (other than the fact that it is non-zero), a * fixed value is specified by the library. */ #define USB_HOST_DEVICEADDRESS 1 #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__) /** Constant for the maximum software timeout period of sent USB control transactions to an attached * device. If a device fails to respond to a sent control request within this period, the * library will return a timeout error code. *  81  * This value may be overridden in the user project makefile as the value of the  Dean Camera committed May 08, 2010 82 83 84 85  * \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch. */ #define USB_HOST_TIMEOUT_MS 1000 #endif  86   Dean Camera committed May 08, 2010 87 88 89 90 91 92  #if !defined(HOST_DEVICE_SETTLE_DELAY_MS) || defined(__DOXYGEN__) /** Constant for the delay in milliseconds after a device is connected before the library * will start the enumeration process. Some devices require a delay of up to 5 seconds * after connection before the enumeration process can start or incorrect operation will * occur. *  Dean Camera committed Jan 13, 2011 93 94  * The default delay value may be overridden in the user project makefile by defining the * \c HOST_DEVICE_SETTLE_DELAY_MS token to the required delay in milliseconds, and passed to the  Dean Camera committed Sep 04, 2010 95  * compiler using the -D switch.  Dean Camera committed May 08, 2010 96  */  Dean Camera committed Sep 04, 2010 97  #define HOST_DEVICE_SETTLE_DELAY_MS 1000  Dean Camera committed May 08, 2010 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112  #endif /** Enum for the error codes for the \ref EVENT_USB_Host_HostError() event. * * \see \ref Group_Events for more information on this event. */ enum USB_Host_ErrorCodes_t { HOST_ERROR_VBusVoltageDip = 0, /**< VBUS voltage dipped to an unacceptable level. This * error may be the result of an attached device drawing * too much current from the VBUS line, or due to the * AVR's power source being unable to supply sufficient * current. */ };  113   Dean Camera committed May 08, 2010 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132  /** Enum for the error codes for the \ref EVENT_USB_Host_DeviceEnumerationFailed() event. * * \see \ref Group_Events for more information on this event. */ enum USB_Host_EnumerationErrorCodes_t { HOST_ENUMERROR_NoError = 0, /**< No error occurred. Used internally, this is not a valid * ErrorCode parameter value for the \ref EVENT_USB_Host_DeviceEnumerationFailed() * event. */ HOST_ENUMERROR_WaitStage = 1, /**< One of the delays between enumeration steps failed * to complete successfully, due to a timeout or other * error. */ HOST_ENUMERROR_NoDeviceDetected = 2, /**< No device was detected, despite the USB data lines * indicating the attachment of a device. */ HOST_ENUMERROR_ControlError = 3, /**< One of the enumeration control requests failed to * complete successfully.  Dean Camera committed Jul 21, 2010 133  */  Dean Camera committed May 08, 2010 134 135 136 137 138  HOST_ENUMERROR_PipeConfigError = 4, /**< The default control pipe (address 0) failed to * configure correctly. */ };  Dean Camera committed Jul 22, 2010 139  /* Inline Functions: */  Dean Camera committed Sep 05, 2010 140 141 142  /** Returns the current USB frame number, when in host mode. Every millisecond the USB bus is active (i.e. not suspended) * the frame number is incremented by one. */  143  static inline uint16_t USB_Host_GetFrameNumber(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;  Dean Camera committed Sep 05, 2010 144 145 146 147  static inline uint16_t USB_Host_GetFrameNumber(void) { return UHFNUM; }  148   Dean Camera committed Oct 07, 2010 149 150 151 152 153  #if !defined(NO_SOF_EVENTS) /** Enables the host mode Start Of Frame events. When enabled, this causes the * \ref EVENT_USB_Host_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus, * at the start of each USB frame when a device is enumerated while in host mode. *  Dean Camera committed Jan 08, 2011 154  * \note Not available when the \c NO_SOF_EVENTS compile time token is defined.  Dean Camera committed Oct 07, 2010 155 156 157 158 159 160  */ static inline void USB_Host_EnableSOFEvents(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_EnableSOFEvents(void) { USB_INT_Enable(USB_INT_HSOFI); }  161   Dean Camera committed Oct 07, 2010 162 163 164 165 166 167 168 169 170 171 172  /** Disables the host mode Start Of Frame events. When disabled, this stops the firing of the * \ref EVENT_USB_Host_StartOfFrame() event when enumerated in host mode. * * \note Not available when the NO_SOF_EVENTS compile time token is defined. */ static inline void USB_Host_DisableSOFEvents(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_DisableSOFEvents(void) { USB_INT_Disable(USB_INT_HSOFI); } #endif  173   Dean Camera committed Jul 22, 2010 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188  /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host. * USB bus resets leave the default control pipe configured (if already configured). * * If the USB bus has been suspended prior to issuing a bus reset, the attached device will be * woken up automatically and the bus resumed after the reset has been correctly issued. */ static inline void USB_Host_ResetBus(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_ResetBus(void) { UHCON |= (1 << RESET); } /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has * completed. *  Dean Camera committed Jan 08, 2011 189  * \return Boolean \c true if no bus reset is currently being sent, \c false otherwise.  Dean Camera committed Jul 22, 2010 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215  */ static inline bool USB_Host_IsBusResetComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_Host_IsBusResetComplete(void) { return ((UHCON & (1 << RESET)) ? false : true); } /** Resumes USB communications with an attached and enumerated device, by resuming the transmission * of the 1MS Start Of Frame messages to the device. When resumed, USB communications between the * host and attached device may occur. */ static inline void USB_Host_ResumeBus(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_ResumeBus(void) { UHCON |= (1 << SOFEN); } /** Suspends the USB bus, preventing any communications from occurring between the host and attached * device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame * messages to the device. */ static inline void USB_Host_SuspendBus(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_SuspendBus(void) { UHCON &= ~(1 << SOFEN); }  216   Dean Camera committed Jul 22, 2010 217 218 219 220  /** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro, * false otherwise. While suspended, no USB communications can occur until the bus is resumed, * except for the Remote Wakeup event from the device if supported. *  Dean Camera committed Jan 08, 2011 221  * \return Boolean \c true if the bus is currently suspended, \c false otherwise.  Dean Camera committed Jul 22, 2010 222 223 224 225 226 227  */ static inline bool USB_Host_IsBusSuspended(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_Host_IsBusSuspended(void) { return ((UHCON & (1 << SOFEN)) ? false : true); }  228   Dean Camera committed Jul 22, 2010 229 230 231  /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or * false if the attached device is enumerated in Low Speed mode (1.5Mb/s). *  Dean Camera committed Jan 08, 2011 232  * \return Boolean \c true if the attached device is enumerated in Full Speed mode, \c false otherwise.  Dean Camera committed Jul 22, 2010 233 234 235 236 237 238 239 240 241 242  */ static inline bool USB_Host_IsDeviceFullSpeed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_Host_IsDeviceFullSpeed(void) { return ((USBSTA & (1 << SPEED)) ? true : false); } /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting * that the host resume the USB bus and wake up the device, false otherwise. *  Dean Camera committed Jan 08, 2011 243  * \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise.  Dean Camera committed Jul 22, 2010 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266  */ static inline bool USB_Host_IsRemoteWakeupSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_Host_IsRemoteWakeupSent(void) { return ((UHINT & (1 << RXRSMI)) ? true : false); } /** Clears the flag indicating that a Remote Wakeup request has been issued by an attached device. */ static inline void USB_Host_ClearRemoteWakeupSent(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_ClearRemoteWakeupSent(void) { UHINT &= ~(1 << RXRSMI); } /** Accepts a Remote Wakeup request from an attached device. This must be issued in response to * a device's Remote Wakeup request within 2ms for the request to be accepted and the bus to * be resumed. */ static inline void USB_Host_ResumeFromWakeupRequest(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_ResumeFromWakeupRequest(void) { UHCON |= (1 << RESUME); }  267   Dean Camera committed Jul 22, 2010 268 269 270  /** Determines if a resume from Remote Wakeup request is currently being sent to an attached * device. *  Dean Camera committed Jan 08, 2011 271  * \return Boolean \c true if no resume request is currently being sent, \c false otherwise.  Dean Camera committed Jul 22, 2010 272 273 274 275 276 277 278 279  */ static inline bool USB_Host_IsResumeFromWakeupRequestSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool USB_Host_IsResumeFromWakeupRequestSent(void) { return ((UHCON & (1 << RESUME)) ? false : true); } /* Function Prototypes: */  Dean Camera committed Jan 08, 2011 280  /** Convenience function. This routine sends a SET CONFIGURATION standard request to the attached  Dean Camera committed Jul 22, 2010 281 282 283 284 285 286 287 288 289 290  * device, with the given configuration index. This can be used to easily set the device * configuration without creating and sending the request manually. * * \note After this routine returns, the control pipe will be selected. * * \param[in] ConfigNumber Configuration index to send to the device. * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result. */ uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);  291   Dean Camera committed Jan 08, 2011 292  /** Convenience function. This routine sends a GET DESCRIPTOR standard request to the attached  Dean Camera committed Jul 22, 2010 293 294 295 296 297 298 299 300 301 302 303  * device, requesting the device descriptor. This can be used to easily retrieve information * about the device such as its VID, PID and power requirements. * * \note After this routine returns, the control pipe will be selected. * * \param[out] DeviceDescriptorPtr Pointer to the destination device descriptor structure where * the read data is to be stored. * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result. */ uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr);  304   Dean Camera committed Jan 08, 2011 305  /** Convenience function. This routine sends a GET DESCRIPTOR standard request to the attached  Dean Camera committed Jul 22, 2010 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321  * device, requesting the string descriptor of the specified index. This can be used to easily * retrieve string descriptors from the device by index, after the index is obtained from the * Device or Configuration descriptors. * * \note After this routine returns, the control pipe will be selected. * * \param[in] Index Index of the string index to retrieve. * \param[out] Buffer Pointer to the destination buffer where the retrieved string descriptor is * to be stored. * \param[in] BufferLength Maximum size of the string descriptor which can be stored into the buffer. * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result. */ uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index, void* const Buffer, const uint8_t BufferLength);  322   Dean Camera committed Jan 08, 2011 323  /** Clears a stall condition on the given pipe, via a CLEAR FEATURE standard request to the attached device.  Dean Camera committed Jul 22, 2010 324 325 326  * * \note After this routine returns, the control pipe will be selected. *  Dean Camera committed Sep 21, 2010 327  * \param[in] EndpointIndex Index of the endpoint to clear, including the endpoint's direction.  Dean Camera committed Jul 22, 2010 328 329 330  * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result. */  Dean Camera committed Oct 12, 2010 331  uint8_t USB_Host_ClearPipeStall(const uint8_t EndpointIndex);  Dean Camera committed Jul 22, 2010 332   Dean Camera committed May 08, 2010 333 334 335  /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */  Dean Camera committed Jul 22, 2010 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353  static inline void USB_Host_HostMode_On(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_HostMode_On(void) { USBCON |= (1 << HOST); } static inline void USB_Host_HostMode_Off(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_HostMode_Off(void) { USBCON &= ~(1 << HOST); } static inline void USB_Host_VBUS_Auto_Enable(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_VBUS_Auto_Enable(void) { OTGCON &= ~(1 << VBUSHWC); UHWCON |= (1 << UVCONE); }  354   Dean Camera committed Jul 22, 2010 355 356 357 358 359  static inline void USB_Host_VBUS_Manual_Enable(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_VBUS_Manual_Enable(void) { OTGCON |= (1 << VBUSHWC); UHWCON &= ~(1 << UVCONE);  360   Dean Camera committed Jul 22, 2010 361 362  DDRE |= (1 << 7); }  Dean Camera committed May 08, 2010 363   Dean Camera committed Jul 22, 2010 364 365 366 367 368  static inline void USB_Host_VBUS_Auto_On(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_VBUS_Auto_On(void) { OTGCON |= (1 << VBUSREQ); }  Dean Camera committed May 08, 2010 369   Dean Camera committed Jul 22, 2010 370 371 372 373 374  static inline void USB_Host_VBUS_Manual_On(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_VBUS_Manual_On(void) { PORTE |= (1 << 7); }  375   Dean Camera committed Jul 22, 2010 376 377 378 379 380  static inline void USB_Host_VBUS_Auto_Off(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_VBUS_Auto_Off(void) { OTGCON |= (1 << VBUSRQC); }  Dean Camera committed May 08, 2010 381   Dean Camera committed Jul 22, 2010 382 383 384 385  static inline void USB_Host_VBUS_Manual_Off(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_VBUS_Manual_Off(void) { PORTE &= ~(1 << 7);  386  }  Dean Camera committed May 08, 2010 387   Dean Camera committed Jul 22, 2010 388 389 390 391 392  static inline void USB_Host_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE; static inline void USB_Host_SetDeviceAddress(const uint8_t Address) { UHADDR = (Address & 0x7F); }  Dean Camera committed May 08, 2010 393 394 395 396 397 398 399 400 401 402 403 404 405  /* Enums: */ enum USB_Host_WaitMSErrorCodes_t { HOST_WAITERROR_Successful = 0, HOST_WAITERROR_DeviceDisconnect = 1, HOST_WAITERROR_PipeError = 2, HOST_WAITERROR_SetupStalled = 3, }; /* Function Prototypes: */ void USB_Host_ProcessNextHostState(void); uint8_t USB_Host_WaitMS(uint8_t MS);  406   Dean Camera committed May 08, 2010 407 408 409 410 411 412 413 414 415  #if defined(__INCLUDE_FROM_HOST_C) static void USB_Host_ResetDevice(void); #endif #endif /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif  416   Dean Camera committed May 08, 2010 417 418 419 #endif /** @} */  420