X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d49cc0f7830319e701294e19937fae4de26ae8e2..d03d6513d0d24cf63225c8d3dfa07675d9107f40:/LUFA/Drivers/USB/HighLevel/Events.h diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h index 12b30b250..8daa8ea2b 100644 --- a/LUFA/Drivers/USB/HighLevel/Events.h +++ b/LUFA/Drivers/USB/HighLevel/Events.h @@ -28,6 +28,25 @@ this software. */ +/** \file + * \brief USB controller events manager. + * + * This file contains macros and functions relating to the management of library events, which are small + * pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from + * multiple places in the user or library code, which may or may not be inside an ISR, thus each handler + * should be written to be as small and fast as possible to prevent possible problems. + * + * Events can be hooked by the user application by declaring a handler function with the same name and parameters + * listed here. If an event with no user-associated handler is fired within the library, it by default maps to an + * internal empty stub function. + * + * Each event must only have one associated event handler, but can be raised by multiple sources by calling the + * event handler function (with any required event parameters). + * + * \note This file should not be included directly. It is automatically included as needed by the USB driver + * dispatch header located in LUFA/Drivers/USB/USB.h. + */ + /** \ingroup Group_USB * @defgroup Group_Events USB Events * @@ -62,7 +81,7 @@ /* Preprocessor Checks: */ #if !defined(__INCLUDE_FROM_USB_DRIVER) - #error Do not include this file directly. Include LUFA/Drivers/USB.h instead. + #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead. #endif /* Public Interface - May be used in end-application: */ @@ -83,6 +102,7 @@ * event has fired (if connected before the role change). * * \note This event only exists on USB AVR models which support dual role modes. + * \n\n * * \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied * to the compiler (see \ref Group_USBManagement documentation). @@ -95,6 +115,7 @@ * \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 does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see * \ref Group_USBManagement documentation). @@ -107,6 +128,7 @@ * management task to reduce CPU consumption. * * \note This event only exists on USB AVR models which supports host mode. + * \n\n * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see * \ref Group_USBManagement documentation). @@ -120,6 +142,7 @@ * can be used to programmatically stop the USB management task to reduce CPU consumption. * * \note This event only exists on USB AVR models which supports host mode. + * \n\n * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see * \ref Group_USBManagement documentation). @@ -139,6 +162,7 @@ * code returned by the \ref USB_Host_SendControlRequest() function. * * \note This event only exists on USB AVR models which supports host mode. + * \n\n * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see * \ref Group_USBManagement documentation). @@ -167,6 +191,7 @@ * needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour 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 * * \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers * if NO_LIMITED_CONTROLLER_CONNECT is not defined. @@ -184,6 +209,7 @@ * needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour 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 * * \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers * if NO_LIMITED_CONTROLLER_CONNECT is not defined. @@ -207,6 +233,7 @@ * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see * \ref Group_USBManagement documentation). + * \n\n * * \note Requests should be handled in the same manner as described in the USB 2.0 Specification, * or appropriate class specification. In all instances, the library has already read the @@ -237,6 +264,7 @@ * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see * \ref Group_USBManagement documentation). + * \n\n * * \note This event does not exist on the series 2 USB AVRs when the NO_LIMITED_CONTROLLER_CONNECT * compile time token is not set - see \ref EVENT_USB_Device_Disconnect. @@ -253,6 +281,7 @@ * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see * \ref Group_USBManagement documentation). + * \n\n * * \note This event does not exist on the series 2 USB AVRs when the NO_LIMITED_CONTROLLER_CONNECT * compile time token is not set - see \ref EVENT_USB_Device_Connect. @@ -282,6 +311,7 @@ * * \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. + * \n\n * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see * \ref Group_USBManagement documentation).