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