-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2010 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 mode definitions.\r
- *\r
- * This file contains structures, function prototypes and macros related to USB host mode.\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_USB\r
- * @defgroup Group_Host Host Management\r
- *\r
- * USB Host mode related macros and enums. This module contains macros and enums which are used when\r
- * the USB controller is initialized in host mode.\r
- *\r
- * @{\r
- */\r
- \r
-#ifndef __USBHOST_H__\r
-#define __USBHOST_H__\r
-\r
- /* Includes: */\r
- #include <avr/io.h>\r
- #include <stdbool.h>\r
- #include <util/delay.h>\r
-\r
- #include "../../../Common/Common.h"\r
- #include "../HighLevel/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
- * This value may be overridden in the user project makefile as the value of the \r
- * HOST_DEVICE_SETTLE_DELAY_MS token, and passed to the compiler using the -D switch.\r
- */\r
- #define HOST_DEVICE_SETTLE_DELAY_MS 1500\r
- #endif\r
- \r
- /* Pseudo-Function Macros: */\r
- #if defined(__DOXYGEN__)\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);\r
-\r
- /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has\r
- * completed.\r
- *\r
- * \return Boolean true if no bus reset is currently being sent, false otherwise.\r
- */\r
- static inline void USB_Host_IsBusResetComplete(void);\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);\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);\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 true if the bus is currently suspended, false otherwise\r
- */\r
- static inline bool USB_Host_IsBusSuspended(void);\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 true if the attached device is enumerated in Full Speed mode, false otherwise\r
- */\r
- static inline bool USB_Host_IsDeviceFullSpeed(void);\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 true if the attached device has sent a Remote Wakeup request, false otherwise\r
- */\r
- static inline bool USB_Host_IsRemoteWakeupSent(void);\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);\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);\r
- \r
- /** Determines if a resume from Remote Wakeup request is currently being sent to an attached\r
- * device.\r
- *\r
- * \return Boolean true if no resume request is currently being sent, false otherwise\r
- */\r
- static inline bool USB_Host_IsResumeFromWakeupRequestSent(void);\r
- #else\r
- #define USB_Host_ResetBus() MACROS{ UHCON |= (1 << RESET); }MACROE\r
-\r
- #define USB_Host_IsBusResetComplete() ((UHCON & (1 << RESET)) ? false : true)\r
-\r
- #define USB_Host_ResumeBus() MACROS{ UHCON |= (1 << SOFEN); }MACROE \r
-\r
- #define USB_Host_SuspendBus() MACROS{ UHCON &= ~(1 << SOFEN); }MACROE \r
- \r
- #define USB_Host_IsBusSuspended() ((UHCON & (1 << SOFEN)) ? false : true)\r
- \r
- #define USB_Host_IsDeviceFullSpeed() ((USBSTA & (1 << SPEED)) ? true : false)\r
-\r
- #define USB_Host_IsRemoteWakeupSent() ((UHINT & (1 << RXRSMI)) ? true : false)\r
-\r
- #define USB_Host_ClearRemoteWakeupSent() MACROS{ UHINT &= ~(1 << RXRSMI); }MACROE\r
-\r
- #define USB_Host_ResumeFromWakeupRequest() MACROS{ UHCON |= (1 << RESUME); }MACROE\r
- \r
- #define USB_Host_IsResumeFromWakeupRequestSent() ((UHCON & (1 << RESUME)) ? false : true)\r
- #endif\r
-\r
- /* Function Prototypes: */\r
- /** Convenience function. This routine sends a SetConfiguration 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 GetDescriptor 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 GetDescriptor 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 decriptor 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, void* const Buffer, const uint8_t BufferLength);\r
- \r
- /** Clears a stall condition on the given pipe, via a ClearFeature 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\r
- *\r
- * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.\r
- */ \r
- uint8_t USB_Host_ClearPipeStall(uint8_t EndpointIndex);\r
-\r
- /* Enums: */\r
- /** Enum for the various states of the USB Host state machine. Only some states are\r
- * implemented in the LUFA library - other states are left to the user to implement.\r
- *\r
- * For information on each possible USB host state, refer to the USB 2.0 specification.\r
- * Several of the USB host states are broken up further into multiple smaller sub-states,\r
- * so that they can be internally implemented inside the library in an efficient manner.\r
- *\r
- * \see \ref USB_HostState, which stores the current host state machine state.\r
- */\r
- enum USB_Host_States_t\r
- {\r
- HOST_STATE_WaitForDeviceRemoval = 0, /**< Internally implemented by the library. This state can be\r
- * used by the library to wait until the attached device is\r
- * removed by the user - useful for when an error occurs or\r
- * further communication with the device is not needed. This\r
- * allows for other code to run while the state machine is\r
- * effectively disabled.\r
- */\r
- HOST_STATE_WaitForDevice = 1, /**< Internally implemented by the library. This state indicates\r
- * that the stack is waiting for an interval to elapse before\r
- * continuing with the next step of the device enumeration\r
- * process.\r
- *\r
- * \note Do not manually change to this state in the user code.\r
- */\r
- HOST_STATE_Unattached = 2, /**< Internally implemented by the library. This state indicates\r
- * that the host state machine is waiting for a device to be\r
- * attached so that it can start the enumeration process.\r
- * \r
- * \note Do not manually change to this state in the user code.\r
- */\r
- HOST_STATE_Powered = 3, /**< Internally implemented by the library. This state indicates\r
- * that a device has been attached, and the library's internals\r
- * are being configured to begin the enumeration process.\r
- * \r
- * \note Do not manually change to this state in the user code.\r
- */\r
- HOST_STATE_Powered_WaitForDeviceSettle = 4, /**< Internally implemented by the library. This state indicates\r
- * that the stack is waiting for the initial settling period to\r
- * elapse before beginning the enumeration process.\r
- * \r
- * \note Do not manually change to this state in the user code.\r
- */\r
- HOST_STATE_Powered_WaitForConnect = 5, /**< Internally implemented by the library. This state indicates\r
- * that the stack is waiting for a connection event from the USB\r
- * controller to indicate a valid USB device has been attached to\r
- * the bus and is ready to be enumerated.\r
- * \r
- * \note Do not manually change to this state in the user code.\r
- */\r
- HOST_STATE_Powered_DoReset = 6, /**< Internally implemented by the library. This state indicates\r
- * that a valid USB device has been attached, and that it is\r
- * will now be reset to ensure it is ready for enumeration.\r
- * \r
- * \note Do not manually change to this state in the user code.\r
- */\r
- HOST_STATE_Powered_ConfigPipe = 7, /**< Internally implemented by the library. This state indicates\r
- * that the attached device is currently powered and reset, and\r
- * that the control pipe is now being configured by the stack.\r
- * \r
- * \note Do not manually change to this state in the user code.\r
- */\r
- HOST_STATE_Default = 8, /**< Internally implemented by the library. This state indicates\r
- * that the stack is currently retrieving the control endpoint's\r
- * size from the device, so that the control pipe can be altered\r
- * to match.\r
- * \r
- * \note Do not manually change to this state in the user code.\r
- */\r
- HOST_STATE_Default_PostReset = 9, /**< Internally implemented by the library. This state indicates that\r
- * the control pipe is being reconfigured to match the retrieved\r
- * control endpoint size from the device, and the device's USB bus\r
- * address is being set.\r
- * \r
- * \note Do not manually change to this state in the user code.\r
- */\r
- HOST_STATE_Default_PostAddressSet = 10, /**< Internally implemented by the library. This state indicates that\r
- * the device's address has now been set, and the stack is has now\r
- * completed the device enumeration process. This state causes the\r
- * stack to change the current USB device address to that set for\r
- * the connected device, before progressing to the user-implemented\r
- * HOST_STATE_Addressed state for further communications.\r
- * \r
- * \note Do not manually change to this state in the user code.\r
- */\r
- HOST_STATE_Addressed = 11, /**< May be implemented by the user project. This state should\r
- * set the device configuration before progressing to the\r
- * HOST_STATE_Configured state. Other processing (such as the\r
- * retrieval and processing of the device descriptor) should also\r
- * be placed in this state.\r
- */\r
- HOST_STATE_Configured = 12, /**< May be implemented by the user project. This state should implement the\r
- * actual work performed on the attached device and changed to the\r
- * HOST_STATE_Suspended or HOST_STATE_WaitForDeviceRemoval states as needed.\r
- */\r
- HOST_STATE_Suspended = 15, /**< May be implemented by the user project. This state should be maintained\r
- * while the bus is suspended, and changed to either the HOST_STATE_Configured\r
- * (after resuming the bus with the USB_Host_ResumeBus() macro) or the\r
- * HOST_STATE_WaitForDeviceRemoval states as needed.\r
- */\r
- };\r
- \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
- /* Private Interface - For use in library only: */\r
- #if !defined(__DOXYGEN__)\r
- /* Macros: */\r
- #define USB_Host_HostMode_On() MACROS{ USBCON |= (1 << HOST); }MACROE\r
- #define USB_Host_HostMode_Off() MACROS{ USBCON &= ~(1 << HOST); }MACROE\r
-\r
- #define USB_Host_VBUS_Auto_Enable() MACROS{ OTGCON &= ~(1 << VBUSHWC); UHWCON |= (1 << UVCONE); }MACROE\r
- #define USB_Host_VBUS_Manual_Enable() MACROS{ OTGCON |= (1 << VBUSHWC); UHWCON &= ~(1 << UVCONE); DDRE |= (1 << 7); }MACROE\r
-\r
- #define USB_Host_VBUS_Auto_On() MACROS{ OTGCON |= (1 << VBUSREQ); }MACROE\r
- #define USB_Host_VBUS_Manual_On() MACROS{ PORTE |= (1 << 7); }MACROE\r
-\r
- #define USB_Host_VBUS_Auto_Off() MACROS{ OTGCON |= (1 << VBUSRQC); }MACROE\r
- #define USB_Host_VBUS_Manual_Off() MACROS{ PORTE &= ~(1 << 7); }MACROE\r
-\r
- #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR = ((addr) & 0x7F); }MACROE\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
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2010.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.fourwalledcubicle.com
+*/
+
+/*
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, 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.
+*/
+
+/** \file
+ * \brief USB host mode definitions.
+ *
+ * This file contains structures, function prototypes and macros related to USB host mode.
+ *
+ * \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.
+ */
+
+/** \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__
+
+ /* Includes: */
+ #include <avr/io.h>
+ #include <stdbool.h>
+ #include <util/delay.h>
+
+ #include "../../../Common/Common.h"
+ #include "../HighLevel/StdDescriptors.h"
+ #include "Pipe.h"
+ #include "USBInterrupt.h"
+
+ /* 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
+
+ /* 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.
+ *
+ * This value may be overridden in the user project makefile as the value of the
+ * \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.
+ */
+ #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
+
+ /* 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 \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);
+
+ /** 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);
+
+ /** 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);
+
+ /** 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);
+
+ /** 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)
+
+ #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
+
+ /* 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.
+ *
+ * \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);
+
+ /** 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.
+ *
+ * \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);
+
+ /** Convenience function. This routine sends a GetDescriptor standard request to the attached
+ * 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 decriptor 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);
+
+ /** 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.
+ *
+ * \param[in] EndpointIndex Index of the endpoint to clear
+ *
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
+ */
+ uint8_t USB_Host_ClearPipeStall(uint8_t EndpointIndex);
+
+ /* 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 possible USB host state, refer to the USB 2.0 specification.
+ * Several of the USB host states are broken up further into multiple smaller sub-states,
+ * so that they can be internally implemented inside the library in an efficient manner.
+ *
+ * \see \ref USB_HostState, which stores the current host state machine state.
+ */
+ enum USB_Host_States_t
+ {
+ 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_Powered = 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_Powered_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_Powered_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_Powered_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_ConfigPipe = 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 the
+ * actual work performed on the attached device and changed to the
+ * HOST_STATE_Suspended or HOST_STATE_WaitForDeviceRemoval states 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_Configured
+ * (after resuming the bus with the USB_Host_ResumeBus() macro) or the
+ * HOST_STATE_WaitForDeviceRemoval states as needed.
+ */
+ };
+
+ /** 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.
+ */
+ };
+
+ /** 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.
+ */
+ 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
+
+ #define USB_Host_VBUS_Auto_Enable() MACROS{ OTGCON &= ~(1 << VBUSHWC); UHWCON |= (1 << UVCONE); }MACROE
+ #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
+
+ #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR = ((addr) & 0x7F); }MACROE
+
+ /* 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);
+
+ #if defined(__INCLUDE_FROM_HOST_C)
+ static void USB_Host_ResetDevice(void);
+ #endif
+ #endif
+
+ /* Disable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ }
+ #endif
+
+#endif
+
+/** @} */
projects / pub / USBasp.git / blobdiff