X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/6a10d6b465be27db090d760dc0fbe722c94e4344..253deb996f321c59c102a64e17f95d0b5b0a0e6d:/LUFA/Drivers/USB/LowLevel/Host.h diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h index 5cc215454..b1d60afb5 100644 --- a/LUFA/Drivers/USB/LowLevel/Host.h +++ b/LUFA/Drivers/USB/LowLevel/Host.h @@ -28,12 +28,15 @@ this software. */ -/** \file +/** \ingroup Group_USB + * @defgroup Group_Host Host Management * * 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. + * + * @{ */ - + #ifndef __USBHOST_H__ #define __USBHOST_H__ @@ -65,7 +68,7 @@ * library will return a timeout error code. * * This value may be overridden in the user project makefile as the value of the - * USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch. + * \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch. */ #define USB_HOST_TIMEOUT_MS 1000 #endif @@ -81,64 +84,94 @@ */ #define HOST_DEVICE_SETTLE_DELAY_MS 1500 #endif - - /** 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. - */ - #define USB_Host_ResetBus() MACROS{ UHCON |= (1 << RESET); }MACROE + + /* Pseudo-Function Macros: */ + #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); - /** Determines if a previously issued bus reset (via the USB_Host_ResetBus() macro) has - * completed. This macro returns true if no bus reset is currently being sent, false - * otherwise. - */ - #define USB_Host_IsResetBusDone() ((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. - */ - #define USB_Host_ResumeBus() MACROS{ UHCON |= (1 << SOFEN); }MACROE + /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has + * completed. + * + * \return Boolean true if no bus reset is currently being sent, false otherwise. + */ + static inline void USB_Host_IsBusResetComplete(void); - /** Suspends the USB bus, preventing any communications from occuring 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. - */ - #define USB_Host_SuspendBus() MACROS{ UHCON &= ~(1 << SOFEN); }MACROE - - /** Returns true if the USB bus has been suspended via the use of the 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. - */ - #define USB_Host_IsBusSuspended() ((UHCON & (1 << SOFEN)) ? false : true) - - /** Returns true 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). - */ - #define USB_Host_IsDeviceFullSpeed() ((USBSTA & (1 << SPEED)) ? true : false) + /** 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); - /** Returns true 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. - */ - #define USB_Host_IsRemoteWakeupSent() ((UHINT & (1 << RXRSMI)) ? true : false) + /** 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); + + /** 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. + * + * \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); - /** Clears the flag indicating that a Remote Wakeup request has been issued by an attached - * device. - */ - #define USB_Host_ClearRemoteWakeupSent() MACROS{ UHINT &= ~(1 << RXRSMI); }MACROE + /** 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); - /** 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. - */ - #define USB_Host_ResumeFromWakeupRequest() MACROS{ UHCON |= (1 << RESUME); }MACROE + /** 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) - /** Returns true if no resume from Remote Wakeup request is currently being sent to an attached - * device, false otherwise. - */ - #define USB_Host_IsResumeFromWakeupRequestSent() ((UHCON & (1 << RESUME)) ? false : true) + #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 /* Enums: */ /** Enum for the various states of the USB Host state machine. Only some states are @@ -146,8 +179,7 @@ * * For information on each state, refer to the USB 2.0 specification. Some states have * - * \see USBTask.h for information on the global variable USB_HostState, which stores the - * current host state machine state. + * \see \ref USB_HostState, which stores the current host state machine state. */ enum USB_Host_States_t { @@ -167,39 +199,39 @@ HOST_STATE_Suspended = 13, /**< May be implemented by the user project. */ }; - /** Enum for the error codes for the USB_HostError event. + /** Enum for the error codes for the \ref USB_HostError event. * - * \see Events.h for more information on this 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 + * 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. */ }; - /** Enum for the error codes for the USB_DeviceEnumerationFailed event. + /** Enum for the error codes for the \ref USB_DeviceEnumerationFailed event. * - * \see Events.h for more information on this 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 USB_DeviceEnumerationFailed + * ErrorCode parameter value for the \ref USB_DeviceEnumerationFailed * event. */ HOST_ENUMERROR_WaitStage = 1, /**< One of the delays between enumeration steps failed - * to complete successfuly, due to a timeout or other + * 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 successfuly. + * complete successfully. */ HOST_ENUMERROR_PipeConfigError = 4, /**< The default control pipe (address 0) failed to * configure correctly. @@ -221,7 +253,7 @@ #define USB_Host_VBUS_Auto_Off() MACROS{ OTGCON |= (1 << VBUSRQC); }MACROE #define USB_Host_VBUS_Manual_Off() MACROS{ PORTE &= ~(1 << 7); }MACROE - #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR = (addr & 0b01111111); }MACROE + #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR = (addr & 0x7F); }MACROE /* Enums: */ enum USB_Host_WaitMSErrorCodes_t @@ -241,5 +273,7 @@ #if defined(__cplusplus) } #endif - + #endif + +/** @} */