Demos/Host/ClassDriver/MouseHost/MouseHost.c

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