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