Demos/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 /* Project Tags, for reading out using the ButtLoad project */
  40 BUTTLOADTAG(ProjName,    "LUFA Mouse Host App");
  41 BUTTLOADTAG(BuildTime,   __TIME__);
  42 BUTTLOADTAG(BuildDate,   __DATE__);
  43 BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);
  44
  45 /* Scheduler Task List */
  46 TASK_LIST
  47 {
  48         { Task: USB_USBTask          , TaskStatus: TASK_STOP },
  49         { Task: USB_Mouse_Host       , TaskStatus: TASK_STOP },
  50 };
  51
  52
  53 /** Main program entry point. This routine configures the hardware required by the application, then
  54  *  starts the scheduler to run the application tasks.
  55  */
  56 int main(void)
  57 {
  58         /* Disable watchdog if enabled by bootloader/fuses */
  59         MCUSR &= ~(1 << WDRF);
  60         wdt_disable();
  61
  62         /* Disable clock division */
  63         clock_prescale_set(clock_div_1);
  64
  65         /* Hardware Initialization */
  66         SerialStream_Init(9600, false);
  67         LEDs_Init();
  68
  69         /* Indicate USB not ready */
  70         UpdateStatus(Status_USBNotReady);
  71
  72         /* Initialize Scheduler so that it can be used */
  73         Scheduler_Init();
  74
  75         /* Initialize USB Subsystem */
  76         USB_Init();
  77
  78         /* Startup message */
  79         puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
  80                "Mouse Host Demo running.\r\n" ESC_INVERSE_OFF));
  81
  82         /* Scheduling - routine never returns, so put this last in the main function */
  83         Scheduler_Start();
  84 }
  85
  86 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  87  *  starts the library USB task to begin the enumeration and USB management process.
  88  */
  89 EVENT_HANDLER(USB_DeviceAttached)
  90 {
  91         puts_P(PSTR("Device Attached.\r\n"));
  92         UpdateStatus(Status_USBEnumerating);
  93
  94         /* Start USB management task to enumerate the device */
  95         Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
  96 }
  97
  98 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  99  *  stops the library USB task management process.
 100  */
 101 EVENT_HANDLER(USB_DeviceUnattached)
 102 {
 103         /* Stop mouse and USB management task */
 104         Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
 105         Scheduler_SetTaskMode(USB_Mouse_Host, TASK_STOP);
 106
 107         puts_P(PSTR("Device Unattached.\r\n"));
 108         UpdateStatus(Status_USBNotReady);
 109 }
 110
 111 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 112  *  enumerated by the host and is now ready to be used by the application.
 113  */
 114 EVENT_HANDLER(USB_DeviceEnumerationComplete)
 115 {
 116         /* Start Mouse Host task */
 117         Scheduler_SetTaskMode(USB_Mouse_Host, TASK_RUN);
 118
 119         /* Indicate device enumeration complete */
 120         UpdateStatus(Status_USBReady);
 121 }
 122
 123 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 124 EVENT_HANDLER(USB_HostError)
 125 {
 126         USB_ShutDown();
 127
 128         puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
 129         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 130
 131         UpdateStatus(Status_HardwareError);
 132         for(;;);
 133 }
 134
 135 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while
 136  *  enumerating an attached USB device.
 137  */
 138 EVENT_HANDLER(USB_DeviceEnumerationFailed)
 139 {
 140         puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
 141         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 142         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 143         printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);
 144
 145         UpdateStatus(Status_EnumerationError);
 146 }
 147
 148 /** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
 149  *  log to a serial port, or anything else that is suitable for status updates.
 150  *
 151  *  \param CurrentStatus  Current status of the system, from the MouseHost_StatusCodes_t enum
 152  */
 153 void UpdateStatus(uint8_t CurrentStatus)
 154 {
 155         uint8_t LEDMask = LEDS_NO_LEDS;
 156
 157         /* Set the LED mask to the appropriate LED mask based on the given status code */
 158         switch (CurrentStatus)
 159         {
 160                 case Status_USBNotReady:
 161                         LEDMask = (LEDS_LED1);
 162                         break;
 163                 case Status_USBEnumerating:
 164                         LEDMask = (LEDS_LED1 | LEDS_LED2);
 165                         break;
 166                 case Status_USBReady:
 167                         LEDMask = (LEDS_LED2);
 168                         break;
 169                 case Status_EnumerationError:
 170                 case Status_HardwareError:
 171                         LEDMask = (LEDS_LED1 | LEDS_LED3);
 172                         break;
 173         }
 174
 175         /* Set the board LEDs to the new LED mask */
 176         LEDs_SetAllLEDs(LEDMask);
 177 }
 178
 179 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 180  *  HID reports from the device and display the results onto the board LEDs.
 181  */
 182 TASK(USB_Mouse_Host)
 183 {
 184         uint8_t ErrorCode;
 185
 186         /* Switch to determine what user-application handled host state the host state machine is in */
 187         switch (USB_HostState)
 188         {
 189                 case HOST_STATE_Addressed:
 190                         /* Standard request to set the device configuration to configuration 1 */
 191                         USB_HostRequest = (USB_Host_Request_Header_t)
 192                                 {
 193                                         bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
 194                                         bRequest:      REQ_SetConfiguration,
 195                                         wValue:        1,
 196                                         wIndex:        0,
 197                                         wLength:       0,
 198                                 };
 199
 200                         /* Send the request, display error and wait for device detatch if request fails */
 201                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 202                         {
 203                                 puts_P(PSTR("Control Error (Set Configuration).\r\n"));
 204                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 205
 206                                 /* Indicate error status */
 207                                 UpdateStatus(Status_EnumerationError);
 208
 209                                 /* Wait until USB device disconnected */
 210                                 while (USB_IsConnected);
 211                                 break;
 212                         }
 213
 214                         USB_HostState = HOST_STATE_Configured;
 215                         break;
 216                 case HOST_STATE_Configured:
 217                         puts_P(PSTR("Getting Config Data.\r\n"));
 218
 219                         /* Get and process the configuration descriptor data */
 220                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 221                         {
 222                                 if (ErrorCode == ControlError)
 223                                   puts_P(PSTR("Control Error (Get Configuration).\r\n"));
 224                                 else
 225                                   puts_P(PSTR("Invalid Device.\r\n"));
 226
 227                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 228
 229                                 /* Indicate error status */
 230                                 UpdateStatus(Status_EnumerationError);
 231
 232                                 /* Wait until USB device disconnected */
 233                                 while (USB_IsConnected);
 234                                 break;
 235                         }
 236
 237                         /* HID class request to set the mouse protocol to the Boot Protocol */
 238                         USB_HostRequest = (USB_Host_Request_Header_t)
 239                                 {
 240                                         bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 241                                         bRequest:      REQ_SetProtocol,
 242                                         wValue:        0,
 243                                         wIndex:        0,
 244                                         wLength:       0,
 245                                 };
 246
 247                         /* Send the request, display error and wait for device detatch if request fails */
 248                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 249                         {
 250                                 puts_P(PSTR("Control Error (Set Protocol).\r\n"));
 251                                 printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
 252
 253                                 /* Indicate error status */
 254                                 UpdateStatus(Status_EnumerationError);
 255
 256                                 /* Wait until USB device disconnected */
 257                                 while (USB_IsConnected);
 258                                 break;
 259                         }
 260
 261                         puts_P(PSTR("Mouse Enumerated.\r\n"));
 262
 263                         USB_HostState = HOST_STATE_Ready;
 264                         break;
 265                 case HOST_STATE_Ready:
 266                         /* Select and unfreeze mouse data pipe */
 267                         Pipe_SelectPipe(MOUSE_DATAPIPE);
 268                         Pipe_Unfreeze();
 269
 270                         /* Check if data has been received from the attached mouse */
 271                         if (Pipe_ReadWriteAllowed())
 272                         {
 273                                 USB_MouseReport_Data_t MouseReport;
 274                                 uint8_t                LEDMask = LEDS_NO_LEDS;
 275
 276                                 /* Read in mouse report data */
 277                                 Pipe_Read_Stream_LE(&MouseReport, sizeof(MouseReport));
 278
 279                                 /* Clear the IN endpoint, ready for next data packet */
 280                                 Pipe_ClearCurrentBank();
 281
 282                                 /* Alter status LEDs according to mouse X movement */
 283                                 if (MouseReport.X > 0)
 284                                   LEDMask |= LEDS_LED1;
 285                                 else if (MouseReport.X < 0)
 286                                   LEDMask |= LEDS_LED2;
 287
 288                                 /* Alter status LEDs according to mouse Y movement */
 289                                 if (MouseReport.Y > 0)
 290                                   LEDMask |= LEDS_LED3;
 291                                 else if (MouseReport.Y < 0)
 292                                   LEDMask |= LEDS_LED4;
 293
 294                                 /* Alter status LEDs according to mouse button position */
 295                                 if (MouseReport.Button)
 296                                   LEDMask = LEDS_ALL_LEDS;
 297
 298                                 LEDs_SetAllLEDs(LEDMask);
 299
 300                                 /* Print mouse report data through the serial port */
 301                                 printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,
 302                                                                               MouseReport.Y,
 303                                                                               MouseReport.Button);
 304                         }
 305
 306                         /* Freeze mouse data pipe */
 307                         Pipe_Freeze();
 308                         break;
 309         }
 310 }