arising out of or in connection with the use or performance of\r
this software.\r
*/\r
-\r
-/** \file\r
- *\r
- * Main library USB management task for both Host and Device mode operations. This contains the master\r
- * USB_USBTask task which should be periodically run to service both host and device USB projects.\r
- */\r
\r
#ifndef __USBTASK_H__\r
#define __USBTASK_H__\r
\r
#include "../../../Scheduler/Scheduler.h"\r
#include "../LowLevel/LowLevel.h"\r
- #include "../LowLevel/USBMode.h"\r
+ #include "StdRequestType.h"\r
+ #include "USBMode.h"\r
#include "Events.h"\r
#include "StdDescriptors.h"\r
\r
* which is not always accurate (host may suspend the bus while still connected). If the actual connection state\r
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
* passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
- * and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually.\r
+ * and disconnection events may be manually fired by \ref RAISE_EVENT(), and the \ref USB_IsConnected global changed manually.\r
+ *\r
+ * \ingroup Group_USBManagement\r
*/\r
extern volatile bool USB_IsConnected;\r
\r
/** Indicates if the USB interface is currently initialized but not necessarily connected to a host\r
- * or device (i.e. if USB_Init() has been run). If this is false, all other library globals are invalid.\r
+ * or device (i.e. if \ref USB_Init() has been run). If this is false, all other library globals are invalid.\r
*\r
* \note This variable should be treated as read-only in the user application, and never manually\r
* changed in value.\r
+ *\r
+ * \ingroup Group_USBManagement\r
*/\r
extern volatile bool USB_IsInitialized;\r
\r
+ /** Structure containing the last received Control request when in Device mode (for use in user-applications\r
+ * inside of the \ref USB_UnhandledControlPacket() event, or for filling up with a control request to issue when\r
+ * in Host mode before calling \ref USB_Host_SendControlRequest().\r
+ *\r
+ * \ingroup Group_USBManagement\r
+ */\r
+ extern USB_Request_Header_t USB_ControlRequest;\r
+ \r
#if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__)\r
/** Indicates if the USB interface is currently suspended by the host when in device mode. When suspended,\r
* the device should consume minimal power, and cannot communicate to the host. If Remote Wakeup is\r
- * supported by the device and USB_RemoteWakeupEnabled is true, suspension can be terminated by the device\r
- * by issuing a Remote Wakup request.\r
+ * supported by the device and \ref USB_RemoteWakeupEnabled is true, suspension can be terminated by the device\r
+ * by issuing a Remote Wakeup request.\r
*\r
* \note This global is only present if the user application can be a USB device.\r
*\r
* \note This variable should be treated as read-only in the user application, and never manually\r
* changed in value.\r
+ *\r
+ * \ingroup Group_Device\r
*/\r
extern volatile bool USB_IsSuspended;\r
#endif\r
\r
#if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)\r
/** Indicates the current host state machine state. When in host mode, this indicates the state\r
- * via one of the values of the USB_Host_States_t enum values in Host.h.\r
+ * via one of the values of the \ref USB_Host_States_t enum values in Host.h.\r
*\r
- * This value may be altered by the user application to implement the HOST_STATE_Addressed,\r
- * HOST_STATE_Configured, HOST_STATE_Ready and HOST_STATE_Suspended states which are not implemented\r
- * by the library.\r
+ * This value may be altered by the user application to implement the \ref HOST_STATE_Addressed,\r
+ * \ref HOST_STATE_Configured, \ref HOST_STATE_Ready and \ref HOST_STATE_Suspended states which\r
+ * are not implemented by the library.\r
*\r
* \note This global is only present if the user application can be a USB host.\r
+ *\r
+ * \ingroup Group_Host\r
*/\r
extern volatile uint8_t USB_HostState;\r
#endif\r
\r
/* Throwable Events: */\r
#if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)\r
- /** This module raises the USB Connect event when a USB device has been connected whilst in host\r
+ /** This module raises the \ref USB_Connect event when a USB device has been connected whilst in host\r
* mode, but not yet enumerated.\r
*\r
- * \see Events.h for more information on this event.\r
+ * \see \ref Group_Events for more information on this event.\r
*/\r
RAISES_EVENT(USB_Connect);\r
\r
- /** This module raises the USB Device Attached event when in host mode, and a device is attached\r
+ /** This module raises the \ref USB_DeviceAttached event when in host mode, and a device is attached\r
* to the AVR's USB interface.\r
*\r
- * \see Events.h for more information on this event.\r
+ * \see \ref Group_Events for more information on this event.\r
*/\r
RAISES_EVENT(USB_DeviceAttached);\r
\r
- /** This module raises the USB Device Unattached event when in host mode, and a device is removed\r
+ /** This module raises the \ref USB_DeviceUnattached event when in host mode, and a device is removed\r
* from the AVR's USB interface.\r
*\r
- * \see Events.h for more information on this event.\r
+ * \see \ref Group_Events for more information on this event.\r
*/\r
RAISES_EVENT(USB_DeviceUnattached);\r
\r
- /** This module raises the USB Device Enumeration Failed event when in host mode, and an\r
+ /** This module raises the \ref USB_DeviceEnumerationFailed event when in host mode, and an\r
* attached USB device has failed to successfully enumerated.\r
*\r
- * \see Events.h for more information on this event.\r
+ * \see \ref Group_Events for more information on this event.\r
*/\r
RAISES_EVENT(USB_DeviceEnumerationFailed);\r
\r
- /** This module raises the USB Device Enumeration Complete event when in host mode, and an\r
+ /** This module raises the \ref USB_DeviceEnumerationComplete event when in host mode, and an\r
* attached USB device has been successfully enumerated and ready to be used by the user\r
* application.\r
*\r
- * \see Events.h for more information on this event.\r
+ * \see \ref Group_Events for more information on this event.\r
*/\r
RAISES_EVENT(USB_DeviceEnumerationComplete);\r
\r
- /** This module raises the USB Disconnect event when an attached USB device is removed from the USB\r
+ /** This module raises the \ref USB_Disconnect event when an attached USB device is removed from the USB\r
* bus.\r
*\r
- * \see Events.h for more information on this event.\r
+ * \see \ref Group_Events for more information on this event.\r
*/\r
RAISES_EVENT(USB_Disconnect);\r
#endif\r
* The USB task must be serviced within 50mS in all modes, when needed. The task may be serviced \r
* at all times, or (for minimum CPU consumption):\r
*\r
- * - In device mode, it may be disabled at start-up, enabled on the firing of the USB_Connect event\r
- * and disabled again on the firing of the USB_Disconnect event.\r
+ * - In device mode, it may be disabled at start-up, enabled on the firing of the \ref USB_Connect event\r
+ * and disabled again on the firing of the \ref USB_Disconnect event.\r
+ *\r
+ * - In host mode, it may be disabled at start-up, enabled on the firing of the \ref USB_DeviceAttached\r
+ * event and disabled again on the firing of the \ref USB_DeviceUnattached event.\r
*\r
- * - In host mode, it may be disabled at start-up, enabled on the firing of the USB_DeviceAttached\r
- * event and disabled again on the firing of the USB_DeviceUnattached event.\r
+ * \see \ref Group_Events for more information on the USB events.\r
*\r
- * \see Events.h for more information on the USB events.\r
+ * \ingroup Group_USBManagement\r
*/\r
TASK(USB_USBTask);\r
\r
projects / pub / USBasp.git / blobdiff