Fixed Mouse and Keyboard device demos not acting in accordance with the HID specifica...

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

diff --git a/Demos/Device/Keyboard/Keyboard.c b/Demos/Device/Keyboard/Keyboard.c
index 33545bf..7b93172 100644 (file)
--- a/Demos/Device/Keyboard/Keyboard.c
+++ b/Demos/Device/Keyboard/Keyboard.c
@@ -56,9 +56,9 @@ TASK_LIST
 bool UsingReportProtocol = true;\r
 \r
 /** Current Idle period. This is set by the host via a Set Idle HID class request to silence the device's reports\r
 bool UsingReportProtocol = true;\r
 \r
 /** Current Idle period. This is set by the host via a Set Idle HID class request to silence the device's reports\r

- *  for either the entire idle duration, or until the report status changes (e.g. the user moves the mouse).\r
+ *  for either the entire idle duration, or until the report status changes (e.g. the user presses a key).\r

  */\r
  */\r

-uint8_t IdleCount = 0;\r
+uint16_t IdleCount = 500;\r

 \r
 /** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle\r
  *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request \r
 \r
 /** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle\r
  *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request \r


@@ -140,9 +140,7 @@ EVENT_HANDLER(USB_Reset)
 EVENT_HANDLER(USB_Disconnect)\r
 {\r
        /* Stop running keyboard reporting and USB management tasks */\r
 EVENT_HANDLER(USB_Disconnect)\r
 {\r
        /* Stop running keyboard reporting and USB management tasks */\r

-       #if !defined(INTERRUPT_DATA_ENDPOINT)\r

        Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_STOP);\r
        Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_STOP);\r

-       #endif\r

 \r
        #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
        Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
 \r
        #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
        Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r


@@ -162,28 +160,16 @@ EVENT_HANDLER(USB_ConfigurationChanged)
                                       ENDPOINT_DIR_IN, KEYBOARD_EPSIZE,\r
                                   ENDPOINT_BANK_SINGLE);\r
 \r
                                       ENDPOINT_DIR_IN, KEYBOARD_EPSIZE,\r
                                   ENDPOINT_BANK_SINGLE);\r
 \r

-       #if defined(INTERRUPT_DATA_ENDPOINT)\r
-       /* Enable the endpoint IN interrupt ISR for the report endpoint */\r
-       USB_INT_Enable(ENDPOINT_INT_IN);\r
-       #endif\r
-\r

        /* Setup Keyboard LED Report Endpoint */\r
        Endpoint_ConfigureEndpoint(KEYBOARD_LEDS_EPNUM, EP_TYPE_INTERRUPT,\r
                                       ENDPOINT_DIR_OUT, KEYBOARD_EPSIZE,\r
                                   ENDPOINT_BANK_SINGLE);\r
 \r
        /* Setup Keyboard LED Report Endpoint */\r
        Endpoint_ConfigureEndpoint(KEYBOARD_LEDS_EPNUM, EP_TYPE_INTERRUPT,\r
                                       ENDPOINT_DIR_OUT, KEYBOARD_EPSIZE,\r
                                   ENDPOINT_BANK_SINGLE);\r
 \r

-       #if defined(INTERRUPT_DATA_ENDPOINT)\r
-       /* Enable the endpoint OUT interrupt ISR for the LED report endpoint */\r
-       USB_INT_Enable(ENDPOINT_INT_OUT);\r
-       #endif\r
-\r

        /* Indicate USB connected and ready */\r
        UpdateStatus(Status_USBReady);\r
 \r
        /* Indicate USB connected and ready */\r
        UpdateStatus(Status_USBReady);\r
 \r

-       #if !defined(INTERRUPT_DATA_ENDPOINT)\r

        /* Start running keyboard reporting task */\r
        Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_RUN);\r
        /* Start running keyboard reporting task */\r
        Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_RUN);\r

-       #endif\r

 }\r
 \r
 /** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific\r
 }\r
 \r
 /** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific\r


@@ -358,7 +344,7 @@ void ProcessLEDReport(uint8_t LEDReport)
 }\r
 \r
 /** Sends the next HID report to the host, via the keyboard data endpoint. */\r
 }\r
 \r
 /** Sends the next HID report to the host, via the keyboard data endpoint. */\r

-static inline void SendNextReport(void)\r
+void SendNextReport(void)\r

 {\r
        static USB_KeyboardReport_Data_t PrevKeyboardReportData;\r
        USB_KeyboardReport_Data_t        KeyboardReportData;\r
 {\r
        static USB_KeyboardReport_Data_t PrevKeyboardReportData;\r
        USB_KeyboardReport_Data_t        KeyboardReportData;\r


@@ -367,41 +353,38 @@ static inline void SendNextReport(void)
        /* Create the next keyboard report for transmission to the host */\r
        CreateKeyboardReport(&KeyboardReportData);\r
        \r
        /* Create the next keyboard report for transmission to the host */\r
        CreateKeyboardReport(&KeyboardReportData);\r
        \r

-       /* Check if the idle period is set */\r
-       if (IdleCount)\r
-       {\r
-               /* Check if idle period has elapsed */\r
-               if (!(IdleMSRemaining))\r
-               {\r
-                       /* Reset the idle time remaining counter, must multiply by 4 to get the duration in milliseconds */\r
-                       IdleMSRemaining = (IdleCount << 2);\r
-               }\r
-               else\r
-               {\r
-                       /* Idle period not elapsed, indicate that a report must not be sent unless the report has changed */\r
-                       SendReport = (memcmp(&PrevKeyboardReportData, &KeyboardReportData, sizeof(USB_KeyboardReport_Data_t)) != 0);\r
-               }\r
-       }\r
+       /* Check to see if the report data has changed - if so a report MUST be sent */\r
+       SendReport = (memcmp(&PrevKeyboardReportData, &KeyboardReportData, sizeof(USB_KeyboardReport_Data_t)) != 0);\r

        \r
        /* Save the current report data for later comparison to check for changes */\r
        PrevKeyboardReportData = KeyboardReportData;\r
        \r
        /* Save the current report data for later comparison to check for changes */\r
        PrevKeyboardReportData = KeyboardReportData;\r

-\r
+       \r
+       /* Check if the idle period is set and has elapsed */\r
+       if ((IdleCount != HID_IDLE_CHANGESONLY) && (!(IdleMSRemaining)))\r
+       {\r
+               /* Reset the idle time remaining counter, must multiply by 4 to get the duration in milliseconds */\r
+               IdleMSRemaining = (IdleCount << 2);\r
+               \r
+               /* Idle period is set and has elapsed, must send a report to the host */\r
+               SendReport = true;\r
+       }\r
+       \r

        /* Select the Keyboard Report Endpoint */\r
        Endpoint_SelectEndpoint(KEYBOARD_EPNUM);\r
 \r
        /* Select the Keyboard Report Endpoint */\r
        Endpoint_SelectEndpoint(KEYBOARD_EPNUM);\r
 \r

-       /* Check if Keyboard Endpoint Ready for Read/Write, and if we should send a report */\r
+       /* Check if Keyboard Endpoint Ready for Read/Write and if we should send a new report */\r

        if (Endpoint_IsReadWriteAllowed() && SendReport)\r
        {\r
                /* Write Keyboard Report Data */\r
                Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));\r
        if (Endpoint_IsReadWriteAllowed() && SendReport)\r
        {\r
                /* Write Keyboard Report Data */\r
                Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));\r

-\r
+               \r

                /* Finalize the stream transfer to send the last packet */\r
                Endpoint_ClearIN();\r
        }\r
 }\r
 \r
 /** Reads the next LED status report from the host from the LED data endpoint, if one has been sent. */\r
                /* Finalize the stream transfer to send the last packet */\r
                Endpoint_ClearIN();\r
        }\r
 }\r
 \r
 /** Reads the next LED status report from the host from the LED data endpoint, if one has been sent. */\r

-static inline void ReceiveNextReport(void)\r
+void ReceiveNextReport(void)\r

 {\r
        /* Select the Keyboard LED Report Endpoint */\r
        Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);\r
 {\r
        /* Select the Keyboard LED Report Endpoint */\r
        Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);\r


@@ -451,7 +434,6 @@ void UpdateStatus(uint8_t CurrentStatus)
        LEDs_SetAllLEDs(LEDMask);\r
 }\r
 \r
        LEDs_SetAllLEDs(LEDMask);\r
 }\r
 \r

-#if !defined(INTERRUPT_DATA_ENDPOINT)\r

 /** Function to manage HID report generation and transmission to the host, when in report mode. */\r
 TASK(USB_Keyboard_Report)\r
 {\r
 /** Function to manage HID report generation and transmission to the host, when in report mode. */\r
 TASK(USB_Keyboard_Report)\r
 {\r


@@ -465,8 +447,8 @@ TASK(USB_Keyboard_Report)
                ReceiveNextReport();\r
        }\r
 }\r
                ReceiveNextReport();\r
        }\r
 }\r

-#endif\r

 \r
 \r

+#if defined(INTERRUPT_CONTROL_ENDPOINT)\r

 /** ISR for the general Pipe/Endpoint interrupt vector. This ISR fires when an endpoint's status changes (such as\r
  *  a packet has been received) on an endpoint with its corresponding ISR enabling bits set. This is used to send\r
  *  HID packets to the host each time the HID interrupt endpoints polling period elapses, as managed by the USB\r
 /** ISR for the general Pipe/Endpoint interrupt vector. This ISR fires when an endpoint's status changes (such as\r
  *  a packet has been received) on an endpoint with its corresponding ISR enabling bits set. This is used to send\r
  *  HID packets to the host each time the HID interrupt endpoints polling period elapses, as managed by the USB\r


@@ -475,52 +457,20 @@ TASK(USB_Keyboard_Report)
  */\r
 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
 {\r
  */\r
 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
 {\r

-       #if defined(INTERRUPT_CONTROL_ENDPOINT)\r
+       /* Save previously selected endpoint before selecting a new endpoint */\r
+       uint8_t PrevSelectedEndpoint = Endpoint_GetCurrentEndpoint();\r
+\r

        /* Check if the control endpoint has received a request */\r
        if (Endpoint_HasEndpointInterrupted(ENDPOINT_CONTROLEP))\r
        {\r
        /* Check if the control endpoint has received a request */\r
        if (Endpoint_HasEndpointInterrupted(ENDPOINT_CONTROLEP))\r
        {\r

-               /* Clear the endpoint interrupt */\r
-               Endpoint_ClearEndpointInterrupt(ENDPOINT_CONTROLEP);\r
-\r

                /* Process the control request */\r
                USB_USBTask();\r
 \r
                /* Handshake the endpoint setup interrupt - must be after the call to USB_USBTask() */\r
                USB_INT_Clear(ENDPOINT_INT_SETUP);\r
        }\r
                /* Process the control request */\r
                USB_USBTask();\r
 \r
                /* Handshake the endpoint setup interrupt - must be after the call to USB_USBTask() */\r
                USB_INT_Clear(ENDPOINT_INT_SETUP);\r
        }\r

-       #endif\r
-\r
-       #if defined(INTERRUPT_DATA_ENDPOINT)\r
-       /* Check if keyboard endpoint has interrupted */\r
-       if (Endpoint_HasEndpointInterrupted(KEYBOARD_EPNUM))\r
-       {\r
-               /* Select the Keyboard Report Endpoint */\r
-               Endpoint_SelectEndpoint(KEYBOARD_EPNUM);\r
-\r
-               /* Clear the endpoint IN interrupt flag */\r
-               USB_INT_Clear(ENDPOINT_INT_IN);\r
-\r
-               /* Clear the Keyboard Report endpoint interrupt */\r
-               Endpoint_ClearEndpointInterrupt(KEYBOARD_EPNUM);\r
-\r
-               /* Send the next keypress report to the host */\r
-               SendNextReport();\r
-       }\r
-\r
-       /* Check if Keyboard LED status Endpoint has interrupted */\r
-       if (Endpoint_HasEndpointInterrupted(KEYBOARD_LEDS_EPNUM))\r
-       {\r
-               /* Select the Keyboard LED Report Endpoint */\r
-               Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);\r
-\r
-               /* Clear the endpoint OUT interrupt flag */\r
-               USB_INT_Clear(ENDPOINT_INT_OUT);\r
-\r
-               /* Clear the Keyboard LED Report endpoint interrupt */\r
-               Endpoint_ClearEndpointInterrupt(KEYBOARD_LEDS_EPNUM);\r
-\r
-               /* Process the LED report sent from the host */\r
-               ReceiveNextReport();\r
-       }\r
-       #endif\r
+       \r
+       /* Restore previously selected endpoint */\r
+       Endpoint_SelectEndpoint(PrevSelectedEndpoint);  \r

 }\r
 }\r

+#endif\r