Demos/Device/LowLevel/Mouse/Mouse.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 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 uint16_t IdleCount = HID_IDLE_CHANGESONLY;
  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 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
  65         for (;;)
  66         {
  67                 Mouse_Task();
  68                 USB_USBTask();
  69         }
  70 }
  71
  72 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  73 void SetupHardware(void)
  74 {
  75         /* Disable watchdog if enabled by bootloader/fuses */
  76         MCUSR &= ~(1 << WDRF);
  77         wdt_disable();
  78
  79         /* Disable clock division */
  80         clock_prescale_set(clock_div_1);
  81
  82         /* Hardware Initialization */
  83         Joystick_Init();
  84         LEDs_Init();
  85         Buttons_Init();
  86         USB_Init();
  87 }
  88
  89 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
  90  *  starts the library USB task to begin the enumeration and USB management process.
  91  */
  92 void EVENT_USB_Device_Connect(void)
  93 {
  94         /* Indicate USB enumerating */
  95         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  96
  97         /* Default to report protocol on connect */
  98         UsingReportProtocol = true;
  99 }
 100
 101 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
 102  *  the status LEDs and stops the USB management and Mouse reporting tasks.
 103  */
 104 void EVENT_USB_Device_Disconnect(void)
 105 {
 106         /* Indicate USB not ready */
 107         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 108 }
 109
 110 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration
 111  *  of the USB device after enumeration - the device endpoints are configured and the mouse reporting task started.
 112  */
 113 void EVENT_USB_Device_ConfigurationChanged(void)
 114 {
 115         /* Indicate USB connected and ready */
 116         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 117
 118         /* Setup Mouse Report Endpoint */
 119         if (!(Endpoint_ConfigureEndpoint(MOUSE_EPNUM, EP_TYPE_INTERRUPT,
 120                                              ENDPOINT_DIR_IN, MOUSE_EPSIZE,
 121                                          ENDPOINT_BANK_SINGLE)))
 122         {
 123                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 124         }
 125
 126         USB_Device_EnableSOFEvents();
 127 }
 128
 129 /** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific
 130  *  control requests that are not handled internally by the USB library (including the HID commands, which are
 131  *  all issued via the control endpoint), so that they can be handled appropriately for the application.
 132  */
 133 void EVENT_USB_Device_UnhandledControlRequest(void)
 134 {
 135         /* Handle HID Class specific requests */
 136         switch (USB_ControlRequest.bRequest)
 137         {
 138                 case REQ_GetReport:
 139                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 140                         {
 141                                 USB_MouseReport_Data_t MouseReportData;
 142
 143                                 Endpoint_ClearSETUP();
 144
 145                                 /* Create the next mouse report for transmission to the host */
 146                                 CreateMouseReport(&MouseReportData);
 147
 148                                 /* Write the report data to the control endpoint */
 149                                 Endpoint_Write_Control_Stream_LE(&MouseReportData, sizeof(MouseReportData));
 150
 151                                 /* Clear the report data afterwards */
 152                                 memset(&MouseReportData, 0, sizeof(MouseReportData));
 153
 154                                 /* Finalize the stream transfer to send the last packet or clear the host abort */
 155                                 Endpoint_ClearOUT();
 156                         }
 157
 158                         break;
 159                 case REQ_GetProtocol:
 160                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 161                         {
 162                                 Endpoint_ClearSETUP();
 163
 164                                 /* Write the current protocol flag to the host */
 165                                 Endpoint_Write_Byte(UsingReportProtocol);
 166
 167                                 /* Send the flag to the host */
 168                                 Endpoint_ClearIN();
 169
 170                                 Endpoint_ClearStatusStage();
 171                         }
 172
 173                         break;
 174                 case REQ_SetProtocol:
 175                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 176                         {
 177                                 Endpoint_ClearSETUP();
 178
 179                                 /* Set or clear the flag depending on what the host indicates that the current Protocol should be */
 180                                 UsingReportProtocol = (USB_ControlRequest.wValue != 0);
 181
 182                                 Endpoint_ClearStatusStage();
 183                         }
 184
 185                         break;
 186                 case REQ_SetIdle:
 187                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 188                         {
 189                                 Endpoint_ClearSETUP();
 190
 191                                 /* Get idle period in MSB, must multiply by 4 to get the duration in milliseconds */
 192                                 IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);
 193
 194                                 Endpoint_ClearStatusStage();
 195                         }
 196
 197                         break;
 198                 case REQ_GetIdle:
 199                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 200                         {
 201                                 Endpoint_ClearSETUP();
 202
 203                                 /* Write the current idle duration to the host, must be divided by 4 before sent to host */
 204                                 Endpoint_Write_Byte(IdleCount >> 2);
 205
 206                                 /* Send the flag to the host */
 207                                 Endpoint_ClearIN();
 208
 209                                 Endpoint_ClearStatusStage();
 210                         }
 211
 212                         break;
 213         }
 214 }
 215
 216 /** Event handler for the USB device Start Of Frame event. */
 217 void EVENT_USB_Device_StartOfFrame(void)
 218 {
 219         /* One millisecond has elapsed, decrement the idle time remaining counter if it has not already elapsed */
 220         if (IdleMSRemaining)
 221           IdleMSRemaining--;
 222 }
 223
 224 /** Fills the given HID report data structure with the next HID report to send to the host.
 225  *
 226  *  \param[out] ReportData  Pointer to a HID report data structure to be filled
 227  */
 228 void CreateMouseReport(USB_MouseReport_Data_t* ReportData)
 229 {
 230         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 231         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 232
 233         /* Clear the report contents */
 234         memset(ReportData, 0, sizeof(USB_MouseReport_Data_t));
 235
 236         if (JoyStatus_LCL & JOY_UP)
 237           ReportData->Y = -1;
 238         else if (JoyStatus_LCL & JOY_DOWN)
 239           ReportData->Y =  1;
 240
 241         if (JoyStatus_LCL & JOY_LEFT)
 242           ReportData->X = -1;
 243         else if (JoyStatus_LCL & JOY_RIGHT)
 244           ReportData->X = 1;
 245
 246         if (JoyStatus_LCL & JOY_PRESS)
 247           ReportData->Button  = (1 << 0);
 248
 249         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 250           ReportData->Button |= (1 << 1);
 251 }
 252
 253 /** Sends the next HID report to the host, via the keyboard data endpoint. */
 254 void SendNextReport(void)
 255 {
 256         static USB_MouseReport_Data_t PrevMouseReportData;
 257         USB_MouseReport_Data_t        MouseReportData;
 258         bool                          SendReport;
 259
 260         /* Create the next mouse report for transmission to the host */
 261         CreateMouseReport(&MouseReportData);
 262
 263         /* Check to see if the report data has changed - if so a report MUST be sent */
 264         SendReport = (memcmp(&PrevMouseReportData, &MouseReportData, sizeof(USB_MouseReport_Data_t)) != 0);
 265
 266         /* Override the check if the Y or X values are non-zero - we want continuous movement while the joystick
 267          * is being held down (via continuous reports), otherwise the cursor will only move once per joystick toggle */
 268         if ((MouseReportData.Y != 0) || (MouseReportData.X != 0))
 269           SendReport = true;
 270
 271         /* Check if the idle period is set and has elapsed */
 272         if ((IdleCount != HID_IDLE_CHANGESONLY) && (!(IdleMSRemaining)))
 273         {
 274                 /* Reset the idle time remaining counter */
 275                 IdleMSRemaining = IdleCount;
 276
 277                 /* Idle period is set and has elapsed, must send a report to the host */
 278                 SendReport = true;
 279         }
 280
 281         /* Select the Mouse Report Endpoint */
 282         Endpoint_SelectEndpoint(MOUSE_EPNUM);
 283
 284         /* Check if Mouse Endpoint Ready for Read/Write and if we should send a new report */
 285         if (Endpoint_IsReadWriteAllowed() && SendReport)
 286         {
 287                 /* Save the current report data for later comparison to check for changes */
 288                 PrevMouseReportData = MouseReportData;
 289
 290                 /* Write Mouse Report Data */
 291                 Endpoint_Write_Stream_LE(&MouseReportData, sizeof(MouseReportData));
 292
 293                 /* Finalize the stream transfer to send the last packet */
 294                 Endpoint_ClearIN();
 295         }
 296 }
 297
 298 /** Task to manage HID report generation and transmission to the host, when in report mode. */
 299 void Mouse_Task(void)
 300 {
 301         /* Device must be connected and configured for the task to run */
 302         if (USB_DeviceState != DEVICE_STATE_Configured)
 303           return;
 304
 305         /* Send the next mouse report to the host */
 306         SendNextReport();
 307 }