X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/7d4cccc22d60125fac111819df48af1873d11018..6865a7bc09e31d3bbebb33eefb6475c8713351bd:/LUFA/Drivers/USB/HighLevel/USBTask.h diff --git a/LUFA/Drivers/USB/HighLevel/USBTask.h b/LUFA/Drivers/USB/HighLevel/USBTask.h index e0ca8ede8..7e88ce88b 100644 --- a/LUFA/Drivers/USB/HighLevel/USBTask.h +++ b/LUFA/Drivers/USB/HighLevel/USBTask.h @@ -27,12 +27,6 @@ arising out of or in connection with the use or performance of this software. */ - -/** \file - * - * Main library USB management task for both Host and Device mode operations. This contains the master - * USB_USBTask task which should be periodically run to service both host and device USB projects. - */ #ifndef __USBTASK_H__ #define __USBTASK_H__ @@ -46,6 +40,7 @@ #include "../../../Scheduler/Scheduler.h" #include "../LowLevel/LowLevel.h" + #include "StdRequestType.h" #include "USBMode.h" #include "Events.h" #include "StdDescriptors.h" @@ -73,6 +68,8 @@ * needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by * passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection * and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually. + * + * \ingroup Group_USBManagement */ extern volatile bool USB_IsConnected; @@ -81,19 +78,31 @@ * * \note This variable should be treated as read-only in the user application, and never manually * changed in value. + * + * \ingroup Group_USBManagement */ extern volatile bool USB_IsInitialized; + /** Structure containing the last received Control request when in Device mode (for use in user-applications + * inside of the USB_UnhandledControlPacket() event, or for filling up with a control request to issue when + * in Host mode before calling USB_Host_SendControlRequest(). + * + * \ingroup Group_USBManagement + */ + extern USB_Request_Header_t USB_ControlRequest; + #if defined(USB_CAN_BE_DEVICE) || defined(__DOXYGEN__) /** Indicates if the USB interface is currently suspended by the host when in device mode. When suspended, * the device should consume minimal power, and cannot communicate to the host. If Remote Wakeup is * supported by the device and USB_RemoteWakeupEnabled is true, suspension can be terminated by the device - * by issuing a Remote Wakup request. + * by issuing a Remote Wakeup request. * * \note This global is only present if the user application can be a USB device. * * \note This variable should be treated as read-only in the user application, and never manually * changed in value. + * + * \ingroup Group_Device */ extern volatile bool USB_IsSuspended; #endif @@ -107,6 +116,8 @@ * by the library. * * \note This global is only present if the user application can be a USB host. + * + * \ingroup Group_Host */ extern volatile uint8_t USB_HostState; #endif @@ -173,6 +184,8 @@ * event and disabled again on the firing of the USB_DeviceUnattached event. * * \see Events.h for more information on the USB events. + * + * \ingroup Group_USBManagement */ TASK(USB_USBTask);