projects
/
pub
/
USBasp.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Renamed Serial_Stream driver to SerialStream to remain consistent with the rest of...
[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
eeb0ed3
..
480e824
100644
(file)
--- a/
LUFA/Drivers/USB/HighLevel/Events.h
+++ b/
LUFA/Drivers/USB/HighLevel/Events.h
@@
-39,6
+39,14
@@
*
\r
* Each event must only have one associated event handler, but can be raised by multiple sources.
\r
*/
\r
*
\r
* Each event must only have one associated event handler, but can be raised by multiple sources.
\r
*/
\r
+
\r
+/** \ingroup Group_USB
\r
+ * @defgroup Group_Events USB Events
\r
+ *
\r
+ * Functions, macros, variables, enums and types related to the management of events from the USB kernel.
\r
+ *
\r
+ * @{
\r
+ */
\r
\r
#ifndef __USBEVENTS_H__
\r
#define __USBEVENTS_H__
\r
\r
#ifndef __USBEVENTS_H__
\r
#define __USBEVENTS_H__
\r
@@
-47,7
+55,7
@@
#include <avr/io.h>
\r
\r
#include "../../../Common/Common.h"
\r
#include <avr/io.h>
\r
\r
#include "../../../Common/Common.h"
\r
- #include "
../LowLevel/
USBMode.h"
\r
+ #include "USBMode.h"
\r
\r
/* Enable C linkage for C++ Compilers: */
\r
#if defined(__cplusplus)
\r
\r
/* Enable C linkage for C++ Compilers: */
\r
#if defined(__cplusplus)
\r
@@
-58,7
+66,7
@@
/* Macros: */
\r
/** Raises a given event name, with the specified parameters. For events with no parameters the
\r
* only argument to the macro is the event name, events with parameters list the parameter values
\r
/* Macros: */
\r
/** Raises a given event name, with the specified parameters. For events with no parameters the
\r
* only argument to the macro is the event name, events with parameters list the parameter values
\r
- * after the name as a comma sep
e
rated list.
\r
+ * after the name as a comma sep
a
rated list.
\r
*
\r
* When a given event is fired, its corresponding event handler code is executed.
\r
*
\r
*
\r
* When a given event is fired, its corresponding event handler code is executed.
\r
*
\r
@@
-75,7
+83,7
@@
*/
\r
#define RAISE_EVENT(e, ...) Event_ ## e (__VA_ARGS__)
\r
\r
*/
\r
#define RAISE_EVENT(e, ...) Event_ ## e (__VA_ARGS__)
\r
\r
- /** Indicates that a given module can raise a given event. This is the equiv
e
lent of putting the
\r
+ /** Indicates that a given module can raise a given event. This is the equiv
a
lent of putting the
\r
* event function's prototype into the module, but in a cleaner way. Each event which may be
\r
* fired via the RAISE_EVENT macro in the module should have an accompanying RAISES_EVENT
\r
* prototype in the module's header file.
\r
* event function's prototype into the module, but in a cleaner way. Each event which may be
\r
* fired via the RAISE_EVENT macro in the module should have an accompanying RAISES_EVENT
\r
* prototype in the module's header file.
\r
@@
-100,7
+108,7
@@
*
\r
* Only one event handler may be defined in any user project for each individual event. Events may
\r
* or may not have parameters - for each event, refer to its documentation elsewhere in this module
\r
*
\r
* Only one event handler may be defined in any user project for each individual event. Events may
\r
* or may not have parameters - for each event, refer to its documentation elsewhere in this module
\r
- * to determine the presen
s
e and purpose of any event parameters.
\r
+ * to determine the presen
c
e and purpose of any event parameters.
\r
*
\r
* Usage Example:
\r
* \code
\r
*
\r
* Usage Example:
\r
* \code
\r
@@
-115,7
+123,7
@@
*/
\r
#define EVENT_HANDLER(e) void Event_ ## e e ## _P
\r
\r
*/
\r
#define EVENT_HANDLER(e) void Event_ ## e e ## _P
\r
\r
- /** Indicates that a given module handles an event. This is the equiv
e
lent of putting the
\r
+ /** Indicates that a given module handles an event. This is the equiv
a
lent of putting the
\r
* event function's prototype into the module, but in a cleaner way. Each event which may be
\r
* handled via the EVENT_HANDLER macro in the module should have an accompanying HANDLES_EVENT
\r
* prototype in the module's header file.
\r
* event function's prototype into the module, but in a cleaner way. Each event which may be
\r
* handled via the EVENT_HANDLER macro in the module should have an accompanying HANDLES_EVENT
\r
* prototype in the module's header file.
\r
@@
-136,7
+144,7
@@
*/
\r
#define HANDLES_EVENT(e) EVENT_HANDLER(e)
\r
\r
*/
\r
#define HANDLES_EVENT(e) EVENT_HANDLER(e)
\r
\r
- /* Psudo-Functions for Doxygen: */
\r
+ /* Ps
e
udo-Functions for Doxygen: */
\r
#if defined(__DOXYGEN__)
\r
/** Event for VBUS level change. This event fires when the VBUS line of the USB AVR changes from
\r
* high to low or vice-versa.
\r
#if defined(__DOXYGEN__)
\r
/** Event for VBUS level change. This event fires when the VBUS line of the USB AVR changes from
\r
* high to low or vice-versa.
\r
@@
-165,7
+173,7
@@
* has been attached (but not yet fully enumerated), or when in device mode and the device is connected
\r
* to a host, beginning the enumeration process.
\r
*
\r
* has been attached (but not yet fully enumerated), or when in device mode and the device is connected
\r
* to a host, beginning the enumeration process.
\r
*
\r
- * When in device mode, this can be used to progmatically start the USB management task to reduce
\r
+ * When in device mode, this can be used to prog
ram
matically start the USB management task to reduce
\r
* CPU usage.
\r
*
\r
* \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.
\r
* CPU usage.
\r
*
\r
* \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.
\r
@@
-183,7
+191,7
@@
* attached and enumerated device has been disconnected, or when in device mode and the device is
\r
* disconnected from the host.
\r
*
\r
* attached and enumerated device has been disconnected, or when in device mode and the device is
\r
* disconnected from the host.
\r
*
\r
- * When in device mode, this can be used to progmatically stop the USB management task to reduce
\r
+ * When in device mode, this can be used to prog
ram
matically stop the USB management task to reduce
\r
* CPU usage.
\r
*
\r
* \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.
\r
* CPU usage.
\r
*
\r
* \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.
\r
@@
-231,7
+239,7
@@
\r
/** Event for USB device attachment. This event fires when a the USB interface is in host mode, and
\r
* a USB device has been connected to the USB interface. This is interrupt driven, thus fires before
\r
\r
/** Event for USB device attachment. This event fires when a the USB interface is in host mode, and
\r
* a USB device has been connected to the USB interface. This is interrupt driven, thus fires before
\r
- * the standard USB_DeviceConnect event and so can be used to programatically start the USB management
\r
+ * the standard USB_DeviceConnect event and so can be used to program
m
atically start the USB management
\r
* task to reduce CPU consumption.
\r
*
\r
* \note This event only exists on USB AVR models which supports host mode.
\r
* task to reduce CPU consumption.
\r
*
\r
* \note This event only exists on USB AVR models which supports host mode.
\r
@@
-245,7
+253,7
@@
\r
/** Event for USB device removal. This event fires when a the USB interface is in host mode, and
\r
* a USB device has been removed the USB interface whether or not it has been enumerated. This
\r
\r
/** Event for USB device removal. This event fires when a the USB interface is in host mode, and
\r
* a USB device has been removed the USB interface whether or not it has been enumerated. This
\r
- * can be used to programatically stop the USB management task to reduce CPU consumption.
\r
+ * can be used to program
m
atically stop the USB management task to reduce CPU consumption.
\r
*
\r
* \note This event only exists on USB AVR models which supports host mode.
\r
*
\r
*
\r
* \note This event only exists on USB AVR models which supports host mode.
\r
*
\r
@@
-436,5
+444,7
@@
#if defined(__cplusplus)
\r
}
\r
#endif
\r
#if defined(__cplusplus)
\r
}
\r
#endif
\r
-
\r
+
\r
#endif
\r
#endif
\r
+
\r
+/** @} */
\r
projects / pub / USBasp.git / blobdiff