Demos/Device/LowLevel/Mouse/Mouse.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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 Mouse demo. This file contains the main tasks of the demo and
  34  *  is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "Mouse.h"
  38
  39 /** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot
  40  *  protocol reporting mode.
  41  */
  42 static bool UsingReportProtocol = true;
  43
  44 /** Current Idle period. This is set by the host via a Set Idle HID class request to silence the device's reports
  45  *  for either the entire idle duration, or until the report status changes (e.g. the user moves the mouse).
  46  */
  47 static uint16_t IdleCount = 0;
  48
  49 /** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle
  50  *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request
  51  *  the current idle period via a Get Idle HID class request, thus its value must be preserved.
  52  */
  53 static uint16_t IdleMSRemaining = 0;
  54
  55
  56 /** Main program entry point. This routine configures the hardware required by the application, then
  57  *  enters a loop to run the application tasks in sequence.
  58  */
  59 int main(void)
  60 {
  61         SetupHardware();
  62
  63         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  64         sei();
  65
  66         for (;;)
  67         {
  68                 Mouse_Task();
  69                 USB_USBTask();
  70         }
  71 }
  72
  73 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  74 void SetupHardware(void)
  75 {
  76         /* Disable watchdog if enabled by bootloader/fuses */
  77         MCUSR &= ~(1 << WDRF);
  78         wdt_disable();
  79
  80         /* Disable clock division */
  81         clock_prescale_set(clock_div_1);
  82
  83         /* Hardware Initialization */
  84         Joystick_Init();
  85         LEDs_Init();
  86         Buttons_Init();
  87         USB_Init();
  88 }
  89
  90 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
  91  *  starts the library USB task to begin the enumeration and USB management process.
  92  */
  93 void EVENT_USB_Device_Connect(void)
  94 {
  95         /* Indicate USB enumerating */
  96         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  97
  98         /* Default to report protocol on connect */
  99         UsingReportProtocol = true;
 100 }
 101
 102 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
 103  *  the status LEDs and stops the USB management and Mouse reporting tasks.
 104  */
 105 void EVENT_USB_Device_Disconnect(void)
 106 {
 107         /* Indicate USB not ready */
 108         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 109 }
 110
 111 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration
 112  *  of the USB device after enumeration - the device endpoints are configured and the mouse reporting task started.
 113  */
 114 void EVENT_USB_Device_ConfigurationChanged(void)
 115 {
 116         bool ConfigSuccess = true;
 117
 118         /* Setup HID Report Endpoint */
 119         ConfigSuccess &= Endpoint_ConfigureEndpoint(MOUSE_EPADDR, EP_TYPE_INTERRUPT, MOUSE_EPSIZE, 1);
 120
 121         /* Turn on Start-of-Frame events for tracking HID report period expiry */
 122         USB_Device_EnableSOFEvents();
 123
 124         /* Indicate endpoint configuration success or failure */
 125         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 126 }
 127
 128 /** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
 129  *  the device from the USB host before passing along unhandled control requests to the library for processing
 130  *  internally.
 131  */
 132 void EVENT_USB_Device_ControlRequest(void)
 133 {
 134         /* Handle HID Class specific requests */
 135         switch (USB_ControlRequest.bRequest)
 136         {
 137                 case HID_REQ_GetReport:
 138                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 139                         {
 140                                 USB_MouseReport_Data_t MouseReportData;
 141
 142                                 /* Create the next mouse report for transmission to the host */
 143                                 CreateMouseReport(&MouseReportData);
 144
 145                                 Endpoint_ClearSETUP();
 146
 147                                 /* Write the report data to the control endpoint */
 148                                 Endpoint_Write_Control_Stream_LE(&MouseReportData, sizeof(MouseReportData));
 149                                 Endpoint_ClearOUT();
 150
 151                                 /* Clear the report data afterwards */
 152                                 memset(&MouseReportData, 0, sizeof(MouseReportData));
 153                         }
 154
 155                         break;
 156                 case HID_REQ_GetProtocol:
 157                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 158                         {
 159                                 Endpoint_ClearSETUP();
 160
 161                                 /* Write the current protocol flag to the host */
 162                                 Endpoint_Write_8(UsingReportProtocol);
 163
 164                                 Endpoint_ClearIN();
 165                                 Endpoint_ClearStatusStage();
 166                         }
 167
 168                         break;
 169                 case HID_REQ_SetProtocol:
 170                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 171                         {
 172                                 Endpoint_ClearSETUP();
 173                                 Endpoint_ClearStatusStage();
 174
 175                                 /* Set or clear the flag depending on what the host indicates that the current Protocol should be */
 176                                 UsingReportProtocol = (USB_ControlRequest.wValue != 0);
 177                         }
 178
 179                         break;
 180                 case HID_REQ_SetIdle:
 181                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 182                         {
 183                                 Endpoint_ClearSETUP();
 184                                 Endpoint_ClearStatusStage();
 185
 186                                 /* Get idle period in MSB, must multiply by 4 to get the duration in milliseconds */
 187                                 IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);
 188                         }
 189
 190                         break;
 191                 case HID_REQ_GetIdle:
 192                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 193                         {
 194                                 Endpoint_ClearSETUP();
 195
 196                                 /* Write the current idle duration to the host, must be divided by 4 before sent to host */
 197                                 Endpoint_Write_8(IdleCount >> 2);
 198
 199                                 Endpoint_ClearIN();
 200                                 Endpoint_ClearStatusStage();
 201                         }
 202
 203                         break;
 204         }
 205 }
 206
 207 /** Event handler for the USB device Start Of Frame event. */
 208 void EVENT_USB_Device_StartOfFrame(void)
 209 {
 210         /* One millisecond has elapsed, decrement the idle time remaining counter if it has not already elapsed */
 211         if (IdleMSRemaining)
 212           IdleMSRemaining--;
 213 }
 214
 215 /** Fills the given HID report data structure with the next HID report to send to the host.
 216  *
 217  *  \param[out] ReportData  Pointer to a HID report data structure to be filled
 218  */
 219 void CreateMouseReport(USB_MouseReport_Data_t* const ReportData)
 220 {
 221         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 222         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 223
 224         /* Clear the report contents */
 225         memset(ReportData, 0, sizeof(USB_MouseReport_Data_t));
 226
 227         if (JoyStatus_LCL & JOY_UP)
 228           ReportData->Y = -1;
 229         else if (JoyStatus_LCL & JOY_DOWN)
 230           ReportData->Y =  1;
 231
 232         if (JoyStatus_LCL & JOY_LEFT)
 233           ReportData->X = -1;
 234         else if (JoyStatus_LCL & JOY_RIGHT)
 235           ReportData->X =  1;
 236
 237         if (JoyStatus_LCL & JOY_PRESS)
 238           ReportData->Button |= (1 << 0);
 239
 240         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 241           ReportData->Button |= (1 << 1);
 242 }
 243
 244 /** Sends the next HID report to the host, via the keyboard data endpoint. */
 245 void SendNextReport(void)
 246 {
 247         static USB_MouseReport_Data_t PrevMouseReportData;
 248         USB_MouseReport_Data_t        MouseReportData;
 249         bool                          SendReport;
 250
 251         /* Create the next mouse report for transmission to the host */
 252         CreateMouseReport(&MouseReportData);
 253
 254         /* Check to see if the report data has changed - if so a report MUST be sent */
 255         SendReport = (memcmp(&PrevMouseReportData, &MouseReportData, sizeof(USB_MouseReport_Data_t)) != 0);
 256
 257         /* Override the check if the Y or X values are non-zero - we want continuous movement while the joystick
 258          * is being held down (via continuous reports), otherwise the cursor will only move once per joystick toggle */
 259         if ((MouseReportData.Y != 0) || (MouseReportData.X != 0))
 260           SendReport = true;
 261
 262         /* Check if the idle period is set and has elapsed */
 263         if (IdleCount && (!(IdleMSRemaining)))
 264         {
 265                 /* Reset the idle time remaining counter */
 266                 IdleMSRemaining = IdleCount;
 267
 268                 /* Idle period is set and has elapsed, must send a report to the host */
 269                 SendReport = true;
 270         }
 271
 272         /* Select the Mouse Report Endpoint */
 273         Endpoint_SelectEndpoint(MOUSE_EPADDR);
 274
 275         /* Check if Mouse Endpoint Ready for Read/Write and if we should send a new report */
 276         if (Endpoint_IsReadWriteAllowed() && SendReport)
 277         {
 278                 /* Save the current report data for later comparison to check for changes */
 279                 PrevMouseReportData = MouseReportData;
 280
 281                 /* Write Mouse Report Data */
 282                 Endpoint_Write_Stream_LE(&MouseReportData, sizeof(MouseReportData), NULL);
 283
 284                 /* Finalize the stream transfer to send the last packet */
 285                 Endpoint_ClearIN();
 286         }
 287 }
 288
 289 /** Task to manage HID report generation and transmission to the host, when in report mode. */
 290 void Mouse_Task(void)
 291 {
 292         /* Device must be connected and configured for the task to run */
 293         if (USB_DeviceState != DEVICE_STATE_Configured)
 294           return;
 295
 296         /* Send the next mouse report to the host */
 297         SendNextReport();
 298 }
 299