Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2018.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2018  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 #if (ARCH == ARCH_AVR8)
  91         /* Disable watchdog if enabled by bootloader/fuses */
  92         MCUSR &= ~(1 << WDRF);
  93         wdt_disable();
  94
  95         /* Disable clock division */
  96         clock_prescale_set(clock_div_1);
  97 #endif
  98
  99         /* Hardware Initialization */
 100         Serial_Init(9600, false);
 101         LEDs_Init();
 102         USB_Init();
 103
 104         /* Create a stdio stream for the serial port for stdin and stdout */
 105         Serial_CreateStream(NULL);
 106 }
 107
 108 /** Task to manage an enumerated USB mouse once connected, to display movement
 109  *  data as it is received.
 110  */
 111 void MouseHost_Task(void)
 112 {
 113         if (USB_HostState != HOST_STATE_Configured)
 114           return;
 115
 116         if (HID_Host_IsReportReceived(&Mouse_HID_Interface))
 117         {
 118                 uint8_t MouseReport[Mouse_HID_Interface.State.LargestReportSize];
 119                 HID_Host_ReceiveReport(&Mouse_HID_Interface, &MouseReport);
 120
 121                 uint8_t LEDMask = LEDS_NO_LEDS;
 122
 123                 for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 124                 {
 125                         HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 126
 127                         /* Update the report item value if it is contained within the current report */
 128                         if (!(USB_GetHIDReportItemInfo(MouseReport, ReportItem)))
 129                           continue;
 130
 131                         /* Determine what report item is being tested, process updated value as needed */
 132                         if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&
 133                             (ReportItem->ItemType                     == HID_REPORT_ITEM_In))
 134                         {
 135                                 /* Buttons are numbered sequentially in their HID usages, button 1 is the left mouse button */
 136                                 uint8_t ButtonID = ReportItem->Attributes.Usage.Usage;
 137
 138                                 if ((ButtonID == 1) && (ReportItem->Value != 0))
 139                                   LEDMask = LEDS_ALL_LEDS;
 140                         }
 141                         else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 142                                  (ReportItem->Attributes.Usage.Usage  == USAGE_SCROLL_WHEEL)       &&
 143                                  (ReportItem->ItemType                == HID_REPORT_ITEM_In))
 144                         {
 145                                 /* Convert wheel data to a 16-bit signed value */
 146                                 int16_t WheelDelta = HID_ALIGN_DATA(ReportItem, int16_t);
 147
 148                                 if (WheelDelta)
 149                                   LEDMask = (LEDS_LED1 | LEDS_LED2 | ((WheelDelta > 0) ? LEDS_LED3 : LEDS_LED4));
 150                         }
 151                         else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 152                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 153                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 154                                  (ReportItem->ItemType                == HID_REPORT_ITEM_In))
 155                         {
 156                                 /* Convert X/Y movement to 16-bit signed value */
 157                                 int16_t DeltaMovement = HID_ALIGN_DATA(ReportItem, int16_t);
 158
 159                                 if (DeltaMovement)
 160                                 {
 161                                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 162                                           LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 163                                         else
 164                                           LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 165                                 }
 166                         }
 167                 }
 168
 169                 LEDs_SetAllLEDs(LEDMask);
 170         }
 171 }
 172
 173 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 174  *  starts the library USB task to begin the enumeration and USB management process.
 175  */
 176 void EVENT_USB_Host_DeviceAttached(void)
 177 {
 178         puts_P(PSTR("Device Attached.\r\n"));
 179         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 180 }
 181
 182 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 183  *  stops the library USB task management process.
 184  */
 185 void EVENT_USB_Host_DeviceUnattached(void)
 186 {
 187         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 188         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 189 }
 190
 191 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 192  *  enumerated by the host and is now ready to be used by the application.
 193  */
 194 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 195 {
 196         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 197
 198         uint16_t ConfigDescriptorSize;
 199         uint8_t  ConfigDescriptorData[512];
 200
 201         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 202                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 203         {
 204                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 205                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 206                 return;
 207         }
 208
 209         if (HID_Host_ConfigurePipes(&Mouse_HID_Interface,
 210                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 211         {
 212                 puts_P(PSTR("Attached Device Not a Valid Mouse.\r\n"));
 213                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 214                 return;
 215         }
 216
 217         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 218         {
 219                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 220                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 221                 return;
 222         }
 223
 224         if (HID_Host_SetReportProtocol(&Mouse_HID_Interface) != 0)
 225         {
 226                 puts_P(PSTR("Error Setting Report Protocol Mode or Not a Valid Mouse.\r\n"));
 227                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 228                 USB_Host_SetDeviceConfiguration(0);
 229                 return;
 230         }
 231
 232         puts_P(PSTR("Mouse Enumerated.\r\n"));
 233         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 234 }
 235
 236 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 237 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 238 {
 239         USB_Disable();
 240
 241         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 242                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 243
 244         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 245         for(;;);
 246 }
 247
 248 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 249  *  enumerating an attached USB device.
 250  */
 251 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 252                                             const uint8_t SubErrorCode)
 253 {
 254         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 255                                  " -- Error Code %d\r\n"
 256                                  " -- Sub Error Code %d\r\n"
 257                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 258
 259         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 260 }
 261
 262 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 263  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 264  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 265  *  have occupied).
 266  *
 267  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
 268  *
 269  *  \return Boolean \c true if the item should be stored into the HID report structure, \c false if it should be discarded
 270  */
 271 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
 272 {
 273         bool IsMouse = false;
 274
 275         /* Iterate through the item's collection path, until either the root collection node or a collection with the
 276          * Mouse Usage is found - this prevents Joysticks, which use identical descriptors except for the Joystick usage
 277          * parent node, from being erroneously treated as a mouse by the demo
 278          */
 279         for (HID_CollectionPath_t* CurrPath = CurrentItem->CollectionPath; CurrPath != NULL; CurrPath = CurrPath->Parent)
 280         {
 281                 if ((CurrPath->Usage.Page  == USAGE_PAGE_GENERIC_DCTRL) &&
 282                     (CurrPath->Usage.Usage == USAGE_MOUSE))
 283                 {
 284                         IsMouse = true;
 285                         break;
 286                 }
 287         }
 288
 289         /* If a collection with the mouse usage was not found, indicate that we are not interested in this item */
 290         if (!IsMouse)
 291           return false;
 292
 293         /* Check the attributes of the current item - see if we are interested in it or not;
 294          * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
 295          * structure to save RAM and ignore the rest
 296          */
 297         return ((CurrentItem->Attributes.Usage.Page == USAGE_PAGE_BUTTON) ||
 298                 (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_GENERIC_DCTRL));
 299 }
 300