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