/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\r
\r
dean [at] fourwalledcubicle [dot] com\r
www.fourwalledcubicle.com\r
*/\r
\r
/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
\r
Permission to use, copy, modify, distribute, and sell this \r
software and its documentation for any purpose is hereby granted\r
this software.\r
*/\r
\r
+/** \file\r
+ * \brief USB controller events manager.\r
+ *\r
+ * This file contains macros and functions relating to the management of library events, which are small\r
+ * pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from\r
+ * multiple places in the user or library code, which may or may not be inside an ISR, thus each handler\r
+ * should be written to be as small and fast as possible to prevent possible problems.\r
+ *\r
+ * Events can be hooked by the user application by declaring a handler function with the same name and parameters\r
+ * listed here. If an event with no user-associated handler is fired within the library, it by default maps to an\r
+ * internal empty stub function.\r
+ *\r
+ * Each event must only have one associated event handler, but can be raised by multiple sources by calling the\r
+ * event handler function (with any required event parameters).\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ * dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
+\r
/** \ingroup Group_USB\r
* @defgroup Group_Events USB Events\r
*\r
* listed here. If an event with no user-associated handler is fired within the library, it by default maps to an\r
* internal empty stub function.\r
*\r
- * Each event must only have one associated event handler, but can be raised by multiple sources by calling the event\r
- * name just like any regular C function (with any required event parameters).\r
+ * Each event must only have one associated event handler, but can be raised by multiple sources by calling the\r
+ * event handler function (with any required event parameters).\r
*\r
* @{\r
*/\r
extern "C" {\r
#endif\r
\r
+ /* Preprocessor Checks: */\r
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
+ #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
+ #endif\r
+ \r
/* Public Interface - May be used in end-application: */ \r
/* Pseudo-Functions for Doxygen: */\r
- #if !defined(INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)\r
+ #if !defined(__INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)\r
/** Event for USB stack initialization failure. This event fires when the USB interface fails to\r
* initialize correctly due to a hardware or software fault.\r
*\r
* event has fired (if connected before the role change).\r
*\r
* \note This event only exists on USB AVR models which support dual role modes.\r
+ * \n\n\r
*\r
* \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied\r
* to the compiler (see \ref Group_USBManagement documentation).\r
* \param[in] ErrorCode Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t\r
*\r
* \note This event only exists on USB AVR models which supports host mode.\r
+ * \n\n\r
*\r
* \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
* management task to reduce CPU consumption.\r
*\r
* \note This event only exists on USB AVR models which supports host mode.\r
+ * \n\n\r
*\r
* \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
* can be used to programmatically 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
+ * \n\n\r
*\r
* \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
* code returned by the \ref USB_Host_SendControlRequest() function.\r
*\r
* \note This event only exists on USB AVR models which supports host mode.\r
+ * \n\n\r
*\r
* \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
* passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
* and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.\r
+ * \n\n\r
*\r
* \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers\r
* if NO_LIMITED_CONTROLLER_CONNECT is not defined.\r
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
* passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
* and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.\r
+ * \n\n\r
*\r
* \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers\r
* if NO_LIMITED_CONTROLLER_CONNECT is not defined.\r
*\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
+ * \n\n\r
*\r
* \note Requests should be handled in the same manner as described in the USB 2.0 Specification,\r
* or appropriate class specification. In all instances, the library has already read the\r
*\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
+ * \n\n\r
+ *\r
+ * \note This event does not exist on the series 2 USB AVRs when the NO_LIMITED_CONTROLLER_CONNECT\r
+ * compile time token is not set - see \ref EVENT_USB_Device_Disconnect.\r
*\r
* \see \ref EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.\r
*/\r
\r
/** Event for USB wake up. This event fires when a the USB interface is suspended while in device\r
* mode, and the host wakes up the device by supplying Start Of Frame pulses. This is generally\r
- * hooked to pull the user application out of a lowe power state and back into normal operating\r
+ * hooked to pull the user application out of a low power state and back into normal operating\r
* mode. If the USB interface is enumerated with the \ref USB_OPT_AUTO_PLL option set, the library\r
* will automatically restart the USB PLL before the event is fired.\r
*\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
+ * \n\n\r
+ *\r
+ * \note This event does not exist on the series 2 USB AVRs when the NO_LIMITED_CONTROLLER_CONNECT\r
+ * compile time token is not set - see \ref EVENT_USB_Device_Connect.\r
*\r
* \see \ref EVENT_USB_Device_Suspend() event for accompanying Suspend event.\r
*/\r
*\r
* \note This event is not normally active - it must be manually enabled and disabled via the\r
* \ref USB_Device_EnableSOFEvents() and \ref USB_Device_DisableSOFEvents() commands after enumeration.\r
+ * \n\n\r
*\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
/* Function Prototypes: */\r
- #if defined(INCLUDE_FROM_EVENTS_C)\r
+ #if defined(__INCLUDE_FROM_EVENTS_C)\r
void USB_Event_Stub(void) ATTR_CONST;\r
\r
#if defined(USB_CAN_BE_BOTH)\r
projects / pub / USBasp.git / blobdiff