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_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_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_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_HostError(const uint8_t ErrorCode)
 101 {
 102         USB_ShutDown();
 103
 104         puts_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"));
 105         printf_P(PSTR(" -- 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_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 115 {
 116         puts_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"));
 117         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 118         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 119         printf_P(PSTR(" -- In State %d\r\n" ESC_FG_WHITE), 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                                 puts_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"));
 159                                 printf_P(PSTR(" -- 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                         puts_P(PSTR("Processing HID Report.\r\n"));
 170
 171                         /* Get and process the device's first HID report descriptor */
 172                         if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)
 173                         {
 174                                 puts_P(PSTR(ESC_FG_RED "Report Parse Error.\r\n"));
 175                                 printf_P(PSTR(" -- 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                         puts_P(PSTR("Mouse Enumerated.\r\n"));
 186
 187                         USB_HostState = HOST_STATE_Configured;
 188                         break;
 189                 case HOST_STATE_Configured:
 190                         /* Select and unfreeze mouse data pipe */
 191                         Pipe_SelectPipe(MOUSE_DATAPIPE);
 192                         Pipe_Unfreeze();
 193
 194                         /* Check to see if a packet has been received */
 195                         if (Pipe_IsINReceived())
 196                         {
 197                                 /* Check if data has been received from the attached mouse */
 198                                 if (Pipe_IsReadWriteAllowed())
 199                                 {
 200                                         /* Create buffer big enough for the report */
 201                                         uint8_t MouseReport[Pipe_BytesInPipe()];
 202
 203                                         /* Load in the mouse report */
 204                                         Pipe_Read_Stream_LE(MouseReport, Pipe_BytesInPipe());
 205
 206                                         /* Process the read in mouse report from the device */
 207                                         ProcessMouseReport(MouseReport);
 208                                 }
 209
 210                                 /* Clear the IN endpoint, ready for next data packet */
 211                                 Pipe_ClearIN();
 212                         }
 213
 214                         /* Freeze mouse data pipe */
 215                         Pipe_Freeze();
 216                         break;
 217         }
 218 }
 219
 220 /** Processes a read HID report from an attached mouse, extracting out elements via the HID parser results
 221  *  as required and displays movement and button presses on the board LEDs.
 222  *
 223  *  \param[in] MouseReport  Pointer to a HID report from an attached mouse device
 224  */
 225 void ProcessMouseReport(uint8_t* MouseReport)
 226 {
 227         uint8_t LEDMask = LEDS_NO_LEDS;
 228
 229         /* Check each HID report item in turn, looking for mouse X/Y/button reports */
 230         for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 231         {
 232                 /* Create a temporary item pointer to the next report item */
 233                 HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 234
 235                 bool FoundData;
 236
 237                 if ((ReportItem->Attributes.Usage.Page       == USAGE_PAGE_BUTTON) &&
 238                         (ReportItem->ItemType                    == REPORT_ITEM_TYPE_In))
 239                 {
 240                         /* Get the mouse button value */
 241                         FoundData = USB_GetHIDReportItemInfo(MouseReport, ReportItem);
 242
 243                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 244                         if (!(FoundData))
 245                           continue;
 246
 247                         /* If button is pressed, all LEDs are turned on */
 248                         if (ReportItem->Value)
 249                           LEDMask = LEDS_ALL_LEDS;
 250                 }
 251                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 252                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 253                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 254                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 255                 {
 256                         /* Get the mouse relative position value */
 257                         FoundData = USB_GetHIDReportItemInfo(MouseReport, ReportItem);
 258
 259                         /* For multi-report devices - if the requested data was not in the issued report, continue */
 260                         if (!(FoundData))
 261                           continue;
 262
 263                         int16_t DeltaMovement;
 264
 265                         if (ReportItem->Attributes.BitSize > 8)
 266                           DeltaMovement = (int16_t)ReportItem->Value;
 267                         else
 268                           DeltaMovement = (int8_t)ReportItem->Value;
 269
 270                         /* Determine if the report is for the X or Y delta movement */
 271                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 272                         {
 273                                 /* Turn on the appropriate LED according to direction if the delta is non-zero */
 274                                 if (DeltaMovement)
 275                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 276                         }
 277                         else
 278                         {
 279                                 /* Turn on the appropriate LED according to direction if the delta is non-zero */
 280                                 if (DeltaMovement)
 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 }