Add LUFA-side channel open/close routines, add signalling handlers for the creation...
[pub/USBasp.git] / Demos / Device / ClassDriver / Keyboard / Keyboard.c
index f44a934..26636bf 100644 (file)
@@ -1,22 +1,22 @@
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)\r
+  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)\r
       Based on code by 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
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all 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
@@ -37,6 +37,9 @@
 \r
 #include "Keyboard.h"\r
 \r
+/** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */\r
+uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_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
@@ -45,18 +48,15 @@ USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
        {\r
                .Config =\r
                        {\r
-                               .InterfaceNumber         = 0,\r
+                               .InterfaceNumber              = 0,\r
 \r
-                               .ReportINEndpointNumber  = KEYBOARD_EPNUM,\r
-                               .ReportINEndpointSize    = KEYBOARD_EPSIZE,\r
+                               .ReportINEndpointNumber       = KEYBOARD_EPNUM,\r
+                               .ReportINEndpointSize         = KEYBOARD_EPSIZE,\r
+                               .ReportINEndpointDoubleBank   = false,\r
 \r
-                               .ReportINBufferSize      = sizeof(USB_KeyboardReport_Data_t),\r
+                               .PrevReportINBuffer           = PrevKeyboardHIDReportBuffer,\r
+                               .PrevReportINBufferSize       = sizeof(PrevKeyboardHIDReportBuffer),\r
                        },\r
-               \r
-               .State =\r
-                       {\r
-                               .IdleCount               = 500,\r
-                       }\r
     };\r
 \r
 /** Main program entry point. This routine contains the overall program flow, including initial\r
@@ -90,102 +90,105 @@ void SetupHardware()
        LEDs_Init();\r
        Buttons_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
+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_Disconnect(void)\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_ConfigurationChanged(void)\r
+void EVENT_USB_Device_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
+       USB_Device_EnableSOFEvents();\r
 }\r
 \r
-/** Event handler for the library USB Unhandled Control Packet event. */\r
-void EVENT_USB_UnhandledControlPacket(void)\r
+/** Event handler for the library USB Unhandled Control Request event. */\r
+void EVENT_USB_Device_UnhandledControlRequest(void)\r
 {\r
-       HID_Device_ProcessControlPacket(&Keyboard_HID_Interface);\r
+       HID_Device_ProcessControlRequest(&Keyboard_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
+/** Event handler for the USB device Start Of Frame event. */\r
+void EVENT_USB_Device_StartOfFrame(void)\r
 {\r
-       if (Keyboard_HID_Interface.State.IdleMSRemaining)\r
-         Keyboard_HID_Interface.State.IdleMSRemaining--;\r
+       HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);\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
+ *  \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[in] ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature\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 Number of bytes written in the report (or zero if no report is to be sent\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
-uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData)\r
+bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,\r
+                                         const uint8_t ReportType, void* ReportData, uint16_t* ReportSize)\r
 {\r
        USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;\r
        \r
        uint8_t JoyStatus_LCL    = Joystick_GetStatus();\r
        uint8_t ButtonStatus_LCL = Buttons_GetStatus();\r
 \r
+       uint8_t UsedKeyCodes = 0;\r
+       \r
+       KeyboardReport->Modifier = HID_KEYBOARD_MODIFER_LEFTSHIFT;\r
+       \r
        if (JoyStatus_LCL & JOY_UP)\r
-         KeyboardReport->KeyCode[0] = 0x04; // A\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x04; // A\r
        else if (JoyStatus_LCL & JOY_DOWN)\r
-         KeyboardReport->KeyCode[0] = 0x05; // B\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x05; // B\r
 \r
        if (JoyStatus_LCL & JOY_LEFT)\r
-         KeyboardReport->KeyCode[0] = 0x06; // C\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x06; // C\r
        else if (JoyStatus_LCL & JOY_RIGHT)\r
-         KeyboardReport->KeyCode[0] = 0x07; // D\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x07; // D\r
 \r
        if (JoyStatus_LCL & JOY_PRESS)\r
-         KeyboardReport->KeyCode[0] = 0x08; // E\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x08; // E\r
          \r
        if (ButtonStatus_LCL & BUTTONS_BUTTON1)\r
-         KeyboardReport->KeyCode[0] = 0x09; // F\r
-         \r
-       return sizeof(USB_KeyboardReport_Data_t);\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x09; // F\r
+\r
+       *ReportSize = sizeof(USB_KeyboardReport_Data_t);\r
+       return false;\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
+ *  \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* HIDInterfaceInfo, uint8_t ReportID,\r
-                                          void* ReportData, uint16_t ReportSize)\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
        uint8_t  LEDMask   = LEDS_NO_LEDS;\r
        uint8_t* LEDReport = (uint8_t*)ReportData;\r
 \r
-       if (*LEDReport & 0x01) // NUM Lock\r
+       if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)\r
          LEDMask |= LEDS_LED1;\r
        \r
-       if (*LEDReport & 0x02) // CAPS Lock\r
+       if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)\r
          LEDMask |= LEDS_LED3;\r
 \r
-       if (*LEDReport & 0x04) // SCROLL Lock\r
+       if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)\r
          LEDMask |= LEDS_LED4;\r
          \r
        LEDs_SetAllLEDs(LEDMask);\r