+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2011.\r
+\r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+ Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, distribute, and sell this\r
+ software and its documentation for any purpose is hereby granted\r
+ without fee, provided that the above copyright notice appear in\r
+ all copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting\r
+ documentation, and that the name of the author not be used in\r
+ advertising or publicity pertaining to distribution of the\r
+ software without specific, written prior permission.\r
+\r
+ The author disclaim all warranties with regard to this\r
+ software, including all implied warranties of merchantability\r
+ and fitness. In no event shall the author be liable for any\r
+ special, indirect or consequential damages or any damages\r
+ whatsoever resulting from loss of use, data or profits, whether\r
+ in an action of contract, negligence or other tortious action,\r
+ arising out of or in connection with the use or performance of\r
+ this software.\r
+*/\r
+\r
+/** \file\r
+ * \brief USB Host definitions for the AVR32 UC3B microcontrollers.\r
+ * \copydetails Group_Host_UC3B\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
+/** \ingroup Group_Host\r
+ * \defgroup Group_Host_UC3B Host Management (UC3B)\r
+ * \brief USB Host definitions for the AVR32 UC3B microcontrollers.\r
+ *\r
+ * Architecture specific USB Host definitions for the Atmel 32-bit AVR UC3B microcontrollers.\r
+ *\r
+ * @{\r
+ */\r
+\r
+#ifndef __USBHOST_UC3B_H__\r
+#define __USBHOST_UC3B_H__\r
+\r
+ /* Includes: */\r
+ #include "../../../../Common/Common.h"\r
+ #include "../StdDescriptors.h"\r
+ #include "../Pipe.h"\r
+ #include "../USBInterrupt.h"\r
+\r
+ /* Enable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ extern "C" {\r
+ #endif\r
+\r
+ /* Preprocessor Checks: */\r
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
+ #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
+ #endif\r
+\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Macros: */\r
+ /** Indicates the fixed USB device address which any attached device is enumerated to when in\r
+ * host mode. As only one USB device may be attached to the AVR in host mode at any one time\r
+ * and that the address used is not important (other than the fact that it is non-zero), a\r
+ * fixed value is specified by the library.\r
+ */\r
+ #define USB_HOST_DEVICEADDRESS 1\r
+\r
+ #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)\r
+ /** Constant for the maximum software timeout period of sent USB control transactions to an attached\r
+ * device. If a device fails to respond to a sent control request within this period, the\r
+ * library will return a timeout error code.\r
+ *\r
+ * This value may be overridden in the user project makefile as the value of the\r
+ * \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.\r
+ */\r
+ #define USB_HOST_TIMEOUT_MS 1000\r
+ #endif\r
+\r
+ #if !defined(HOST_DEVICE_SETTLE_DELAY_MS) || defined(__DOXYGEN__)\r
+ /** Constant for the delay in milliseconds after a device is connected before the library\r
+ * will start the enumeration process. Some devices require a delay of up to 5 seconds\r
+ * after connection before the enumeration process can start or incorrect operation will\r
+ * occur.\r
+ *\r
+ * The default delay value may be overridden in the user project makefile by defining the\r
+ * \c HOST_DEVICE_SETTLE_DELAY_MS token to the required delay in milliseconds, and passed to the\r
+ * compiler using the -D switch.\r
+ */\r
+ #define HOST_DEVICE_SETTLE_DELAY_MS 1000\r
+ #endif\r
+\r
+ /* Enums: */\r
+ /** Enum for the error codes for the \ref EVENT_USB_Host_HostError() event.\r
+ *\r
+ * \see \ref Group_Events for more information on this event.\r
+ */\r
+ enum USB_Host_ErrorCodes_t\r
+ {\r
+ HOST_ERROR_VBusVoltageDip = 0, /**< VBUS voltage dipped to an unacceptable level. This\r
+ * error may be the result of an attached device drawing\r
+ * too much current from the VBUS line, or due to the\r
+ * AVR's power source being unable to supply sufficient\r
+ * current.\r
+ */\r
+ };\r
+\r
+ /** Enum for the error codes for the \ref EVENT_USB_Host_DeviceEnumerationFailed() event.\r
+ *\r
+ * \see \ref Group_Events for more information on this event.\r
+ */\r
+ enum USB_Host_EnumerationErrorCodes_t\r
+ {\r
+ HOST_ENUMERROR_NoError = 0, /**< No error occurred. Used internally, this is not a valid\r
+ * ErrorCode parameter value for the \ref EVENT_USB_Host_DeviceEnumerationFailed()\r
+ * event.\r
+ */\r
+ HOST_ENUMERROR_WaitStage = 1, /**< One of the delays between enumeration steps failed\r
+ * to complete successfully, due to a timeout or other\r
+ * error.\r
+ */\r
+ HOST_ENUMERROR_NoDeviceDetected = 2, /**< No device was detected, despite the USB data lines\r
+ * indicating the attachment of a device.\r
+ */\r
+ HOST_ENUMERROR_ControlError = 3, /**< One of the enumeration control requests failed to\r
+ * complete successfully.\r
+ */\r
+ HOST_ENUMERROR_PipeConfigError = 4, /**< The default control pipe (address 0) failed to\r
+ * configure correctly.\r
+ */\r
+ };\r
+\r
+ /* Inline Functions: */\r
+ /** Returns the current USB frame number, when in host mode. Every millisecond the USB bus is active (i.e. not suspended)\r
+ * the frame number is incremented by one.\r
+ */\r
+ static inline uint16_t USB_Host_GetFrameNumber(void)\r
+ {\r
+ return AVR32_USBB_UHFNUM;\r
+ }\r
+\r
+ #if !defined(NO_SOF_EVENTS)\r
+ /** Enables the host mode Start Of Frame events. When enabled, this causes the\r
+ * \ref EVENT_USB_Host_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,\r
+ * at the start of each USB frame when a device is enumerated while in host mode.\r
+ *\r
+ * \note Not available when the \c NO_SOF_EVENTS compile time token is defined.\r
+ */\r
+ static inline void USB_Host_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_EnableSOFEvents(void)\r
+ {\r
+ USB_INT_Enable(USB_INT_HSOFI);\r
+ }\r
+\r
+ /** Disables the host mode Start Of Frame events. When disabled, this stops the firing of the\r
+ * \ref EVENT_USB_Host_StartOfFrame() event when enumerated in host mode.\r
+ *\r
+ * \note Not available when the NO_SOF_EVENTS compile time token is defined.\r
+ */\r
+ static inline void USB_Host_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_DisableSOFEvents(void)\r
+ {\r
+ USB_INT_Disable(USB_INT_HSOFI);\r
+ }\r
+ #endif\r
+\r
+ /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host.\r
+ * USB bus resets leave the default control pipe configured (if already configured).\r
+ *\r
+ * If the USB bus has been suspended prior to issuing a bus reset, the attached device will be\r
+ * woken up automatically and the bus resumed after the reset has been correctly issued.\r
+ */\r
+ static inline void USB_Host_ResetBus(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_ResetBus(void)\r
+ {\r
+ AVR32_USBB.UHCON.reset = true;\r
+ }\r
+\r
+ /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has\r
+ * completed.\r
+ *\r
+ * \return Boolean \c true if no bus reset is currently being sent, \c false otherwise.\r
+ */\r
+ static inline bool USB_Host_IsBusResetComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
+ static inline bool USB_Host_IsBusResetComplete(void)\r
+ {\r
+ return AVR32_USBB.UHCON.reset;\r
+ }\r
+\r
+ /** Resumes USB communications with an attached and enumerated device, by resuming the transmission\r
+ * of the 1MS Start Of Frame messages to the device. When resumed, USB communications between the\r
+ * host and attached device may occur.\r
+ */\r
+ static inline void USB_Host_ResumeBus(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_ResumeBus(void)\r
+ {\r
+ AVR32_USBB.UHCON.sofe = true;\r
+ }\r
+\r
+ /** Suspends the USB bus, preventing any communications from occurring between the host and attached\r
+ * device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame\r
+ * messages to the device.\r
+ */\r
+ static inline void USB_Host_SuspendBus(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_SuspendBus(void)\r
+ {\r
+ AVR32_USBB.UHCON.sofe = false;\r
+ }\r
+\r
+ /** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro,\r
+ * false otherwise. While suspended, no USB communications can occur until the bus is resumed,\r
+ * except for the Remote Wakeup event from the device if supported.\r
+ *\r
+ * \return Boolean \c true if the bus is currently suspended, \c false otherwise.\r
+ */\r
+ static inline bool USB_Host_IsBusSuspended(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
+ static inline bool USB_Host_IsBusSuspended(void)\r
+ {\r
+ return AVR32_USBB.UHCON.sofe;\r
+ }\r
+\r
+ /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or\r
+ * false if the attached device is enumerated in Low Speed mode (1.5Mb/s).\r
+ *\r
+ * \return Boolean \c true if the attached device is enumerated in Full Speed mode, \c false otherwise.\r
+ */\r
+ static inline bool USB_Host_IsDeviceFullSpeed(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
+ static inline bool USB_Host_IsDeviceFullSpeed(void)\r
+ {\r
+ return (AVR32_USBB.USBSTA.speed == AVR32_USBB_SPEED_FULL);\r
+ }\r
+\r
+ /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting\r
+ * that the host resume the USB bus and wake up the device, false otherwise.\r
+ *\r
+ * \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise.\r
+ */\r
+ static inline bool USB_Host_IsRemoteWakeupSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
+ static inline bool USB_Host_IsRemoteWakeupSent(void)\r
+ {\r
+ return AVR32_USBB.UHINT.rxrsmi;\r
+ }\r
+\r
+ /** Clears the flag indicating that a Remote Wakeup request has been issued by an attached device. */\r
+ static inline void USB_Host_ClearRemoteWakeupSent(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_ClearRemoteWakeupSent(void)\r
+ {\r
+ AVR32_USBB.UHINTCLR.rxrsmic = true;\r
+ }\r
+\r
+ /** Accepts a Remote Wakeup request from an attached device. This must be issued in response to\r
+ * a device's Remote Wakeup request within 2ms for the request to be accepted and the bus to\r
+ * be resumed.\r
+ */\r
+ static inline void USB_Host_ResumeFromWakeupRequest(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_ResumeFromWakeupRequest(void)\r
+ {\r
+ AVR32_USBB.UHCON.resume = true;\r
+ }\r
+\r
+ /** Determines if a resume from Remote Wakeup request is currently being sent to an attached\r
+ * device.\r
+ *\r
+ * \return Boolean \c true if no resume request is currently being sent, \c false otherwise.\r
+ */\r
+ static inline bool USB_Host_IsResumeFromWakeupRequestSent(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
+ static inline bool USB_Host_IsResumeFromWakeupRequestSent(void)\r
+ {\r
+ return AVR32_USBB.UHCON.resume;\r
+ }\r
+\r
+ /* Function Prototypes: */\r
+ /** Convenience function. This routine sends a SET CONFIGURATION standard request to the attached\r
+ * device, with the given configuration index. This can be used to easily set the device\r
+ * configuration without creating and sending the request manually.\r
+ *\r
+ * \note After this routine returns, the control pipe will be selected.\r
+ *\r
+ * \param[in] ConfigNumber Configuration index to send to the device.\r
+ *\r
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+ */\r
+ uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);\r
+\r
+ /** Convenience function. This routine sends a GET DESCRIPTOR standard request to the attached\r
+ * device, requesting the device descriptor. This can be used to easily retrieve information\r
+ * about the device such as its VID, PID and power requirements.\r
+ *\r
+ * \note After this routine returns, the control pipe will be selected.\r
+ *\r
+ * \param[out] DeviceDescriptorPtr Pointer to the destination device descriptor structure where\r
+ * the read data is to be stored.\r
+ *\r
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+ */\r
+ uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr);\r
+\r
+ /** Convenience function. This routine sends a GET DESCRIPTOR standard request to the attached\r
+ * device, requesting the string descriptor of the specified index. This can be used to easily\r
+ * retrieve string descriptors from the device by index, after the index is obtained from the\r
+ * Device or Configuration descriptors.\r
+ *\r
+ * \note After this routine returns, the control pipe will be selected.\r
+ *\r
+ * \param[in] Index Index of the string index to retrieve.\r
+ * \param[out] Buffer Pointer to the destination buffer where the retrieved string descriptor is\r
+ * to be stored.\r
+ * \param[in] BufferLength Maximum size of the string descriptor which can be stored into the buffer.\r
+ *\r
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+ */\r
+ uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,\r
+ void* const Buffer,\r
+ const uint8_t BufferLength);\r
+\r
+ /** Clears a stall condition on the given pipe, via a CLEAR FEATURE standard request to the attached device.\r
+ *\r
+ * \note After this routine returns, the control pipe will be selected.\r
+ *\r
+ * \param[in] EndpointIndex Index of the endpoint to clear, including the endpoint's direction.\r
+ *\r
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
+ */\r
+ uint8_t USB_Host_ClearPipeStall(const uint8_t EndpointIndex);\r
+\r
+ /* Private Interface - For use in library only: */\r
+ #if !defined(__DOXYGEN__)\r
+ /* Macros: */\r
+ static inline void USB_Host_HostMode_On(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_HostMode_On(void)\r
+ {\r
+ // Not required for UC3B\r
+ }\r
+\r
+ static inline void USB_Host_HostMode_Off(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_HostMode_Off(void)\r
+ {\r
+ // Not required for UC3B\r
+ }\r
+\r
+ static inline void USB_Host_VBUS_Auto_Enable(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_VBUS_Auto_Enable(void)\r
+ {\r
+ AVR32_USBB.USBCON.vbushwc = false;\r
+ }\r
+\r
+ static inline void USB_Host_VBUS_Manual_Enable(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_VBUS_Manual_Enable(void)\r
+ {\r
+ AVR32_USBB.USBCON.vbushwc = true;\r
+ }\r
+\r
+ static inline void USB_Host_VBUS_Auto_On(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_VBUS_Auto_On(void)\r
+ {\r
+ AVR32_USBB.USBSTASET.vbusrqs = true;\r
+ }\r
+\r
+ static inline void USB_Host_VBUS_Manual_On(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_VBUS_Manual_On(void)\r
+ {\r
+ AVR32_USBB.USBSTASET.vbusrqs = true;\r
+ }\r
+\r
+ static inline void USB_Host_VBUS_Auto_Off(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_VBUS_Auto_Off(void)\r
+ {\r
+ AVR32_USBB.USBSTACLR.vbusrqc = true;\r
+ }\r
+\r
+ static inline void USB_Host_VBUS_Manual_Off(void) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_VBUS_Manual_Off(void)\r
+ {\r
+ AVR32_USBB.USBSTACLR.vbusrqc = true;\r
+ }\r
+\r
+ static inline void USB_Host_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE;\r
+ static inline void USB_Host_SetDeviceAddress(const uint8_t Address)\r
+ {\r
+ AVR32_USBB.UHADDR1.uhaddr_p0 = Address;\r
+ AVR32_USBB.UHADDR1.uhaddr_p1 = Address;\r
+ AVR32_USBB.UHADDR1.uhaddr_p2 = Address;\r
+ AVR32_USBB.UHADDR1.uhaddr_p3 = Address;\r
+ AVR32_USBB.UHADDR2.uhaddr_p4 = Address;\r
+ AVR32_USBB.UHADDR2.uhaddr_p5 = Address;\r
+ AVR32_USBB.UHADDR2.uhaddr_p6 = Address;\r
+ }\r
+\r
+ /* Enums: */\r
+ enum USB_Host_WaitMSErrorCodes_t\r
+ {\r
+ HOST_WAITERROR_Successful = 0,\r
+ HOST_WAITERROR_DeviceDisconnect = 1,\r
+ HOST_WAITERROR_PipeError = 2,\r
+ HOST_WAITERROR_SetupStalled = 3,\r
+ };\r
+\r
+ /* Function Prototypes: */\r
+ void USB_Host_ProcessNextHostState(void);\r
+ uint8_t USB_Host_WaitMS(uint8_t MS);\r
+\r
+ #if defined(__INCLUDE_FROM_HOST_C)\r
+ static void USB_Host_ResetDevice(void);\r
+ #endif\r
+ #endif\r
+\r
+ /* Disable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ }\r
+ #endif\r
+\r
+#endif\r
+\r
+/** @} */\r
+\r
projects / pub / USBasp.git / commitdiff