Minor documentation enhancements.

[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 edc7a8b..f1d6f03 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/Events.h
+++ b/LUFA/Drivers/USB/HighLevel/Events.h
@@ -69,7 +69,7 @@
 #define __USBEVENTS_H__
 
        /* Includes: */
 #define __USBEVENTS_H__
 
        /* Includes: */

-               #include <avr/io.h>
+               #include <stdint.h>

                
                #include "../../../Common/Common.h"
                #include "USBMode.h"
                
                #include "../../../Common/Common.h"
                #include "USBMode.h"


@@ -87,15 +87,6 @@
        /* Public Interface - May be used in end-application: */                        
                /* Pseudo-Functions for Doxygen: */
                #if !defined(__INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)
        /* Public Interface - May be used in end-application: */                        
                /* Pseudo-Functions for Doxygen: */
                #if !defined(__INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)

-                       /** Event for USB stack initialization failure. This event fires when the USB interface fails to
-                        *  initialize correctly due to a hardware or software fault.
-                        *
-                        *  \note This event only exists on USB AVR models which support dual role modes.
-                        *
-                        *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t
-                        */
-                       void EVENT_USB_InitFailure(const uint8_t ErrorCode);
-

                        /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role
                         *  mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires
                         *  before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Device_Disconnect
                        /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role
                         *  mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires
                         *  before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Device_Disconnect


@@ -112,7 +103,7 @@
                        /** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB
                         *  interface is in host mode.
                         *
                        /** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB
                         *  interface is in host mode.
                         *

-                        *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t
+                        *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t.

                         *
                         *  \note This event only exists on USB AVR models which supports host mode.
                         *        \n\n
                         *
                         *  \note This event only exists on USB AVR models which supports host mode.
                         *        \n\n


@@ -154,8 +145,8 @@
                        /** Event for USB device enumeration failure. This event fires when a the USB interface is
                         *  in host mode, and an attached USB device has failed to enumerate completely.
                         *
                        /** Event for USB device enumeration failure. This event fires when a the USB interface is
                         *  in host mode, and an attached USB device has failed to enumerate completely.
                         *

-                        *  \param[in] ErrorCode  Error code indicating the failure reason, a value in 
-                        *                        \ref USB_Host_EnumerationErrorCodes_t
+                        *  \param[in] ErrorCode     Error code indicating the failure reason, a value in 
+                        *                           \ref USB_Host_EnumerationErrorCodes_t.

                         *
                         *  \param[in] SubErrorCode  Sub error code indicating the reason for failure - for example, if the
                         *                           ErrorCode parameter indicates a control error, this will give the error
                         *
                         *  \param[in] SubErrorCode  Sub error code indicating the reason for failure - for example, if the
                         *                           ErrorCode parameter indicates a control error, this will give the error


@@ -167,7 +158,8 @@
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
                         *        \ref Group_USBManagement documentation).
                         */
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
                         *        \ref Group_USBManagement documentation).
                         */

-                       void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);
+                       void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
+                                                                   const uint8_t SubErrorCode);

 
                        /** Event for USB device enumeration completion. This event fires when a the USB interface is
                         *  in host mode and an attached USB device has been completely enumerated and is ready to be
 
                        /** Event for USB device enumeration completion. This event fires when a the USB interface is
                         *  in host mode and an attached USB device has been completely enumerated and is ready to be


@@ -179,6 +171,23 @@
                         */
                        void EVENT_USB_Host_DeviceEnumerationComplete(void);
 
                         */
                        void EVENT_USB_Host_DeviceEnumerationComplete(void);
 

+                       /** Event for USB Start Of Frame detection, when enabled. This event fires at the start of each USB
+                        *  frame, once per millisecond, and is synchronized to the USB bus. This can be used as an accurate
+                        *  millisecond timer source when the USB bus is not suspended while in host mode.
+                        *
+                        *  This event is time-critical; it is run once per millisecond and thus long handlers will significantly
+                        *  degrade device performance. This event should only be enabled when needed to reduce device wake-ups.
+                        *
+                        *  \note This event is not normally active - it must be manually enabled and disabled via the
+                        *        \ref USB_Host_EnableSOFEvents() and \ref USB_Host_DisableSOFEvents() commands after enumeration of
+                        *        a USB device.
+                        *        \n\n
+                        *
+                        *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
+                        *        \ref Group_USBManagement documentation).
+                        */
+                       void EVENT_USB_Host_StartOfFrame(void);
+

                        /** Event for USB device connection. This event fires when the AVR in device mode and the device is connected
                         *  to a host, beginning the enumeration process, measured by a rising level on the AVR's VBUS pin.
                         *
                        /** Event for USB device connection. This event fires when the AVR in device mode and the device is connected
                         *  to a host, beginning the enumeration process, measured by a rising level on the AVR's VBUS pin.
                         *


@@ -226,7 +235,7 @@
                         *  This event is time-critical; each packet within the request transaction must be acknowledged or
                         *  sent within 50ms or the host will abort the transfer.
                         *
                         *  This event is time-critical; each packet within the request transaction must be acknowledged or
                         *  sent within 50ms or the host will abort the transfer.
                         *

-                        *  The library interally handles all standard control requests with the exceptions of SYNC FRAME,
+                        *  The library internally handles all standard control requests with the exceptions of SYNC FRAME,

                         *  SET DESCRIPTOR and SET INTERFACE. These and all other non-standard control requests will be left
                         *  for the user to process via this event if desired. If not handled in the user application, requests
                         *  are automatically STALLed.
                         *  SET DESCRIPTOR and SET INTERFACE. These and all other non-standard control requests will be left
                         *  for the user to process via this event if desired. If not handled in the user application, requests
                         *  are automatically STALLed.


@@ -307,7 +316,7 @@
                         *  millisecond timer source when the USB bus is enumerated in device mode to a USB host.
                         *
                         *  This event is time-critical; it is run once per millisecond and thus long handlers will significantly
                         *  millisecond timer source when the USB bus is enumerated in device mode to a USB host.
                         *
                         *  This event is time-critical; it is run once per millisecond and thus long handlers will significantly

-                        *  degrade device performance. This event should only be enabled when needed to reduce device wakeups.
+                        *  degrade device performance. This event should only be enabled when needed to reduce device wake-ups.

                         *
                         *  \note This event is not normally active - it must be manually enabled and disabled via the
                         *        \ref USB_Device_EnableSOFEvents() and \ref USB_Device_DisableSOFEvents() commands after enumeration.
                         *
                         *  \note This event is not normally active - it must be manually enabled and disabled via the
                         *        \ref USB_Device_EnableSOFEvents() and \ref USB_Device_DisableSOFEvents() commands after enumeration.


@@ -326,7 +335,6 @@
                                void USB_Event_Stub(void) ATTR_CONST;
                                        
                                #if defined(USB_CAN_BE_BOTH)
                                void USB_Event_Stub(void) ATTR_CONST;
                                        
                                #if defined(USB_CAN_BE_BOTH)

-                                       void EVENT_USB_InitFailure(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);

                                        void EVENT_USB_UIDChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
                                #endif
                                
                                        void EVENT_USB_UIDChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
                                #endif
                                


@@ -335,8 +343,10 @@
                                        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_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);
+                                       void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
+                                                                const uint8_t SubErrorCode)
+                                                                                   ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+                                       void EVENT_USB_Host_StartOfFrame(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);

                                #endif
 
                                #if defined(USB_CAN_BE_DEVICE)
                                #endif
 
                                #if defined(USB_CAN_BE_DEVICE)