Demos/Host/LowLevel/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 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_FG_CYAN "Mouse HID Parser Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         GlobalInterruptEnable();
  50
  51         for (;;)
  52         {
  53                 MouseHost_Task();
  54
  55                 USB_USBTask();
  56         }
  57 }
  58
  59 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  60 void SetupHardware(void)
  61 {
  62 #if (ARCH == ARCH_AVR8)
  63         /* Disable watchdog if enabled by bootloader/fuses */
  64         MCUSR &= ~(1 << WDRF);
  65         wdt_disable();
  66
  67         /* Disable clock division */
  68         clock_prescale_set(clock_div_1);
  69 #endif
  70
  71         /* Hardware Initialization */
  72         Serial_Init(9600, false);
  73         LEDs_Init();
  74         USB_Init();
  75
  76         /* Create a stdio stream for the serial port for stdin and stdout */
  77         Serial_CreateStream(NULL);
  78 }
  79
  80 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  81  *  starts the library USB task to begin the enumeration and USB management process.
  82  */
  83 void EVENT_USB_Host_DeviceAttached(void)
  84 {
  85         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  86         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  87 }
  88
  89 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  90  *  stops the library USB task management process.
  91  */
  92 void EVENT_USB_Host_DeviceUnattached(void)
  93 {
  94         puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
  95         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  96 }
  97
  98 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  99  *  enumerated by the host and is now ready to be used by the application.
 100  */
 101 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 102 {
 103         puts_P(PSTR("Getting Config Data.\r\n"));
 104
 105         uint8_t ErrorCode;
 106
 107         /* Get and process the configuration descriptor data */
 108         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 109         {
 110                 if (ErrorCode == ControlError)
 111                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 112                 else
 113                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 114
 115                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 116
 117                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 118                 return;
 119         }
 120
 121         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 122         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 123         {
 124                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 125                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 126
 127                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 128                 return;
 129         }
 130
 131         printf_P(PSTR("Processing HID Report (Size %d Bytes).\r\n"), HIDReportSize);
 132
 133         /* Get and process the device's first HID report descriptor */
 134         if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)
 135         {
 136                 puts_P(PSTR(ESC_FG_RED "Report Parse Error.\r\n"));
 137
 138                 if (!(HIDReportInfo.TotalReportItems))
 139                         puts_P(PSTR("Not a valid Mouse." ESC_FG_WHITE));
 140                 else
 141                         printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 142
 143                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 144                 USB_Host_SetDeviceConfiguration(0);
 145                 return;
 146         }
 147
 148         puts_P(PSTR("Mouse Enumerated.\r\n"));
 149         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 150 }
 151
 152 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 153 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 154 {
 155         USB_Disable();
 156
 157         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 158                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 159
 160         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 161         for(;;);
 162 }
 163
 164 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 165  *  enumerating an attached USB device.
 166  */
 167 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 168                                             const uint8_t SubErrorCode)
 169 {
 170         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 171                                  " -- Error Code %d\r\n"
 172                                  " -- Sub Error Code %d\r\n"
 173                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 174
 175         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 176 }
 177
 178 /** Task to read and process the HID report descriptor and HID reports from the device and display the
 179  *  results onto the board LEDs.
 180  */
 181 void MouseHost_Task(void)
 182 {
 183         if (USB_HostState != HOST_STATE_Configured)
 184           return;
 185
 186         /* Select and unfreeze mouse data pipe */
 187         Pipe_SelectPipe(MOUSE_DATA_IN_PIPE);
 188         Pipe_Unfreeze();
 189
 190         /* Check to see if a packet has been received */
 191         if (Pipe_IsINReceived())
 192         {
 193                 /* Check if data has been received from the attached mouse */
 194                 if (Pipe_IsReadWriteAllowed())
 195                 {
 196                         /* Create buffer big enough for the report */
 197                         uint8_t MouseReport[Pipe_BytesInPipe()];
 198
 199                         /* Load in the mouse report */
 200                         Pipe_Read_Stream_LE(MouseReport, Pipe_BytesInPipe(), NULL);
 201
 202                         /* Process the read in mouse report from the device */
 203                         ProcessMouseReport(MouseReport);
 204                 }
 205
 206                 /* Clear the IN endpoint, ready for next data packet */
 207                 Pipe_ClearIN();
 208         }
 209
 210         /* Freeze mouse data pipe */
 211         Pipe_Freeze();
 212 }
 213
 214 /** Processes a read HID report from an attached mouse, extracting out elements via the HID parser results
 215  *  as required and displays movement and button presses on the board LEDs.
 216  *
 217  *  \param[in] MouseReport  Pointer to a HID report from an attached mouse device
 218  */
 219 void ProcessMouseReport(uint8_t* MouseReport)
 220 {
 221         uint8_t LEDMask = LEDS_NO_LEDS;
 222
 223         /* Check each HID report item in turn, looking for mouse X/Y/button reports */
 224         for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 225         {
 226                 /* Create a temporary item pointer to the next report item */
 227                 HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 228
 229                 bool FoundData;
 230
 231                 if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&
 232                         (ReportItem->ItemType                     == HID_REPORT_ITEM_In))
 233                 {
 234                         /* Get the mouse button value */
 235                         FoundData = USB_GetHIDReportItemInfo(MouseReport, ReportItem);
 236
 237                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 238                         if (!(FoundData))
 239                           continue;
 240
 241                         /* If button is pressed, all LEDs are turned on */
 242                         if (ReportItem->Value)
 243                           LEDMask = LEDS_ALL_LEDS;
 244                 }
 245                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 246                                  (ReportItem->Attributes.Usage.Usage  == USAGE_SCROLL_WHEEL)       &&
 247                                  (ReportItem->ItemType                == HID_REPORT_ITEM_In))
 248                 {
 249                         /* Get the mouse wheel value if it is contained within the current
 250                          * report, if not, skip to the next item in the parser list
 251                          */
 252                         if (!(USB_GetHIDReportItemInfo(MouseReport, ReportItem)))
 253                           continue;
 254
 255                         int16_t WheelDelta = HID_ALIGN_DATA(ReportItem, int16_t);
 256
 257                         if (WheelDelta)
 258                           LEDMask = (LEDS_LED1 | LEDS_LED2 | ((WheelDelta > 0) ? LEDS_LED3 : LEDS_LED4));
 259                 }
 260                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 261                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 262                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 263                                  (ReportItem->ItemType                == HID_REPORT_ITEM_In))
 264                 {
 265                         /* Get the mouse relative position value */
 266                         FoundData = USB_GetHIDReportItemInfo(MouseReport, ReportItem);
 267
 268                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 269                         if (!(FoundData))
 270                           continue;
 271
 272                         int16_t DeltaMovement = HID_ALIGN_DATA(ReportItem, int16_t);
 273
 274                         /* Check to see if a (non-zero) delta movement has been indicated */
 275                         if (DeltaMovement)
 276                         {
 277                                 /* Determine if the report is for the X or Y delta movement, light LEDs as appropriate */
 278                                 if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 279                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 280                                 else
 281                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 282                         }
 283                 }
 284         }
 285
 286         /* Display the button information on the board LEDs */
 287         LEDs_SetAllLEDs(LEDMask);
 288 }
 289