Add tag for the 120219 release.
[pub/USBasp.git] / Demos / Device / ClassDriver / KeyboardMouse / KeyboardMouse.c
index 30e90f4..cb2eebf 100644 (file)
-/*\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
-  Copyright 2009  Denver Gingerich (denver [at] ossguy [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 KeyboardMouse demo. This file contains the main tasks of\r
- *  the demo and is responsible for the initial application hardware configuration.\r
- */\r
-\r
-#include "KeyboardMouse.h"\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. This is for the keyboard HID\r
- *  interface within the device.\r
- */\r
-USB_ClassInfo_HID_t Keyboard_HID_Interface =\r
-       {\r
-               .InterfaceNumber         = 0,\r
-\r
-               .ReportINEndpointNumber  = KEYBOARD_IN_EPNUM,\r
-               .ReportINEndpointSize    = HID_EPSIZE,\r
-               \r
-               .ReportINBufferSize      = sizeof(USB_KeyboardReport_Data_t),\r
-\r
-               .IdleCount               = 500,\r
-       };\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. This is for the mouse HID\r
- *  interface within the device.\r
- */\r
-USB_ClassInfo_HID_t Mouse_HID_Interface =\r
-       {\r
-               .InterfaceNumber         = 0,\r
-\r
-               .ReportINEndpointNumber  = MOUSE_IN_EPNUM,\r
-               .ReportINEndpointSize    = HID_EPSIZE,\r
-\r
-               .ReportINBufferSize      = sizeof(USB_MouseReport_Data_t),\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
-               HID_Device_USBTask(&Keyboard_HID_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()\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
-       /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */\r
-       OCR0A  = ((F_CPU / 64) / 1000);\r
-       TCCR0A = (1 << WGM01);\r
-       TCCR0B = ((1 << CS01) | (1 << CS00));\r
-       TIMSK0 = (1 << OCIE0A);\r
-}\r
-\r
-/** Event handler for the library USB Connection event. */\r
-void EVENT_USB_Connect(void)\r
-{\r
-    LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
-}\r
-\r
-/** Event handler for the library USB Disconnection event. */\r
-void EVENT_USB_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_ConfigurationChanged(void)\r
-{\r
-       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
-\r
-       if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))\r
-         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-       \r
-       if (!(HID_Device_ConfigureEndpoints(&Mouse_HID_Interface)))\r
-         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-}\r
-\r
-/** Event handler for the library USB Unhandled Control Packet event. */\r
-void EVENT_USB_UnhandledControlPacket(void)\r
-{\r
-       HID_Device_ProcessControlPacket(&Keyboard_HID_Interface);\r
-       HID_Device_ProcessControlPacket(&Mouse_HID_Interface);\r
-}\r
-\r
-/** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */\r
-ISR(TIMER0_COMPA_vect, ISR_BLOCK)\r
-{\r
-       if (Keyboard_HID_Interface.IdleMSRemaining)\r
-         Keyboard_HID_Interface.IdleMSRemaining--;\r
-\r
-       if (Mouse_HID_Interface.IdleMSRemaining)\r
-         Mouse_HID_Interface.IdleMSRemaining--;\r
-}\r
-\r
-/** HID class driver callback function for the creation of HID reports to the host.\r
- *\r
- *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
- *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID\r
- *  \param ReportData  Pointer to a buffer where the created report should be stored\r
- *\r
- *  \return Number of bytes written in the report (or zero if no report is to be sent\r
- */\r
-uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData)\r
-{\r
-       uint8_t JoyStatus_LCL    = Joystick_GetStatus();\r
-       uint8_t ButtonStatus_LCL = Buttons_GetStatus();\r
-\r
-       if (HIDInterfaceInfo == &Keyboard_HID_Interface)\r
-       {\r
-               USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;\r
-               \r
-               /* If first board button not being held down, no keyboard report */\r
-               if (!(ButtonStatus_LCL & BUTTONS_BUTTON1))\r
-                 return 0;\r
-               \r
-               if (JoyStatus_LCL & JOY_UP)\r
-                 KeyboardReport->KeyCode[0] = 0x04; // A\r
-               else if (JoyStatus_LCL & JOY_DOWN)\r
-                 KeyboardReport->KeyCode[0] = 0x05; // B\r
-\r
-               if (JoyStatus_LCL & JOY_LEFT)\r
-                 KeyboardReport->KeyCode[0] = 0x06; // C\r
-               else if (JoyStatus_LCL & JOY_RIGHT)\r
-                 KeyboardReport->KeyCode[0] = 0x07; // D\r
-\r
-               if (JoyStatus_LCL & JOY_PRESS)\r
-                 KeyboardReport->KeyCode[0] = 0x08; // E\r
-                 \r
-               return sizeof(USB_KeyboardReport_Data_t);\r
-       }\r
-       else\r
-       {\r
-               USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;\r
-\r
-               /* If first board button being held down, no mouse report */\r
-               if (ButtonStatus_LCL & BUTTONS_BUTTON1)\r
-                 return 0;\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
-               return sizeof(USB_MouseReport_Data_t);          \r
-       }\r
-}\r
-\r
-/** HID class driver callback function for the processing of HID reports from the host.\r
- *\r
- *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
- *  \param ReportID  Report ID of the received report from the host\r
- *  \param ReportData  Pointer to a buffer where the created report has been stored\r
- *  \param ReportSize  Size in bytes of the received HID report\r
- */\r
-void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID,\r
-                                          void* ReportData, uint16_t ReportSize)\r
-{\r
-       if (HIDInterfaceInfo == &Keyboard_HID_Interface)\r
-       {\r
-               uint8_t  LEDMask   = LEDS_NO_LEDS;\r
-               uint8_t* LEDReport = (uint8_t*)ReportData;\r
-\r
-               if (*LEDReport & 0x01) // NUM Lock\r
-                 LEDMask |= LEDS_LED1;\r
-               \r
-               if (*LEDReport & 0x02) // CAPS Lock\r
-                 LEDMask |= LEDS_LED3;\r
-\r
-               if (*LEDReport & 0x04) // SCROLL Lock\r
-                 LEDMask |= LEDS_LED4;\r
-                 \r
-               LEDs_SetAllLEDs(LEDMask);\r
-       }\r
-}
\ No newline at end of file
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2012.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Main source file for the KeyboardMouse demo. This file contains the main tasks of
+ *  the demo and is responsible for the initial application hardware configuration.
+ */
+
+#include "KeyboardMouse.h"
+
+/** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */
+static uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];
+
+/** Buffer to hold the previously generated Mouse HID report, for comparison purposes inside the HID class driver. */
+static uint8_t PrevMouseHIDReportBuffer[sizeof(USB_MouseReport_Data_t)];
+
+/** LUFA HID Class driver interface configuration and state information. This structure is
+ *  passed to all HID Class driver functions, so that multiple instances of the same class
+ *  within a device can be differentiated from one another. This is for the keyboard HID
+ *  interface within the device.
+ */
+USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
+       {
+               .Config =
+                       {
+                               .InterfaceNumber              = 0,
+
+                               .ReportINEndpointNumber       = KEYBOARD_IN_EPNUM,
+                               .ReportINEndpointSize         = HID_EPSIZE,
+                               .ReportINEndpointDoubleBank   = false,
+
+                               .PrevReportINBuffer           = PrevKeyboardHIDReportBuffer,
+                               .PrevReportINBufferSize       = sizeof(PrevKeyboardHIDReportBuffer),
+                       },
+       };
+
+/** LUFA HID Class driver interface configuration and state information. This structure is
+ *  passed to all HID Class driver functions, so that multiple instances of the same class
+ *  within a device can be differentiated from one another. This is for the mouse HID
+ *  interface within the device.
+ */
+USB_ClassInfo_HID_Device_t Mouse_HID_Interface =
+       {
+               .Config =
+                       {
+                               .InterfaceNumber              = 1,
+
+                               .ReportINEndpointNumber       = MOUSE_IN_EPNUM,
+                               .ReportINEndpointSize         = HID_EPSIZE,
+
+                               .PrevReportINBuffer           = PrevMouseHIDReportBuffer,
+                               .PrevReportINBufferSize       = sizeof(PrevMouseHIDReportBuffer),
+                       },
+       };
+
+
+/** Main program entry point. This routine contains the overall program flow, including initial
+ *  setup of all components and the main program loop.
+ */
+int main(void)
+{
+       SetupHardware();
+
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+       sei();
+
+       for (;;)
+       {
+               HID_Device_USBTask(&Keyboard_HID_Interface);
+               HID_Device_USBTask(&Mouse_HID_Interface);
+               USB_USBTask();
+       }
+}
+
+/** Configures the board hardware and chip peripherals for the demo's functionality. */
+void SetupHardware()
+{
+       /* Disable watchdog if enabled by bootloader/fuses */
+       MCUSR &= ~(1 << WDRF);
+       wdt_disable();
+
+       /* Disable clock division */
+       clock_prescale_set(clock_div_1);
+
+       /* Hardware Initialization */
+       Joystick_Init();
+       LEDs_Init();
+       USB_Init();
+}
+
+/** Event handler for the library USB Connection event. */
+void EVENT_USB_Device_Connect(void)
+{
+    LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+}
+
+/** Event handler for the library USB Disconnection event. */
+void EVENT_USB_Device_Disconnect(void)
+{
+    LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+}
+
+/** Event handler for the library USB Configuration Changed event. */
+void EVENT_USB_Device_ConfigurationChanged(void)
+{
+       bool ConfigSuccess = true;
+
+       ConfigSuccess &= HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);
+       ConfigSuccess &= HID_Device_ConfigureEndpoints(&Mouse_HID_Interface);
+
+       USB_Device_EnableSOFEvents();
+
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
+}
+
+/** Event handler for the library USB Control Request reception event. */
+void EVENT_USB_Device_ControlRequest(void)
+{
+       HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
+       HID_Device_ProcessControlRequest(&Mouse_HID_Interface);
+}
+
+/** Event handler for the USB device Start Of Frame event. */
+void EVENT_USB_Device_StartOfFrame(void)
+{
+       HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
+       HID_Device_MillisecondElapsed(&Mouse_HID_Interface);
+}
+
+/** HID class driver callback function for the creation of HID reports to the host.
+ *
+ *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
+ *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
+ *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
+ *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent)
+ *
+ *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
+ */
+bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
+                                         uint8_t* const ReportID,
+                                         const uint8_t ReportType,
+                                         void* ReportData,
+                                         uint16_t* const ReportSize)
+{
+       uint8_t JoyStatus_LCL    = Joystick_GetStatus();
+       uint8_t ButtonStatus_LCL = Buttons_GetStatus();
+
+       /* Determine which interface must have its report generated */
+       if (HIDInterfaceInfo == &Keyboard_HID_Interface)
+       {
+               USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
+
+               /* If first board button not being held down, no keyboard report */
+               if (!(ButtonStatus_LCL & BUTTONS_BUTTON1))
+                 return 0;
+
+               KeyboardReport->Modifier = HID_KEYBOARD_MODIFIER_LEFTSHIFT;
+
+               if (JoyStatus_LCL & JOY_UP)
+                 KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_A;
+               else if (JoyStatus_LCL & JOY_DOWN)
+                 KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_B;
+
+               if (JoyStatus_LCL & JOY_LEFT)
+                 KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_C;
+               else if (JoyStatus_LCL & JOY_RIGHT)
+                 KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_D;
+
+               if (JoyStatus_LCL & JOY_PRESS)
+                 KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_E;
+
+               *ReportSize = sizeof(USB_KeyboardReport_Data_t);
+               return false;
+       }
+       else
+       {
+               USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
+
+               /* If first board button being held down, no mouse report */
+               if (ButtonStatus_LCL & BUTTONS_BUTTON1)
+                 return 0;
+
+               if (JoyStatus_LCL & JOY_UP)
+                 MouseReport->Y = -1;
+               else if (JoyStatus_LCL & JOY_DOWN)
+                 MouseReport->Y =  1;
+
+               if (JoyStatus_LCL & JOY_LEFT)
+                 MouseReport->X = -1;
+               else if (JoyStatus_LCL & JOY_RIGHT)
+                 MouseReport->X =  1;
+
+               if (JoyStatus_LCL & JOY_PRESS)
+                 MouseReport->Button |= (1 << 0);
+
+               *ReportSize = sizeof(USB_MouseReport_Data_t);
+               return true;
+       }
+}
+
+/** HID class driver callback function for the processing of HID reports from the host.
+ *
+ *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param[in] ReportID    Report ID of the received report from the host
+ *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
+ *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
+ *  \param[in] ReportSize  Size in bytes of the received HID report
+ */
+void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
+                                          const uint8_t ReportID,
+                                          const uint8_t ReportType,
+                                          const void* ReportData,
+                                          const uint16_t ReportSize)
+{
+       if (HIDInterfaceInfo == &Keyboard_HID_Interface)
+       {
+               uint8_t  LEDMask   = LEDS_NO_LEDS;
+               uint8_t* LEDReport = (uint8_t*)ReportData;
+
+               if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
+                 LEDMask |= LEDS_LED1;
+
+               if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
+                 LEDMask |= LEDS_LED3;
+
+               if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
+                 LEDMask |= LEDS_LED4;
+
+               LEDs_SetAllLEDs(LEDMask);
+       }
+}
+