Demos/Host/ClassDriver/MouseHost/MouseHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2016.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2016  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 disclaims 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 MouseHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "MouseHost.h"
  38
  39 /** LUFA HID Class driver interface configuration and state information. This structure is
  40  *  passed to all HID Class driver functions, so that multiple instances of the same class
  41  *  within a device can be differentiated from one another.
  42  */
  43 USB_ClassInfo_HID_Host_t Mouse_HID_Interface =
  44         {
  45                 .Config =
  46                         {
  47                                 .DataINPipe             =
  48                                         {
  49                                                 .Address        = (PIPE_DIR_IN  | 1),
  50                                                 .Banks          = 1,
  51                                         },
  52                                 .DataOUTPipe            =
  53                                         {
  54                                                 .Address        = (PIPE_DIR_OUT | 2),
  55                                                 .Banks          = 1,
  56                                         },
  57                                 .HIDInterfaceProtocol   = HID_CSCP_MouseBootProtocol,
  58                         },
  59         };
  60
  61
  62 /** Main program entry point. This routine configures the hardware required by the application, then
  63  *  enters a loop to run the application tasks in sequence.
  64  */
  65 int main(void)
  66 {
  67         SetupHardware();
  68
  69         puts_P(PSTR(ESC_FG_CYAN "Mouse Host Demo running.\r\n" ESC_FG_WHITE));
  70
  71         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  72         GlobalInterruptEnable();
  73
  74         for (;;)
  75         {
  76                 MouseHost_Task();
  77
  78                 HID_Host_USBTask(&Mouse_HID_Interface);
  79                 USB_USBTask();
  80         }
  81 }
  82
  83 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  84 void SetupHardware(void)
  85 {
  86 #if (ARCH == ARCH_AVR8)
  87         /* Disable watchdog if enabled by bootloader/fuses */
  88         MCUSR &= ~(1 << WDRF);
  89         wdt_disable();
  90
  91         /* Disable clock division */
  92         clock_prescale_set(clock_div_1);
  93 #endif
  94
  95         /* Hardware Initialization */
  96         Serial_Init(9600, false);
  97         LEDs_Init();
  98         USB_Init();
  99
 100         /* Create a stdio stream for the serial port for stdin and stdout */
 101         Serial_CreateStream(NULL);
 102 }
 103
 104 /** Task to manage an enumerated USB mouse once connected, to display movement
 105  *  data as it is received.
 106  */
 107 void MouseHost_Task(void)
 108 {
 109         if (USB_HostState != HOST_STATE_Configured)
 110           return;
 111
 112         if (HID_Host_IsReportReceived(&Mouse_HID_Interface))
 113         {
 114                 uint8_t LEDMask = LEDS_NO_LEDS;
 115
 116                 USB_MouseReport_Data_t MouseReport;
 117                 HID_Host_ReceiveReport(&Mouse_HID_Interface, &MouseReport);
 118
 119                 printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,
 120                                                               MouseReport.Y,
 121                                                               MouseReport.Button);
 122                 if (MouseReport.X > 0)
 123                   LEDMask |= LEDS_LED1;
 124                 else if (MouseReport.X < 0)
 125                   LEDMask |= LEDS_LED2;
 126
 127                 if (MouseReport.Y > 0)
 128                   LEDMask |= LEDS_LED3;
 129                 else if (MouseReport.Y < 0)
 130                   LEDMask |= LEDS_LED4;
 131
 132                 if (MouseReport.Button)
 133                   LEDMask  = LEDS_ALL_LEDS;
 134
 135                 LEDs_SetAllLEDs(LEDMask);
 136         }
 137 }
 138
 139 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 140  *  starts the library USB task to begin the enumeration and USB management process.
 141  */
 142 void EVENT_USB_Host_DeviceAttached(void)
 143 {
 144         puts_P(PSTR("Device Attached.\r\n"));
 145         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 146 }
 147
 148 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 149  *  stops the library USB task management process.
 150  */
 151 void EVENT_USB_Host_DeviceUnattached(void)
 152 {
 153         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 154         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 155 }
 156
 157 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 158  *  enumerated by the host and is now ready to be used by the application.
 159  */
 160 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 161 {
 162         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 163
 164         uint16_t ConfigDescriptorSize;
 165         uint8_t  ConfigDescriptorData[512];
 166
 167         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 168                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 169         {
 170                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 171                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 172                 return;
 173         }
 174
 175         if (HID_Host_ConfigurePipes(&Mouse_HID_Interface,
 176                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 177         {
 178                 puts_P(PSTR("Attached Device Not a Valid Mouse.\r\n"));
 179                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 180                 return;
 181         }
 182
 183         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 184         {
 185                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 186                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 187                 return;
 188         }
 189
 190         if (HID_Host_SetBootProtocol(&Mouse_HID_Interface) != 0)
 191         {
 192                 puts_P(PSTR("Could not Set Boot Protocol Mode.\r\n"));
 193                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 194                 USB_Host_SetDeviceConfiguration(0);
 195                 return;
 196         }
 197
 198         puts_P(PSTR("Mouse Enumerated.\r\n"));
 199         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 200 }
 201
 202 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 203 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 204 {
 205         USB_Disable();
 206
 207         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 208                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 209
 210         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 211         for(;;);
 212 }
 213
 214 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 215  *  enumerating an attached USB device.
 216  */
 217 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 218                                             const uint8_t SubErrorCode)
 219 {
 220         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 221                                  " -- Error Code %d\r\n"
 222                                  " -- Sub Error Code %d\r\n"
 223                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 224
 225         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 226 }
 227