Fix up the incomplete Webserver project so that it integrates with the uIP stack...

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / Events.h

diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h
index d53cd8e..08727d7 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/Events.h
+++ b/LUFA/Drivers/USB/HighLevel/Events.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r

 \r
 \r

-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -28,16 +28,22 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

-/** Library events module. This module contains macros and functions relating to the management of library\r
- *  events, which are small pieces of code similar to ISRs which are run when a given condition is met. Each\r
- *  event can be fired from multiple places in the user or library code, which may or may not be inside an ISR,\r
- *  thus each handler should be written to be as small and fast as possible to prevent possible problems.\r
+/** \ingroup Group_USB\r
+ *  @defgroup Group_Events USB Events\r

  *\r
  *\r

- *  Events can be hooked by the user application using the EVENT_HANDLER() and HANDLES_EVENT() macros. If an\r
- *  event with no associated handler is fired within the library, it by default fires an internal empty stub\r
- *  function. This is achieved through the use of the GCC compiler's "alias" attribute.\r
+ *  This module contains macros and functions relating to the management of library events, which are small\r
+ *  pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from\r
+ *  multiple places in the user or library code, which may or may not be inside an ISR, thus each handler\r
+ *  should be written to be as small and fast as possible to prevent possible problems.\r

  *\r
  *\r

- *  Each event must only have one associated event handler, but can be raised by multiple sources.\r
+ *  Events can be hooked by the user application by declaring a handler function with the same name and parameters\r
+ *  listed here. If an event with no user-associated handler is fired within the library, it by default maps to an\r
+ *  internal empty stub function.\r
+ *\r
+ *  Each event must only have one associated event handler, but can be raised by multiple sources by calling the\r
+ *  event handler function (with any required event parameters).\r
+ *\r
+ *  @{\r

  */\r
  \r
 #ifndef __USBEVENTS_H__\r
  */\r
  \r
 #ifndef __USBEVENTS_H__\r


@@ -47,201 +53,62 @@
                #include <avr/io.h>\r
                \r
                #include "../../../Common/Common.h"\r
                #include <avr/io.h>\r
                \r
                #include "../../../Common/Common.h"\r

-               #include "../LowLevel/USBMode.h"\r
+               #include "USBMode.h"\r

 \r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r
                #endif\r
 \r
 \r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r
                #endif\r
 \r

-       /* Public Interface - May be used in end-application: */\r
-               /* Macros: */\r
-                       /** Raises a given event name, with the specified parameters. For events with no parameters the\r
-                        *  only argument to the macro is the event name, events with parameters list the parameter values\r
-                        *  after the name as a comma separated list.\r
-                        *\r
-                        *  When a given event is fired, its corresponding event handler code is executed.\r
-                        *\r
-                        *  Usage Examples:\r
-                        *  \code\r
-                        *  // Raise the USB_VBUSChange event, which takes no parameters\r
-                        *  RAISE_EVENT(USB_VBUSChange);\r
-                        *\r
-                        *  // Raise the USB_UnhandledControlPacket event which takes two parameters\r
-                        *  RAISE_EVENT(USB_UnhandledControlPacket, 0, 1);\r
-                        *  \endcode\r
-                        *\r
-                        *  \see RAISES_EVENT()\r
-                        */\r
-                       #define RAISE_EVENT(e, ...)                 Event_ ## e (__VA_ARGS__)\r
-\r
-                       /** Indicates that a given module can raise a given event. This is the equivalent of putting the\r
-                        *  event function's prototype into the module, but in a cleaner way. Each event which may be\r
-                        *  fired via the RAISE_EVENT macro in the module should have an accompanying RAISES_EVENT\r
-                        *  prototype in the module's header file.\r
-                        *\r
-                        *  Usage Examples:\r
-                        *  \code\r
-                        *  // Module can raise the USB_VBUSChange event\r
-                        *  RAISES_EVENT(USB_VBUSChange);\r
-                        *\r
-                        *  // ...\r
-                        *  // Inside a block of code in a function of the module, raise the USB_VBUSChange event\r
-                        *  RAISE_EVENT(USB_VBUSChange);\r
-                        *  \endcode\r
-                        *\r
-                        *  \see RAISE_EVENT()\r
-                        */\r
-                       #define RAISES_EVENT(e)                     HANDLES_EVENT(e)\r
-\r
-                       /** Defines an event handler for the given event. Event handlers should be short in length, as they\r
-                        *  may be raised from inside an ISR. The user application can react to each event as it sees fit,\r
-                        *  such as logging the event, indicating the change to the user or performing some other action.\r
-                        *\r
-                        *  Only one event handler may be defined in any user project for each individual event. Events may\r
-                        *  or may not have parameters - for each event, refer to its documentation elsewhere in this module\r
-                        *  to determine the presence and purpose of any event parameters.\r
-                        *\r
-                        *  Usage Example:\r
-                        *  \code\r
-                        *  // Create an event handler for the USB_VBUSChange event\r
-                        *  EVENT_HANDLER(USB_VBUSChange)\r
-                        *  {\r
-                        *      // Code to execute when the VBUS level changes\r
-                        *  }\r
-                        *  \endcode\r
-                        *\r
-                        *  \see HANDLES_EVENT()\r
-                        */\r
-                       #define EVENT_HANDLER(e)                    void Event_ ## e e ## _P\r
-                       \r
-                       /** Indicates that a given module handles an event. This is the equivalent of putting the\r
-                        *  event function's prototype into the module, but in a cleaner way. Each event which may be\r
-                        *  handled via the EVENT_HANDLER macro in the module should have an accompanying HANDLES_EVENT\r
-                        *  prototype in the module's header file.\r
-                        *\r
-                        *  Usage Examples:\r
-                        *  \code\r
-                        *  // Module handles the USB_VBUSChange event\r
-                        *  HANDLES_EVENT(USB_VBUSChange);\r
-                        *\r
-                        *  // Create the USB_VBUSChange event handler\r
-                        *  EVENT_HANDLER(USB_VBUSChange)\r
-                        *  {\r
-                        *      // Event handler code here\r
-                        *  }\r
-                        *  \endcode\r
-                        *\r
-                        *  \see EVENT_HANDLER()\r
-                        */\r
-                       #define HANDLES_EVENT(e)                    EVENT_HANDLER(e)\r
-                       \r
+       /* Public Interface - May be used in end-application: */                        \r

                /* Pseudo-Functions for Doxygen: */\r
                /* Pseudo-Functions for Doxygen: */\r

-               #if defined(__DOXYGEN__)\r
-                       /** Event for VBUS level change. This event fires when the VBUS line of the USB AVR changes from\r
-                        *  high to low or vice-versa.\r
-                        *\r
-                        *  \note This event is only available on USB AVR models which support VBUS notification interrupts.\r
-                        */\r
-                       void USB_VBUSChange(void);\r
-\r
-                       /** Event for VBUS attachment. This event fires when the VBUS line of the USB AVR changes from\r
-                        *  low to high, signalling the attachment of the USB device to a host, before the enumeration\r
-                        *  process has begun.\r
-                        *\r
-                        *  \note This event is only available on USB AVR models which support VBUS notification interrupts.\r
-                        */\r
-                       void USB_VBUSConnect(void);\r
-\r
-                       /** Event for VBUS detachment. This event fires when the VBUS line of the USB AVR changes from\r
-                        *  high to low, signalling the USB device has been removed from a host whether it has been enumerated\r
-                        *  or not.\r
-                        *\r
-                        *  \note This event is only available on USB AVR models which support VBUS notification interrupts.\r
-                        */\r
-                       void USB_VBUSDisconnect(void);\r
-\r
-                       /** Event for USB device connection. This event fires when the AVR is in USB host mode and a device\r
-                        *  has been attached (but not yet fully enumerated), or when in device mode and the device is connected\r
-                        *  to a host, beginning the enumeration process.\r
-                        *\r
-                        *  When in device mode, this can be used to programmatically start the USB management task to reduce\r
-                        *  CPU usage.\r
-                        *\r
-                        *  \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.\r
-                        *        this means that the current connection state is derived from the bus suspension and wake up events by default,\r
-                        *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state\r
-                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
-                        *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
-                        *        and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually.\r
-                        *\r
-                        *  \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
-                        */\r
-                       void USB_Connect(void);\r
-\r
-                       /** Event for USB device disconnection. This event fires when the AVR is in USB host mode and an\r
-                        *  attached and enumerated device has been disconnected, or when in device mode and the device is\r
-                        *  disconnected from the host.\r
-                        *\r
-                        *  When in device mode, this can be used to programmatically stop the USB management task to reduce\r
-                        *  CPU usage.\r
-                        *\r
-                        *  \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.\r
-                        *        this means that the current connection state is derived from the bus suspension and wake up events by default,\r
-                        *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state\r
-                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
-                        *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
-                        *        and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually.\r
-                        *\r
-                        *  \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
-                        */\r
-                       void USB_Disconnect(void);\r
-                       \r
-                       /** Event for USB device power on failure. This event fires when the USB interface fails to\r
+               #if !defined(INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)\r
+                       /** Event for USB stack initialization failure. This event fires when the USB interface fails to\r

                         *  initialize correctly due to a hardware or software fault.\r
                         *\r
                         *  initialize correctly due to a hardware or software fault.\r
                         *\r

-                        *  \param ErrorCode  Error code indicating the failure reason, a value in USB_PowerOnErrorCodes_t\r
-                        *                    located in LowLevel.h.\r
+                        *  \note This event only exists on USB AVR models which support dual role modes.\r
+                        *\r
+                        *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t\r

                         */\r
                         */\r

-                       void USB_PowerOnFail(const uint8_t ErrorCode);\r
+                       void EVENT_USB_InitFailure(const uint8_t ErrorCode);\r

 \r
                        /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role\r
                         *  mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires\r
 \r
                        /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role\r
                         *  mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires\r

-                        *  before the mode is switched to the newly indicated mode.\r
+                        *  before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Device_Disconnect\r
+                        *  event has fired (if connected before the role change).\r

                         *\r
                         *  \note This event only exists on USB AVR models which support dual role modes.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied\r
                         *\r
                         *  \note This event only exists on USB AVR models which support dual role modes.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied\r

-                        *        to the compiler (see LowLevel.h documentation).\r
+                        *        to the compiler (see \ref Group_USBManagement documentation).\r

                         */\r
                         */\r

-                       void USB_UIDChange(void);\r
+                       void EVENT_USB_UIDChange(void);\r

 \r
                        /** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB\r
                         *  interface is in host mode.\r
                         *\r
 \r
                        /** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB\r
                         *  interface is in host mode.\r
                         *\r

-                        *  \param ErrorCode  Error code indicating the failure reason, a value in USB_Host_ErrorCodes_t\r
-                        *                    located in Host.h.\r
+                        *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t\r

                         *\r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
                         *\r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r

-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r

                         */\r
                         */\r

-                       void USB_HostError(const uint8_t ErrorCode);\r
+                       void EVENT_USB_Host_HostError(const uint8_t ErrorCode);\r

                        \r
                        /** Event for USB device attachment. This event fires when a the USB interface is in host mode, and\r
                         *  a USB device has been connected to the USB interface. This is interrupt driven, thus fires before\r
                        \r
                        /** Event for USB device attachment. This event fires when a the USB interface is in host mode, and\r
                         *  a USB device has been connected to the USB interface. This is interrupt driven, thus fires before\r

-                        *  the standard USB_DeviceConnect event and so can be used to programmatically start the USB management\r
-                        *  task to reduce CPU consumption.\r
+                        *  the standard \ref EVENT_USB_Device_Connect() event and so can be used to programmatically start the USB\r
+                        *  management task to reduce CPU consumption.\r

                         *\r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
                         *\r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r

-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r

                         *\r
                         *\r

-                        *  \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
+                        *  \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.\r

                         */\r
                         */\r

-                       void USB_DeviceAttached(void);\r
+                       void EVENT_USB_Host_DeviceAttached(void);\r

 \r
                        /** Event for USB device removal. This event fires when a the USB interface is in host mode, and\r
                         *  a USB device has been removed the USB interface whether or not it has been enumerated. This\r
 \r
                        /** Event for USB device removal. This event fires when a the USB interface is in host mode, and\r
                         *  a USB device has been removed the USB interface whether or not it has been enumerated. This\r


@@ -250,184 +117,202 @@
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r

-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r

                         *\r
                         *\r

-                        *  \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
+                        *  \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.\r

                         */\r
                         */\r

-                       void USB_DeviceUnattached(void);\r
+                       void EVENT_USB_Host_DeviceUnattached(void);\r

                        \r
                        /** Event for USB device enumeration failure. This event fires when a the USB interface is\r
                         *  in host mode, and an attached USB device has failed to enumerate completely.\r
                         *\r
                        \r
                        /** Event for USB device enumeration failure. This event fires when a the USB interface is\r
                         *  in host mode, and an attached USB device has failed to enumerate completely.\r
                         *\r

-                        *  \param ErrorCode  Error code indicating the failure reason, a value in \r
-                        *                    USB_Host_EnumerationErrorCodes_t located in Host.h.\r
+                        *  \param[in] ErrorCode  Error code indicating the failure reason, a value in \r
+                        *                        \ref USB_Host_EnumerationErrorCodes_t\r

                         *\r
                         *\r

-                        *  \param SubErrorCode  Sub error code indicating the reason for failure - for example, if the\r
-                        *                       ErrorCode parameter indicates a control error, this will give the error\r
-                        *                       code returned by the USB_Host_SendControlRequest() function.\r
+                        *  \param[in] SubErrorCode  Sub error code indicating the reason for failure - for example, if the\r
+                        *                           ErrorCode parameter indicates a control error, this will give the error\r
+                        *                           code returned by the \ref USB_Host_SendControlRequest() function.\r

                         *\r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
                         *\r
                         *  \note This event only exists on USB AVR models which supports host mode.\r
                         *\r
                         *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r

-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r

                         */\r
                         */\r

-                       void USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);\r
+                       void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);\r

 \r
                        /** Event for USB device enumeration completion. This event fires when a the USB interface is\r
                         *  in host mode and an attached USB device has been completely enumerated and is ready to be\r
 \r
                        /** Event for USB device enumeration completion. This event fires when a the USB interface is\r
                         *  in host mode and an attached USB device has been completely enumerated and is ready to be\r

-                        *  controlled by the user application, or when the library is in device mode, and the Host\r
-                        *  has finished enumerating the device.\r
+                        *  controlled by the user application.\r
+                        *\r
+                        *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around\r
+                        *  1 second) when a transaction is waiting to be processed by the device will prevent break communications\r
+                        *  and cause the host to reset the USB bus.\r
+                        */\r
+                       void EVENT_USB_Host_DeviceEnumerationComplete(void);\r
+\r
+                       /** Event for USB device connection. This event fires when the AVR in device mode and the device is connected\r
+                        *  to a host, beginning the enumeration process, measured by a rising level on the AVR's VBUS pin.\r
+                        *\r
+                        *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around\r
+                        *  two seconds) will prevent the device from enumerating correctly.\r
+                        *\r
+                        *  \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.\r
+                        *        this means that the current connection state is derived from the bus suspension and wake up events by default,\r
+                        *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state\r
+                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
+                        *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
+                        *        and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.\r
+                        *\r
+                        *  \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers\r
+                        *        if NO_LIMITED_CONTROLLER_CONNECT is not defined.\r
+                        *\r
+                        *  \see USBTask.h for more information on the USB management task and reducing CPU usage.\r

                         */\r
                         */\r

-                       void USB_DeviceEnumerationComplete(void);\r
+                       void EVENT_USB_Device_Connect(void);\r
+\r
+                       /** Event for USB device disconnection. This event fires when the AVR in device mode and the device is disconnected\r
+                        *  from a host, measured by a falling level on the AVR's VBUS pin.\r
+                        *\r
+                        *  \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller.\r
+                        *        this means that the current connection state is derived from the bus suspension and wake up events by default,\r
+                        *        which is not always accurate (host may suspend the bus while still connected). If the actual connection state\r
+                        *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
+                        *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
+                        *        and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.\r
+                        *\r
+                        *  \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers\r
+                        *        if NO_LIMITED_CONTROLLER_CONNECT is not defined.\r
+                        *\r
+                        *  \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
+                        */\r
+                       void EVENT_USB_Device_Disconnect(void);\r

 \r
                        /** Event for unhandled control requests. This event fires when a the USB host issues a control\r
                         *  request to the control endpoint (address 0) that the library does not handle. This may either\r
                         *  be a standard request that the library has no handler code for, or a class specific request\r
 \r
                        /** Event for unhandled control requests. This event fires when a the USB host issues a control\r
                         *  request to the control endpoint (address 0) that the library does not handle. This may either\r
                         *  be a standard request that the library has no handler code for, or a class specific request\r

-                        *  issued to the device which must be handled appropriately. Due to the strict timing requirements\r
-                        *  on control transfers, interrupts are disabled during control request processing.\r
+                        *  issued to the device which must be handled appropriately.\r
+                        *\r
+                        *  This event is time-critical; each packet within the request transaction must be acknowledged or\r
+                        *  sent within 50ms or the host will abort the transfer.\r

                         *\r
                         *\r

-                        *  \param bRequest       Request value, indicating what command the host has issued.\r
-                        *  \param bmRequestType  Mask indicating the request data direction (if any), type and recipient.\r
+                        *  The library interally handles all standard control requests with the exceptions of SYNC FRAME,\r
+                        *  SET DESCRIPTOR and SET INTERFACE. These and all other non-standard control requests will be left\r
+                        *  for the user to process via this event if desired. If not handled in the user application, requests\r
+                        *  are automatically STALLed.\r

                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r

-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r

                         *\r
                         *  \note Requests should be handled in the same manner as described in the USB 2.0 Specification,\r
                         *\r
                         *  \note Requests should be handled in the same manner as described in the USB 2.0 Specification,\r

-                        *        or appropriate class' specification. In all instances, the library has already read the\r
-                        *        request bmRequestType and bRequest values out (into the Request and RequestType parameters\r
-                        *        respectively) so that it can correctly determine if it is able to handle the request\r
-                        *        internally, or hand off the request to the user application via this event. Other request\r
-                        *        parameters (wValue, wIndex, wLength, and Data) remain in the control endpoint bank until\r
-                        *        read out by the user application for processing.\r
+                        *        or appropriate class specification. In all instances, the library has already read the\r
+                        *        request SETUP parameters into the \ref USB_ControlRequest structure which should then be used\r
+                        *        by the application to determine how to handle the issued request.\r

                         */\r
                         */\r

-                       void USB_UnhandledControlPacket(const uint8_t bRequest, const uint8_t bmRequestType);\r
+                       void EVENT_USB_Device_UnhandledControlRequest(void);\r

 \r
                        /** Event for USB configuration number changed. This event fires when a the USB host changes the\r
                         *  selected configuration number while in device mode. This event should be hooked in device\r
                         *  applications to create the endpoints and configure the device for the selected configuration.\r
                         *\r
 \r
                        /** Event for USB configuration number changed. This event fires when a the USB host changes the\r
                         *  selected configuration number while in device mode. This event should be hooked in device\r
                         *  applications to create the endpoints and configure the device for the selected configuration.\r
                         *\r

-                        *  This event fires after the value of USB_ConfigurationNumber has been changed.\r
+                        *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around\r
+                        *  one second) will prevent the device from enumerating correctly.\r
+                        *\r
+                        *  This event fires after the value of \ref USB_ConfigurationNumber has been changed.\r

                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r

-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r

                         */\r
                         */\r

-                       void USB_ConfigurationChanged(void);\r
+                       void EVENT_USB_Device_ConfigurationChanged(void);\r

 \r
                        /** Event for USB suspend. This event fires when a the USB host suspends the device by halting its\r
                         *  transmission of Start Of Frame pulses to the device. This is generally hooked in order to move\r
 \r
                        /** Event for USB suspend. This event fires when a the USB host suspends the device by halting its\r
                         *  transmission of Start Of Frame pulses to the device. This is generally hooked in order to move\r

-                        *  the device over to a low power state until the host wakes up the device.\r
+                        *  the device over to a low power state until the host wakes up the device. If the USB interface is\r
+                        *  enumerated with the \ref USB_OPT_AUTO_PLL option set, the library will automatically suspend the\r
+                        *  USB PLL before the event is fired to save power.\r

                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r

-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
+                        *\r
+                        *  \note This event does not exist on the series 2 USB AVRs when the NO_LIMITED_CONTROLLER_CONNECT\r
+                        *        compile time token is not set - see \ref EVENT_USB_Device_Disconnect.\r

                         *\r
                         *\r

-                        *  \see USB_WakeUp() event for accompanying Wake Up event.\r
+                        *  \see \ref EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.\r

                         */\r
                         */\r

-                       void USB_Suspend(void);\r
+                       void EVENT_USB_Device_Suspend(void);\r

 \r
                        /** Event for USB wake up. This event fires when a the USB interface is suspended while in device\r
                         *  mode, and the host wakes up the device by supplying Start Of Frame pulses. This is generally\r
 \r
                        /** Event for USB wake up. This event fires when a the USB interface is suspended while in device\r
                         *  mode, and the host wakes up the device by supplying Start Of Frame pulses. This is generally\r

-                        *  hooked to pull the user application out of a lowe power state and back into normal operating\r
-                        *  mode.\r
+                        *  hooked to pull the user application out of a low power state and back into normal operating\r
+                        *  mode. If the USB interface is enumerated with the \ref USB_OPT_AUTO_PLL option set, the library\r
+                        *  will automatically restart the USB PLL before the event is fired.\r

                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r

-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r
+                        *\r
+                        *  \note This event does not exist on the series 2 USB AVRs when the NO_LIMITED_CONTROLLER_CONNECT\r
+                        *        compile time token is not set - see \ref EVENT_USB_Device_Connect.\r

                         *\r
                         *\r

-                        *  \see USB_Suspend() event for accompanying Suspend event.\r
+                        *  \see \ref EVENT_USB_Device_Suspend() event for accompanying Suspend event.\r

                         */\r
                         */\r

-                       void USB_WakeUp(void);\r
+                       void EVENT_USB_Device_WakeUp(void);\r

 \r
 \r

-                       /** Event for USB interface reset. This event fires when a the USB interface is in device mode, and\r
-                        *  a the USB host requests that the device reset its interface. This is generally hooked so that\r
-                        *  the USB control endpoint can be switched to interrupt driven mode, by selecting it and calling\r
-                        *  USB_INT_Enable(ENDPOINT_INT_SETUP). Before this event fires, all device endpoints are reset and\r
-                        *  disabled.\r
+                       /** Event for USB interface reset. This event fires when the USB interface is in device mode, and\r
+                        *  a the USB host requests that the device reset its interface. This event fires after the control\r
+                        *  endpoint has been automatically configured by the library.\r
+                        *\r
+                        *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around\r
+                        *  two seconds) will prevent the device from enumerating correctly.\r

                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r

-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r

                         */\r
                         */\r

-                       void USB_Reset(void);\r
-                       \r
-                       /** Event for USB device mode error. This event fires when the USB interface is in device mode,\r
-                        *  and an error occurs which prevents it from operating normally.\r
+                       void EVENT_USB_Device_Reset(void);\r
+\r
+                       /** Event for USB Start Of Frame detection, when enabled. This event fires at the start of each USB\r
+                        *  frame, once per millisecond, and is synchronized to the USB bus. This can be used as an accurate\r
+                        *  millisecond timer source when the USB bus is enumerated in device mode to a USB host.\r

                         *\r
                         *\r

-                        *  \param ErrorCode  Error code indicating the source of the error. One of the values in the\r
-                        *                    USB_Device_ErrorCodes_t enum located in Device.h.\r
+                        *  This event is time-critical; it is run once per millisecond and thus long handlers will significantly\r
+                        *  degrade device performance. This event should only be enabled when needed to reduce device wakeups.\r
+                        *\r
+                        *  \note This event is not normally active - it must be manually enabled and disabled via the\r
+                        *        \ref USB_Device_EnableSOFEvents() and \ref USB_Device_DisableSOFEvents() commands after enumeration.\r

                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r

-                        *        LowLevel.h documentation).\r
+                        *        \ref Group_USBManagement documentation).\r

                         */\r
                         */\r

-                       void USB_DeviceError(const uint8_t ErrorCode);\r
+                       void EVENT_USB_Device_StartOfFrame(void);\r

                #endif\r
                \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                #endif\r
                \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r

-               /* Macros: */\r
-                       #define ALIAS_STUB(e)                       EVENT_HANDLER(e) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub)\r
-               \r
-                       #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER)\r
-                               #define USB_VBUSChange_P                (void)\r
-                               #define USB_VBUSConnect_P               (void)\r
-                               #define USB_VBUSDisconnect_P            (void)\r
-                       #endif\r
-                       \r
-                       #define USB_Connect_P                       (void)\r
-                       #define USB_Disconnect_P                    (void)\r
-                       #define USB_DeviceEnumerationComplete_P     (void)\r
-                       \r
-                       #if defined(USB_CAN_BE_BOTH)\r
-                               #define USB_PowerOnFail_P               (const uint8_t ErrorCode)\r
-                               #define USB_UIDChange_P                 (void)\r
-                       #endif\r
-\r
-                       #if defined(USB_CAN_BE_HOST)\r
-                               #define USB_HostError_P                 (const uint8_t ErrorCode)\r
-                               #define USB_DeviceAttached_P            (void)\r
-                               #define USB_DeviceUnattached_P          (void)\r
-                               #define USB_DeviceEnumerationFailed_P   (const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
-                       #endif\r
-                       \r
-                       #if defined(USB_CAN_BE_DEVICE)\r
-                               #define USB_UnhandledControlPacket_P    (const uint8_t bRequest, const uint8_t bmRequestType)\r
-                               #define USB_ConfigurationChanged_P      (void)\r
-                               #define USB_Suspend_P                   (void)\r
-                               #define USB_WakeUp_P                    (void)\r
-                               #define USB_Reset_P                     (void)\r
-                               #define USB_DeviceError_P               (const uint8_t ErrorCode)\r
-                       #endif\r
-\r

                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_EVENTS_C)\r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_EVENTS_C)\r

-                               void USB_Event_Stub (void) ATTR_CONST;\r
-\r
-                               #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER)\r
-                                       ALIAS_STUB(USB_VBUSChange);\r
-                                       ALIAS_STUB(USB_VBUSConnect);\r
-                                       ALIAS_STUB(USB_VBUSDisconnect);\r
-                               #endif\r
-                               \r
-                               ALIAS_STUB(USB_Connect);\r
-                               ALIAS_STUB(USB_Disconnect);\r
-                               ALIAS_STUB(USB_DeviceEnumerationComplete);\r
-                               \r
+                               void USB_Event_Stub(void) ATTR_CONST;\r
+                                       \r

                                #if defined(USB_CAN_BE_BOTH)\r
                                #if defined(USB_CAN_BE_BOTH)\r

-                                       ALIAS_STUB(USB_PowerOnFail);\r
-                                       ALIAS_STUB(USB_UIDChange);\r
+                                       void EVENT_USB_InitFailure(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_UIDChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r

                                #endif\r
                                \r
                                #if defined(USB_CAN_BE_HOST)\r
                                #endif\r
                                \r
                                #if defined(USB_CAN_BE_HOST)\r

-                                       ALIAS_STUB(USB_HostError);\r
-                                       ALIAS_STUB(USB_DeviceAttached);\r
-                                       ALIAS_STUB(USB_DeviceUnattached);\r
-                                       ALIAS_STUB(USB_DeviceEnumerationFailed);\r
+                                       void EVENT_USB_Host_HostError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Host_DeviceAttached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Host_DeviceUnattached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Host_DeviceEnumerationComplete(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
+                                                                              ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r

                                #endif\r
 \r
                                #if defined(USB_CAN_BE_DEVICE)\r
                                #endif\r
 \r
                                #if defined(USB_CAN_BE_DEVICE)\r

-                                       ALIAS_STUB(USB_UnhandledControlPacket);\r
-                                       ALIAS_STUB(USB_ConfigurationChanged);\r
-                                       ALIAS_STUB(USB_Suspend);\r
-                                       ALIAS_STUB(USB_WakeUp);\r
-                                       ALIAS_STUB(USB_Reset);\r
-                                       ALIAS_STUB(USB_DeviceError);\r
+                                       void EVENT_USB_Device_Connect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Device_Disconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Device_UnhandledControlRequest(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Device_ConfigurationChanged(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Device_Suspend(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Device_WakeUp(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Device_Reset(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+                                       void EVENT_USB_Device_StartOfFrame(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r

                                #endif\r
                        #endif\r
        #endif\r
                                #endif\r
                        #endif\r
        #endif\r


@@ -436,5 +321,7 @@
                #if defined(__cplusplus)\r
                        }\r
                #endif\r
                #if defined(__cplusplus)\r
                        }\r
                #endif\r

-               \r
+       \r

 #endif\r
 #endif\r

+\r
+/** @} */\r