Demos/Host/ClassDriver/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 /** Processed HID report descriptor items structure, containing information on each HID report element */
  40 HID_ReportInfo_t HIDReportInfo;
  41
  42 /** LUFA HID Class driver interface configuration and state information. This structure is
  43  *  passed to all HID Class driver functions, so that multiple instances of the same class
  44  *  within a device can be differentiated from one another.
  45  */
  46 USB_ClassInfo_HID_Host_t Mouse_HID_Interface =
  47         {
  48                 .Config =
  49                         {
  50                                 .DataINPipeNumber       = 1,
  51                                 .DataOUTPipeNumber      = 2,
  52
  53                                 .HIDInterfaceProtocol   = HID_NON_BOOT_PROTOCOL,
  54
  55                                 .HIDParserData          = &HIDReportInfo
  56                         },
  57         };
  58
  59
  60 /** Main program entry point. This routine configures the hardware required by the application, then
  61  *  starts the scheduler to run the application tasks.
  62  */
  63 int main(void)
  64 {
  65         SetupHardware();
  66
  67         puts_P(PSTR(ESC_FG_CYAN "Mouse Host Demo running.\r\n" ESC_FG_WHITE));
  68
  69         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  70
  71         for (;;)
  72         {
  73                 switch (USB_HostState)
  74                 {
  75                         case HOST_STATE_Addressed:
  76                                 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  77
  78                                 uint16_t ConfigDescriptorSize;
  79                                 uint8_t  ConfigDescriptorData[512];
  80
  81                                 if (USB_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
  82                                                                   sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
  83                                 {
  84                                         printf("Error Retrieving Configuration Descriptor.\r\n");
  85                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  86                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
  87                                         break;
  88                                 }
  89
  90                                 if (HID_Host_ConfigurePipes(&Mouse_HID_Interface,
  91                                                             ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
  92                                 {
  93                                         printf("Attached Device Not a Valid Mouse.\r\n");
  94                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  95                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
  96                                         break;
  97                                 }
  98
  99                                 if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 100                                 {
 101                                         printf("Error Setting Device Configuration.\r\n");
 102                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 103                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 104                                         break;
 105                                 }
 106
 107                                 if (HID_Host_SetReportProtocol(&Mouse_HID_Interface) != 0)
 108                                 {
 109                                         printf("Error Setting Report Protocol Mode or Not a Valid Mouse.\r\n");
 110                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 111                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 112                                         break;
 113                                 }
 114
 115                                 LEDs_SetAllLEDs(LEDS_NO_LEDS);
 116
 117                                 printf("Mouse Enumerated.\r\n");
 118                                 USB_HostState = HOST_STATE_Configured;
 119                                 break;
 120                         case HOST_STATE_Configured:
 121                                 if (HID_Host_IsReportReceived(&Mouse_HID_Interface))
 122                                 {
 123                                         uint8_t MouseReport[Mouse_HID_Interface.State.LargestReportSize];
 124                                         HID_Host_ReceiveReport(&Mouse_HID_Interface, &MouseReport);
 125
 126                                         uint8_t LEDMask = LEDS_NO_LEDS;
 127
 128                                         for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
 129                                         {
 130                                                 HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
 131
 132                                                 if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) &&
 133                                                         (ReportItem->ItemType                     == REPORT_ITEM_TYPE_In))
 134                                                 {
 135                                                         /* Get the mouse button value if it is contained within the current report, if not,
 136                                                          * skip to the next item in the parser list
 137                                                          */
 138                                                         if (!(USB_GetHIDReportItemInfo(MouseReport, ReportItem)))
 139                                                           continue;
 140
 141                                                         if (ReportItem->Value)
 142                                                           LEDMask = LEDS_ALL_LEDS;
 143                                                 }
 144                                                 else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) &&
 145                                                                  ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  ||
 146                                                                   (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 &&
 147                                                                  (ReportItem->ItemType                == REPORT_ITEM_TYPE_In))
 148                                                 {
 149                                                         /* Get the mouse relative position value if it is contained within the current
 150                                                          * report, if not, skip to the next item in the parser list
 151                                                          */
 152                                                         if (!(USB_GetHIDReportItemInfo(MouseReport, ReportItem)))
 153                                                           continue;
 154
 155                                                         int16_t DeltaMovement = (int16_t)(ReportItem->Value << (16 - ReportItem->Attributes.BitSize));
 156
 157                                                         if (ReportItem->Attributes.Usage.Usage == USAGE_X)
 158                                                         {
 159                                                                 if (DeltaMovement)
 160                                                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2);
 161                                                         }
 162                                                         else
 163                                                         {
 164                                                                 if (DeltaMovement)
 165                                                                   LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4);
 166                                                         }
 167                                                 }
 168                                         }
 169
 170                                         LEDs_SetAllLEDs(LEDMask);
 171                                 }
 172
 173                                 break;
 174                 }
 175
 176                 HID_Host_USBTask(&Mouse_HID_Interface);
 177                 USB_USBTask();
 178         }
 179 }
 180
 181 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 182 void SetupHardware(void)
 183 {
 184         /* Disable watchdog if enabled by bootloader/fuses */
 185         MCUSR &= ~(1 << WDRF);
 186         wdt_disable();
 187
 188         /* Disable clock division */
 189         clock_prescale_set(clock_div_1);
 190
 191         /* Hardware Initialization */
 192         SerialStream_Init(9600, false);
 193         LEDs_Init();
 194         USB_Init();
 195 }
 196
 197 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 198  *  starts the library USB task to begin the enumeration and USB management process.
 199  */
 200 void EVENT_USB_Host_DeviceAttached(void)
 201 {
 202         puts_P(PSTR("Device Attached.\r\n"));
 203         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 204 }
 205
 206 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 207  *  stops the library USB task management process.
 208  */
 209 void EVENT_USB_Host_DeviceUnattached(void)
 210 {
 211         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 212         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 213 }
 214
 215 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 216  *  enumerated by the host and is now ready to be used by the application.
 217  */
 218 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 219 {
 220         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 221 }
 222
 223 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 224 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 225 {
 226         USB_ShutDown();
 227
 228         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 229                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 230
 231         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 232         for(;;);
 233 }
 234
 235 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 236  *  enumerating an attached USB device.
 237  */
 238 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 239 {
 240         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 241                                  " -- Error Code %d\r\n"
 242                                  " -- Sub Error Code %d\r\n"
 243                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 244
 245         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 246 }
 247
 248 /** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
 249  *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
 250  *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
 251  *  have occupied).
 252  *
 253  *  \param[in] CurrentItemAttributes  Pointer to the attrbutes of the item the HID report parser is currently working with
 254  *
 255  *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
 256  */
 257 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_Attributes_t* CurrentItemAttributes)
 258 {
 259         /* Check the attributes of the current item - see if we are interested in it or not;
 260          * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
 261          * structure to save RAM and ignore the rest
 262          */
 263         return ((CurrentItemAttributes->Usage.Page == USAGE_PAGE_BUTTON) ||
 264                 (CurrentItemAttributes->Usage.Page == USAGE_PAGE_GENERIC_DCTRL))
 265 }