LUFA/Drivers/USB/HighLevel/Events.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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
  44  *  event handler 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         /* Preprocessor Checks: */
  64                 #if !defined(__INCLUDE_FROM_USB_DRIVER)
  65                         #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
  66                 #endif
  67
  68         /* Public Interface - May be used in end-application: */
  69                 /* Pseudo-Functions for Doxygen: */
  70                 #if !defined(__INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)
  71                         /** Event for USB stack initialization failure. This event fires when the USB interface fails to
  72                          *  initialize correctly due to a hardware or software fault.
  73                          *
  74                          *  \note This event only exists on USB AVR models which support dual role modes.
  75                          *
  76                          *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t
  77                          */
  78                         void EVENT_USB_InitFailure(const uint8_t ErrorCode);
  79
  80                         /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role
  81                          *  mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires
  82                          *  before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Device_Disconnect
  83                          *  event has fired (if connected before the role change).
  84                          *
  85                          *  \note This event only exists on USB AVR models which support dual role modes.
  86                          *
  87                          *  \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied
  88                          *        to the compiler (see \ref Group_USBManagement documentation).
  89                          */
  90                         void EVENT_USB_UIDChange(void);
  91
  92                         /** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB
  93                          *  interface is in host mode.
  94                          *
  95                          *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t
  96                          *
  97                          *  \note This event only exists on USB AVR models which supports host mode.
  98                          *
  99                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 100                          *        \ref Group_USBManagement documentation).
 101                          */
 102                         void EVENT_USB_Host_HostError(const uint8_t ErrorCode);
 103
 104                         /** Event for USB device attachment. This event fires when a the USB interface is in host mode, and
 105                          *  a USB device has been connected to the USB interface. This is interrupt driven, thus fires before
 106                          *  the standard \ref EVENT_USB_Device_Connect() event and so can be used to programmatically start the USB
 107                          *  management task to reduce CPU consumption.
 108                          *
 109                          *  \note This event only exists on USB AVR models which supports host mode.
 110                          *
 111                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 112                          *        \ref Group_USBManagement documentation).
 113                          *
 114                          *  \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.
 115                          */
 116                         void EVENT_USB_Host_DeviceAttached(void);
 117
 118                         /** Event for USB device removal. This event fires when a the USB interface is in host mode, and
 119                          *  a USB device has been removed the USB interface whether or not it has been enumerated. This
 120                          *  can be used to programmatically stop the USB management task to reduce CPU consumption.
 121                          *
 122                          *  \note This event only exists on USB AVR models which supports host mode.
 123                          *
 124                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 125                          *        \ref Group_USBManagement documentation).
 126                          *
 127                          *  \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.
 128                          */
 129                         void EVENT_USB_Host_DeviceUnattached(void);
 130
 131                         /** Event for USB device enumeration failure. This event fires when a the USB interface is
 132                          *  in host mode, and an attached USB device has failed to enumerate completely.
 133                          *
 134                          *  \param[in] ErrorCode  Error code indicating the failure reason, a value in
 135                          *                        \ref USB_Host_EnumerationErrorCodes_t
 136                          *
 137                          *  \param[in] SubErrorCode  Sub error code indicating the reason for failure - for example, if the
 138                          *                           ErrorCode parameter indicates a control error, this will give the error
 139                          *                           code returned by the \ref USB_Host_SendControlRequest() function.
 140                          *
 141                          *  \note This event only exists on USB AVR models which supports host mode.
 142                          *
 143                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 144                          *        \ref Group_USBManagement documentation).
 145                          */
 146                         void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);
 147
 148                         /** Event for USB device enumeration completion. This event fires when a the USB interface is
 149                          *  in host mode and an attached USB device has been completely enumerated and is ready to be
 150                          *  controlled by the user application.
 151                          *
 152                          *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
 153                          *  1 second) when a transaction is waiting to be processed by the device will prevent break communications
 154                          *  and cause the host to reset the USB bus.
 155                          */
 156                         void EVENT_USB_Host_DeviceEnumerationComplete(void);
 157
 158                         /** Event for USB device connection. This event fires when the AVR in device mode and the device is connected
 159                          *  to a host, beginning the enumeration process, measured by a rising level on the AVR's VBUS pin.
 160                          *
 161                          *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
 162                          *  two seconds) will prevent the device from enumerating correctly.
 163                          *
 164                          *  \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.
 165                          *        this means that the current connection state is derived from the bus suspension and wake up events by default,
 166                          *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state
 167                          *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
 168                          *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
 169                          *        and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
 170                          *
 171                          *  \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers
 172                          *        if NO_LIMITED_CONTROLLER_CONNECT is not defined.
 173                          *
 174                          *  \see USBTask.h for more information on the USB management task and reducing CPU usage.
 175                          */
 176                         void EVENT_USB_Device_Connect(void);
 177
 178                         /** Event for USB device disconnection. This event fires when the AVR in device mode and the device is disconnected
 179                          *  from a host, measured by a falling level on the AVR's VBUS pin.
 180                          *
 181                          *  \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.
 182                          *        this means that the current connection state is derived from the bus suspension and wake up events by default,
 183                          *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state
 184                          *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
 185                          *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
 186                          *        and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
 187                          *
 188                          *  \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers
 189                          *        if NO_LIMITED_CONTROLLER_CONNECT is not defined.
 190                          *
 191                          *  \see USBTask.h for more information on the USB management task and reducing CPU usage.
 192                          */
 193                         void EVENT_USB_Device_Disconnect(void);
 194
 195                         /** Event for unhandled control requests. This event fires when a the USB host issues a control
 196                          *  request to the control endpoint (address 0) that the library does not handle. This may either
 197                          *  be a standard request that the library has no handler code for, or a class specific request
 198                          *  issued to the device which must be handled appropriately.
 199                          *
 200                          *  This event is time-critical; each packet within the request transaction must be acknowledged or
 201                          *  sent within 50ms or the host will abort the transfer.
 202                          *
 203                          *  The library interally handles all standard control requests with the exceptions of SYNC FRAME,
 204                          *  SET DESCRIPTOR and SET INTERFACE. These and all other non-standard control requests will be left
 205                          *  for the user to process via this event if desired. If not handled in the user application, requests
 206                          *  are automatically STALLed.
 207                          *
 208                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 209                          *        \ref Group_USBManagement documentation).
 210                          *
 211                          *  \note Requests should be handled in the same manner as described in the USB 2.0 Specification,
 212                          *        or appropriate class specification. In all instances, the library has already read the
 213                          *        request SETUP parameters into the \ref USB_ControlRequest structure which should then be used
 214                          *        by the application to determine how to handle the issued request.
 215                          */
 216                         void EVENT_USB_Device_UnhandledControlRequest(void);
 217
 218                         /** Event for USB configuration number changed. This event fires when a the USB host changes the
 219                          *  selected configuration number while in device mode. This event should be hooked in device
 220                          *  applications to create the endpoints and configure the device for the selected configuration.
 221                          *
 222                          *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
 223                          *  one second) will prevent the device from enumerating correctly.
 224                          *
 225                          *  This event fires after the value of \ref USB_ConfigurationNumber has been changed.
 226                          *
 227                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 228                          *        \ref Group_USBManagement documentation).
 229                          */
 230                         void EVENT_USB_Device_ConfigurationChanged(void);
 231
 232                         /** Event for USB suspend. This event fires when a the USB host suspends the device by halting its
 233                          *  transmission of Start Of Frame pulses to the device. This is generally hooked in order to move
 234                          *  the device over to a low power state until the host wakes up the device. If the USB interface is
 235                          *  enumerated with the \ref USB_OPT_AUTO_PLL option set, the library will automatically suspend the
 236                          *  USB PLL before the event is fired to save power.
 237                          *
 238                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 239                          *        \ref Group_USBManagement documentation).
 240                          *
 241                          *  \note This event does not exist on the series 2 USB AVRs when the NO_LIMITED_CONTROLLER_CONNECT
 242                          *        compile time token is not set - see \ref EVENT_USB_Device_Disconnect.
 243                          *
 244                          *  \see \ref EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.
 245                          */
 246                         void EVENT_USB_Device_Suspend(void);
 247
 248                         /** Event for USB wake up. This event fires when a the USB interface is suspended while in device
 249                          *  mode, and the host wakes up the device by supplying Start Of Frame pulses. This is generally
 250                          *  hooked to pull the user application out of a low power state and back into normal operating
 251                          *  mode. If the USB interface is enumerated with the \ref USB_OPT_AUTO_PLL option set, the library
 252                          *  will automatically restart the USB PLL before the event is fired.
 253                          *
 254                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 255                          *        \ref Group_USBManagement documentation).
 256                          *
 257                          *  \note This event does not exist on the series 2 USB AVRs when the NO_LIMITED_CONTROLLER_CONNECT
 258                          *        compile time token is not set - see \ref EVENT_USB_Device_Connect.
 259                          *
 260                          *  \see \ref EVENT_USB_Device_Suspend() event for accompanying Suspend event.
 261                          */
 262                         void EVENT_USB_Device_WakeUp(void);
 263
 264                         /** Event for USB interface reset. This event fires when the USB interface is in device mode, and
 265                          *  a the USB host requests that the device reset its interface. This event fires after the control
 266                          *  endpoint has been automatically configured by the library.
 267                          *
 268                          *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
 269                          *  two seconds) will prevent the device from enumerating correctly.
 270                          *
 271                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 272                          *        \ref Group_USBManagement documentation).
 273                          */
 274                         void EVENT_USB_Device_Reset(void);
 275
 276                         /** Event for USB Start Of Frame detection, when enabled. This event fires at the start of each USB
 277                          *  frame, once per millisecond, and is synchronized to the USB bus. This can be used as an accurate
 278                          *  millisecond timer source when the USB bus is enumerated in device mode to a USB host.
 279                          *
 280                          *  This event is time-critical; it is run once per millisecond and thus long handlers will significantly
 281                          *  degrade device performance. This event should only be enabled when needed to reduce device wakeups.
 282                          *
 283                          *  \note This event is not normally active - it must be manually enabled and disabled via the
 284                          *        \ref USB_Device_EnableSOFEvents() and \ref USB_Device_DisableSOFEvents() commands after enumeration.
 285                          *
 286                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 287                          *        \ref Group_USBManagement documentation).
 288                          */
 289                         void EVENT_USB_Device_StartOfFrame(void);
 290                 #endif
 291
 292         /* Private Interface - For use in library only: */
 293         #if !defined(__DOXYGEN__)
 294                 /* Function Prototypes: */
 295                         #if defined(__INCLUDE_FROM_EVENTS_C)
 296                                 void USB_Event_Stub(void) ATTR_CONST;
 297
 298                                 #if defined(USB_CAN_BE_BOTH)
 299                                         void EVENT_USB_InitFailure(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 300                                         void EVENT_USB_UIDChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 301                                 #endif
 302
 303                                 #if defined(USB_CAN_BE_HOST)
 304                                         void EVENT_USB_Host_HostError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 305                                         void EVENT_USB_Host_DeviceAttached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 306                                         void EVENT_USB_Host_DeviceUnattached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 307                                         void EVENT_USB_Host_DeviceEnumerationComplete(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 308                                         void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 309                                                                                ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 310                                 #endif
 311
 312                                 #if defined(USB_CAN_BE_DEVICE)
 313                                         void EVENT_USB_Device_Connect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 314                                         void EVENT_USB_Device_Disconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 315                                         void EVENT_USB_Device_UnhandledControlRequest(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 316                                         void EVENT_USB_Device_ConfigurationChanged(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 317                                         void EVENT_USB_Device_Suspend(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 318                                         void EVENT_USB_Device_WakeUp(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 319                                         void EVENT_USB_Device_Reset(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 320                                         void EVENT_USB_Device_StartOfFrame(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 321                                 #endif
 322                         #endif
 323         #endif
 324
 325         /* Disable C linkage for C++ Compilers: */
 326                 #if defined(__cplusplus)
 327                         }
 328                 #endif
 329
 330 #endif
 331
 332 /** @} */