Demos/Host/LowLevel/MouseHost/MouseHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2016.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2016  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  *  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 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  enters a loop to run the application tasks in sequence.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_FG_CYAN "Mouse HID Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49         GlobalInterruptEnable();
  50
  51         for (;;)
  52         {
  53                 MouseHost_Task();
  54
  55                 USB_USBTask();
  56         }
  57 }
  58
  59 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  60 void SetupHardware(void)
  61 {
  62 #if (ARCH == ARCH_AVR8)
  63         /* Disable watchdog if enabled by bootloader/fuses */
  64         MCUSR &= ~(1 << WDRF);
  65         wdt_disable();
  66
  67         /* Disable clock division */
  68         clock_prescale_set(clock_div_1);
  69 #endif
  70
  71         /* Hardware Initialization */
  72         Serial_Init(9600, false);
  73         LEDs_Init();
  74         USB_Init();
  75
  76         /* Create a stdio stream for the serial port for stdin and stdout */
  77         Serial_CreateStream(NULL);
  78 }
  79
  80 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  81  *  starts the library USB task to begin the enumeration and USB management process.
  82  */
  83 void EVENT_USB_Host_DeviceAttached(void)
  84 {
  85         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  86         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  87 }
  88
  89 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  90  *  stops the library USB task management process.
  91  */
  92 void EVENT_USB_Host_DeviceUnattached(void)
  93 {
  94         puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
  95         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  96 }
  97
  98 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  99  *  enumerated by the host and is now ready to be used by the application.
 100  */
 101 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 102 {
 103         puts_P(PSTR("Getting Config Data.\r\n"));
 104
 105         uint8_t ErrorCode;
 106
 107         /* Get and process the configuration descriptor data */
 108         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 109         {
 110                 if (ErrorCode == ControlError)
 111                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 112                 else
 113                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 114
 115                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 116
 117                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 118                 return;
 119         }
 120
 121         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 122         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 123         {
 124                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 125                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 126
 127                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 128                 return;
 129         }
 130
 131         /* HID class request to set the mouse protocol to the Boot Protocol */
 132         USB_ControlRequest = (USB_Request_Header_t)
 133                 {
 134                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 135                         .bRequest      = HID_REQ_SetProtocol,
 136                         .wValue        = 0,
 137                         .wIndex        = 0,
 138                         .wLength       = 0,
 139                 };
 140
 141         /* Select the control pipe for the request transfer */
 142         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 143
 144         /* Send the request, display error and wait for device detach if request fails */
 145         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 146         {
 147                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Protocol).\r\n"
 148                                                                  " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 149
 150                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 151                 USB_Host_SetDeviceConfiguration(0);
 152                 return;
 153         }
 154
 155         puts_P(PSTR("Mouse Enumerated.\r\n"));
 156         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 157 }
 158
 159 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 160 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 161 {
 162         USB_Disable();
 163
 164         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 165                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 166
 167         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 168         for(;;);
 169 }
 170
 171 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 172  *  enumerating an attached USB device.
 173  */
 174 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 175                                             const uint8_t SubErrorCode)
 176 {
 177         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 178                                  " -- Error Code %d\r\n"
 179                                  " -- Sub Error Code %d\r\n"
 180                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 181
 182         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 183 }
 184
 185 /** Reads in and processes the next report from the attached device, displaying the report
 186  *  contents on the board LEDs and via the serial port.
 187  */
 188 void MouseHost_Task(void)
 189 {
 190         if (USB_HostState != HOST_STATE_Configured)
 191           return;
 192
 193         USB_MouseReport_Data_t MouseReport;
 194         uint8_t                LEDMask = LEDS_NO_LEDS;
 195
 196         /* Select mouse data pipe */
 197         Pipe_SelectPipe(MOUSE_DATA_IN_PIPE);
 198
 199         /* Unfreeze mouse data pipe */
 200         Pipe_Unfreeze();
 201
 202         /* Check to see if a packet has been received */
 203         if (!(Pipe_IsINReceived()))
 204         {
 205                 /* No packet received (no movement), turn off LEDs */
 206                 LEDs_SetAllLEDs(LEDS_NO_LEDS);
 207
 208                 /* Refreeze HID data IN pipe */
 209                 Pipe_Freeze();
 210
 211                 return;
 212         }
 213
 214         /* Ensure pipe contains data before trying to read from it */
 215         if (Pipe_IsReadWriteAllowed())
 216         {
 217                 /* Read in mouse report data */
 218                 Pipe_Read_Stream_LE(&MouseReport, sizeof(MouseReport), NULL);
 219
 220                 /* Alter status LEDs according to mouse X movement */
 221                 if (MouseReport.X > 0)
 222                   LEDMask |= LEDS_LED1;
 223                 else if (MouseReport.X < 0)
 224                   LEDMask |= LEDS_LED2;
 225
 226                 /* Alter status LEDs according to mouse Y movement */
 227                 if (MouseReport.Y > 0)
 228                   LEDMask |= LEDS_LED3;
 229                 else if (MouseReport.Y < 0)
 230                   LEDMask |= LEDS_LED4;
 231
 232                 /* Alter status LEDs according to mouse button position */
 233                 if (MouseReport.Button)
 234                   LEDMask  = LEDS_ALL_LEDS;
 235
 236                 LEDs_SetAllLEDs(LEDMask);
 237
 238                 /* Print mouse report data through the serial port */
 239                 printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,
 240                                                                                                           MouseReport.Y,
 241                                                                                                           MouseReport.Button);
 242         }
 243
 244         /* Clear the IN endpoint, ready for next data packet */
 245         Pipe_ClearIN();
 246
 247         /* Refreeze mouse data pipe */
 248         Pipe_Freeze();
 249 }
 250