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