Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c

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