LUFA/Drivers/USB/HighLevel/Events.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \ingroup Group_USB
  32  *  @defgroup Group_Events USB Events
  33  *
  34  *  This module contains macros and functions relating to the management of library events, which are small
  35  *  pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from
  36  *  multiple places in the user or library code, which may or may not be inside an ISR, thus each handler
  37  *  should be written to be as small and fast as possible to prevent possible problems.
  38  *
  39  *  Events can be hooked by the user application by declaring a handler function with the same name and parameters
  40  *  listed here. If an event with no user-associated handler is fired within the library, it by default maps to an
  41  *  internal empty stub function.
  42  *
  43  *  Each event must only have one associated event handler, but can be raised by multiple sources by calling the event
  44  *  name just like any regular C function (with any required event parameters).
  45  *
  46  *  @{
  47  */
  48
  49 #ifndef __USBEVENTS_H__
  50 #define __USBEVENTS_H__
  51
  52         /* Includes: */
  53                 #include <avr/io.h>
  54
  55                 #include "../../../Common/Common.h"
  56                 #include "USBMode.h"
  57
  58         /* Enable C linkage for C++ Compilers: */
  59                 #if defined(__cplusplus)
  60                         extern "C" {
  61                 #endif
  62
  63         /* Public Interface - May be used in end-application: */
  64                 /* Pseudo-Functions for Doxygen: */
  65                 #if !defined(INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)
  66                         /** Event for USB stack initialization failure. This event fires when the USB interface fails to
  67                          *  initialize correctly due to a hardware or software fault.
  68                          *
  69                          *  \note This event only exists on USB AVR models which support dual role modes.
  70                          *
  71                          *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t
  72                          */
  73                         void EVENT_USB_InitFailure(const uint8_t ErrorCode);
  74
  75                         /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role
  76                          *  mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires
  77                          *  before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Device_Disconnect
  78                          *  event has fired (if connected before the role change).
  79                          *
  80                          *  \note This event only exists on USB AVR models which support dual role modes.
  81                          *
  82                          *  \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied
  83                          *        to the compiler (see \ref Group_USBManagement documentation).
  84                          */
  85                         void EVENT_USB_UIDChange(void);
  86
  87                         /** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB
  88                          *  interface is in host mode.
  89                          *
  90                          *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t
  91                          *
  92                          *  \note This event only exists on USB AVR models which supports host mode.
  93                          *
  94                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
  95                          *        \ref Group_USBManagement documentation).
  96                          */
  97                         void EVENT_USB_Host_HostError(const uint8_t ErrorCode);
  98
  99                         /** Event for USB device attachment. This event fires when a the USB interface is in host mode, and
 100                          *  a USB device has been connected to the USB interface. This is interrupt driven, thus fires before
 101                          *  the standard \ref EVENT_USB_Device_Connect() event and so can be used to programmatically start the USB
 102                          *  management task to reduce CPU consumption.
 103                          *
 104                          *  \note This event only exists on USB AVR models which supports host mode.
 105                          *
 106                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 107                          *        \ref Group_USBManagement documentation).
 108                          *
 109                          *  \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.
 110                          */
 111                         void EVENT_USB_Host_DeviceAttached(void);
 112
 113                         /** Event for USB device removal. This event fires when a the USB interface is in host mode, and
 114                          *  a USB device has been removed the USB interface whether or not it has been enumerated. This
 115                          *  can be used to programmatically stop the USB management task to reduce CPU consumption.
 116                          *
 117                          *  \note This event only exists on USB AVR models which supports host mode.
 118                          *
 119                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 120                          *        \ref Group_USBManagement documentation).
 121                          *
 122                          *  \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.
 123                          */
 124                         void EVENT_USB_Host_DeviceUnattached(void);
 125
 126                         /** Event for USB device enumeration failure. This event fires when a the USB interface is
 127                          *  in host mode, and an attached USB device has failed to enumerate completely.
 128                          *
 129                          *  \param[in] ErrorCode  Error code indicating the failure reason, a value in
 130                          *                        \ref USB_Host_EnumerationErrorCodes_t
 131                          *
 132                          *  \param[in] SubErrorCode  Sub error code indicating the reason for failure - for example, if the
 133                          *                           ErrorCode parameter indicates a control error, this will give the error
 134                          *                           code returned by the \ref USB_Host_SendControlRequest() function.
 135                          *
 136                          *  \note This event only exists on USB AVR models which supports host mode.
 137                          *
 138                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 139                          *        \ref Group_USBManagement documentation).
 140                          */
 141                         void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);
 142
 143                         /** Event for USB device enumeration completion. This event fires when a the USB interface is
 144                          *  in host mode and an attached USB device has been completely enumerated and is ready to be
 145                          *  controlled by the user application.
 146                          *
 147                          *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
 148                          *  1 second) when a transaction is waiting to be processed by the device will prevent break communications
 149                          *  and cause the host to reset the USB bus.
 150                          */
 151                         void EVENT_USB_Host_DeviceEnumerationComplete(void);
 152
 153                         /** Event for USB device connection. This event fires when the AVR in device mode and the device is connected
 154                          *  to a host, beginning the enumeration process, measured by a rising level on the AVR's VBUS pin.
 155                          *
 156                          *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
 157                          *  two seconds) will prevent the device from enumerating correctly.
 158                          *
 159                          *  \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.
 160                          *        this means that the current connection state is derived from the bus suspension and wake up events by default,
 161                          *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state
 162                          *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
 163                          *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
 164                          *        and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
 165                          *
 166                          *  \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers
 167                          *        if NO_LIMITED_CONTROLLER_CONNECT is not defined.
 168                          *
 169                          *  \see USBTask.h for more information on the USB management task and reducing CPU usage.
 170                          */
 171                         void EVENT_USB_Device_Connect(void);
 172
 173                         /** Event for USB device disconnection. This event fires when the AVR in device mode and the device is disconnected
 174                          *  from a host, measured by a falling level on the AVR's VBUS pin.
 175                          *
 176                          *  \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.
 177                          *        this means that the current connection state is derived from the bus suspension and wake up events by default,
 178                          *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state
 179                          *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
 180                          *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
 181                          *        and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
 182                          *
 183                          *  \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers
 184                          *        if NO_LIMITED_CONTROLLER_CONNECT is not defined.
 185                          *
 186                          *  \see USBTask.h for more information on the USB management task and reducing CPU usage.
 187                          */
 188                         void EVENT_USB_Device_Disconnect(void);
 189
 190                         /** Event for unhandled control requests. This event fires when a the USB host issues a control
 191                          *  request to the control endpoint (address 0) that the library does not handle. This may either
 192                          *  be a standard request that the library has no handler code for, or a class specific request
 193                          *  issued to the device which must be handled appropriately.
 194                          *
 195                          *  This event is time-critical; eack packet within the request transaction must be acknowedged or
 196                          *  sent within 50ms or the host will abort the transfer.
 197                          *
 198                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 199                          *        \ref Group_USBManagement documentation).
 200                          *
 201                          *  \note Requests should be handled in the same manner as described in the USB 2.0 Specification,
 202                          *        or appropriate class specification. In all instances, the library has already read the
 203                          *        request SETUP parameters into the \ref USB_ControlRequest structure which should then be used
 204                          *        by the application to determine how to handle the issued request.
 205                          */
 206                         void EVENT_USB_Device_UnhandledControlRequest(void);
 207
 208                         /** Event for USB configuration number changed. This event fires when a the USB host changes the
 209                          *  selected configuration number while in device mode. This event should be hooked in device
 210                          *  applications to create the endpoints and configure the device for the selected configuration.
 211                          *
 212                          *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
 213                          *  one second) will prevent the device from enumerating correctly.
 214                          *
 215                          *  This event fires after the value of \ref USB_ConfigurationNumber has been changed.
 216                          *
 217                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 218                          *        \ref Group_USBManagement documentation).
 219                          */
 220                         void EVENT_USB_Device_ConfigurationChanged(void);
 221
 222                         /** Event for USB suspend. This event fires when a the USB host suspends the device by halting its
 223                          *  transmission of Start Of Frame pulses to the device. This is generally hooked in order to move
 224                          *  the device over to a low power state until the host wakes up the device. If the USB interface is
 225                          *  enumerated with the \ref USB_OPT_AUTO_PLL option set, the library will automatically suspend the
 226                          *  USB PLL before the event is fired to save power.
 227                          *
 228                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 229                          *        \ref Group_USBManagement documentation).
 230                          *
 231                          *  \see \ref EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.
 232                          */
 233                         void EVENT_USB_Device_Suspend(void);
 234
 235                         /** Event for USB wake up. This event fires when a the USB interface is suspended while in device
 236                          *  mode, and the host wakes up the device by supplying Start Of Frame pulses. This is generally
 237                          *  hooked to pull the user application out of a lowe power state and back into normal operating
 238                          *  mode. If the USB interface is enumerated with the \ref USB_OPT_AUTO_PLL option set, the library
 239                          *  will automatically restart the USB PLL before the event is fired.
 240                          *
 241                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 242                          *        \ref Group_USBManagement documentation).
 243                          *
 244                          *  \see \ref EVENT_USB_Device_Suspend() event for accompanying Suspend event.
 245                          */
 246                         void EVENT_USB_Device_WakeUp(void);
 247
 248                         /** Event for USB interface reset. This event fires when the USB interface is in device mode, and
 249                          *  a the USB host requests that the device reset its interface. This event fires after the control
 250                          *  endpoint has been automatically configured by the library.
 251                          *
 252                          *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
 253                          *  two seconds) will prevent the device from enumerating correctly.
 254                          *
 255                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 256                          *        \ref Group_USBManagement documentation).
 257                          */
 258                         void EVENT_USB_Device_Reset(void);
 259
 260                         /** Event for USB Start Of Frame detection, when enabled. This event fires at the start of each USB
 261                          *  frame, once per millisecond, and is synchronised to the USB bus. This can be used as an accurate
 262                          *  millisecond timer source when the USB bus is enumerated in device mode to a USB host.
 263                          *
 264                          *  This event is time-critical; it is run once per millisecond and thus long handlers will significantly
 265                          *  degrade device performance. This event should only be enabled when needed to reduce device wakeups.
 266                          *
 267                          *  \note This event is not normally active - it must be manually enabled and disabled via the
 268                          *        \ref USB_Device_EnableSOFEvents() and \ref USB_Device_DisableSOFEvents() commands after enumeration.
 269                          *
 270                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 271                          *        \ref Group_USBManagement documentation).
 272                          */
 273                         void EVENT_USB_Device_StartOfFrame(void);
 274                 #endif
 275
 276         /* Private Interface - For use in library only: */
 277         #if !defined(__DOXYGEN__)
 278                 /* Function Prototypes: */
 279                         #if defined(INCLUDE_FROM_EVENTS_C)
 280                                 void USB_Event_Stub(void) ATTR_CONST;
 281
 282                                 #if defined(USB_CAN_BE_BOTH)
 283                                         void EVENT_USB_InitFailure(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 284                                         void EVENT_USB_UIDChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 285                                 #endif
 286
 287                                 #if defined(USB_CAN_BE_HOST)
 288                                         void EVENT_USB_Host_HostError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 289                                         void EVENT_USB_Host_DeviceAttached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 290                                         void EVENT_USB_Host_DeviceUnattached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 291                                         void EVENT_USB_Host_DeviceEnumerationComplete(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 292                                         void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 293                                                                                ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 294                                 #endif
 295
 296                                 #if defined(USB_CAN_BE_DEVICE)
 297                                         void EVENT_USB_Device_Connect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 298                                         void EVENT_USB_Device_Disconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 299                                         void EVENT_USB_Device_UnhandledControlRequest(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 300                                         void EVENT_USB_Device_ConfigurationChanged(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 301                                         void EVENT_USB_Device_Suspend(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 302                                         void EVENT_USB_Device_WakeUp(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 303                                         void EVENT_USB_Device_Reset(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 304                                         void EVENT_USB_Device_StartOfFrame(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 305                                 #endif
 306                         #endif
 307         #endif
 308
 309         /* Disable C linkage for C++ Compilers: */
 310                 #if defined(__cplusplus)
 311                         }
 312                 #endif
 313
 314 #endif
 315
 316 /** @} */