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 933091a..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


@@ -40,8 +40,8 @@
  *  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
  *  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 event\r
- *  name just like any regular C function (with any required event parameters).\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
  *  @{\r
  */\r


@@ -195,6 +195,11 @@
                         *  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
                         *  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

+                        *  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
                         *        \ref Group_USBManagement documentation).\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
                         *        \ref Group_USBManagement documentation).\r
                         *\r


@@ -228,19 +233,25 @@
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
                         *        \ref Group_USBManagement documentation).\r
                         *\r
                         *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\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

                         *  \see \ref EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.\r
                         */\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
                         *  \see \ref EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.\r
                         */\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

-                        *  hooked to pull the user application out of a lowe power state and back into normal operating\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
                         *        \ref Group_USBManagement documentation).\r
                         *\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
                         *        \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

                         *  \see \ref EVENT_USB_Device_Suspend() event for accompanying Suspend event.\r
                         */\r
                        void EVENT_USB_Device_WakeUp(void);\r
                         *  \see \ref EVENT_USB_Device_Suspend() event for accompanying Suspend event.\r
                         */\r
                        void EVENT_USB_Device_WakeUp(void);\r