Fixed bug in RNDISEthernet and DualCDC demos not using the correct USB_ControlRequest...

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / USBInterrupt.h

diff --git a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h
index 65e0b5f..9a16047 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h
+++ b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h
@@ -28,16 +28,12 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

-/** \file\r
- *\r
- *  Main USB interrupt vector handler. This file manages the main USB interrupt vector, for handling such\r
- *  events as VBUS interrupts (on supported USB AVR models), device connections and disconnections, etc.\r
- */\r
-\r

 /** \ingroup Group_USB\r
  *  @defgroup Group_USBInterrupt Endpoint and Pipe Interrupts\r
  *\r
 /** \ingroup Group_USB\r
  *  @defgroup Group_USBInterrupt Endpoint and Pipe Interrupts\r
  *\r

- *  Functions, macros, variables, enums and types related to endpoint and pipe interrupts.\r
+ *  This module manages the main USB interrupt vector, for handling such events as VBUS interrupts\r
+ *  (on supported USB AVR models), device connections and disconnections, etc. as well as providing\r
+ *  easy to use macros for the management of the unified Endpoint/Pipe interrupt vector.\r

  *\r
  *  @{\r
  */\r
  *\r
  *  @{\r
  */\r


@@ -74,7 +70,7 @@
 \r
                        /** Disables the given USB interrupt vector.\r
                         *\r
 \r
                        /** Disables the given USB interrupt vector.\r
                         *\r

-                        *  \see USB_INT_Enable()\r
+                        *  \see \ref USB_INT_Enable()\r

                         */\r
                        #define USB_INT_Disable(int)             MACROS{ USB_INT_GET_EN_REG(int)   &= ~(USB_INT_GET_EN_MASK(int));  }MACROE\r
 \r
                         */\r
                        #define USB_INT_Disable(int)             MACROS{ USB_INT_GET_EN_REG(int)   &= ~(USB_INT_GET_EN_MASK(int));  }MACROE\r
 \r


@@ -100,7 +96,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 RAISE_EVENT(), and the USB_IsConnected global changed manually.\r
+                        *        and disconnection events may be manually fired by \ref RAISE_EVENT(), and the USB_IsConnected global changed manually.\r

                         */\r
                        RAISES_EVENT(USB_Connect);\r
 \r
                         */\r
                        RAISES_EVENT(USB_Connect);\r
 \r


@@ -112,7 +108,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 RAISE_EVENT(), and the USB_IsConnected global changed manually.\r
+                        *        and disconnection events may be manually fired by \ref RAISE_EVENT(), and the USB_IsConnected global changed manually.\r

                         */\r
                        RAISES_EVENT(USB_Disconnect);\r
 \r
                         */\r
                        RAISES_EVENT(USB_Disconnect);\r
 \r


@@ -122,7 +118,7 @@
                                 *\r
                                 *  \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.\r
                                 *\r
                                 *\r
                                 *  \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.\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_VBUSChange);\r
 \r
                                 */\r
                                RAISES_EVENT(USB_VBUSChange);\r
 \r


@@ -130,7 +126,7 @@
                                 *\r
                                 *  \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.\r
                                 *\r
                                 *\r
                                 *  \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.\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_VBUSConnect);\r
 \r
                                 */\r
                                RAISES_EVENT(USB_VBUSConnect);\r
 \r


@@ -138,7 +134,7 @@
                                 *\r
                                 *  \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.\r
                                 *\r
                                 *\r
                                 *  \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.\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_VBUSDisconnect);\r
                        #endif\r
                                 */\r
                                RAISES_EVENT(USB_VBUSDisconnect);\r
                        #endif\r


@@ -147,21 +143,21 @@
                                /** This module raises the Suspended event when the host suspends the USB interface of the AVR\r
                                 *  whilst running in device mode.\r
                                 *\r
                                /** This module raises the Suspended event when the host suspends the USB interface of the AVR\r
                                 *  whilst running in device mode.\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_Suspend);\r
 \r
                                /** This module raises the Wake Up event when the host resumes the USB interface of the AVR\r
                                 *  whilst running in device mode.\r
                                 *\r
                                 */\r
                                RAISES_EVENT(USB_Suspend);\r
 \r
                                /** This module raises the Wake Up event when the host resumes the USB interface of the AVR\r
                                 *  whilst running in device mode.\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_WakeUp);\r
 \r
                                /** This module raises the USB Reset event when the host resets the USB interface of the AVR\r
                                 *  whilst running in device mode.\r
                                 *\r
                                 */\r
                                RAISES_EVENT(USB_WakeUp);\r
 \r
                                /** This module raises the USB Reset event when the host resets the USB interface of the AVR\r
                                 *  whilst running in device mode.\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_Reset);\r
                        #endif\r
                                 */\r
                                RAISES_EVENT(USB_Reset);\r
                        #endif\r


@@ -172,7 +168,7 @@
                                 *\r
                                 *  \note Not all USB AVR models support host mode; this event only exists on supported AVRs.\r
                                 *\r
                                 *\r
                                 *  \note Not all USB AVR models support host mode; this event only exists on supported AVRs.\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_HostError);\r
 \r
                                 */\r
                                RAISES_EVENT(USB_HostError);\r
 \r


@@ -181,7 +177,7 @@
                                 *\r
                                 *  \note Not all USB AVR models support host mode; this event only exists on supported AVRs.\r
                                 *\r
                                 *\r
                                 *  \note Not all USB AVR models support host mode; this event only exists on supported AVRs.\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
                        #endif\r
                                 */\r
                                RAISES_EVENT(USB_DeviceUnattached);\r
                        #endif\r


@@ -192,7 +188,7 @@
                                 *  \note Not all USB AVR models support host mode and thus the UID pin; this event only exists on\r
                                 *        supported AVRs.\r
                                 *\r
                                 *  \note Not all USB AVR models support host mode and thus the UID pin; this event only exists on\r
                                 *        supported AVRs.\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_UIDChange);\r
                        #endif\r
                                 */\r
                                RAISES_EVENT(USB_UIDChange);\r
                        #endif\r