Demos/Host/LowLevel/MouseHost/MouseHost.c

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