Demos/DualRole/ClassDriver/MouseHostDevice/HostFunctions.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  *  Host Mode USB Mouse functionality for the MouseHostDevice demo. This file contains the Host mode
  34  *  USB Mouse related code of the demo and is responsible for all the Host mode Mouse functionality.
  35  */
  36
  37 #include "HostFunctions.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_Host_Interface =
  44         {
  45                 .Config =
  46                         {
  47                                 .DataINPipeNumber       = 1,
  48                                 .DataOUTPipeNumber      = 2,
  49
  50                                 .HIDInterfaceProtocol   = HID_CSCP_MouseBootProtocol,
  51                         },
  52         };
  53
  54
  55 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  56  *  starts the library USB task to begin the enumeration and USB management process.
  57  */
  58 void EVENT_USB_Host_DeviceAttached(void)
  59 {
  60         puts_P(PSTR("Device Attached.\r\n"));
  61         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  62 }
  63
  64 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  65  *  stops the library USB task management process.
  66  */
  67 void EVENT_USB_Host_DeviceUnattached(void)
  68 {
  69         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
  70         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  71 }
  72
  73 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  74  *  enumerated by the host and is now ready to be used by the application.
  75  */
  76 void EVENT_USB_Host_DeviceEnumerationComplete(void)
  77 {
  78         LEDs_SetAllLEDs(LEDMASK_USB_READY);
  79 }
  80
  81 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
  82 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
  83 {
  84         USB_Disable();
  85
  86         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
  87                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
  88
  89         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  90         for(;;);
  91 }
  92
  93 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
  94  *  enumerating an attached USB device.
  95  */
  96 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
  97                                             const uint8_t SubErrorCode)
  98 {
  99         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 100                                  " -- Error Code %d\r\n"
 101                                  " -- Sub Error Code %d\r\n"
 102                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 103
 104         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 105 }
 106
 107 /** Host state machine task. This task handles the enumeration and control of USB Mice while in USB Host mode,
 108  *  setting up the appropriate data pipes and processing reports from the attached device.
 109  */
 110 void MouseHostTask(void)
 111 {
 112         switch (USB_HostState)
 113         {
 114                 case HOST_STATE_Addressed:
 115                         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 116
 117                         uint16_t ConfigDescriptorSize;
 118                         uint8_t  ConfigDescriptorData[512];
 119
 120                         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 121                                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 122                         {
 123                                 printf("Error Retrieving Configuration Descriptor.\r\n");
 124                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 125                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 126                                 break;
 127                         }
 128
 129                         if (HID_Host_ConfigurePipes(&Mouse_HID_Host_Interface,
 130                                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 131                         {
 132                                 printf("Attached Device Not a Valid Mouse.\r\n");
 133                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 134                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 135                                 break;
 136                         }
 137
 138                         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 139                         {
 140                                 printf("Error Setting Device Configuration.\r\n");
 141                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 142                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 143                                 break;
 144                         }
 145
 146                         if (HID_Host_SetBootProtocol(&Mouse_HID_Host_Interface) != HOST_SENDCONTROL_Successful)
 147                         {
 148                                 printf("Could not Set Boot Protocol Mode.\r\n");
 149                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 150                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 151                                 break;
 152                         }
 153
 154                         printf("Mouse Enumerated.\r\n");
 155                         USB_HostState = HOST_STATE_Configured;
 156                         break;
 157                 case HOST_STATE_Configured:
 158                         if (HID_Host_IsReportReceived(&Mouse_HID_Host_Interface))
 159                         {
 160                                 uint8_t LEDMask  = LEDS_NO_LEDS;
 161
 162                                 USB_MouseReport_Data_t MouseReport;
 163                                 HID_Host_ReceiveReport(&Mouse_HID_Host_Interface, &MouseReport);
 164
 165                                 printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,
 166                                                                                                                           MouseReport.Y,
 167                                                                                                                           MouseReport.Button);
 168                                 if (MouseReport.X > 0)
 169                                   LEDMask |= LEDS_LED1;
 170                                 else if (MouseReport.X < 0)
 171                                   LEDMask |= LEDS_LED2;
 172
 173                                 if (MouseReport.Y > 0)
 174                                   LEDMask |= LEDS_LED3;
 175                                 else if (MouseReport.Y < 0)
 176                                   LEDMask |= LEDS_LED4;
 177
 178                                 if (MouseReport.Button)
 179                                   LEDMask  = LEDS_ALL_LEDS;
 180
 181                                 LEDs_SetAllLEDs(LEDMask);
 182                         }
 183
 184                         break;
 185         }
 186 }
 187