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

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / HID.h

diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h
index d51327c..f62c08c 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.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


@@ -89,7 +89,8 @@
                                                                      */\r
                                        uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a\r
                                                                          *  second buffer of the same size within the driver so that subsequent reports\r
                                                                      */\r
                                        uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a\r
                                                                          *  second buffer of the same size within the driver so that subsequent reports\r

-                                                                         *  can be compared.\r
+                                                                         *  can be compared. If the user app is to determine when reports are to be sent\r
+                                                                         *  exclusively (i.e. \ref PrevReportINBuffer is NULL) this value is ignored.\r

                                                                          */\r
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
                                                                          */\r
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r


@@ -130,15 +131,6 @@
                         */\r
                        void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
                        \r
                         */\r
                        void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
                        \r

-                       /** Indicates that a millisecond of idle time has elapsed on the given HID interface, and the interface's idle count should be\r
-                        *  decremented. This should be called once per millisecond so that hardware key-repeats function correctly. It is recommended\r
-                        *  that this be called by the \ref EVENT_USB_Device_StartOfFrame() event, once SOF events have been enabled via\r
-                        *  \ref USB_Device_EnableSOFEvents();.\r
-                        *\r
-                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state\r
-                        */\r
-                       void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
-                       \r

                        /** HID class driver callback for the user creation of a HID IN report. This callback may fire in response to either\r
                         *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the\r
                         *  user is responsible for the creation of the next HID input report to be sent to the host.\r
                        /** HID class driver callback for the user creation of a HID IN report. This callback may fire in response to either\r
                         *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the\r
                         *  user is responsible for the creation of the next HID input report to be sent to the host.\r


@@ -172,6 +164,21 @@
                                                                  const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)\r
                                                                  ATTR_NON_NULL_PTR_ARG(3);\r
 \r
                                                                  const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)\r
                                                                  ATTR_NON_NULL_PTR_ARG(3);\r
 \r

+               /* Inline Functions: */\r
+                       /** Indicates that a millisecond of idle time has elapsed on the given HID interface, and the interface's idle count should be\r
+                        *  decremented. This should be called once per millisecond so that hardware key-repeats function correctly. It is recommended\r
+                        *  that this be called by the \ref EVENT_USB_Device_StartOfFrame() event, once SOF events have been enabled via\r
+                        *  \ref USB_Device_EnableSOFEvents();.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state\r
+                        */\r
+                       static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
+                       static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo)\r
+                       {\r
+                               if (HIDInterfaceInfo->State.IdleMSRemaining)\r
+                                 HIDInterfaceInfo->State.IdleMSRemaining--;\r
+                       }\r
+                       \r

        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        }\r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        }\r