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