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.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef __USBEVENTS_H__
  49 #define __USBEVENTS_H__
  50
  51         /* Includes: */
  52                 #include <avr/io.h>
  53
  54                 #include "../../../Common/Common.h"
  55                 #include "USBMode.h"
  56
  57         /* Enable C linkage for C++ Compilers: */
  58                 #if defined(__cplusplus)
  59                         extern "C" {
  60                 #endif
  61
  62         /* Public Interface - May be used in end-application: */
  63                 /* Pseudo-Functions for Doxygen: */
  64                 #if !defined(INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)
  65                         /** Event for VBUS level change. This event fires when the VBUS line of the USB AVR changes from
  66                          *  high to low or vice-versa, before the new VBUS level is sampled and the appropriate action
  67                          *  taken.
  68                          *
  69                          *  \note This event is only available on USB AVR models which support VBUS notification interrupts.
  70                          */
  71                         void EVENT_USB_VBUSChange(void);
  72
  73                         /** Event for VBUS attachment. On the AVR models with a dedicated VBUS pin, this event fires when
  74                          *  the VBUS line of the USB AVR changes from low to high (after the VBUS events have been handled),
  75                          *  signalling the attachment of the USB device to a host, before the enumeration process has begun.
  76                          *
  77                          *  \note This event is only available on USB AVR models which support VBUS notification interrupts.
  78                          */
  79                         void EVENT_USB_VBUSConnect(void);
  80
  81                         /** Event for VBUS attachment. On the AVR models with a dedicated VBUS pin, this event fires when
  82                          *  the VBUS line of the USB AVR changes from high to low (after the VBUS events have been handled),
  83                          *  signalling the detatchment of the USB device from a host, regardless of its enumeration state.
  84                          *
  85                          *  \note This event is only available on USB AVR models which support VBUS notification interrupts.
  86                          */
  87                         void EVENT_USB_VBUSDisconnect(void);
  88
  89                         /** Event for USB device connection. This event fires when the AVR is in USB host mode and a device
  90                          *  has been attached (but not yet fully enumerated), or when in device mode and the device is connected
  91                          *  to a host, beginning the enumeration process.
  92                          *
  93                          *  When in device mode, this can be used to programmatically start the USB management task to reduce
  94                          *  CPU usage.
  95                          *
  96                          *  \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.
  97                          *        this means that the current connection state is derived from the bus suspension and wake up events by default,
  98                          *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state
  99                          *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
 100                          *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
 101                          *        and disconnection events may be manually fired, and the \ref USB_IsConnected global changed manually.
 102                          *
 103                          *  \see USBTask.h for more information on the USB management task and reducing CPU usage.
 104                          */
 105                         void EVENT_USB_Connect(void);
 106
 107                         /** Event for USB device disconnection. This event fires when the AVR is in USB host mode and an
 108                          *  attached and enumerated device has been disconnected, or when in device mode and the device is
 109                          *  disconnected from the host.
 110                          *
 111                          *  When in device mode, this can be used to programmatically stop the USB management task to reduce
 112                          *  CPU usage.
 113                          *
 114                          *  \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.
 115                          *        this means that the current connection state is derived from the bus suspension and wake up events by default,
 116                          *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state
 117                          *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by
 118                          *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
 119                          *        and disconnection events may be manually fired, and the \ref USB_IsConnected global changed manually.
 120                          *
 121                          *  \see USBTask.h for more information on the USB management task and reducing CPU usage.
 122                          */
 123                         void EVENT_USB_Disconnect(void);
 124
 125                         /** Event for USB initialization failure. This event fires when the USB interface fails to
 126                          *  initialize correctly due to a hardware or software fault.
 127                          *
 128                          *  \note This event only exists on USB AVR models which support dual role modes.
 129                          *
 130                          *  \param ErrorCode  Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t
 131                          */
 132                         void EVENT_USB_InitFailure(const uint8_t ErrorCode);
 133
 134                         /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role
 135                          *  mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires
 136                          *  before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Disconnect event
 137                          *  has fired (if connected before the role change).
 138                          *
 139                          *  \note This event only exists on USB AVR models which support dual role modes.
 140                          *
 141                          *  \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied
 142                          *        to the compiler (see \ref Group_USBManagement documentation).
 143                          */
 144                         void EVENT_USB_UIDChange(void);
 145
 146                         /** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB
 147                          *  interface is in host mode.
 148                          *
 149                          *  \param ErrorCode  Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t
 150                          *
 151                          *  \note This event only exists on USB AVR models which supports host mode.
 152                          *
 153                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 154                          *        \ref Group_USBManagement documentation).
 155                          */
 156                         void EVENT_USB_HostError(const uint8_t ErrorCode);
 157
 158                         /** Event for USB device attachment. This event fires when a the USB interface is in host mode, and
 159                          *  a USB device has been connected to the USB interface. This is interrupt driven, thus fires before
 160                          *  the standard \ref EVENT_USB_Connect event and so can be used to programmatically start the USB management
 161                          *  task to reduce CPU consumption.
 162                          *
 163                          *  \note This event only exists on USB AVR models which supports host mode.
 164                          *
 165                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 166                          *        \ref Group_USBManagement documentation).
 167                          *
 168                          *  \see \ref TASK(USB_USBTask) for more information on the USB management task and reducing CPU usage.
 169                          */
 170                         void EVENT_USB_DeviceAttached(void);
 171
 172                         /** Event for USB device removal. This event fires when a the USB interface is in host mode, and
 173                          *  a USB device has been removed the USB interface whether or not it has been enumerated. This
 174                          *  can be used to programmatically stop the USB management task to reduce CPU consumption.
 175                          *
 176                          *  \note This event only exists on USB AVR models which supports host mode.
 177                          *
 178                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 179                          *        \ref Group_USBManagement documentation).
 180                          *
 181                          *  \see \ref TASK(USB_USBTask) for more information on the USB management task and reducing CPU usage.
 182                          */
 183                         void EVENT_USB_DeviceUnattached(void);
 184
 185                         /** Event for USB device enumeration failure. This event fires when a the USB interface is
 186                          *  in host mode, and an attached USB device has failed to enumerate completely.
 187                          *
 188                          *  \param ErrorCode  Error code indicating the failure reason, a value in
 189                          *                    \ref USB_Host_EnumerationErrorCodes_t
 190                          *
 191                          *  \param SubErrorCode  Sub error code indicating the reason for failure - for example, if the
 192                          *                       ErrorCode parameter indicates a control error, this will give the error
 193                          *                       code returned by the \ref USB_Host_SendControlRequest() function.
 194                          *
 195                          *  \note This event only exists on USB AVR models which supports host mode.
 196                          *
 197                          *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
 198                          *        \ref Group_USBManagement documentation).
 199                          */
 200                         void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);
 201
 202                         /** Event for USB device enumeration completion. This event fires when a the USB interface is
 203                          *  in host mode and an attached USB device has been completely enumerated and is ready to be
 204                          *  controlled by the user application, or when the library is in device mode, and the Host
 205                          *  has finished enumerating the device.
 206                          */
 207                         void EVENT_USB_DeviceEnumerationComplete(void);
 208
 209                         /** Event for unhandled control requests. This event fires when a the USB host issues a control
 210                          *  request to the control endpoint (address 0) that the library does not handle. This may either
 211                          *  be a standard request that the library has no handler code for, or a class specific request
 212                          *  issued to the device which must be handled appropriately. Due to the strict timing requirements
 213                          *  on control transfers, interrupts are disabled during control request processing.
 214                          *
 215                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 216                          *        \ref Group_USBManagement documentation).
 217                          *
 218                          *  \note Requests should be handled in the same manner as described in the USB 2.0 Specification,
 219                          *        or appropriate class specification. In all instances, the library has already read the
 220                          *        request SETUP parameters into the \ref USB_ControlRequest structure which should then be used
 221                          *        by the application to determine how to handle the issued request.
 222                          */
 223                         void EVENT_USB_UnhandledControlPacket(void);
 224
 225                         /** Event for USB configuration number changed. This event fires when a the USB host changes the
 226                          *  selected configuration number while in device mode. This event should be hooked in device
 227                          *  applications to create the endpoints and configure the device for the selected configuration.
 228                          *
 229                          *  This event fires after the value of \ref USB_ConfigurationNumber has been changed.
 230                          *
 231                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 232                          *        \ref Group_USBManagement documentation).
 233                          */
 234                         void EVENT_USB_ConfigurationChanged(void);
 235
 236                         /** Event for USB suspend. This event fires when a the USB host suspends the device by halting its
 237                          *  transmission of Start Of Frame pulses to the device. This is generally hooked in order to move
 238                          *  the device over to a low power state until the host wakes up the device. If the USB interface is
 239                          *  enumerated with the \ref USB_OPT_AUTO_PLL option set, the library will automatically suspend the
 240                          *  USB PLL before the event is fired to save power.
 241                          *
 242                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 243                          *        \ref Group_USBManagement documentation).
 244                          *
 245                          *  \see \ref EVENT_USB_WakeUp() event for accompanying Wake Up event.
 246                          */
 247                         void EVENT_USB_Suspend(void);
 248
 249                         /** Event for USB wake up. This event fires when a the USB interface is suspended while in device
 250                          *  mode, and the host wakes up the device by supplying Start Of Frame pulses. This is generally
 251                          *  hooked to pull the user application out of a lowe power state and back into normal operating
 252                          *  mode. If the USB interface is enumerated with the \ref USB_OPT_AUTO_PLL option set, the library
 253                          *  will automatically restart the USB PLL before the event is fired.
 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                          *  \see \ref EVENT_USB_Suspend() event for accompanying Suspend event.
 259                          */
 260                         void EVENT_USB_WakeUp(void);
 261
 262                         /** Event for USB interface reset. This event fires when the USB interface is in device mode, and
 263                          *  a the USB host requests that the device reset its interface. This event fires after the control
 264                          *  endpoint has been automatically configured by the library.
 265                          *
 266                          *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
 267                          *        \ref Group_USBManagement documentation).
 268                          */
 269                         void EVENT_USB_Reset(void);
 270                 #endif
 271
 272         /* Private Interface - For use in library only: */
 273         #if !defined(__DOXYGEN__)
 274                 /* Function Prototypes: */
 275                         #if defined(INCLUDE_FROM_EVENTS_C)
 276                                 void USB_Event_Stub(void) ATTR_CONST;
 277
 278                                 #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER)
 279                                         void EVENT_USB_VBUSChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 280                                         void EVENT_USB_VBUSConnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 281                                         void EVENT_USB_VBUSDisconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 282                                 #endif
 283
 284                                 void EVENT_USB_Connect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 285                                 void EVENT_USB_Disconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 286                                 void EVENT_USB_DeviceEnumerationComplete(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 287
 288                                 #if defined(USB_CAN_BE_BOTH)
 289                                         void EVENT_USB_InitFailure(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 290                                         void EVENT_USB_UIDChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 291                                 #endif
 292
 293                                 #if defined(USB_CAN_BE_HOST)
 294                                         void EVENT_USB_HostError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 295                                         void EVENT_USB_DeviceAttached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 296                                         void EVENT_USB_DeviceUnattached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 297                                         void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 298                                                                                ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 299                                 #endif
 300
 301                                 void EVENT_USB_UnhandledControlPacket(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 302                                 void EVENT_USB_ConfigurationChanged(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 303                                 void EVENT_USB_Suspend(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 304                                 void EVENT_USB_WakeUp(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 305                                 void EVENT_USB_Reset(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);
 306                         #endif
 307         #endif
 308
 309         /* Disable C linkage for C++ Compilers: */
 310                 #if defined(__cplusplus)
 311                         }
 312                 #endif
 313
 314 #endif
 315
 316 /** @} */