Demos/Host/LowLevel/MouseHost/MouseHost.c

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