Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the MouseHostWithParser demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "MouseHostWithParser.h"
  38
  39 /** Processed HID report descriptor items structure, containing information on each HID report element */
  40 static HID_ReportInfo_t HIDReportInfo;
  41
  42 /** LUFA HID Class driver interface configuration and state information. This structure is
  43  *  passed to all HID Class driver functions, so that multiple instances of the same class
  44  *  within a device can be differentiated from one another.
  45  */
  46 USB_ClassInfo_HID_Host_t Mouse_HID_Interface =
  47         {
  48                 .Config =
  49                         {
  50                                 .DataINPipe             =
  51                                         {
  52                                                 .Address        = (PIPE_DIR_IN  | 1),
  53                                                 .Banks          = 1,
  54                                         },
  55                                 .DataOUTPipe            =
  56                                         {
  57                                                 .Address        = (PIPE_DIR_OUT | 2),
  58                                                 .Banks          = 1,
  59                                         },
  60                                 .HIDInterfaceProtocol   = HID_CSCP_NonBootProtocol,
  61                                 .HIDParserData          = &HIDReportInfo
  62                         },
  63         };
  64
  65
  66 /** Main program entry point. This routine configures the hardware required by the application, then
  67  *  enters a loop to run the application tasks in sequence.
  68  */
  69 int main(void)
  70 {
  71         SetupHardware();
  72
  73         puts_P(PSTR(ESC_FG_CYAN "Mouse Host Demo running.\r\n" ESC_FG_WHITE));
  74
  75         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  76         GlobalInterruptEnable();
  77
  78         for (;;)
  79         {
  80                 MouseHost_Task();
  81
  82                 HID_Host_USBTask(&Mouse_HID_Interface);
  83                 USB_USBTask();
  84         }
  85 }
  86
  87 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  88 void SetupHardware(void)
  89 {
  90         /* Disable watchdog if enabled by bootloader/fuses */
  91         MCUSR &= ~(1 << WDRF);
  92         wdt_disable();
  93
  94         /* Disable clock division */
  95         clock_prescale_set(clock_div_1);
  96
  97         /* Hardware Initialization */
  98         Serial_Init(9600, false);
  99         LEDs_Init();
 100         USB_Init();
 101
 102         /* Create a stdio stream for the serial port for stdin and stdout */
 103         Serial_CreateStream(NULL);
 104 }
 105
 106 /** Task to manage an enumerated USB mouse once connected, to display movement
 107  *  data as it is received.
 108  */
 109 void MouseHost_Task(void)
 110 {
 111         if (USB_HostState != HOST_STATE_Configured)
 112           return;
 113
 114         if (HID_Host_IsReportReceived(&Mouse_HID_Interface))
 115         {
 116                 uint8_t MouseReport[Mouse_HID_Interface.State.LargestReportSize];
 117                 HID_Host_ReceiveReport(&Mouse_HID_Interface, &MouseReport);
 118
 119                 uint8_t LEDMask = LEDS_NO_LEDS;
 120
 121                 for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 122                 {
 123                         HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 124
 125                         /* Update the report item value if it is contained within the current report */
 126                         if (!(USB_GetHIDReportItemInfo(MouseReport, ReportItem)))
 127                           continue;
 128
 129                         /* Determine what report item is being tested, process updated value as needed */
 130                         if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&
 131                             (ReportItem->ItemType                     == HID_REPORT_ITEM_In))
 132                         {
 133                                 if (ReportItem->Value)
 134                                   LEDMask = LEDS_ALL_LEDS;
 135                         }
 136                         else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 137                                  (ReportItem->Attributes.Usage.Usage  == USAGE_SCROLL_WHEEL)       &&
 138                                  (ReportItem->ItemType                == HID_REPORT_ITEM_In))
 139                         {
 140                                 int16_t WheelDelta = HID_ALIGN_DATA(ReportItem, int16_t);
 141
 142                                 if (WheelDelta)
 143                                   LEDMask = (LEDS_LED1 | LEDS_LED2 | ((WheelDelta > 0) ? LEDS_LED3 : LEDS_LED4));
 144                         }
 145                         else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 146                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 147                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 148                                  (ReportItem->ItemType                == HID_REPORT_ITEM_In))
 149                         {
 150                                 int16_t DeltaMovement = HID_ALIGN_DATA(ReportItem, int16_t);
 151
 152                                 if (DeltaMovement)
 153                                 {
 154                                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 155                                           LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 156                                         else
 157                                           LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 158                                 }
 159                         }
 160                 }
 161
 162                 LEDs_SetAllLEDs(LEDMask);
 163         }
 164 }
 165
 166 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 167  *  starts the library USB task to begin the enumeration and USB management process.
 168  */
 169 void EVENT_USB_Host_DeviceAttached(void)
 170 {
 171         puts_P(PSTR("Device Attached.\r\n"));
 172         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 173 }
 174
 175 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 176  *  stops the library USB task management process.
 177  */
 178 void EVENT_USB_Host_DeviceUnattached(void)
 179 {
 180         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 181         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 182 }
 183
 184 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 185  *  enumerated by the host and is now ready to be used by the application.
 186  */
 187 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 188 {
 189         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 190
 191         uint16_t ConfigDescriptorSize;
 192         uint8_t  ConfigDescriptorData[512];
 193
 194         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 195                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 196         {
 197                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 198                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 199                 return;
 200         }
 201
 202         if (HID_Host_ConfigurePipes(&Mouse_HID_Interface,
 203                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 204         {
 205                 puts_P(PSTR("Attached Device Not a Valid Mouse.\r\n"));
 206                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 207                 return;
 208         }
 209
 210         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 211         {
 212                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 213                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 214                 return;
 215         }
 216
 217         if (HID_Host_SetReportProtocol(&Mouse_HID_Interface) != 0)
 218         {
 219                 puts_P(PSTR("Error Setting Report Protocol Mode or Not a Valid Mouse.\r\n"));
 220                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 221                 USB_Host_SetDeviceConfiguration(0);
 222                 return;
 223         }
 224
 225         puts_P(PSTR("Mouse Enumerated.\r\n"));
 226         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 227 }
 228
 229 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 230 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 231 {
 232         USB_Disable();
 233
 234         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 235                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 236
 237         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 238         for(;;);
 239 }
 240
 241 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 242  *  enumerating an attached USB device.
 243  */
 244 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 245                                             const uint8_t SubErrorCode)
 246 {
 247         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 248                                  " -- Error Code %d\r\n"
 249                                  " -- Sub Error Code %d\r\n"
 250                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 251
 252         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 253 }
 254
 255 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 256  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 257  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 258  *  have occupied).
 259  *
 260  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
 261  *
 262  *  \return Boolean \c true if the item should be stored into the HID report structure, \c false if it should be discarded
 263  */
 264 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
 265 {
 266         bool IsMouse = false;
 267
 268         /* Iterate through the item's collection path, until either the root collection node or a collection with the
 269          * Mouse Usage is found - this prevents Joysticks, which use identical descriptors except for the Joystick usage
 270          * parent node, from being erroneously treated as a mouse by the demo
 271          */
 272         for (HID_CollectionPath_t* CurrPath = CurrentItem->CollectionPath; CurrPath != NULL; CurrPath = CurrPath->Parent)
 273         {
 274                 if ((CurrPath->Usage.Page  == USAGE_PAGE_GENERIC_DCTRL) &&
 275                     (CurrPath->Usage.Usage == USAGE_MOUSE))
 276                 {
 277                         IsMouse = true;
 278                         break;
 279                 }
 280         }
 281
 282         /* If a collection with the mouse usage was not found, indicate that we are not interested in this item */
 283         if (!IsMouse)
 284           return false;
 285
 286         /* Check the attributes of the current item - see if we are interested in it or not;
 287          * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
 288          * structure to save RAM and ignore the rest
 289          */
 290         return ((CurrentItem->Attributes.Usage.Page == USAGE_PAGE_BUTTON) ||
 291                 (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_GENERIC_DCTRL));
 292 }
 293