Add const keyword to the demo function parameters where possible.

[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 fcea5ae..1ab7177 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *  \brief Device mode driver for the library USB HID Class driver.\r
+ *\r
+ *  Device mode driver for the library USB HID Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/HID.h.\r
+ */\r
+\r
 /** \ingroup Group_USBClassHID\r
  *  @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver\r
  *\r
@@ -55,9 +64,16 @@
                        extern "C" {\r
                #endif\r
 \r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_HID_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/HID.h instead.\r
+               #endif\r
+\r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
-                       /** Class state structure. An instance of this structure should be made for each HID interface\r
+                       /** \brief HID Class Device Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made for each HID interface\r
                         *  within the user application, and passed to each of the HID class driver functions as the\r
                         *  HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.\r
                         *\r
@@ -131,15 +147,6 @@
                         */\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
@@ -173,6 +180,21 @@
                                                                  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