Start porting the USB core to the AVR32 UC3B.

[pub/USBasp.git] / Demos / Host / ClassDriver / MouseHostWithParser / MouseHostWithParser.c

diff --git a/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c b/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c
index f26e9e2..b641185 100644 (file)
--- a/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c
+++ b/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c
@@ -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
-\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
+  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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -36,327 +36,255 @@
  \r
 #include "MouseHostWithParser.h"\r
 \r
  \r
 #include "MouseHostWithParser.h"\r
 \r

-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },\r
-       { .Task = USB_Mouse_Host       , .TaskStatus = TASK_STOP },\r
-};\r
+/** Processed HID report descriptor items structure, containing information on each HID report element */\r
+HID_ReportInfo_t HIDReportInfo;\r
+\r
+/** LUFA HID Class driver interface configuration and state information. This structure is\r
+ *  passed to all HID Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another.\r
+ */\r
+USB_ClassInfo_HID_Host_t Mouse_HID_Interface =\r
+       {\r
+               .Config =\r
+                       {\r
+                               .DataINPipeNumber       = 1,\r
+                               .DataINPipeDoubleBank   = false,\r

 \r
 \r

+                               .DataOUTPipeNumber      = 2,\r
+                               .DataOUTPipeDoubleBank  = false,\r
+                               \r
+                               .HIDInterfaceProtocol   = HID_NON_BOOT_PROTOCOL,\r
+                               \r
+                               .HIDParserData          = &HIDReportInfo\r
+                       },\r
+       };\r

 \r
 \r

+       \r

 /** Main program entry point. This routine configures the hardware required by the application, then\r
 /** Main program entry point. This routine configures the hardware required by the application, then\r

- *  starts the scheduler to run the application tasks.\r
+ *  enters a loop to run the application tasks in sequence.\r

  */\r
 int main(void)\r
 {\r
  */\r
 int main(void)\r
 {\r

+       SetupHardware();\r
+\r
+       puts_P(PSTR(ESC_FG_CYAN "Mouse Host Demo running.\r\n" ESC_FG_WHITE));\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+       for (;;)\r
+       {\r
+               switch (USB_HostState)\r
+               {\r
+                       case HOST_STATE_Addressed:\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+                       \r
+                               uint16_t ConfigDescriptorSize;\r
+                               uint8_t  ConfigDescriptorData[512];\r
+\r
+                               if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,\r
+                                                                      sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)\r
+                               {\r
+                                       printf("Error Retrieving Configuration Descriptor.\r\n");\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+\r
+                               if (HID_Host_ConfigurePipes(&Mouse_HID_Interface,\r
+                                                           ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)\r
+                               {\r
+                                       printf("Attached Device Not a Valid Mouse.\r\n");\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+                               \r
+                               if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)\r
+                               {\r
+                                       printf("Error Setting Device Configuration.\r\n");\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+\r
+                               if (HID_Host_SetReportProtocol(&Mouse_HID_Interface) != 0)\r
+                               {\r
+                                       printf("Error Setting Report Protocol Mode or Not a Valid Mouse.\r\n");\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+                               \r
+                               LEDs_SetAllLEDs(LEDS_NO_LEDS);\r
+                               \r
+                               printf("Mouse Enumerated.\r\n");\r
+                               USB_HostState = HOST_STATE_Configured;\r
+                               break;\r
+                       case HOST_STATE_Configured:\r
+                               if (HID_Host_IsReportReceived(&Mouse_HID_Interface))\r
+                               {\r
+                                       uint8_t MouseReport[Mouse_HID_Interface.State.LargestReportSize];\r
+                                       HID_Host_ReceiveReport(&Mouse_HID_Interface, &MouseReport);\r
+\r
+                                       uint8_t LEDMask = LEDS_NO_LEDS;\r
+\r
+                                       for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)\r
+                                       {\r
+                                               HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];\r
+                                               \r
+                                               /* Update the report item value if it is contained within the current report */\r
+                                               if (!(USB_GetHIDReportItemInfo(MouseReport, ReportItem)))\r
+                                                 continue;\r
+                                               \r
+                                               /* Determine what report item is being tested, process updated value as needed */\r
+                                               if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&\r
+                                                       (ReportItem->ItemType                     == REPORT_ITEM_TYPE_In))\r
+                                               {\r
+                                                       if (ReportItem->Value)\r
+                                                         LEDMask = LEDS_ALL_LEDS;\r
+                                               }\r
+                                               else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&\r
+                                                                (ReportItem->Attributes.Usage.Usage  == USAGE_SCROLL_WHEEL)       &&\r
+                                                                (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))\r
+                                               {\r
+                                                       int16_t WheelDelta = (int16_t)(ReportItem->Value << (16 - ReportItem->Attributes.BitSize));\r
+                                                       \r
+                                                       if (WheelDelta)\r
+                                                         LEDMask = (LEDS_LED1 | LEDS_LED2 | ((WheelDelta > 0) ? LEDS_LED3 : LEDS_LED4));\r
+                                               }\r
+                                               else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&\r
+                                                                ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||\r
+                                                                 (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&\r
+                                                                (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))\r
+                                               {\r
+                                                       int16_t DeltaMovement = (int16_t)(ReportItem->Value << (16 - ReportItem->Attributes.BitSize));\r
+                                                       \r
+                                                       if (ReportItem->Attributes.Usage.Usage == USAGE_X)\r
+                                                       {\r
+                                                               if (DeltaMovement)\r
+                                                                 LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);\r
+                                                       }\r
+                                                       else\r
+                                                       {\r
+                                                               if (DeltaMovement)\r
+                                                                 LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);\r
+                                                       }\r
+                                               }\r
+                                       }\r
+                                       \r
+                                       LEDs_SetAllLEDs(LEDMask);\r
+                               }\r
+                               \r
+                               break;\r
+               }\r
+       \r
+               HID_Host_USBTask(&Mouse_HID_Interface);\r
+               USB_USBTask();\r
+       }\r
+}\r
+\r
+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
+void SetupHardware(void)\r
+{\r

        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r
 \r
        /* Disable clock division */\r
        clock_prescale_set(clock_div_1);\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r
 \r
        /* Disable clock division */\r
        clock_prescale_set(clock_div_1);\r

-       \r
+\r

        /* Hardware Initialization */\r
        SerialStream_Init(9600, false);\r
        LEDs_Init();\r
        /* Hardware Initialization */\r
        SerialStream_Init(9600, false);\r
        LEDs_Init();\r

-       \r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
-       \r
-       /* Initialize Scheduler so that it can be used */\r
-       Scheduler_Init();\r
-\r
-       /* Initialize USB Subsystem */\r

        USB_Init();\r
        USB_Init();\r

-\r
-       /* Start-up message */\r
-       puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY\r
-              "Mouse Host Demo running.\r\n" ESC_INVERSE_OFF));\r
-                  \r
-       /* Scheduling - routine never returns, so put this last in the main function */\r
-       Scheduler_Start();\r

 }\r
 \r
 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and\r
  *  starts the library USB task to begin the enumeration and USB management process.\r
  */\r
 }\r
 \r
 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and\r
  *  starts the library USB task to begin the enumeration and USB management process.\r
  */\r

-void EVENT_USB_DeviceAttached(void)\r
+void EVENT_USB_Host_DeviceAttached(void)\r

 {\r
        puts_P(PSTR("Device Attached.\r\n"));\r
 {\r
        puts_P(PSTR("Device Attached.\r\n"));\r

-       UpdateStatus(Status_USBEnumerating);\r
-\r
-       /* Start USB management task to enumerate the device */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r

 }\r
 \r
 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and\r
  *  stops the library USB task management process.\r
  */\r
 }\r
 \r
 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and\r
  *  stops the library USB task management process.\r
  */\r

-void EVENT_USB_DeviceUnattached(void)\r
+void EVENT_USB_Host_DeviceUnattached(void)\r

 {\r
 {\r

-       /* Stop mouse and USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_Mouse_Host, TASK_STOP);\r
-\r
-       puts_P(PSTR("Device Unattached.\r\n"));\r
-       UpdateStatus(Status_USBNotReady);\r
+       puts_P(PSTR("\r\nDevice Unattached.\r\n"));\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r

 }\r
 \r
 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully\r
  *  enumerated by the host and is now ready to be used by the application.\r
  */\r
 }\r
 \r
 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully\r
  *  enumerated by the host and is now ready to be used by the application.\r
  */\r

-void EVENT_USB_DeviceEnumerationComplete(void)\r
+void EVENT_USB_Host_DeviceEnumerationComplete(void)\r

 {\r
 {\r

-       /* Start Mouse Host task */\r
-       Scheduler_SetTaskMode(USB_Mouse_Host, TASK_RUN);\r
-       \r
-       /* Indicate device enumeration complete */\r
-       UpdateStatus(Status_USBReady);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r

 }\r
 \r
 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r
 }\r
 \r
 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r

-void EVENT_USB_HostError(const uint8_t ErrorCode)\r
+void EVENT_USB_Host_HostError(const uint8_t ErrorCode)\r

 {\r
        USB_ShutDown();\r
 \r
 {\r
        USB_ShutDown();\r
 \r

-       puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));\r
-       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
+       printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"\r
+                                " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);\r

 \r
 \r

-       UpdateStatus(Status_HardwareError);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r

        for(;;);\r
 }\r
 \r
 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while\r
  *  enumerating an attached USB device.\r
  */\r
        for(;;);\r
 }\r
 \r
 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while\r
  *  enumerating an attached USB device.\r
  */\r

-void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
+void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r

 {\r
 {\r

-       puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));\r
-       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
-       printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);\r
-       printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);\r
+       printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"\r
+                                " -- Error Code %d\r\n"\r
+                                " -- Sub Error Code %d\r\n"\r
+                                " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);\r

        \r
        \r

-       UpdateStatus(Status_EnumerationError);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r

 }\r
 \r
 }\r
 \r

-/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
- *  log to a serial port, or anything else that is suitable for status updates.\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
  *\r

- *  \param CurrentStatus  Current status of the system, from the MouseHostWithParser_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
-{\r
-       uint8_t LEDMask = LEDS_NO_LEDS;\r
-       \r
-       /* Set the LED mask to the appropriate LED mask based on the given status code */\r
-       switch (CurrentStatus)\r
-       {\r
-               case Status_USBNotReady:\r
-                       LEDMask = (LEDS_LED1);\r
-                       break;\r
-               case Status_USBEnumerating:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED2);\r
-                       break;\r
-               case Status_USBReady:\r
-                       LEDMask = (LEDS_LED2);\r
-                       break;\r
-               case Status_EnumerationError:\r
-               case Status_HardwareError:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED3);\r
-                       break;\r
-               case Status_Busy:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED4);\r
-                       break;\r
-       }\r
-       \r
-       /* Set the board LEDs to the new LED mask */\r
-       LEDs_SetAllLEDs(LEDMask);\r
-}\r
-\r
-/** Task to set the configuration of the attached device after it has been enumerated, and to read and process\r
- *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.\r
- */\r
-TASK(USB_Mouse_Host)\r
-{\r
-       uint8_t ErrorCode;\r
-\r
-       /* Switch to determine what user-application handled host state the host state machine is in */\r
-       switch (USB_HostState)\r
-       {\r
-               case HOST_STATE_Addressed:      \r
-                       /* Standard request to set the device configuration to configuration 1 */\r
-                       USB_ControlRequest = (USB_Request_Header_t)\r
-                               {\r
-                                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),\r
-                                       .bRequest      = REQ_SetConfiguration,\r
-                                       .wValue        = 1,\r
-                                       .wIndex        = 0,\r
-                                       .wLength       = 0,\r
-                               };\r
-\r
-                       /* Select the control pipe for the request transfer */\r
-                       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
-                       /* Send the request, display error and wait for device detach if request fails */\r
-                       if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
-                       {\r
-                               puts_P(PSTR("Control Error (Set Configuration).\r\n"));\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
-\r
-                               /* Indicate error via status LEDs */\r
-                               UpdateStatus(Status_EnumerationError);\r
-\r
-                               /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
-                               break;\r
-                       }\r
-                       \r
-                       USB_HostState = HOST_STATE_Configured;\r
-                       break;\r
-               case HOST_STATE_Configured:\r
-                       puts_P(PSTR("Getting Config Data.\r\n"));\r
-               \r
-                       /* Get and process the configuration descriptor data */\r
-                       if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)\r
-                       {\r
-                               if (ErrorCode == ControlError)\r
-                                 puts_P(PSTR("Control Error (Get Configuration).\r\n"));\r
-                               else\r
-                                 puts_P(PSTR("Invalid Device.\r\n"));\r
-\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
-                               \r
-                               /* Indicate error via status LEDs */\r
-                               UpdateStatus(Status_EnumerationError);\r
-\r
-                               /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
-                               break;\r
-                       }\r
-               \r
-                       puts_P(PSTR("Processing HID Report.\r\n"));\r
-\r
-                       /* LEDs one and two on to indicate busy processing */\r
-                       UpdateStatus(Status_Busy);\r
-\r
-                       /* Get and process the device's first HID report descriptor */\r
-                       if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)\r
-                       {\r
-                               puts_P(PSTR("Report Parse Error.\r\n"));\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
-                       \r
-                               /* Indicate error via status LEDs */\r
-                               UpdateStatus(Status_EnumerationError);\r
-                               \r
-                               /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
-                               break;                  \r
-                       }\r
-                       \r
-                       /* All LEDs off - ready to indicate key presses */\r
-                       UpdateStatus(Status_USBReady);\r
-\r
-                       puts_P(PSTR("Mouse Enumerated.\r\n"));\r
-                               \r
-                       USB_HostState = HOST_STATE_Ready;\r
-                       break;\r
-               case HOST_STATE_Ready:\r
-                       /* Select and unfreeze mouse data pipe */\r
-                       Pipe_SelectPipe(MOUSE_DATAPIPE);        \r
-                       Pipe_Unfreeze();\r
-\r
-                       /* Check to see if a packet has been received */\r
-                       if (Pipe_IsINReceived())\r
-                       {\r
-                               /* Check if data has been received from the attached mouse */\r
-                               if (Pipe_IsReadWriteAllowed())\r
-                               {\r
-                                       /* Create buffer big enough for the report */\r
-                                       uint8_t MouseReport[Pipe_BytesInPipe()];\r
-\r
-                                       /* Load in the mouse report */\r
-                                       Pipe_Read_Stream_LE(MouseReport, Pipe_BytesInPipe());\r
-                               \r
-                                       /* Process the read in mouse report from the device */\r
-                                       ProcessMouseReport(MouseReport);\r
-                               }\r
-                               \r
-                               /* Clear the IN endpoint, ready for next data packet */\r
-                               Pipe_ClearIN();\r
-                       }\r
-\r
-                       /* Freeze mouse data pipe */\r
-                       Pipe_Freeze();\r
-                       break;\r
-       }\r
-}\r
-\r
-/** Processes a read HID report from an attached mouse, extracting out elements via the HID parser results\r
- *  as required and displays movement and button presses on the board LEDs.\r
+ *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with\r

  *\r
  *\r

- *  \param MouseReport  Pointer to a HID report from an attached mouse device\r
+ *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded\r

  */\r
  */\r

-void ProcessMouseReport(uint8_t* MouseReport)\r
+bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* CurrentItem)\r

 {\r
 {\r

-       uint8_t LEDMask = LEDS_NO_LEDS;\r
+       bool IsMouse = false;\r

 \r
 \r

-       /* Check each HID report item in turn, looking for mouse X/Y/button reports */\r
-       for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)\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 by the demo\r
+        */\r
+       for (HID_CollectionPath_t* CurrPath = CurrentItem->CollectionPath; CurrPath != NULL; CurrPath = CurrPath->Parent)\r

        {\r
        {\r

-               /* Create a temporary item pointer to the next report item */\r
-               HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];\r
-               \r
-               bool FoundData;\r
-\r
-               if ((ReportItem->Attributes.Usage.Page       == USAGE_PAGE_BUTTON) &&\r
-                       (ReportItem->ItemType                    == REPORT_ITEM_TYPE_In))\r
+               if ((CurrPath->Usage.Page  == USAGE_PAGE_GENERIC_DCTRL) &&\r
+                   (CurrPath->Usage.Usage == USAGE_MOUSE))\r

                {\r
                {\r

-                       /* Get the mouse button value */\r
-                       FoundData = USB_GetHIDReportItemInfo(MouseReport, ReportItem);\r
-                       \r
-                       /* For multi-report devices - if the requested data was not in the issued report, continue */\r
-                       if (!(FoundData))\r
-                         continue;\r
-\r
-                       /* If button is pressed, all LEDs are turned on */\r
-                       if (ReportItem->Value)\r
-                         LEDMask = LEDS_ALL_LEDS;\r
-               }\r
-               else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&\r
-                                ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||\r
-                                 (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&\r
-                                (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))\r
-               {\r
-                       /* Get the mouse relative position value */\r
-                       FoundData = USB_GetHIDReportItemInfo(MouseReport, ReportItem);\r
-                       \r
-                       /* For multi-report devices - if the requested data was not in the issued report, continue */\r
-                       if (!(FoundData))\r
-                         continue;\r
-                         \r
-                       int16_t DeltaMovement;\r
-                       \r
-                       if (ReportItem->Attributes.BitSize > 8)\r
-                         DeltaMovement = (int16_t)ReportItem->Value;\r
-                       else\r
-                         DeltaMovement = (int8_t)ReportItem->Value;\r
-                       \r
-                       /* Determine if the report is for the X or Y delta movement */\r
-                       if (ReportItem->Attributes.Usage.Usage == USAGE_X)\r
-                       {\r
-                               /* Turn on the appropriate LED according to direction if the delta is non-zero */\r
-                               if (DeltaMovement)\r
-                                 LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);\r
-                       }\r
-                       else\r
-                       {\r
-                               /* Turn on the appropriate LED according to direction if the delta is non-zero */\r
-                               if (DeltaMovement)\r
-                                 LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);\r
-                       }\r
+                       IsMouse = true;\r
+                       break;\r

                }\r
        }\r
                }\r
        }\r

-       \r
-       /* Display the button information on the board LEDs */\r
-       LEDs_SetAllLEDs(LEDMask);\r
-}
\ No newline at end of file
+\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 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