Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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  *  starts the scheduler to run the application tasks.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
  47                "Mouse HID Parser Host Demo running.\r\n" ESC_INVERSE_OFF));
  48
  49         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  50
  51         for (;;)
  52         {
  53                 Mouse_HID_Task();
  54                 USB_USBTask();
  55         }
  56 }
  57
  58 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  59 void SetupHardware(void)
  60 {
  61         /* Disable watchdog if enabled by bootloader/fuses */
  62         MCUSR &= ~(1 << WDRF);
  63         wdt_disable();
  64
  65         /* Disable clock division */
  66         clock_prescale_set(clock_div_1);
  67
  68         /* Hardware Initialization */
  69         SerialStream_Init(9600, false);
  70         LEDs_Init();
  71         USB_Init();
  72 }
  73
  74 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  75  *  starts the library USB task to begin the enumeration and USB management process.
  76  */
  77 void EVENT_USB_DeviceAttached(void)
  78 {
  79         puts_P(PSTR("Device Attached.\r\n"));
  80         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  81 }
  82
  83 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  84  *  stops the library USB task management process.
  85  */
  86 void EVENT_USB_DeviceUnattached(void)
  87 {
  88         puts_P(PSTR("Device Unattached.\r\n"));
  89         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  90 }
  91
  92 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  93  *  enumerated by the host and is now ready to be used by the application.
  94  */
  95 void EVENT_USB_DeviceEnumerationComplete(void)
  96 {
  97         LEDs_SetAllLEDs(LEDMASK_USB_READY);
  98 }
  99
 100 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 101 void EVENT_USB_HostError(const uint8_t ErrorCode)
 102 {
 103         USB_ShutDown();
 104
 105         puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
 106         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 107
 108         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 109         for(;;);
 110 }
 111
 112 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 113  *  enumerating an attached USB device.
 114  */
 115 void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 116 {
 117         puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
 118         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 119         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 120         printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);
 121
 122         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 123 }
 124
 125 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 126  *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.
 127  */
 128 void Mouse_HID_Task(void)
 129 {
 130         uint8_t ErrorCode;
 131
 132         /* Switch to determine what user-application handled host state the host state machine is in */
 133         switch (USB_HostState)
 134         {
 135                 case HOST_STATE_Addressed:
 136                         puts_P(PSTR("Getting Config Data.\r\n"));
 137
 138                         /* Get and process the configuration descriptor data */
 139                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 140                         {
 141                                 if (ErrorCode == ControlError)
 142                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 143                                 else
 144                                   puts_P(PSTR("Invalid Device.\r\n"));
 145
 146                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 147
 148                                 /* Indicate error via status LEDs */
 149                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 150
 151                                 /* Wait until USB device disconnected */
 152                                 while (USB_IsConnected);
 153                                 break;
 154                         }
 155
 156                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 157                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 158                         {
 159                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 160                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 161
 162                                 /* Indicate error via status LEDs */
 163                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 164
 165                                 /* Wait until USB device disconnected */
 166                                 while (USB_IsConnected);
 167                                 break;
 168                         }
 169
 170                         USB_HostState = HOST_STATE_Configured;
 171                         break;
 172                 case HOST_STATE_Configured:
 173                         puts_P(PSTR("Processing HID Report.\r\n"));
 174
 175                         /* Get and process the device's first HID report descriptor */
 176                         if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)
 177                         {
 178                                 puts_P(PSTR("Report Parse Error.\r\n"));
 179                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 180
 181                                 /* Indicate error via status LEDs */
 182                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 183
 184                                 /* Wait until USB device disconnected */
 185                                 while (USB_IsConnected);
 186                                 break;
 187                         }
 188
 189                         puts_P(PSTR("Mouse Enumerated.\r\n"));
 190
 191                         USB_HostState = HOST_STATE_Ready;
 192                         break;
 193                 case HOST_STATE_Ready:
 194                         /* Select and unfreeze mouse data pipe */
 195                         Pipe_SelectPipe(MOUSE_DATAPIPE);
 196                         Pipe_Unfreeze();
 197
 198                         /* Check to see if a packet has been received */
 199                         if (Pipe_IsINReceived())
 200                         {
 201                                 /* Check if data has been received from the attached mouse */
 202                                 if (Pipe_IsReadWriteAllowed())
 203                                 {
 204                                         /* Create buffer big enough for the report */
 205                                         uint8_t MouseReport[Pipe_BytesInPipe()];
 206
 207                                         /* Load in the mouse report */
 208                                         Pipe_Read_Stream_LE(MouseReport, Pipe_BytesInPipe());
 209
 210                                         /* Process the read in mouse report from the device */
 211                                         ProcessMouseReport(MouseReport);
 212                                 }
 213
 214                                 /* Clear the IN endpoint, ready for next data packet */
 215                                 Pipe_ClearIN();
 216                         }
 217
 218                         /* Freeze mouse data pipe */
 219                         Pipe_Freeze();
 220                         break;
 221         }
 222 }
 223
 224 /** Processes a read HID report from an attached mouse, extracting out elements via the HID parser results
 225  *  as required and displays movement and button presses on the board LEDs.
 226  *
 227  *  \param[in] MouseReport  Pointer to a HID report from an attached mouse device
 228  */
 229 void ProcessMouseReport(uint8_t* MouseReport)
 230 {
 231         uint8_t LEDMask = LEDS_NO_LEDS;
 232
 233         /* Check each HID report item in turn, looking for mouse X/Y/button reports */
 234         for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 235         {
 236                 /* Create a temporary item pointer to the next report item */
 237                 HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 238
 239                 bool FoundData;
 240
 241                 if ((ReportItem->Attributes.Usage.Page       == USAGE_PAGE_BUTTON) &&
 242                         (ReportItem->ItemType                    == REPORT_ITEM_TYPE_In))
 243                 {
 244                         /* Get the mouse button value */
 245                         FoundData = USB_GetHIDReportItemInfo(MouseReport, ReportItem);
 246
 247                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 248                         if (!(FoundData))
 249                           continue;
 250
 251                         /* If button is pressed, all LEDs are turned on */
 252                         if (ReportItem->Value)
 253                           LEDMask = LEDS_ALL_LEDS;
 254                 }
 255                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 256                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 257                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 258                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 259                 {
 260                         /* Get the mouse relative position value */
 261                         FoundData = USB_GetHIDReportItemInfo(MouseReport, ReportItem);
 262
 263                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 264                         if (!(FoundData))
 265                           continue;
 266
 267                         int16_t DeltaMovement;
 268
 269                         if (ReportItem->Attributes.BitSize > 8)
 270                           DeltaMovement = (int16_t)ReportItem->Value;
 271                         else
 272                           DeltaMovement = (int8_t)ReportItem->Value;
 273
 274                         /* Determine if the report is for the X or Y delta movement */
 275                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 276                         {
 277                                 /* Turn on the appropriate LED according to direction if the delta is non-zero */
 278                                 if (DeltaMovement)
 279                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 280                         }
 281                         else
 282                         {
 283                                 /* Turn on the appropriate LED according to direction if the delta is non-zero */
 284                                 if (DeltaMovement)
 285                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 286                         }
 287                 }
 288         }
 289
 290         /* Display the button information on the board LEDs */
 291         LEDs_SetAllLEDs(LEDMask);
 292 }