Pipe_GetErrorFlags() now returns additional error flags for overflow and underflow...
[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / USBTask.h
index 918fa5e..e4c8a02 100644 (file)
@@ -38,7 +38,6 @@
                #include <stdbool.h>\r
                #include <stddef.h>\r
                \r
-               #include "../../../Scheduler/Scheduler.h"\r
                #include "../LowLevel/LowLevel.h"\r
                #include "StdRequestType.h"\r
                #include "USBMode.h"\r
@@ -67,7 +66,7 @@
                         *        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 \ref RAISE_EVENT(), and the \ref USB_IsConnected global changed manually.\r
+                        *        and disconnection events may be manually fired, and the \ref USB_IsConnected global changed manually.\r
                         *\r
                         *  \ingroup Group_USBManagement\r
                         */\r
@@ -84,7 +83,7 @@
                        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
+                        *  inside of the \ref EVENT_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
                        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 \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
-                                */\r
-                               RAISES_EVENT(USB_Connect);\r
-\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
-                                */\r
-                               RAISES_EVENT(USB_DeviceAttached);\r
-\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
-                                */\r
-                               RAISES_EVENT(USB_DeviceUnattached);\r
-                               \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
-                                */\r
-                               RAISES_EVENT(USB_DeviceEnumerationFailed);\r
-\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
-                                */\r
-                               RAISES_EVENT(USB_DeviceEnumerationComplete);\r
-\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
-                                */\r
-                               RAISES_EVENT(USB_Disconnect);\r
-                       #endif\r
-\r
-               /* Tasks: */\r
+               /* Function Prototypes: */\r
                        /** This is the main USB management task. The USB driver requires that this task be executed\r
                         *  continuously when the USB system is active (device attached in host mode, or attached to a host\r
                         *  in device mode) in order to manage USB communications. This task may be executed inside an RTOS,\r
-                        *  scheduler (e.g. the simple LUFA Scheduler), fast timer ISR or the main user application loop.\r
+                        *  fast timer ISR or the main user application loop.\r
+                        *\r
+                        *  The USB task must be serviced within 30ms while in device mode, or within 1ms while in host mode.\r
+                        *  The task may be serviced at all times, or (for minimum CPU consumption):\r
                         *\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
+                        *    - In device mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_Connect() event\r
+                        *    and disabled again on the firing of the \ref EVENT_USB_Disconnect() event.\r
                         *\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
+                        *    - In host mode, it may be disabled at start-up, enabled on the firing of the \ref EVENT_USB_DeviceAttached()\r
+                        *    event and disabled again on the firing of the \ref EVENT_USB_DeviceEnumerationComplete() or\r
+                        *    \ref EVENT_USB_DeviceEnumerationFailed() events.\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
+                        *  If in device mode (only), the control endpoint can instead be managed via interrupts entirely by the library\r
+                        *  by defining the INTERRUPT_CONTROL_ENDPOINT token and passing it to the compiler via the -D switch.\r
                         *\r
-                        *  \see Events.h for more information on the USB events.\r
+                        *  \see \ref Group_Events for more information on the USB events.\r
                         *\r
                         *  \ingroup Group_USBManagement\r
                         */\r
-                       TASK(USB_USBTask);\r
+                       void USB_USBTask(void);\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r