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