Commit for the 091122 release.

[pub/USBasp.git] / Demos / Device / ClassDriver / Keyboard / Keyboard.c

diff --git a/Demos/Device/ClassDriver/Keyboard/Keyboard.c b/Demos/Device/ClassDriver/Keyboard/Keyboard.c
index bebad12..2918f5a 100644 (file)
--- a/Demos/Device/ClassDriver/Keyboard/Keyboard.c
+++ b/Demos/Device/ClassDriver/Keyboard/Keyboard.c
@@ -37,20 +37,26 @@
 \r
 #include "Keyboard.h"\r
 \r
 \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
  */\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_t Keyboard_HID_Interface =\r
-    {\r
-        .InterfaceNumber         = 0,\r
-\r
-        .ReportINEndpointNumber  = KEYBOARD_EPNUM,\r
-        .ReportINEndpointSize    = KEYBOARD_EPSIZE,\r
-\r
-               .ReportINBufferSize      = sizeof(USB_KeyboardReport_Data_t),\r
-\r
-        .IdleCount               = 500,\r
+USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =\r
+       {\r
+               .Config =\r
+                       {\r
+                               .InterfaceNumber              = 0,\r
+\r
+                               .ReportINEndpointNumber       = KEYBOARD_EPNUM,\r
+                               .ReportINEndpointSize         = KEYBOARD_EPSIZE,\r
+                               .ReportINEndpointDoubleBank   = false,\r
+\r
+                               .PrevReportINBuffer           = PrevKeyboardHIDReportBuffer,\r
+                               .PrevReportINBufferSize       = sizeof(PrevKeyboardHIDReportBuffer),\r
+                       },\r

     };\r
 \r
 /** Main program entry point. This routine contains the overall program flow, including initial\r
     };\r
 \r
 /** Main program entry point. This routine contains the overall program flow, including initial\r


@@ -58,127 +64,139 @@ USB_ClassInfo_HID_t Keyboard_HID_Interface =
  */\r
 int main(void)\r
 {\r
  */\r
 int main(void)\r
 {\r

-    SetupHardware();\r
-\r
-    LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-    \r
-    for (;;)\r
-    {\r
-        USB_HID_USBTask(&Keyboard_HID_Interface);\r
-        USB_USBTask();\r
-    }\r
+       SetupHardware();\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+       \r
+       for (;;)\r
+       {\r
+               HID_Device_USBTask(&Keyboard_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
 }\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
-    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
+       /* 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
+       Buttons_Init();\r
+       USB_Init();\r

 }\r
 \r
 /** Event handler for the library USB Connection event. */\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
 {\r

-    LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r

 }\r
 \r
 /** Event handler for the library USB Disconnection event. */\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
 {\r

-    LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r

 }\r
 \r
 /** Event handler for the library USB Configuration Changed event. */\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
 {\r

-    LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+\r
+       if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))\r
+         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r

 \r
 \r

-    if (!(USB_HID_ConfigureEndpoints(&Keyboard_HID_Interface)))\r
-      LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+       USB_Device_EnableSOFEvents();\r

 }\r
 \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
 {\r

-    USB_HID_ProcessControlPacket(&Keyboard_HID_Interface);\r
+       HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);\r

 }\r
 \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
 {\r

-       if (Keyboard_HID_Interface.IdleMSRemaining)\r
-         Keyboard_HID_Interface.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
 }\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 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[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
  *\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
  */\r

-uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_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
+                                         void* ReportData, uint16_t* ReportSize)\r

 {\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
-    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
-    if (ButtonStatus_LCL & BUTTONS_BUTTON1)\r
-      KeyboardReport->KeyCode[0] = 0x09; // F\r
-      \r
-    return sizeof(USB_KeyboardReport_Data_t);\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
+       static uint8_t PrevUsedKeyCodes;\r
+       uint8_t UsedKeyCodes = 0;\r
+       \r
+       if (JoyStatus_LCL & JOY_UP)\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x04; // A\r
+       else if (JoyStatus_LCL & JOY_DOWN)\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x05; // B\r
+\r
+       if (JoyStatus_LCL & JOY_LEFT)\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x06; // C\r
+       else if (JoyStatus_LCL & JOY_RIGHT)\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x07; // D\r
+\r
+       if (JoyStatus_LCL & JOY_PRESS)\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x08; // E\r
+         \r
+       if (ButtonStatus_LCL & BUTTONS_BUTTON1)\r
+         KeyboardReport->KeyCode[UsedKeyCodes++] = 0x09; // F\r
+       \r
+       /* The host will ignore the device if we add a new keycode to the report while another keycode is currently\r
+        * being sent (i.e. the user has pressed another key while a key is already being pressed) - we need to intersperse\r
+        * the two reports with a zeroed report to force the host to accept the additional keys */\r
+       if (UsedKeyCodes != PrevUsedKeyCodes)\r
+       {\r
+               memset(KeyboardReport, sizeof(USB_KeyboardReport_Data_t), 0x00);\r
+               PrevUsedKeyCodes = UsedKeyCodes;\r
+       }\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
 }\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 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
  */\r

-void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_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
 {\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
+       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
 }\r