Applied STATIC_ENDPOINT_CONFIGURATION and FIXED_CONTROL_SIZE tokens to all Device...

[pub/lufa.git] / LUFA / Drivers / USB / HighLevel / USBTask.h

diff --git a/LUFA/Drivers/USB/HighLevel/USBTask.h b/LUFA/Drivers/USB/HighLevel/USBTask.h
index c8180f5..7e88ce8 100644 (file)
--- 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\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
@@ -46,7 +40,8 @@
                \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
@@ -73,6 +68,8 @@
                         *        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
+                        *\r
+                        *  \ingroup Group_USBManagement\r
                         */\r
                        extern volatile bool USB_IsConnected;\r
 \r
@@ -81,19 +78,31 @@
                         *\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 USB_UnhandledControlPacket() event, or for filling up with a control request to issue when\r
+                        *  in Host mode before calling 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
+                        *  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
@@ -107,6 +116,8 @@
                         *  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
@@ -173,6 +184,8 @@
                         *    event and disabled again on the firing of the USB_DeviceUnattached event.\r
                         *\r
                         *  \see Events.h for more information on the USB events.\r
+                        *\r
+                        *  \ingroup Group_USBManagement\r
                         */\r
                        TASK(USB_USBTask);\r
 \r