Add new tag for the LUFA-120219-BETA release.
[pub/USBasp.git] / Demos / Host / LowLevel / JoystickHostWithParser / HIDReport.c
index 1b4fe7e..aa9743c 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\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, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-#include "HIDReport.h"\r
-\r
-/** Size in bytes of the attached device's HID report descriptor */\r
-uint16_t         HIDReportSize;\r
-\r
-/** Processed HID report descriptor items structure, containing information on each HID report element */\r
-HID_ReportInfo_t HIDReportInfo;\r
-\r
-\r
-/** Function to read in the HID report descriptor from the attached device, and process it into easy-to-read\r
- *  structures via the HID parser routines in the LUFA library.\r
- *\r
- *  \return  A value from the MouseHostWithParser_GetHIDReportDataCodes_t enum\r
- */\r
-uint8_t GetHIDReportData(void)\r
-{\r
-       /* Create a buffer big enough to hold the entire returned HID report */\r
-       uint8_t HIDReportData[HIDReportSize];\r
-       \r
-       USB_ControlRequest = (USB_Request_Header_t)\r
-               {\r
-                       .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_INTERFACE),\r
-                       .bRequest      = REQ_GetDescriptor,\r
-                       .wValue        = (DTYPE_Report << 8),\r
-                       .wIndex        = 0,\r
-                       .wLength       = HIDReportSize,\r
-               };\r
-\r
-       /* Select the control pipe for the request transfer */\r
-       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
-       /* Send control request to retrieve the HID report from the attached device */\r
-       if (USB_Host_SendControlRequest(HIDReportData) != HOST_SENDCONTROL_Successful)\r
-         return ParseControlError;\r
-\r
-       /* Send the HID report to the parser for processing */\r
-       if (USB_ProcessHIDReport(HIDReportData, HIDReportSize, &HIDReportInfo) != HID_PARSE_Successful)\r
-         return ParseError;\r
-       \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 IsJoystick = false;\r
-\r
-       /* Iterate through the item's collection path, until either the root collection node or a collection with the\r
-        * Joystick Usage is found - this prevents Mice, which use identical descriptors except for the Mouse usage\r
-        * parent node, from being erroneously treated as a joystick\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_JOYSTICK))\r
-               {\r
-                       IsJoystick = true;\r
-                       break;\r
-               }\r
-       }\r
-\r
-       /* If a collection with the joystick usage was not found, indicate that we are not interested in this item */\r
-       if (!IsJoystick)\r
-         return false;\r
-  \r
-       /* Check the attributes of the current joystick 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
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2012.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+#include "HIDReport.h"
+
+/** Size in bytes of the attached device's HID report descriptor */
+uint16_t         HIDReportSize;
+
+/** Processed HID report descriptor items structure, containing information on each HID report element */
+HID_ReportInfo_t HIDReportInfo;
+
+
+/** Function to read in the HID report descriptor from the attached device, and process it into easy-to-read
+ *  structures via the HID parser routines in the LUFA library.
+ *
+ *  \return  A value from the \ref JoystickHostWithParser_GetHIDReportDataCodes_t enum
+ */
+uint8_t GetHIDReportData(void)
+{
+       /* Create a buffer big enough to hold the entire returned HID report */
+       uint8_t HIDReportData[HIDReportSize];
+
+       USB_ControlRequest = (USB_Request_Header_t)
+               {
+                       .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_INTERFACE),
+                       .bRequest      = REQ_GetDescriptor,
+                       .wValue        = (HID_DTYPE_Report << 8),
+                       .wIndex        = 0,
+                       .wLength       = HIDReportSize,
+               };
+
+       /* Select the control pipe for the request transfer */
+       Pipe_SelectPipe(PIPE_CONTROLPIPE);
+
+       /* Send control request to retrieve the HID report from the attached device */
+       if (USB_Host_SendControlRequest(HIDReportData) != HOST_SENDCONTROL_Successful)
+         return ParseControlError;
+
+       /* Send the HID report to the parser for processing */
+       if (USB_ProcessHIDReport(HIDReportData, HIDReportSize, &HIDReportInfo) != HID_PARSE_Successful)
+         return ParseError;
+
+       return ParseSuccessful;
+}
+
+/** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
+ *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
+ *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
+ *  have occupied).
+ *
+ *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
+ *
+ *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
+ */
+bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
+{
+       bool IsJoystick = false;
+
+       /* Iterate through the item's collection path, until either the root collection node or a collection with the
+        * Joystick Usage is found - this prevents Mice, which use identical descriptors except for the Mouse usage
+        * parent node, from being erroneously treated as a joystick
+        */
+       for (HID_CollectionPath_t* CurrPath = CurrentItem->CollectionPath; CurrPath != NULL; CurrPath = CurrPath->Parent)
+       {
+               if ((CurrPath->Usage.Page  == USAGE_PAGE_GENERIC_DCTRL) &&
+                   (CurrPath->Usage.Usage == USAGE_JOYSTICK))
+               {
+                       IsJoystick = true;
+                       break;
+               }
+       }
+
+       /* If a collection with the joystick usage was not found, indicate that we are not interested in this item */
+       if (!IsJoystick)
+         return false;
+
+       /* Check the attributes of the current joystick item - see if we are interested in it or not;
+        * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
+        * structure to save RAM and ignore the rest
+        */
+       return ((CurrentItem->Attributes.Usage.Page == USAGE_PAGE_BUTTON) ||
+               (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_GENERIC_DCTRL));
+}
+