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 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  starts the scheduler to run the application tasks.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
  47                "Mouse HID Host Demo running.\r\n" ESC_INVERSE_OFF));
  48
  49         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  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_DeviceAttached(void)
  78 {
  79         puts_P(PSTR("Device Attached.\r\n"));
  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_DeviceUnattached(void)
  87 {
  88         puts_P(PSTR("Device Unattached.\r\n"));
  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_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_HostError(const uint8_t ErrorCode)
 102 {
 103         USB_ShutDown();
 104
 105         puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
 106         printf_P(PSTR(" -- Error Code %d\r\n"), 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_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 116 {
 117         puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
 118         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 119         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 120         printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);
 121
 122         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 123 }
 124
 125 /** Reads in and processes the next report from the attached device, displaying the report
 126  *  contents on the board LEDs and via the serial port.
 127  */
 128 void ReadNextReport(void)
 129 {
 130         USB_MouseReport_Data_t MouseReport;
 131         uint8_t                LEDMask = LEDS_NO_LEDS;
 132
 133         /* Select mouse data pipe */
 134         Pipe_SelectPipe(MOUSE_DATAPIPE);
 135
 136         /* Unfreeze keyboard data pipe */
 137         Pipe_Unfreeze();
 138
 139         /* Check to see if a packet has been received */
 140         if (!(Pipe_IsINReceived()))
 141         {
 142                 /* Refreeze HID data IN pipe */
 143                 Pipe_Freeze();
 144
 145                 return;
 146         }
 147
 148         /* Ensure pipe contains data before trying to read from it */
 149         if (Pipe_IsReadWriteAllowed())
 150         {
 151                 /* Read in mouse report data */
 152                 Pipe_Read_Stream_LE(&MouseReport, sizeof(MouseReport));
 153
 154                 /* Alter status LEDs according to mouse X movement */
 155                 if (MouseReport.X > 0)
 156                   LEDMask |= LEDS_LED1;
 157                 else if (MouseReport.X < 0)
 158                   LEDMask |= LEDS_LED2;
 159
 160                 /* Alter status LEDs according to mouse Y movement */
 161                 if (MouseReport.Y > 0)
 162                   LEDMask |= LEDS_LED3;
 163                 else if (MouseReport.Y < 0)
 164                   LEDMask |= LEDS_LED4;
 165
 166                 /* Alter status LEDs according to mouse button position */
 167                 if (MouseReport.Button)
 168                   LEDMask  = LEDS_ALL_LEDS;
 169
 170                 LEDs_SetAllLEDs(LEDMask);
 171
 172                 /* Print mouse report data through the serial port */
 173                 printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,
 174                                                                                                           MouseReport.Y,
 175                                                                                                           MouseReport.Button);
 176         }
 177
 178         /* Clear the IN endpoint, ready for next data packet */
 179         Pipe_ClearIN();
 180
 181         /* Refreeze mouse data pipe */
 182         Pipe_Freeze();
 183 }
 184
 185 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 186  *  HID reports from the device and display the results onto the board LEDs.
 187  */
 188 void Mouse_HID_Task(void)
 189 {
 190         uint8_t ErrorCode;
 191
 192         /* Switch to determine what user-application handled host state the host state machine is in */
 193         switch (USB_HostState)
 194         {
 195                 case HOST_STATE_Addressed:
 196                         /* Standard request to set the device configuration to configuration 1 */
 197                         USB_ControlRequest = (USB_Request_Header_t)
 198                                 {
 199                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 200                                         .bRequest      = REQ_SetConfiguration,
 201                                         .wValue        = 1,
 202                                         .wIndex        = 0,
 203                                         .wLength       = 0,
 204                                 };
 205
 206                         /* Select the control pipe for the request transfer */
 207                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 208
 209                         /* Send the request, display error and wait for device detach if request fails */
 210                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 211                         {
 212                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 213                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 214
 215                                 /* Indicate error status */
 216                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 217
 218                                 /* Wait until USB device disconnected */
 219                                 while (USB_IsConnected);
 220                                 break;
 221                         }
 222
 223                         USB_HostState = HOST_STATE_Configured;
 224                         break;
 225                 case HOST_STATE_Configured:
 226                         puts_P(PSTR("Getting Config Data.\r\n"));
 227
 228                         /* Get and process the configuration descriptor data */
 229                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 230                         {
 231                                 if (ErrorCode == ControlError)
 232                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 233                                 else
 234                                   puts_P(PSTR("Invalid Device.\r\n"));
 235
 236                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 237
 238                                 /* Indicate error status */
 239                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 240
 241                                 /* Wait until USB device disconnected */
 242                                 while (USB_IsConnected);
 243                                 break;
 244                         }
 245
 246                         /* HID class request to set the mouse protocol to the Boot Protocol */
 247                         USB_ControlRequest = (USB_Request_Header_t)
 248                                 {
 249                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 250                                         .bRequest      = REQ_SetProtocol,
 251                                         .wValue        = 0,
 252                                         .wIndex        = 0,
 253                                         .wLength       = 0,
 254                                 };
 255
 256                         /* Select the control pipe for the request transfer */
 257                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 258
 259                         /* Send the request, display error and wait for device detach if request fails */
 260                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 261                         {
 262                                 puts_P(PSTR("Control Error (Set Protocol).\r\n"));
 263                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 264
 265                                 /* Indicate error status */
 266                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 267
 268                                 /* Wait until USB device disconnected */
 269                                 while (USB_IsConnected);
 270                                 break;
 271                         }
 272
 273                         puts_P(PSTR("Mouse Enumerated.\r\n"));
 274
 275                         USB_HostState = HOST_STATE_Ready;
 276                         break;
 277                 case HOST_STATE_Ready:
 278                         /* If a report has been received, read and process it */
 279                         ReadNextReport();
 280
 281                         break;
 282         }
 283 }