Remove deleted source files from the LUFA library makefile.

[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 06456cf..ccd7426 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -56,21 +56,14 @@
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r

-               /* Macros: */\r
-                       #if !defined(HID_MAX_REPORT_SIZE)\r
-                               /** Maximum size of an IN report which can be generated by the device and sent to the host, in bytes.\r
-                                *\r
-                                *  \note If larger reports than the default specified here are to be generated by the device, this\r
-                                *        value can be overridden by defining this token to the required value in the project makefile\r
-                                *        and passing it to the compiler via the -D switch.\r
-                                */\r
-                               #define HID_MAX_REPORT_SIZE     16\r
-                       #endif\r
-       \r

                /* Type Defines: */\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
                /* Type Defines: */\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
+                        *  \note Due to technical limitations, the HID device class driver does not utilize a seperate OUT\r
+                        *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to\r
+                        *        the device via the control endpoint.\r

                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r


@@ -80,6 +73,16 @@
 \r
                                        uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */\r
                                        uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */                                  \r
 \r
                                        uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */\r
                                        uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */                                  \r

+                                       \r
+                                       void*    PrevReportINBuffer; /** Pointer to a buffer where the previously created HID input report can be\r
+                                                                     *  stored by the driver, for comparison purposes to detect report changes that\r
+                                                                     *  must be sent immediately to the host. This should point to a buffer big enough\r
+                                                                     *  to hold the largest HID input report sent from the HID interface.\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
+                                                                         */\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
                                           */                                                                            \r


@@ -89,8 +92,6 @@
                                        uint16_t IdleCount; /**< Report idle period, in mS, set by the host */\r
                                        uint16_t IdleMSRemaining; /**< Total number of mS remaining before the idle period elapsed - this should be\r
                                                                                           *   decremented by the user application if non-zero each millisecond */      \r
                                        uint16_t IdleCount; /**< Report idle period, in mS, set by the host */\r
                                        uint16_t IdleMSRemaining; /**< Total number of mS remaining before the idle period elapsed - this should be\r
                                                                                           *   decremented by the user application if non-zero each millisecond */      \r

-\r
-                                       uint8_t PreviousReportINData[HID_MAX_REPORT_SIZE]; /**< Previously generated report from the HID interface */\r

                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                          *   are reset to their defaults when the interface is enumerated.\r
                                          */\r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                          *   are reset to their defaults when the interface is enumerated.\r
                                          */\r


@@ -98,35 +99,37 @@
        \r
                /* Function Prototypes: */\r
                        /** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library\r
        \r
                /* Function Prototypes: */\r
                        /** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library\r

-                        *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+                        *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration\r

                         *  containing the given HID interface is selected.\r
                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         *\r
                         *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                         */\r
                         *  containing the given HID interface is selected.\r
                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         *\r
                         *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                         */\r

-                       bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
+                       bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                        \r
                        /** Processes incomming control requests from the host, that are directed to the given HID class interface. This should be\r
                        \r
                        /** Processes incomming control requests from the host, that are directed to the given HID class interface. This should be\r

-                        *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+                        *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r

                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         */             \r
                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         */             \r

-                       void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
+                       void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
                        /** General management task for a given HID class interface, required for the correct operation of the interface. This should\r
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         */\r
 \r
                        /** General management task for a given HID class interface, required for the correct operation of the interface. This should\r
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         */\r

-                       void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\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
                        \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.\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
                         *\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);\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 input 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
                        \r
                        /** HID class driver callback for the user creation of a HID input 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


@@ -137,11 +140,14 @@
                         *                 be set to the report ID of the generated HID input report. If multiple reports are not sent via the\r
                         *                 given HID interface, this parameter should be ignored.\r
                         *  \param[out] ReportData  Pointer to a buffer where the generated HID report should be stored.\r
                         *                 be set to the report ID of the generated HID input report. If multiple reports are not sent via the\r
                         *                 given HID interface, this parameter should be ignored.\r
                         *  \param[out] ReportData  Pointer to a buffer where the generated HID report should be stored.\r

+                        *  \param[out] ReportSize  Number of bytes in the generated input report, or zero if no report is to be sent\r

                         *\r
                         *\r

-                        *  \return  Number of bytes in the generated input report, or zero if no report is to be sent\r
+                        *  \return Boolean true to force the sending of the report even if it is identical to the previous report and still within\r
+                        *          the idle period (useful for devices which report relative movement), false otherwise\r

                         */\r
                         */\r

-                       uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);\r
-\r
+                       bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,\r
+                                                     void* ReportData, uint16_t* ReportSize) ATTR_NON_NULL_PTR_ARG(1, 2, 3, 4);\r
+                       \r

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


@@ -153,7 +159,7 @@
                         *  \param[in] ReportSize  Size in bytes of the received report from the host.\r
                         */\r
                        void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
                         *  \param[in] ReportSize  Size in bytes of the received report from the host.\r
                         */\r
                        void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,\r

-                                                                 const void* ReportData, const uint16_t ReportSize);\r
+                                                                 const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1, 3);\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