Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   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 VirtualSerialMouse demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "VirtualSerialMouse.h"
  38
  39 /** LUFA CDC Class driver interface configuration and state information. This structure is
  40  *  passed to all CDC Class driver functions, so that multiple instances of the same class
  41  *  within a device can be differentiated from one another.
  42  */
  43 USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =
  44         {
  45                 .Config =
  46                         {
  47                                 .ControlInterfaceNumber         = 0,
  48
  49                                 .DataINEndpointNumber           = CDC_TX_EPNUM,
  50                                 .DataINEndpointSize             = CDC_TXRX_EPSIZE,
  51                                 .DataINEndpointDoubleBank       = false,
  52
  53                                 .DataOUTEndpointNumber          = CDC_RX_EPNUM,
  54                                 .DataOUTEndpointSize            = CDC_TXRX_EPSIZE,
  55                                 .DataOUTEndpointDoubleBank      = false,
  56
  57                                 .NotificationEndpointNumber     = CDC_NOTIFICATION_EPNUM,
  58                                 .NotificationEndpointSize       = CDC_NOTIFICATION_EPSIZE,
  59                                 .NotificationEndpointDoubleBank = false,
  60                         },
  61         };
  62
  63 /** Buffer to hold the previously generated Mouse HID report, for comparison purposes inside the HID class driver. */
  64 uint8_t PrevMouseHIDReportBuffer[sizeof(USB_MouseReport_Data_t)];
  65
  66 /** LUFA HID Class driver interface configuration and state information. This structure is
  67  *  passed to all HID Class driver functions, so that multiple instances of the same class
  68  *  within a device can be differentiated from one another.
  69  */
  70 USB_ClassInfo_HID_Device_t Mouse_HID_Interface =
  71         {
  72                 .Config =
  73                         {
  74                                 .InterfaceNumber                = 2,
  75
  76                                 .ReportINEndpointNumber         = MOUSE_EPNUM,
  77                                 .ReportINEndpointSize           = MOUSE_EPSIZE,
  78                                 .ReportINEndpointDoubleBank     = false,
  79
  80                                 .PrevReportINBuffer             = PrevMouseHIDReportBuffer,
  81                                 .PrevReportINBufferSize         = sizeof(PrevMouseHIDReportBuffer),
  82                         },
  83         };
  84
  85 /** Main program entry point. This routine contains the overall program flow, including initial
  86  *  setup of all components and the main program loop.
  87  */
  88 int main(void)
  89 {
  90         SetupHardware();
  91
  92         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  93         sei();
  94
  95         for (;;)
  96         {
  97                 CheckJoystickMovement();
  98
  99                 /* Must throw away unused bytes from the host, or it will lock up while waiting for the device */
 100                 CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);
 101
 102                 CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
 103                 HID_Device_USBTask(&Mouse_HID_Interface);
 104                 USB_USBTask();
 105         }
 106 }
 107
 108 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 109 void SetupHardware(void)
 110 {
 111         /* Disable watchdog if enabled by bootloader/fuses */
 112         MCUSR &= ~(1 << WDRF);
 113         wdt_disable();
 114
 115         /* Disable clock division */
 116         clock_prescale_set(clock_div_1);
 117
 118         /* Hardware Initialization */
 119         Joystick_Init();
 120         LEDs_Init();
 121         USB_Init();
 122 }
 123
 124 /** Checks for changes in the position of the board joystick, sending strings to the host upon each change. */
 125 void CheckJoystickMovement(void)
 126 {
 127         uint8_t     JoyStatus_LCL = Joystick_GetStatus();
 128         char*       ReportString  = NULL;
 129         static bool ActionSent    = false;
 130
 131         if (JoyStatus_LCL & JOY_UP)
 132           ReportString = "Joystick Up\r\n";
 133         else if (JoyStatus_LCL & JOY_DOWN)
 134           ReportString = "Joystick Down\r\n";
 135         else if (JoyStatus_LCL & JOY_LEFT)
 136           ReportString = "Joystick Left\r\n";
 137         else if (JoyStatus_LCL & JOY_RIGHT)
 138           ReportString = "Joystick Right\r\n";
 139         else if (JoyStatus_LCL & JOY_PRESS)
 140           ReportString = "Joystick Pressed\r\n";
 141         else
 142           ActionSent = false;
 143
 144         if ((ReportString != NULL) && (ActionSent == false))
 145         {
 146                 ActionSent = true;
 147
 148                 CDC_Device_SendString(&VirtualSerial_CDC_Interface, ReportString, strlen(ReportString));
 149         }
 150 }
 151
 152 /** Event handler for the library USB Connection event. */
 153 void EVENT_USB_Device_Connect(void)
 154 {
 155         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 156 }
 157
 158 /** Event handler for the library USB Disconnection event. */
 159 void EVENT_USB_Device_Disconnect(void)
 160 {
 161         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 162 }
 163
 164 /** Event handler for the library USB Configuration Changed event. */
 165 void EVENT_USB_Device_ConfigurationChanged(void)
 166 {
 167         bool ConfigSuccess = true;
 168
 169         ConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
 170         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Mouse_HID_Interface);
 171
 172         USB_Device_EnableSOFEvents();
 173
 174         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 175 }
 176
 177 /** Event handler for the library USB Control Request reception event. */
 178 void EVENT_USB_Device_ControlRequest(void)
 179 {
 180         CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
 181         HID_Device_ProcessControlRequest(&Mouse_HID_Interface);
 182 }
 183
 184 /** Event handler for the USB device Start Of Frame event. */
 185 void EVENT_USB_Device_StartOfFrame(void)
 186 {
 187         HID_Device_MillisecondElapsed(&Mouse_HID_Interface);
 188 }
 189
 190 /** HID class driver callback function for the creation of HID reports to the host.
 191  *
 192  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 193  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 194  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 195  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 196  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 197  *
 198  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 199  */
 200 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 201                                          uint8_t* const ReportID,
 202                                          const uint8_t ReportType,
 203                                          void* ReportData,
 204                                          uint16_t* const ReportSize)
 205 {
 206         USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
 207
 208         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 209         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 210
 211         if (JoyStatus_LCL & JOY_UP)
 212           MouseReport->Y = -1;
 213         else if (JoyStatus_LCL & JOY_DOWN)
 214           MouseReport->Y =  1;
 215
 216         if (JoyStatus_LCL & JOY_LEFT)
 217           MouseReport->X = -1;
 218         else if (JoyStatus_LCL & JOY_RIGHT)
 219           MouseReport->X =  1;
 220
 221         if (JoyStatus_LCL & JOY_PRESS)
 222           MouseReport->Button |= (1 << 0);
 223
 224         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 225           MouseReport->Button |= (1 << 1);
 226
 227         *ReportSize = sizeof(USB_MouseReport_Data_t);
 228         return true;
 229 }
 230
 231 /** HID class driver callback function for the processing of HID reports from the host.
 232  *
 233  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 234  *  \param[in] ReportID    Report ID of the received report from the host
 235  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 236  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 237  *  \param[in] ReportSize  Size in bytes of the received HID report
 238  */
 239 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 240                                           const uint8_t ReportID,
 241                                           const uint8_t ReportType,
 242                                           const void* ReportData,
 243                                           const uint16_t ReportSize)
 244 {
 245         // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports
 246 }
 247