Build: Fix incorrect build target for Ubuntu CI builds.
[pub/USBasp.git] / LUFA / Drivers / USB / Core / Events.h
index e0a57e1..85b63a5 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2019.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2019  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
                         *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
                         *  1 second) when a transaction is waiting to be processed by the device will prevent break communications
                         *  and cause the host to reset the USB bus.
+                        *
+                        *  \note This event only exists on microcontrollers that supports USB host mode.
+                        *        \n\n
+                        *
+                        *  \note This event does not exist if the \c USB_DEVICE_ONLY token is supplied to the compiler (see
+                        *        \ref Group_USBManagement documentation).
                         */
                        void EVENT_USB_Host_DeviceEnumerationComplete(void);
 
                         *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
                         *  two seconds) will prevent the device from enumerating correctly.
                         *
+                        *  \attention This event may fire multiple times during device enumeration on the microcontrollers with limited USB controllers
+                        *             if \c NO_LIMITED_CONTROLLER_CONNECT is not defined.
+                        *
                         *  \note For the microcontrollers with limited USB controller functionality, VBUS sensing is not available.
                         *        this means that the current connection state is derived from the bus suspension and wake up events by default,
                         *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state
-                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
+                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behavior turned off by
                         *        passing the \c NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
                         *        and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
                         *        \n\n
                         *
-                        *  \note This event may fire multiple times during device enumeration on the microcontrollers with limited USB controllers
-                        *        if \c NO_LIMITED_CONTROLLER_CONNECT is not defined.
-                        *
                         *  \see \ref Group_USBManagement for more information on the USB management task and reducing CPU usage.
                         */
                        void EVENT_USB_Device_Connect(void);
                        /** Event for USB device disconnection. This event fires when the microcontroller is in USB Device mode and the device is
                         *  disconnected from a host, measured by a falling level on the microcontroller's VBUS sense pin.
                         *
+                        *  \attention This event may fire multiple times during device enumeration on the microcontrollers with limited USB controllers
+                        *             if \c NO_LIMITED_CONTROLLER_CONNECT is not defined.
+                        *
                         *  \note For the microcontrollers with limited USB controllers, VBUS sense is not available to the USB controller.
                         *        this means that the current connection state is derived from the bus suspension and wake up events by default,
                         *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state
-                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
+                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behavior turned off by
                         *        passing the \c NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
                         *        and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
                         *        \n\n
                         *
-                        *  \note This event may fire multiple times during device enumeration on the microcontrollers with limited USB controllers
-                        *        if \c NO_LIMITED_CONTROLLER_CONNECT is not defined.
-                        *
                         *  \see \ref Group_USBManagement for more information on the USB management task and reducing CPU usage.
                         */
                        void EVENT_USB_Device_Disconnect(void);
        #if !defined(__DOXYGEN__)
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_EVENTS_C)
-                               void USB_Event_Stub(void) ATTR_CONST;
+                               void USB_Event_Stub(void);
+                               void USB_Event_Stub_2(const uint8_t _1);
+                               void USB_Event_Stub_3(const uint8_t _1, const uint8_t _2);
 
                                #if defined(USB_CAN_BE_BOTH)
                                        void EVENT_USB_UIDChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
                                #endif
 
                                #if defined(USB_CAN_BE_HOST)
-                                       void EVENT_USB_Host_HostError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+                                       void EVENT_USB_Host_HostError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub_2);
                                        void EVENT_USB_Host_DeviceAttached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
                                        void EVENT_USB_Host_DeviceUnattached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
                                        void EVENT_USB_Host_DeviceEnumerationComplete(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
                                        void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
                                                                 const uint8_t SubErrorCode)
-                                                                                   ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+                                                                                   ATTR_WEAK ATTR_ALIAS(USB_Event_Stub_3);
                                        void EVENT_USB_Host_StartOfFrame(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
                                #endif