Demos/Host/ClassDriver/MouseHost/MouseHost.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 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                                 .DataOUTPipeNumber      = 2,
  49
  50                                 .HIDInterfaceProtocol   = HID_BOOT_MOUSE_PROTOCOL,
  51                         },
  52         };
  53
  54
  55 /** Main program entry point. This routine configures the hardware required by the application, then
  56  *  starts the scheduler to run the application tasks.
  57  */
  58 int main(void)
  59 {
  60         SetupHardware();
  61
  62         puts_P(PSTR(ESC_FG_CYAN "Mouse Host Demo running.\r\n" ESC_FG_WHITE));
  63
  64         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  65
  66         for (;;)
  67         {
  68                 switch (USB_HostState)
  69                 {
  70                         case HOST_STATE_Addressed:
  71                                 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  72
  73                                 uint16_t ConfigDescriptorSize;
  74                                 uint8_t  ConfigDescriptorData[512];
  75
  76                                 if (USB_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
  77                                                                   sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
  78                                 {
  79                                         printf("Error Retrieving Configuration Descriptor.\r\n");
  80                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  81                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
  82                                         break;
  83                                 }
  84
  85                                 if (HID_Host_ConfigurePipes(&Mouse_HID_Interface,
  86                                                             ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
  87                                 {
  88                                         printf("Attached Device Not a Valid Mouse.\r\n");
  89                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  90                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
  91                                         break;
  92                                 }
  93
  94                                 if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
  95                                 {
  96                                         printf("Error Setting Device Configuration.\r\n");
  97                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  98                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
  99                                         break;
 100                                 }
 101
 102                                 if (USB_HID_Host_SetBootProtocol(&Mouse_HID_Interface) != 0)
 103                                 {
 104                                         printf("Could not Set Boot Protocol Mode.\r\n");
 105                                         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 106                                         USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 107                                         break;
 108                                 }
 109
 110                                 printf("Mouse Enumerated.\r\n");
 111                                 USB_HostState = HOST_STATE_Configured;
 112                                 break;
 113                         case HOST_STATE_Configured:
 114                                 if (HID_Host_IsReportReceived(&Mouse_HID_Interface))
 115                                 {
 116                                         USB_MouseReport_Data_t MouseReport;
 117                                         uint8_t ReportID = 0;
 118                                         uint8_t LEDMask  = LEDS_NO_LEDS;
 119
 120                                         /* Receive next boot protocol mouse report from the device */
 121                                         HID_Host_ReceiveReport(&Mouse_HID_Interface, false, &ReportID, &MouseReport);
 122
 123                                         /* Print mouse report data through the serial port */
 124                                         printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,
 125                                                                                                                                   MouseReport.Y,
 126                                                                                                                                   MouseReport.Button);
 127
 128                                         /* Alter status LEDs according to mouse X movement */
 129                                         if (MouseReport.X > 0)
 130                                           LEDMask |= LEDS_LED1;
 131                                         else if (MouseReport.X < 0)
 132                                           LEDMask |= LEDS_LED2;
 133
 134                                         /* Alter status LEDs according to mouse Y movement */
 135                                         if (MouseReport.Y > 0)
 136                                           LEDMask |= LEDS_LED3;
 137                                         else if (MouseReport.Y < 0)
 138                                           LEDMask |= LEDS_LED4;
 139
 140                                         /* Alter status LEDs according to mouse button position */
 141                                         if (MouseReport.Button)
 142                                           LEDMask  = LEDS_ALL_LEDS;
 143
 144                                         LEDs_SetAllLEDs(LEDMask);
 145                                 }
 146
 147                                 break;
 148                 }
 149
 150                 HID_Host_USBTask(&Mouse_HID_Interface);
 151                 USB_USBTask();
 152         }
 153 }
 154
 155 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 156 void SetupHardware(void)
 157 {
 158         /* Disable watchdog if enabled by bootloader/fuses */
 159         MCUSR &= ~(1 << WDRF);
 160         wdt_disable();
 161
 162         /* Disable clock division */
 163         clock_prescale_set(clock_div_1);
 164
 165         /* Hardware Initialization */
 166         SerialStream_Init(9600, false);
 167         LEDs_Init();
 168         USB_Init();
 169 }
 170
 171 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 172  *  starts the library USB task to begin the enumeration and USB management process.
 173  */
 174 void EVENT_USB_Host_DeviceAttached(void)
 175 {
 176         puts_P(PSTR("Device Attached.\r\n"));
 177         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 178 }
 179
 180 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 181  *  stops the library USB task management process.
 182  */
 183 void EVENT_USB_Host_DeviceUnattached(void)
 184 {
 185         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 186         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 187 }
 188
 189 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 190  *  enumerated by the host and is now ready to be used by the application.
 191  */
 192 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 193 {
 194         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 195 }
 196
 197 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 198 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 199 {
 200         USB_ShutDown();
 201
 202         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 203                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 204
 205         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 206         for(;;);
 207 }
 208
 209 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 210  *  enumerating an attached USB device.
 211  */
 212 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, 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 }