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