Demos/DualRole/ClassDriver/MouseHostDevice/HostFunctions.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2018.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2018  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 disclaims 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                                 .DataINPipe             =
  48                                         {
  49                                                 .Address        = (PIPE_DIR_IN  | 1),
  50                                                 .Banks          = 1,
  51                                         },
  52                                 .DataINPipe             =
  53                                         {
  54                                                 .Address        = (PIPE_DIR_OUT | 2),
  55                                                 .Banks          = 1,
  56                                         },
  57                                 .HIDInterfaceProtocol   = HID_CSCP_MouseBootProtocol,
  58                         },
  59         };
  60
  61
  62 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  63  *  starts the library USB task to begin the enumeration and USB management process.
  64  */
  65 void EVENT_USB_Host_DeviceAttached(void)
  66 {
  67         puts_P(PSTR("Device Attached.\r\n"));
  68         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  69 }
  70
  71 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  72  *  stops the library USB task management process.
  73  */
  74 void EVENT_USB_Host_DeviceUnattached(void)
  75 {
  76         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
  77         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  78 }
  79
  80 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  81  *  enumerated by the host and is now ready to be used by the application.
  82  */
  83 void EVENT_USB_Host_DeviceEnumerationComplete(void)
  84 {
  85         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  86
  87         uint16_t ConfigDescriptorSize;
  88         uint8_t  ConfigDescriptorData[512];
  89
  90         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
  91                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
  92         {
  93                 printf("Error Retrieving Configuration Descriptor.\r\n");
  94                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
  95                 return;
  96         }
  97
  98         if (HID_Host_ConfigurePipes(&Mouse_HID_Host_Interface,
  99                                     ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
 100         {
 101                 printf("Attached Device Not a Valid Mouse.\r\n");
 102                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 103                 return;
 104         }
 105
 106         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 107         {
 108                 printf("Error Setting Device Configuration.\r\n");
 109                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 110                 return;
 111         }
 112
 113         if (HID_Host_SetBootProtocol(&Mouse_HID_Host_Interface) != HOST_SENDCONTROL_Successful)
 114         {
 115                 printf("Could not Set Boot Protocol Mode.\r\n");
 116                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 117                 return;
 118         }
 119
 120         printf("Mouse Enumerated.\r\n");
 121         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 122 }
 123
 124 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 125 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 126 {
 127         USB_Disable();
 128
 129         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 130                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 131
 132         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 133         for(;;);
 134 }
 135
 136 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 137  *  enumerating an attached USB device.
 138  */
 139 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 140                                             const uint8_t SubErrorCode)
 141 {
 142         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 143                                  " -- Error Code %d\r\n"
 144                                  " -- Sub Error Code %d\r\n"
 145                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 146
 147         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 148 }
 149
 150 /** Host USB management task. This task handles the control of USB Mice while in USB Host mode,
 151  *  setting up the appropriate data pipes and processing reports from the attached device.
 152  */
 153 void MouseHost_Task(void)
 154 {
 155         if (USB_HostState != HOST_STATE_Configured)
 156           return;
 157
 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