-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\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
- without fee, provided that the above copyright notice appear in \r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting \r
- documentation, and that the name of the author not be used in \r
- advertising or publicity pertaining to distribution of the \r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\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
- * This module 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
- * @{\r
- */\r
- \r
-#ifndef __USBEVENTS_H__\r
-#define __USBEVENTS_H__\r
-\r
- /* Includes: */\r
- #include <avr/io.h>\r
- \r
- #include "../../../Common/Common.h"\r
- #include "USBMode.h"\r
-\r
- /* Enable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\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
- /** 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
- * \note This event only exists on USB AVR models which support dual role modes.\r
- *\r
- * \param[in] ErrorCode Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t\r
- */\r
- void EVENT_USB_InitFailure(const uint8_t ErrorCode);\r
-\r
- /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role\r
- * mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires\r
- * before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Device_Disconnect\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
- */\r
- void EVENT_USB_UIDChange(void);\r
-\r
- /** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB\r
- * interface is in host mode.\r
- *\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
- */\r
- void EVENT_USB_Host_HostError(const uint8_t ErrorCode);\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 \ref EVENT_USB_Device_Connect() event and so can be used to programmatically start the USB\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
- *\r
- * \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.\r
- */\r
- void EVENT_USB_Host_DeviceAttached(void);\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 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
- *\r
- * \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.\r
- */\r
- void EVENT_USB_Host_DeviceUnattached(void);\r
- \r
- /** Event for USB device enumeration failure. This event fires when a the USB interface is\r
- * in host mode, and an attached USB device has failed to enumerate completely.\r
- *\r
- * \param[in] ErrorCode Error code indicating the failure reason, a value in \r
- * \ref USB_Host_EnumerationErrorCodes_t\r
- *\r
- * \param[in] SubErrorCode Sub error code indicating the reason for failure - for example, if the\r
- * ErrorCode parameter indicates a control error, this will give the error\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
- */\r
- void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);\r
-\r
- /** Event for USB device enumeration completion. This event fires when a the USB interface is\r
- * in host mode and an attached USB device has been completely enumerated and is ready to be\r
- * controlled by the user application.\r
- *\r
- * This event is time-critical; exceeding OS-specific delays within this event handler (typically of around\r
- * 1 second) when a transaction is waiting to be processed by the device will prevent break communications\r
- * and cause the host to reset the USB bus.\r
- */\r
- void EVENT_USB_Host_DeviceEnumerationComplete(void);\r
-\r
- /** Event for USB device connection. This event fires when the AVR in device mode and the device is connected\r
- * to a host, beginning the enumeration process, measured by a rising level on the AVR's VBUS pin.\r
- *\r
- * This event is time-critical; exceeding OS-specific delays within this event handler (typically of around\r
- * two seconds) will prevent the device from enumerating correctly.\r
- *\r
- * \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.\r
- * this means that the current connection state is derived from the bus suspension and wake up events by default,\r
- * which is not always accurate (host may suspend the bus while still connected). If the actual connection state\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
- * \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
- */\r
- void EVENT_USB_Device_Connect(void);\r
-\r
- /** Event for USB device disconnection. This event fires when the AVR in device mode and the device is disconnected\r
- * from a host, measured by a falling level on the AVR's VBUS pin.\r
- *\r
- * \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.\r
- * this means that the current connection state is derived from the bus suspension and wake up events by default,\r
- * which is not always accurate (host may suspend the bus while still connected). If the actual connection state\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
- * \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
- */\r
- void EVENT_USB_Device_Disconnect(void);\r
-\r
- /** Event for unhandled control requests. This event fires when a the USB host issues a control\r
- * request to the control endpoint (address 0) that the library does not handle. This may either\r
- * be a standard request that the library has no handler code for, or a class specific request\r
- * issued to the device which must be handled appropriately.\r
- *\r
- * This event is time-critical; each packet within the request transaction must be acknowledged or\r
- * sent within 50ms or the host will abort the transfer.\r
- *\r
- * The library interally handles all standard control requests with the exceptions of SYNC FRAME,\r
- * SET DESCRIPTOR and SET INTERFACE. These and all other non-standard control requests will be left\r
- * for the user to process via this event if desired. If not handled in the user application, requests\r
- * are automatically STALLed.\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
- * request SETUP parameters into the \ref USB_ControlRequest structure which should then be used\r
- * by the application to determine how to handle the issued request.\r
- */\r
- void EVENT_USB_Device_UnhandledControlRequest(void);\r
-\r
- /** Event for USB configuration number changed. This event fires when a the USB host changes the\r
- * selected configuration number while in device mode. This event should be hooked in device\r
- * applications to create the endpoints and configure the device for the selected configuration.\r
- *\r
- * This event is time-critical; exceeding OS-specific delays within this event handler (typically of around\r
- * one second) will prevent the device from enumerating correctly.\r
- *\r
- * This event fires after the value of \ref USB_ConfigurationNumber has been changed.\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
- */\r
- void EVENT_USB_Device_ConfigurationChanged(void);\r
-\r
- /** Event for USB suspend. This event fires when a the USB host suspends the device by halting its\r
- * transmission of Start Of Frame pulses to the device. This is generally hooked in order to move\r
- * the device over to a low power state until the host wakes up the device. If the USB interface is\r
- * enumerated with the \ref USB_OPT_AUTO_PLL option set, the library will automatically suspend the\r
- * USB PLL before the event is fired to save power.\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
- void EVENT_USB_Device_Suspend(void);\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 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
- void EVENT_USB_Device_WakeUp(void);\r
-\r
- /** Event for USB interface reset. This event fires when the USB interface is in device mode, and\r
- * a the USB host requests that the device reset its interface. This event fires after the control\r
- * endpoint has been automatically configured by the library.\r
- *\r
- * This event is time-critical; exceeding OS-specific delays within this event handler (typically of around\r
- * two seconds) will prevent the device from enumerating correctly.\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
- */\r
- void EVENT_USB_Device_Reset(void);\r
-\r
- /** Event for USB Start Of Frame detection, when enabled. This event fires at the start of each USB\r
- * frame, once per millisecond, and is synchronized to the USB bus. This can be used as an accurate\r
- * millisecond timer source when the USB bus is enumerated in device mode to a USB host.\r
- *\r
- * This event is time-critical; it is run once per millisecond and thus long handlers will significantly\r
- * degrade device performance. This event should only be enabled when needed to reduce device wakeups.\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
- */\r
- void EVENT_USB_Device_StartOfFrame(void);\r
- #endif\r
- \r
- /* Private Interface - For use in library only: */\r
- #if !defined(__DOXYGEN__)\r
- /* Function Prototypes: */\r
- #if defined(__INCLUDE_FROM_EVENTS_C)\r
- void USB_Event_Stub(void) ATTR_CONST;\r
- \r
- #if defined(USB_CAN_BE_BOTH)\r
- void EVENT_USB_InitFailure(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_UIDChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- #endif\r
- \r
- #if defined(USB_CAN_BE_HOST)\r
- void EVENT_USB_Host_HostError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Host_DeviceAttached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Host_DeviceUnattached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Host_DeviceEnumerationComplete(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
- ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- #endif\r
-\r
- #if defined(USB_CAN_BE_DEVICE)\r
- void EVENT_USB_Device_Connect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Device_Disconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Device_UnhandledControlRequest(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Device_ConfigurationChanged(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Device_Suspend(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Device_WakeUp(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Device_Reset(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Device_StartOfFrame(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- #endif\r
- #endif\r
- #endif\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
- \r
-#endif\r
-\r
-/** @} */\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2010.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.fourwalledcubicle.com
+*/
+
+/*
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ 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
+ *
+ * This module 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).
+ *
+ * @{
+ */
+
+#ifndef __USBEVENTS_H__
+#define __USBEVENTS_H__
+
+ /* Includes: */
+ #include <avr/io.h>
+
+ #include "../../../Common/Common.h"
+ #include "USBMode.h"
+
+ /* Enable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ extern "C" {
+ #endif
+
+ /* Preprocessor Checks: */
+ #if !defined(__INCLUDE_FROM_USB_DRIVER)
+ #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
+ #endif
+
+ /* Public Interface - May be used in end-application: */
+ /* Pseudo-Functions for Doxygen: */
+ #if !defined(__INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)
+ /** Event for USB stack initialization failure. This event fires when the USB interface fails to
+ * initialize correctly due to a hardware or software fault.
+ *
+ * \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
+ */
+ void EVENT_USB_InitFailure(const uint8_t ErrorCode);
+
+ /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role
+ * mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires
+ * before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Device_Disconnect
+ * 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).
+ */
+ void EVENT_USB_UIDChange(void);
+
+ /** 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
+ *
+ * \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).
+ */
+ void EVENT_USB_Host_HostError(const uint8_t ErrorCode);
+
+ /** Event for USB device attachment. This event fires when a the USB interface is in host mode, and
+ * a USB device has been connected to the USB interface. This is interrupt driven, thus fires before
+ * the standard \ref EVENT_USB_Device_Connect() event and so can be used to programmatically start 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).
+ *
+ * \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.
+ */
+ void EVENT_USB_Host_DeviceAttached(void);
+
+ /** Event for USB device removal. This event fires when a the USB interface is in host mode, and
+ * a USB device has been removed the USB interface whether or not it has been enumerated. This
+ * 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).
+ *
+ * \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.
+ */
+ void EVENT_USB_Host_DeviceUnattached(void);
+
+ /** 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] SubErrorCode Sub error code indicating the reason for failure - for example, if the
+ * ErrorCode parameter indicates a control error, this will give the error
+ * 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).
+ */
+ 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
+ * controlled by the user application.
+ *
+ * This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
+ * 1 second) when a transaction is waiting to be processed by the device will prevent break communications
+ * and cause the host to reset the USB bus.
+ */
+ void EVENT_USB_Host_DeviceEnumerationComplete(void);
+
+ /** Event for USB device connection. This event fires when the AVR in device mode and the device is connected
+ * to a host, beginning the enumeration process, measured by a rising level on the AVR's VBUS pin.
+ *
+ * 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.
+ *
+ * \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
+ * 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.
+ *
+ * \see USBTask.h for more information on the USB management task and reducing CPU usage.
+ */
+ void EVENT_USB_Device_Connect(void);
+
+ /** Event for USB device disconnection. This event fires when the AVR in device mode and the device is disconnected
+ * from a host, measured by a falling level on the AVR's VBUS pin.
+ *
+ * \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
+ * 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.
+ *
+ * \see USBTask.h for more information on the USB management task and reducing CPU usage.
+ */
+ void EVENT_USB_Device_Disconnect(void);
+
+ /** Event for unhandled control requests. This event fires when a the USB host issues a control
+ * request to the control endpoint (address 0) that the library does not handle. This may either
+ * be a standard request that the library has no handler code for, or a class specific request
+ * issued to the device which must be handled appropriately.
+ *
+ * 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,
+ * 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.
+ *
+ * \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
+ * request SETUP parameters into the \ref USB_ControlRequest structure which should then be used
+ * by the application to determine how to handle the issued request.
+ */
+ void EVENT_USB_Device_UnhandledControlRequest(void);
+
+ /** Event for USB configuration number changed. This event fires when a the USB host changes the
+ * selected configuration number while in device mode. This event should be hooked in device
+ * applications to create the endpoints and configure the device for the selected configuration.
+ *
+ * This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
+ * one second) will prevent the device from enumerating correctly.
+ *
+ * This event fires after the value of \ref USB_ConfigurationNumber has been changed.
+ *
+ * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
+ * \ref Group_USBManagement documentation).
+ */
+ void EVENT_USB_Device_ConfigurationChanged(void);
+
+ /** Event for USB suspend. This event fires when a the USB host suspends the device by halting its
+ * transmission of Start Of Frame pulses to the device. This is generally hooked in order to move
+ * the device over to a low power state until the host wakes up the device. If the USB interface is
+ * enumerated with the \ref USB_OPT_AUTO_PLL option set, the library will automatically suspend the
+ * USB PLL before the event is fired to save power.
+ *
+ * \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.
+ *
+ * \see \ref EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.
+ */
+ void EVENT_USB_Device_Suspend(void);
+
+ /** Event for USB wake up. This event fires when a the USB interface is suspended while in device
+ * mode, and the host wakes up the device by supplying Start Of Frame pulses. This is generally
+ * hooked to pull the user application out of a low power state and back into normal operating
+ * mode. If the USB interface is enumerated with the \ref USB_OPT_AUTO_PLL option set, the library
+ * will automatically restart the USB PLL before the event is fired.
+ *
+ * \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.
+ *
+ * \see \ref EVENT_USB_Device_Suspend() event for accompanying Suspend event.
+ */
+ void EVENT_USB_Device_WakeUp(void);
+
+ /** Event for USB interface reset. This event fires when the USB interface is in device mode, and
+ * a the USB host requests that the device reset its interface. This event fires after the control
+ * endpoint has been automatically configured by the library.
+ *
+ * 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.
+ *
+ * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
+ * \ref Group_USBManagement documentation).
+ */
+ void EVENT_USB_Device_Reset(void);
+
+ /** Event for USB Start Of Frame detection, when enabled. This event fires at the start of each USB
+ * frame, once per millisecond, and is synchronized to the USB bus. This can be used as an accurate
+ * 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.
+ *
+ * \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).
+ */
+ void EVENT_USB_Device_StartOfFrame(void);
+ #endif
+
+ /* Private Interface - For use in library only: */
+ #if !defined(__DOXYGEN__)
+ /* Function Prototypes: */
+ #if defined(__INCLUDE_FROM_EVENTS_C)
+ void USB_Event_Stub(void) ATTR_CONST;
+
+ #if defined(USB_CAN_BE_BOTH)
+ void EVENT_USB_InitFailure(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+ void EVENT_USB_UIDChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+ #endif
+
+ #if defined(USB_CAN_BE_HOST)
+ void EVENT_USB_Host_HostError(const uint8_t ErrorCode) 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);
+ #endif
+
+ #if defined(USB_CAN_BE_DEVICE)
+ void EVENT_USB_Device_Connect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+ void EVENT_USB_Device_Disconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+ void EVENT_USB_Device_UnhandledControlRequest(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+ void EVENT_USB_Device_ConfigurationChanged(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+ void EVENT_USB_Device_Suspend(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+ void EVENT_USB_Device_WakeUp(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+ void EVENT_USB_Device_Reset(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+ void EVENT_USB_Device_StartOfFrame(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
+ #endif
+ #endif
+ #endif
+
+ /* Disable C linkage for C++ Compilers: */
+ #if defined(__cplusplus)
+ }
+ #endif
+
+#endif
+
+/** @} */
projects / pub / USBasp.git / blobdiff