Rewritten event system to remove all macros, to make user code clearer.

[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 9cb4e60..21b1ae2 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/USBTask.h
+++ b/LUFA/Drivers/USB/HighLevel/USBTask.h
@@ -67,7 +67,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
                         *        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
                         *\r
                         *  \ingroup Group_USBManagement\r
                         */\r


@@ -84,7 +84,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
                        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
                         *  in Host mode before calling \ref USB_Host_SendControlRequest().\r
                         *\r
                         *  \ingroup Group_USBManagement\r


@@ -122,52 +122,6 @@
                        extern volatile uint8_t USB_HostState;\r
                        #endif\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 \ref USB_Connect event when a USB device has been connected whilst in host\r
-                                *  mode, but not yet enumerated.\r
-                                *\r
-                                *  \see \ref Group_Events 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 \ref Group_Events 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 \ref Group_Events 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 \ref Group_Events 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 \ref Group_Events 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 \ref Group_Events for more information on this event.\r
-                                */\r
-                               RAISES_EVENT(USB_Disconnect);\r
-                       #endif\r
-\r

                /* Tasks: */\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
                /* Tasks: */\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


@@ -177,11 +131,11 @@
                         *  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
                         *  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 \ref USB_Connect event\r
-                        *    and disabled again on the firing of the \ref USB_Disconnect event.\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
                         *\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
+                        *    - 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_DeviceUnattached() event.\r

                         *\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
                         *  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