Host.h 22.9 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 /** \ingroup Group_USB * @defgroup Group_Host Host Management *  Dean Camera committed Apr 17, 2009 34 35  * USB Host mode related macros and enums. This module contains macros and enums which are used when * the USB controller is initialized in host mode.  Dean Camera committed Apr 16, 2009 36 37 38 39  * * @{ */  Dean Camera committed Feb 23, 2009 40 41 42 43 44 45 46 47 48 49 #ifndef __USBHOST_H__ #define __USBHOST_H__ /* Includes: */ #include #include #include #include "../../../Common/Common.h" #include "../HighLevel/USBInterrupt.h"  Dean Camera committed Jun 18, 2009 50 51  #include "../HighLevel/StdDescriptors.h" #include "Pipe.h"  Dean Camera committed Feb 23, 2009 52 53 54 55 56 57 58 59 60 61 62 63 64  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* 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. */  65  #define USB_HOST_DEVICEADDRESS 1  Dean Camera committed Feb 23, 2009 66 67 68 69 70 71 72  #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. * * This value may be overridden in the user project makefile as the value of the  Dean Camera committed Apr 22, 2009 73  * \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.  Dean Camera committed Feb 23, 2009 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88  */ #define USB_HOST_TIMEOUT_MS 1000 #endif #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. * * This value may be overridden in the user project makefile as the value of the * HOST_DEVICE_SETTLE_DELAY_MS token, and passed to the compiler using the -D switch. */ #define HOST_DEVICE_SETTLE_DELAY_MS 1500 #endif  Dean Camera committed Apr 16, 2009 89   Dean Camera committed Apr 19, 2009 90  /* Pseudo-Function Macros: */  Dean Camera committed Apr 16, 2009 91 92 93 94 95 96 97 98  #if defined(__DOXYGEN__) /** 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);  Dean Camera committed Feb 23, 2009 99   Dean Camera committed Apr 22, 2009 100  /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has  Dean Camera committed Apr 16, 2009 101 102 103 104 105  * completed. * * \return Boolean true if no bus reset is currently being sent, false otherwise. */ static inline void USB_Host_IsBusResetComplete(void);  Dean Camera committed Feb 23, 2009 106   Dean Camera committed Apr 16, 2009 107 108 109 110 111  /** 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);  Dean Camera committed Feb 23, 2009 112   Dean Camera committed Apr 16, 2009 113 114 115 116 117 118  /** 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);  Dean Camera committed Apr 22, 2009 119  /** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro,  Dean Camera committed Apr 16, 2009 120 121 122 123 124 125 126 127 128 129 130 131 132  * 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. * * \return Boolean true if the bus is currently suspended, false otherwise */ static inline bool USB_Host_IsBusSuspended(void); /** 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). * * \return Boolean true if the attached device is enumerated in Full Speed mode, false otherwise */ static inline bool USB_Host_IsDeviceFullSpeed(void);  Dean Camera committed Feb 23, 2009 133   Dean Camera committed Apr 16, 2009 134 135 136 137 138 139  /** 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. * * \return Boolean true if the attached device has sent a Remote Wakeup request, false otherwise */ static inline bool USB_Host_IsRemoteWakeupSent(void);  Dean Camera committed Feb 23, 2009 140   Dean Camera committed Apr 16, 2009 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165  /** Clears the flag indicating that a Remote Wakeup request has been issued by an attached device. */ static inline void USB_Host_ClearRemoteWakeupSent(void); /** 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); /** Determines if a resume from Remote Wakeup request is currently being sent to an attached * device. * * \return Boolean true if no resume request is currently being sent, false otherwise */ static inline bool USB_Host_IsResumeFromWakeupRequestSent(void); #else #define USB_Host_ResetBus() MACROS{ UHCON |= (1 << RESET); }MACROE #define USB_Host_IsBusResetComplete() ((UHCON & (1 << RESET)) ? false : true) #define USB_Host_ResumeBus() MACROS{ UHCON |= (1 << SOFEN); }MACROE #define USB_Host_SuspendBus() MACROS{ UHCON &= ~(1 << SOFEN); }MACROE #define USB_Host_IsBusSuspended() ((UHCON & (1 << SOFEN)) ? false : true)  Dean Camera committed Feb 23, 2009 166   Dean Camera committed Apr 16, 2009 167 168 169 170 171 172 173 174 175 176  #define USB_Host_IsDeviceFullSpeed() ((USBSTA & (1 << SPEED)) ? true : false) #define USB_Host_IsRemoteWakeupSent() ((UHINT & (1 << RXRSMI)) ? true : false) #define USB_Host_ClearRemoteWakeupSent() MACROS{ UHINT &= ~(1 << RXRSMI); }MACROE #define USB_Host_ResumeFromWakeupRequest() MACROS{ UHCON |= (1 << RESUME); }MACROE #define USB_Host_IsResumeFromWakeupRequestSent() ((UHCON & (1 << RESUME)) ? false : true) #endif  Dean Camera committed Feb 23, 2009 177   Dean Camera committed Jun 16, 2009 178 179 180 181 182 183 184  /* Function Prototypes: */ /** Convenience function. This routine sends a SetConfiguration standard request to the attached * 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. *  Dean Camera committed Jun 28, 2009 185  * \param[in] ConfigNumber Configuration index to send to the device  Dean Camera committed Jun 16, 2009 186 187 188 189  * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result. */ uint8_t USB_Host_SetDeviceConfiguration(uint8_t ConfigNumber);  Dean Camera committed Jun 18, 2009 190 191 192 193 194 195 196  /** Convenience function. This routine sends a GetDescriptor standard request to the attached * 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. *  Dean Camera committed Jun 28, 2009 197 198  * \param[out] DeviceDescriptorPtr Pointer to the destination device descriptor structure where * the read data is to be stored  Dean Camera committed Jun 18, 2009 199 200 201  * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result. */  Dean Camera committed Jun 19, 2009 202  uint8_t USB_Host_GetDeviceDescriptor(void* DeviceDescriptorPtr);  Dean Camera committed Jun 18, 2009 203 204 205 206 207  /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device. * * \note After this routine returns, the control pipe will be selected. *  Dean Camera committed Jun 28, 2009 208  * \param[in] EndpointIndex Index of the endpoint to clear  Dean Camera committed Jun 18, 2009 209 210 211 212  * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result. */ uint8_t USB_Host_ClearPipeStall(uint8_t EndpointIndex);  Dean Camera committed Jun 16, 2009 213   Dean Camera committed Feb 23, 2009 214 215 216 217 218 219  /* Enums: */ /** Enum for the various states of the USB Host state machine. Only some states are * implemented in the LUFA library - other states are left to the user to implement. * * For information on each state, refer to the USB 2.0 specification. Some states have *  Dean Camera committed May 04, 2009 220  * \see \ref USB_HostState, which stores the current host state machine state.  Dean Camera committed Feb 23, 2009 221 222 223  */ enum USB_Host_States_t {  Dean Camera committed Jul 13, 2009 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 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320  HOST_STATE_WaitForDeviceRemoval = 0, /**< Internally implemented by the library. This state can be * used by the library to wait until the attached device is * removed by the user - useful for when an error occurs or * further communication with the device is not needed. This * allows for other code to run while the state machine is * effectively disabled. */ HOST_STATE_WaitForDevice = 1, /**< Internally implemented by the library. This state indicates * that the stack is waiting for an interval to elapse before * continuing with the next step of the device enumeration * process. * * \note Do not manually change to this state in the user code. */ HOST_STATE_Unattached = 2, /**< Internally implemented by the library. This state indicates * that the host state machine is waiting for a device to be * attached so that it can start the enumeration process. * * \note Do not manually change to this state in the user code. */ HOST_STATE_Attached = 3, /**< Internally implemented by the library. This state indicates * that a device has been attached, and the library's internals * are being configured to begin the enumeration process. * * \note Do not manually change to this state in the user code. */ HOST_STATE_Attached_WaitForDeviceSettle = 4, /**< Internally implemented by the library. This state indicates * that the stack is waiting for the initial settling period to * elapse before beginning the enumeration process. * * \note Do not manually change to this state in the user code. */ HOST_STATE_Attached_WaitForConnect = 5, /**< Internally implemented by the library. This state indicates * that the stack is waiting for a connection event from the USB * controller to indicate a valid USB device has been attached to * the bus and is ready to be enumerated. * * \note Do not manually change to this state in the user code. */ HOST_STATE_Attached_DoReset = 6, /**< Internally implemented by the library. This state indicates * that a valid USB device has been attached, and that it is * will now be reset to ensure it is ready for enumeration. * * \note Do not manually change to this state in the user code. */ HOST_STATE_Powered = 7, /**< Internally implemented by the library. This state indicates * that the attached device is currently powered and reset, and * that the control pipe is now being configured by the stack. * * \note Do not manually change to this state in the user code. */ HOST_STATE_Default = 8, /**< Internally implemented by the library. This state indicates * that the stack is currently retrieving the control endpoint's * size from the device, so that the control pipe can be altered * to match. * * \note Do not manually change to this state in the user code. */ HOST_STATE_Default_PostReset = 9, /**< Internally implemented by the library. This state indicates that * the control pipe is being reconfigured to match the retrieved * control endpoint size from the device, and the device's USB bus * address is being set. * * \note Do not manually change to this state in the user code. */ HOST_STATE_Default_PostAddressSet = 10, /**< Internally implemented by the library. This state indicates that * the device's address has now been set, and the stack is has now * completed the device enumeration process. This state causes the * stack to change the current USB device address to that set for * the connected device, before progressing to the user-implemented * HOST_STATE_Addressed state for further communications. * * \note Do not manually change to this state in the user code. */ HOST_STATE_Addressed = 11, /**< May be implemented by the user project. This state should * set the device configuration before progressing to the * HOST_STATE_Configured state. Other processing (such as the * retrieval and processing of the device descriptor) should also * be placed in this state. */ HOST_STATE_Configured = 12, /**< May be implemented by the user project. This state should * implement any extra device configuration (such as the setting of * class-specific parameters) before normal communication is begun * in the HOST_STATE_Ready state. */ HOST_STATE_Ready = 13, /**< May be implemented by the user project. This state should * contain the main communications with the attached device. From this * this state the host state machine should be changed to either * HOST_STATE_Suspended (after the bus is manually suspended using the * USB_Host_SuspendBus() macro) or HOST_STATE_WaitForDeviceRemoval as * needed. */ HOST_STATE_Suspended = 15, /**< May be implemented by the user project. This state should be maintained * while the bus is suspended, and changed to either the HOST_STATE_Ready * (after resuming the bus with the USB_Host_ResumeBus() macro) or the * HOST_STATE_WaitForDeviceRemoval states as needed. */  Dean Camera committed Feb 23, 2009 321 322  };  Dean Camera committed May 18, 2009 323  /** Enum for the error codes for the \ref EVENT_USB_HostError() event.  Dean Camera committed Feb 23, 2009 324  *  Dean Camera committed May 04, 2009 325  * \see \ref Group_Events for more information on this event.  Dean Camera committed Feb 23, 2009 326 327 328 329  */ enum USB_Host_ErrorCodes_t { HOST_ERROR_VBusVoltageDip = 0, /**< VBUS voltage dipped to an unacceptable level. This  Dean Camera committed Apr 22, 2009 330  * error may be the result of an attached device drawing  Dean Camera committed Feb 23, 2009 331 332 333 334 335 336  * too much current from the VBUS line, or due to the * AVR's power source being unable to supply sufficient * current. */ };  Dean Camera committed May 18, 2009 337  /** Enum for the error codes for the \ref EVENT_USB_DeviceEnumerationFailed() event.  Dean Camera committed Feb 23, 2009 338  *  Dean Camera committed May 04, 2009 339  * \see \ref Group_Events for more information on this event.  Dean Camera committed Feb 23, 2009 340 341 342 343  */ enum USB_Host_EnumerationErrorCodes_t { HOST_ENUMERROR_NoError = 0, /**< No error occurred. Used internally, this is not a valid  Dean Camera committed May 18, 2009 344  * ErrorCode parameter value for the \ref EVENT_USB_DeviceEnumerationFailed()  Dean Camera committed Feb 23, 2009 345 346 347  * event. */ HOST_ENUMERROR_WaitStage = 1, /**< One of the delays between enumeration steps failed  Dean Camera committed Apr 01, 2009 348  * to complete successfully, due to a timeout or other  Dean Camera committed Feb 23, 2009 349 350 351 352 353 354  * 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  Dean Camera committed Apr 01, 2009 355  * complete successfully.  Dean Camera committed Feb 23, 2009 356 357 358 359 360 361 362 363 364 365 366 367  */ HOST_ENUMERROR_PipeConfigError = 4, /**< The default control pipe (address 0) failed to * configure correctly. */ }; /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */ #define USB_Host_HostMode_On() MACROS{ USBCON |= (1 << HOST); }MACROE #define USB_Host_HostMode_Off() MACROS{ USBCON &= ~(1 << HOST); }MACROE  368  #define USB_Host_VBUS_Auto_Enable() MACROS{ OTGCON &= ~(1 << VBUSHWC); UHWCON |= (1 << UVCONE); }MACROE  Dean Camera committed Feb 23, 2009 369 370 371 372 373 374 375 376  #define USB_Host_VBUS_Manual_Enable() MACROS{ OTGCON |= (1 << VBUSHWC); UHWCON &= ~(1 << UVCONE); DDRE |= (1 << 7); }MACROE #define USB_Host_VBUS_Auto_On() MACROS{ OTGCON |= (1 << VBUSREQ); }MACROE #define USB_Host_VBUS_Manual_On() MACROS{ PORTE |= (1 << 7); }MACROE #define USB_Host_VBUS_Auto_Off() MACROS{ OTGCON |= (1 << VBUSRQC); }MACROE #define USB_Host_VBUS_Manual_Off() MACROS{ PORTE &= ~(1 << 7); }MACROE  Dean Camera committed Apr 05, 2009 377  #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR = (addr & 0x7F); }MACROE  Dean Camera committed Feb 23, 2009 378 379 380 381 382 383 384 385 386 387 388  /* Enums: */ enum USB_Host_WaitMSErrorCodes_t { HOST_WAITERROR_Successful = 0, HOST_WAITERROR_DeviceDisconnect = 1, HOST_WAITERROR_PipeError = 2, HOST_WAITERROR_SetupStalled = 3, }; /* Function Prototypes: */  Dean Camera committed May 13, 2009 389  void USB_Host_ProcessNextHostState(void);  Dean Camera committed Feb 23, 2009 390  uint8_t USB_Host_WaitMS(uint8_t MS);  Dean Camera committed May 13, 2009 391 392 393 394  #if defined(INCLUDE_FROM_HOST_C) static void USB_Host_ResetDevice(void); #endif  Dean Camera committed Feb 23, 2009 395 396 397 398 399 400  #endif /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif  Dean Camera committed Apr 16, 2009 401   Dean Camera committed Feb 23, 2009 402 #endif  Dean Camera committed Apr 16, 2009 403 404  /** @} */