Add new CDCMouse ClassDriver device demo, combining a CDC Virtual Serial Port and...
[pub/lufa.git] / Demos / Device / ClassDriver / CDCMouse / CDCMouse.c
diff --git a/Demos/Device/ClassDriver/CDCMouse/CDCMouse.c b/Demos/Device/ClassDriver/CDCMouse/CDCMouse.c
new file mode 100644 (file)
index 0000000..1102b7e
--- /dev/null
@@ -0,0 +1,235 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Main source file for the CDCMouse demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r
+ */\r
\r
+#include "CDCMouse.h"\r
+\r
+/** LUFA CDC Class driver interface configuration and state information. This structure is\r
+ *  passed to all CDC Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another.\r
+ */\r
+USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =\r
+       {\r
+               .Config =\r
+                       {\r
+                               .ControlInterfaceNumber     = 0,\r
+\r
+                               .DataINEndpointNumber       = CDC_TX_EPNUM,\r
+                               .DataINEndpointSize         = CDC_TXRX_EPSIZE,\r
+\r
+                               .DataOUTEndpointNumber      = CDC_RX_EPNUM,\r
+                               .DataOUTEndpointSize        = CDC_TXRX_EPSIZE,\r
+\r
+                               .NotificationEndpointNumber = CDC_NOTIFICATION_EPNUM,\r
+                               .NotificationEndpointSize   = CDC_NOTIFICATION_EPSIZE,\r
+                       },\r
+       };\r
+\r
+/** Buffer to hold the previously generated Mouse HID report, for comparison purposes inside the HID class driver. */\r
+uint8_t PrevMouseHIDReportBuffer[sizeof(USB_MouseReport_Data_t)];\r
+\r
+/** LUFA HID Class driver interface configuration and state information. This structure is\r
+ *  passed to all HID Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another.\r
+ */\r
+USB_ClassInfo_HID_Device_t Mouse_HID_Interface =\r
+       {\r
+               .Config =\r
+                       {\r
+                               .InterfaceNumber         = 0,\r
+\r
+                               .ReportINEndpointNumber  = MOUSE_EPNUM,\r
+                               .ReportINEndpointSize    = MOUSE_EPSIZE,\r
+\r
+                               .PrevReportINBuffer      = PrevMouseHIDReportBuffer,\r
+                               .PrevReportINBufferSize  = sizeof(PrevMouseHIDReportBuffer),\r
+                       },\r
+       };\r
+\r
+/** Main program entry point. This routine contains the overall program flow, including initial\r
+ *  setup of all components and the main program loop.\r
+ */\r
+int main(void)\r
+{\r
+       SetupHardware();\r
+       \r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+       for (;;)\r
+       {\r
+               CheckJoystickMovement();\r
+                \r
+               /* Must throw away unused bytes from the host, or it will lock up while waiting for the device */\r
+               while (CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface))\r
+                 CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);\r
+\r
+               CDC_Device_USBTask(&VirtualSerial_CDC_Interface);\r
+               HID_Device_USBTask(&Mouse_HID_Interface);\r
+               USB_USBTask();\r
+       }\r
+}\r
+\r
+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
+void SetupHardware(void)\r
+{\r
+       /* Disable watchdog if enabled by bootloader/fuses */\r
+       MCUSR &= ~(1 << WDRF);\r
+       wdt_disable();\r
+\r
+       /* Disable clock division */\r
+       clock_prescale_set(clock_div_1);\r
+\r
+       /* Hardware Initialization */\r
+       Joystick_Init();\r
+       LEDs_Init();\r
+       USB_Init();\r
+}\r
+\r
+/** Checks for changes in the position of the board joystick, sending strings to the host upon each change. */\r
+void CheckJoystickMovement(void)\r
+{\r
+       uint8_t     JoyStatus_LCL = Joystick_GetStatus();\r
+       char*       ReportString  = NULL;\r
+       static bool ActionSent    = false;\r
+       \r
+       if (JoyStatus_LCL & JOY_UP)\r
+         ReportString = "Joystick Up\r\n";\r
+       else if (JoyStatus_LCL & JOY_DOWN)\r
+         ReportString = "Joystick Down\r\n";\r
+       else if (JoyStatus_LCL & JOY_LEFT)\r
+         ReportString = "Joystick Left\r\n";\r
+       else if (JoyStatus_LCL & JOY_RIGHT)\r
+         ReportString = "Joystick Right\r\n";\r
+       else if (JoyStatus_LCL & JOY_PRESS)\r
+         ReportString = "Joystick Pressed\r\n";\r
+       else\r
+         ActionSent = false;\r
+         \r
+       if ((ReportString != NULL) && (ActionSent == false))\r
+       {\r
+               ActionSent = true;\r
+               \r
+               CDC_Device_SendString(&VirtualSerial_CDC_Interface, ReportString, strlen(ReportString));                \r
+       }\r
+}\r
+\r
+/** Event handler for the library USB Connection event. */\r
+void EVENT_USB_Device_Connect(void)\r
+{\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+}\r
+\r
+/** Event handler for the library USB Disconnection event. */\r
+void EVENT_USB_Device_Disconnect(void)\r
+{\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+}\r
+\r
+/** Event handler for the library USB Configuration Changed event. */\r
+void EVENT_USB_Device_ConfigurationChanged(void)\r
+{\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+\r
+       if (!(CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface)))\r
+         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+\r
+       if (!(HID_Device_ConfigureEndpoints(&Mouse_HID_Interface)))\r
+         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+         \r
+       USB_Device_EnableSOFEvents();\r
+}\r
+\r
+/** Event handler for the library USB Unhandled Control Request event. */\r
+void EVENT_USB_Device_UnhandledControlRequest(void)\r
+{\r
+       CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);\r
+       HID_Device_ProcessControlRequest(&Mouse_HID_Interface);\r
+}\r
+\r
+/** Event handler for the USB device Start Of Frame event. */\r
+void EVENT_USB_Device_StartOfFrame(void)\r
+{\r
+       HID_Device_MillisecondElapsed(&Mouse_HID_Interface);\r
+}\r
+\r
+/** HID class driver callback function for the creation of HID reports to the host.\r
+ *\r
+ *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID\r
+ *  \param[out] ReportData  Pointer to a buffer where the created report should be stored\r
+ *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent\r
+ *\r
+ *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent\r
+ */\r
+bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,\r
+                                         void* ReportData, uint16_t* ReportSize)\r
+{\r
+       USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;\r
+               \r
+       uint8_t JoyStatus_LCL    = Joystick_GetStatus();\r
+       uint8_t ButtonStatus_LCL = Buttons_GetStatus();\r
+\r
+       if (JoyStatus_LCL & JOY_UP)\r
+         MouseReport->Y = -1;\r
+       else if (JoyStatus_LCL & JOY_DOWN)\r
+         MouseReport->Y =  1;\r
+\r
+       if (JoyStatus_LCL & JOY_RIGHT)\r
+         MouseReport->X =  1;\r
+       else if (JoyStatus_LCL & JOY_LEFT)\r
+         MouseReport->X = -1;\r
+\r
+       if (JoyStatus_LCL & JOY_PRESS)\r
+         MouseReport->Button  = (1 << 0);\r
+         \r
+       if (ButtonStatus_LCL & BUTTONS_BUTTON1)\r
+         MouseReport->Button |= (1 << 1);\r
+       \r
+       *ReportSize = sizeof(USB_MouseReport_Data_t);\r
+       return true;\r
+}\r
+\r
+/** HID class driver callback function for the processing of HID reports from the host.\r
+ *\r
+ *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param[in] ReportID  Report ID of the received report from the host\r
+ *  \param[in] ReportData  Pointer to a buffer where the created report has been stored\r
+ *  \param[in] ReportSize  Size in bytes of the received HID report\r
+ */\r
+void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
+                                          const void* ReportData, const uint16_t ReportSize)\r
+{\r
+       // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports\r
+}\r