aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Core/Events.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2012-02-24 20:25:36 +0000
committerDean Camera <dean@fourwalledcubicle.com>2012-02-24 20:25:36 +0000
commite406140f119281a945c281d25e9a1041b862d592 (patch)
treed8ad16a77830f8116e5ae5bdbe99fcb263a7f9d6 /LUFA/Drivers/USB/Core/Events.h
parent5561524a8fe7baaeaac3421c9e1d3347186fdf95 (diff)
downloadlufa-e406140f119281a945c281d25e9a1041b862d592.tar.gz
lufa-e406140f119281a945c281d25e9a1041b862d592.tar.bz2
lufa-e406140f119281a945c281d25e9a1041b862d592.zip
Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation.
Diffstat (limited to 'LUFA/Drivers/USB/Core/Events.h')
-rw-r--r--LUFA/Drivers/USB/Core/Events.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/LUFA/Drivers/USB/Core/Events.h b/LUFA/Drivers/USB/Core/Events.h
index 2fff44046..8d627d4f2 100644
--- a/LUFA/Drivers/USB/Core/Events.h
+++ b/LUFA/Drivers/USB/Core/Events.h
@@ -183,6 +183,9 @@
* 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
@@ -191,9 +194,6 @@
* 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);
@@ -201,6 +201,9 @@
/** 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
@@ -209,9 +212,6 @@
* 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);