More minor renaming of library enums and events to try to create a consistent API.

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

diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h
index 7815534..4624e5b 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/Events.h
+++ b/LUFA/Drivers/USB/HighLevel/Events.h
@@ -202,13 +202,15 @@
                         */\r
                        void USB_Disconnect(void);\r
                        \r
                         */\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
                         *  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
                         *                    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
 \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


@@ -374,7 +376,7 @@
                        #define USB_DeviceEnumerationComplete_P     (void)\r
                        \r
                        #if defined(USB_CAN_BE_BOTH)\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
                                #define USB_UIDChange_P                 (void)\r
                        #endif\r
 \r


@@ -409,7 +411,7 @@
                                ALIAS_STUB(USB_DeviceEnumerationComplete);\r
                                \r
                                #if defined(USB_CAN_BE_BOTH)\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
                                        ALIAS_STUB(USB_UIDChange);\r
                                #endif\r
                                \r