Fixed bug in RNDISEthernet and DualCDC demos not using the correct USB_ControlRequest...
[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / Events.h
index 7815534..36e16c9 100644 (file)
                         */\r
                        void USB_Disconnect(void);\r
                        \r
-                       /** Event for USB device power on failure. This event fires when the USB interface fails to\r
+                       /** Event for USB initialization failure. This event fires when the USB interface fails to\r
                         *  initialize correctly due to a hardware or software fault.\r
                         *\r
-                        *  \param ErrorCode  Error code indicating the failure reason, a value in \ref USB_PowerOnErrorCodes_t\r
+                        *  \note This event only exists on USB AVR models which support dual role modes.\r
+                        *\r
+                        *  \param ErrorCode  Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t\r
                         *                    located in LowLevel.h.\r
                         */\r
-                       void USB_PowerOnFail(const uint8_t ErrorCode);\r
+                       void USB_InitFailure(const uint8_t ErrorCode);\r
 \r
                        /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role\r
                         *  mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires\r
                         *  \note This event only exists on USB AVR models which support dual role modes.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied\r
-                        *        to the compiler (see LowLevel.h documentation).\r
+                        *        to the compiler (see \ref Group_USBManagement documentation).\r
                         */\r
                        void USB_UIDChange(void);\r
 \r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
                         */\r
                        void USB_HostError(const uint8_t ErrorCode);\r
                        \r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
                         *\r
-                        *  \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
+                        *  \see \ref TASK(USB_USBTask) for more information on the USB management task and reducing CPU usage.\r
                         */\r
                        void USB_DeviceAttached(void);\r
 \r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
                         *\r
-                        *  \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
+                        *  \see \ref TASK(USB_USBTask) for more information on the USB management task and reducing CPU usage.\r
                         */\r
                        void USB_DeviceUnattached(void);\r
                        \r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
                         */\r
                        void USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);\r
 \r
                         *  on control transfers, interrupts are disabled during control request processing.\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
                         *\r
                         *  \note Requests should be handled in the same manner as described in the USB 2.0 Specification,\r
                         *        or appropriate class specification. In all instances, the library has already read the\r
                         *  This event fires after the value of \ref USB_ConfigurationNumber has been changed.\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
                         */\r
                        void USB_ConfigurationChanged(void);\r
 \r
                         *  the device over to a low power state until the host wakes up the device.\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
                         *\r
                         *  \see \ref USB_WakeUp() event for accompanying Wake Up event.\r
                         */\r
                         *  mode.\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
                         *\r
                         *  \see \ref USB_Suspend() event for accompanying Suspend event.\r
                         */\r
                         *  disabled.\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
                         */\r
                        void USB_Reset(void);\r
                        \r
                         *                    \ref USB_Device_ErrorCodes_t enum located in Device.h.\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
                         */\r
                        void USB_DeviceError(const uint8_t ErrorCode);\r
                #endif\r
                        #define USB_DeviceEnumerationComplete_P     (void)\r
                        \r
                        #if defined(USB_CAN_BE_BOTH)\r
-                               #define USB_PowerOnFail_P               (const uint8_t ErrorCode)\r
+                               #define USB_InitFailure_P               (const uint8_t ErrorCode)\r
                                #define USB_UIDChange_P                 (void)\r
                        #endif\r
 \r
                                ALIAS_STUB(USB_DeviceEnumerationComplete);\r
                                \r
                                #if defined(USB_CAN_BE_BOTH)\r
-                                       ALIAS_STUB(USB_PowerOnFail);\r
+                                       ALIAS_STUB(USB_InitFailure);\r
                                        ALIAS_STUB(USB_UIDChange);\r
                                #endif\r
                                \r