Rename PDIProtocol.c/.h to XPROGProtocol.c/.h as it will now handle both TPI and...

[pub/USBasp.git] / Demos / Host / LowLevel / MouseHostWithParser / HIDReport.c

diff --git a/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c b/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c
index 4d89590..faf8e98 100644 (file)
--- a/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c
+++ b/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c
@@ -69,3 +69,42 @@ uint8_t GetHIDReportData(void)
        \r
        return ParseSuccessful;\r
 }\r
+\r
+/** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store\r
+ *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items\r
+ *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would\r
+ *  have occupied).\r
+ *\r
+ *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with\r
+ *\r
+ *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded\r
+ */\r
+bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* CurrentItem)\r
+{\r
+       bool IsMouse = false;\r
+\r
+       /* Iterate through the item's collection path, until either the root collection node or a collection with the\r
+        * Mouse Usage is found - this prevents Joysticks, which use identical descriptors except for the Joystick usage\r
+        * parent node, from being erroneously treated as a mouse\r
+        */\r
+       for (HID_CollectionPath_t* CurrPath = CurrentItem->CollectionPath; CurrPath != NULL; CurrPath = CurrPath->Parent)\r
+       {\r
+               if ((CurrPath->Usage.Page  == USAGE_PAGE_GENERIC_DCTRL) &&\r
+                   (CurrPath->Usage.Usage == USAGE_MOUSE))\r
+               {\r
+                       IsMouse = true;\r
+                       break;\r
+               }\r
+       }\r
+\r
+       /* If a collection with the mouse usage was not found, indicate that we are not interested in this item */\r
+       if (!IsMouse)\r
+         return false;\r
+  \r
+       /* Check the attributes of the current mouse item - see if we are interested in it or not;\r
+        * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report\r
+        * structure to save RAM and ignore the rest\r
+        */\r
+       return ((CurrentItem->Attributes.Usage.Page == USAGE_PAGE_BUTTON) ||\r
+               (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_GENERIC_DCTRL));\r
+}\r