Add comments to the currently completed portions of the incomplete Test and Measureme...

[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..42b0ec7 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"


@@ -92,7 +92,7 @@
                         *
                         *  \note This event only exists on USB AVR models which support dual role modes.
                         *
                         *
                         *  \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
+                        *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t.

                         */
                        void EVENT_USB_InitFailure(const uint8_t ErrorCode);
 
                         */
                        void EVENT_USB_InitFailure(const uint8_t ErrorCode);
 


@@ -112,7 +112,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 +154,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 +167,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


@@ -188,7 +189,7 @@
                         *  \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS 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
                         *  \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS 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 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
                         *        passing the 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


@@ -206,7 +207,7 @@
                         *  \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS 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
                         *  \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS 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 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
                         *        passing the 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


@@ -226,7 +227,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 +308,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.


@@ -335,8 +336,9 @@
                                        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);

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