Demos/Host/ClassDriver/MouseHost/MouseHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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 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 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         sei();
  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         /* Disable watchdog if enabled by bootloader/fuses */
  87         MCUSR &= ~(1 << WDRF);
  88         wdt_disable();
  89
  90         /* Disable clock division */
  91         clock_prescale_set(clock_div_1);
  92
  93         /* Hardware Initialization */
  94         Serial_Init(9600, false);
  95         LEDs_Init();
  96         USB_Init();
  97
  98         /* Create a stdio stream for the serial port for stdin and stdout */
  99         Serial_CreateStream(NULL);
 100 }
 101
 102 /** Task to manage an enumerated USB mouse once connected, to display movement
 103  *  data as it is received.
 104  */
 105 void MouseHost_Task(void)
 106 {
 107         if (USB_HostState != HOST_STATE_Configured)
 108           return;
 109
 110         if (HID_Host_IsReportReceived(&Mouse_HID_Interface))
 111         {
 112                 uint8_t LEDMask = LEDS_NO_LEDS;
 113
 114                 USB_MouseReport_Data_t MouseReport;
 115                 HID_Host_ReceiveReport(&Mouse_HID_Interface, &MouseReport);
 116
 117                 printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,
 118                                                               MouseReport.Y,
 119                                                               MouseReport.Button);
 120                 if (MouseReport.X > 0)
 121                   LEDMask |= LEDS_LED1;
 122                 else if (MouseReport.X < 0)
 123                   LEDMask |= LEDS_LED2;
 124
 125                 if (MouseReport.Y > 0)
 126                   LEDMask |= LEDS_LED3;
 127                 else if (MouseReport.Y < 0)
 128                   LEDMask |= LEDS_LED4;
 129
 130                 if (MouseReport.Button)
 131                   LEDMask  = LEDS_ALL_LEDS;
 132
 133                 LEDs_SetAllLEDs(LEDMask);
 134         }
 135 }
 136
 137 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 138  *  starts the library USB task to begin the enumeration and USB management process.
 139  */
 140 void EVENT_USB_Host_DeviceAttached(void)
 141 {
 142         puts_P(PSTR("Device Attached.\r\n"));
 143         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 144 }
 145
 146 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 147  *  stops the library USB task management process.
 148  */
 149 void EVENT_USB_Host_DeviceUnattached(void)
 150 {
 151         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 152         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 153 }
 154
 155 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 156  *  enumerated by the host and is now ready to be used by the application.
 157  */
 158 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 159 {
 160         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 161
 162         uint16_t ConfigDescriptorSize;
 163         uint8_t  ConfigDescriptorData[512];
 164
 165         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 166                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 167         {
 168                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 169                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 170                 return;
 171         }
 172
 173         if (HID_Host_ConfigurePipes(&Mouse_HID_Interface,
 174                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 175         {
 176                 puts_P(PSTR("Attached Device Not a Valid Mouse.\r\n"));
 177                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 178                 return;
 179         }
 180
 181         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 182         {
 183                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 184                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 185                 return;
 186         }
 187
 188         if (HID_Host_SetBootProtocol(&Mouse_HID_Interface) != 0)
 189         {
 190                 puts_P(PSTR("Could not Set Boot Protocol Mode.\r\n"));
 191                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 192                 USB_Host_SetDeviceConfiguration(0);
 193                 return;
 194         }
 195
 196         puts_P(PSTR("Mouse Enumerated.\r\n"));
 197         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 198 }
 199
 200 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 201 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 202 {
 203         USB_Disable();
 204
 205         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 206                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 207
 208         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 209         for(;;);
 210 }
 211
 212 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 213  *  enumerating an attached USB device.
 214  */
 215 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 216                                             const uint8_t SubErrorCode)
 217 {
 218         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 219                                  " -- Error Code %d\r\n"
 220                                  " -- Sub Error Code %d\r\n"
 221                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 222
 223         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 224 }
 225