Events.h 17.7 KB
 Dean Camera committed Feb 23, 2009 1 2 /* LUFA Library  Dean Camera committed Dec 30, 2009 3  Copyright (C) Dean Camera, 2010.  Dean Camera committed Feb 23, 2009 4 5 6 7 8 9  dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /*  Dean Camera committed Dec 30, 2009 10  Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)  Dean Camera committed Feb 23, 2009 11   Dean Camera committed Dec 28, 2009 12 13 14 15 16 17 18  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  Dean Camera committed Feb 23, 2009 19 20 21 22 23 24 25 26 27 28 29 30  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. */  Dean Camera committed Apr 17, 2009 31 32 33 34 35 36 37 /** \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.  Dean Camera committed Feb 23, 2009 38  *  Dean Camera committed May 18, 2009 39 40  * 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  Dean Camera committed May 19, 2009 41  * internal empty stub function.  Dean Camera committed Feb 23, 2009 42  *  Dean Camera committed Jan 17, 2010 43 44  * 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).  Dean Camera committed Apr 16, 2009 45 46 47  * * @{ */  Dean Camera committed Feb 23, 2009 48 49 50 51 52 53 54 55  #ifndef __USBEVENTS_H__ #define __USBEVENTS_H__ /* Includes: */ #include #include "../../../Common/Common.h"  Dean Camera committed Apr 05, 2009 56  #include "USBMode.h"  Dean Camera committed Feb 23, 2009 57 58 59 60 61 62  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif  Dean Camera committed May 18, 2009 63  /* Public Interface - May be used in end-application: */  Dean Camera committed Apr 01, 2009 64  /* Pseudo-Functions for Doxygen: */  Dean Camera committed May 18, 2009 65  #if !defined(INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)  Dean Camera committed Aug 05, 2009 66  /** Event for USB stack initialization failure. This event fires when the USB interface fails to  Dean Camera committed Feb 23, 2009 67 68  * initialize correctly due to a hardware or software fault. *  69 70  * \note This event only exists on USB AVR models which support dual role modes. *  Dean Camera committed Jun 28, 2009 71  * \param[in] ErrorCode Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t  Dean Camera committed Feb 23, 2009 72  */  Dean Camera committed May 18, 2009 73  void EVENT_USB_InitFailure(const uint8_t ErrorCode);  Dean Camera committed Feb 23, 2009 74 75 76  /** 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  Dean Camera committed Aug 05, 2009 77 78  * 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).  Dean Camera committed Feb 23, 2009 79 80 81 82  * * \note This event only exists on USB AVR models which support dual role modes. * * \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied  Dean Camera committed May 04, 2009 83  * to the compiler (see \ref Group_USBManagement documentation).  Dean Camera committed Feb 23, 2009 84  */  Dean Camera committed May 18, 2009 85  void EVENT_USB_UIDChange(void);  Dean Camera committed Feb 23, 2009 86 87 88 89  /** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB * interface is in host mode. *  Dean Camera committed Jun 28, 2009 90  * \param[in] ErrorCode Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t  Dean Camera committed Feb 23, 2009 91 92 93 94  * * \note This event only exists on USB AVR models which supports host mode. * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see  Dean Camera committed May 04, 2009 95  * \ref Group_USBManagement documentation).  Dean Camera committed Feb 23, 2009 96  */  Dean Camera committed Aug 05, 2009 97  void EVENT_USB_Host_HostError(const uint8_t ErrorCode);  Dean Camera committed Feb 23, 2009 98 99 100  /** 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  Dean Camera committed Aug 20, 2009 101  * the standard \ref EVENT_USB_Device_Connect() event and so can be used to programmatically start the USB  Dean Camera committed Aug 05, 2009 102  * management task to reduce CPU consumption.  Dean Camera committed Feb 23, 2009 103 104 105 106  * * \note This event only exists on USB AVR models which supports host mode. * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see  Dean Camera committed May 04, 2009 107  * \ref Group_USBManagement documentation).  Dean Camera committed Feb 23, 2009 108  *  Dean Camera committed Jun 04, 2009 109  * \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.  Dean Camera committed Feb 23, 2009 110  */  Dean Camera committed Aug 05, 2009 111  void EVENT_USB_Host_DeviceAttached(void);  Dean Camera committed Feb 23, 2009 112 113 114  /** 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  Dean Camera committed Apr 01, 2009 115  * can be used to programmatically stop the USB management task to reduce CPU consumption.  Dean Camera committed Feb 23, 2009 116 117 118 119  * * \note This event only exists on USB AVR models which supports host mode. * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see  Dean Camera committed May 04, 2009 120  * \ref Group_USBManagement documentation).  Dean Camera committed Feb 23, 2009 121  *  Dean Camera committed Jun 04, 2009 122  * \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.  Dean Camera committed Feb 23, 2009 123  */  Dean Camera committed Aug 05, 2009 124  void EVENT_USB_Host_DeviceUnattached(void);  Dean Camera committed Feb 23, 2009 125 126 127 128  /** 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. *  Dean Camera committed Jun 28, 2009 129 130  * \param[in] ErrorCode Error code indicating the failure reason, a value in * \ref USB_Host_EnumerationErrorCodes_t  Dean Camera committed Feb 23, 2009 131  *  Dean Camera committed Jun 28, 2009 132 133 134  * \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.  Dean Camera committed Feb 23, 2009 135 136 137 138  * * \note This event only exists on USB AVR models which supports host mode. * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see  Dean Camera committed May 04, 2009 139  * \ref Group_USBManagement documentation).  Dean Camera committed Feb 23, 2009 140  */  Dean Camera committed Aug 05, 2009 141  void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);  Dean Camera committed Feb 23, 2009 142 143 144  /** 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  Dean Camera committed Aug 05, 2009 145  * controlled by the user application.  Dean Camera committed Oct 14, 2009 146 147 148 149  * * 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.  Dean Camera committed Feb 23, 2009 150  */  Dean Camera committed Aug 05, 2009 151 152 153 154 155  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. *  Dean Camera committed Oct 14, 2009 156 157 158  * 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. *  Dean Camera committed Sep 07, 2009 159  * \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.  Dean Camera committed Aug 05, 2009 160 161 162 163 164 165  * 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. *  Dean Camera committed Sep 07, 2009 166 167 168  * \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. *  Dean Camera committed Aug 05, 2009 169 170 171 172 173 174 175  * \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. *  Dean Camera committed Sep 07, 2009 176  * \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.  Dean Camera committed Aug 05, 2009 177 178 179 180 181 182  * 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. *  Dean Camera committed Sep 07, 2009 183 184 185  * \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. *  Dean Camera committed Aug 05, 2009 186 187 188  * \see USBTask.h for more information on the USB management task and reducing CPU usage. */ void EVENT_USB_Device_Disconnect(void);  Dean Camera committed Feb 23, 2009 189 190 191 192  /** 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  Dean Camera committed Oct 14, 2009 193 194  * issued to the device which must be handled appropriately. *  Dean Camera committed Nov 09, 2009 195  * This event is time-critical; each packet within the request transaction must be acknowledged or  Dean Camera committed Oct 14, 2009 196  * sent within 50ms or the host will abort the transfer.  Dean Camera committed Feb 23, 2009 197  *  198 199 200 201 202  * 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. *  Dean Camera committed Feb 23, 2009 203  * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see  Dean Camera committed May 04, 2009 204  * \ref Group_USBManagement documentation).  Dean Camera committed Feb 23, 2009 205 206  * * \note Requests should be handled in the same manner as described in the USB 2.0 Specification,  Dean Camera committed Apr 22, 2009 207 208 209  * 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.  Dean Camera committed Feb 23, 2009 210  */  Dean Camera committed Aug 05, 2009 211  void EVENT_USB_Device_UnhandledControlRequest(void);  Dean Camera committed Feb 23, 2009 212 213 214 215 216  /** 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. *  Dean Camera committed Oct 14, 2009 217 218 219  * 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. *  Dean Camera committed Apr 22, 2009 220  * This event fires after the value of \ref USB_ConfigurationNumber has been changed.  Dean Camera committed Feb 23, 2009 221 222  * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see  Dean Camera committed May 04, 2009 223  * \ref Group_USBManagement documentation).  Dean Camera committed Feb 23, 2009 224  */  Dean Camera committed Aug 05, 2009 225  void EVENT_USB_Device_ConfigurationChanged(void);  Dean Camera committed Feb 23, 2009 226 227 228  /** 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  Dean Camera committed May 19, 2009 229 230 231  * 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.  Dean Camera committed Feb 23, 2009 232 233  * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see  Dean Camera committed May 04, 2009 234  * \ref Group_USBManagement documentation).  Dean Camera committed Feb 23, 2009 235  *  Dean Camera committed Jan 17, 2010 236 237 238  * \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. *  Dean Camera committed Aug 05, 2009 239  * \see \ref EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.  Dean Camera committed Feb 23, 2009 240  */  Dean Camera committed Aug 05, 2009 241  void EVENT_USB_Device_Suspend(void);  Dean Camera committed Feb 23, 2009 242 243 244  /** 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  Dean Camera committed Jan 17, 2010 245  * hooked to pull the user application out of a low power state and back into normal operating  Dean Camera committed May 19, 2009 246 247  * 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.  Dean Camera committed Feb 23, 2009 248 249  * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see  Dean Camera committed May 04, 2009 250  * \ref Group_USBManagement documentation).  Dean Camera committed Feb 23, 2009 251  *  Dean Camera committed Jan 17, 2010 252 253 254  * \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. *  Dean Camera committed Aug 05, 2009 255  * \see \ref EVENT_USB_Device_Suspend() event for accompanying Suspend event.  Dean Camera committed Feb 23, 2009 256  */  Dean Camera committed Aug 05, 2009 257  void EVENT_USB_Device_WakeUp(void);  Dean Camera committed Feb 23, 2009 258   Dean Camera committed May 19, 2009 259 260 261  /** 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.  Dean Camera committed Feb 23, 2009 262  *  Dean Camera committed Oct 14, 2009 263 264 265  * 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. *  Dean Camera committed Feb 23, 2009 266  * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see  Dean Camera committed May 04, 2009 267  * \ref Group_USBManagement documentation).  Dean Camera committed Feb 23, 2009 268  */  Dean Camera committed Aug 05, 2009 269  void EVENT_USB_Device_Reset(void);  Dean Camera committed Aug 16, 2009 270 271  /** Event for USB Start Of Frame detection, when enabled. This event fires at the start of each USB  Dean Camera committed Nov 09, 2009 272  * frame, once per millisecond, and is synchronized to the USB bus. This can be used as an accurate  Dean Camera committed Aug 16, 2009 273 274  * millisecond timer source when the USB bus is enumerated in device mode to a USB host. *  Dean Camera committed Oct 14, 2009 275 276 277 278 279  * 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.  Dean Camera committed Aug 16, 2009 280 281 282 283 284  * * \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);  Dean Camera committed Feb 23, 2009 285 286 287 288 289 290  #endif /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Function Prototypes: */ #if defined(INCLUDE_FROM_EVENTS_C)  Dean Camera committed May 13, 2009 291  void USB_Event_Stub(void) ATTR_CONST;  Dean Camera committed May 18, 2009 292   Dean Camera committed Feb 23, 2009 293  #if defined(USB_CAN_BE_BOTH)  Dean Camera committed May 18, 2009 294 295  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);  Dean Camera committed Feb 23, 2009 296 297 298  #endif #if defined(USB_CAN_BE_HOST)  Dean Camera committed Aug 05, 2009 299 300 301 302 303  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)  Dean Camera committed May 18, 2009 304  ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);  Dean Camera committed Feb 23, 2009 305 306  #endif  Dean Camera committed Aug 05, 2009 307 308 309 310 311 312 313 314  #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);  Dean Camera committed Aug 16, 2009 315  void EVENT_USB_Device_StartOfFrame(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);  Dean Camera committed Aug 05, 2009 316  #endif  Dean Camera committed Feb 23, 2009 317 318 319 320 321 322 323  #endif #endif /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif  Dean Camera committed Apr 16, 2009 324   Dean Camera committed Feb 23, 2009 325 #endif  Dean Camera committed Apr 16, 2009 326 327  /** @} */