USB_IsConnected is now cleared before the USB_Disconnect() event is fired in response...
[pub/USBasp.git] / Demos / Device / Keyboard / Keyboard.c
index f0e0186..6abd193 100644 (file)
 /* Scheduler Task List */\r
 TASK_LIST\r
 {\r
-       #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
-       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },\r
-       #endif\r
-       \r
-       #if !defined(INTERRUPT_DATA_ENDPOINT)\r
+       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },     \r
        { .Task = USB_Keyboard_Report  , .TaskStatus = TASK_STOP },\r
-       #endif\r
 };\r
 \r
 /* Global Variables */\r
@@ -56,9 +51,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
- *  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
-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
@@ -105,12 +100,10 @@ int main(void)
 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and\r
  *  starts the library USB task to begin the enumeration and USB management process.\r
  */\r
-EVENT_HANDLER(USB_Connect)\r
+void EVENT_USB_Connect(void)\r
 {\r
-       #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
        /* Start USB management task */\r
        Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-       #endif\r
 \r
        /* Indicate USB enumerating */\r
        UpdateStatus(Status_USBEnumerating);\r
@@ -119,34 +112,14 @@ EVENT_HANDLER(USB_Connect)
        UsingReportProtocol = true;\r
 }\r
 \r
-/** Event handler for the USB_Reset event. This fires when the USB interface is reset by the USB host, before the\r
- *  enumeration process begins, and enables the control endpoint interrupt so that control requests can be handled\r
- *  asynchronously when they arrive rather than when the control endpoint is polled manually.\r
- */\r
-EVENT_HANDLER(USB_Reset)\r
-{\r
-       #if defined(INTERRUPT_CONTROL_ENDPOINT)\r
-       /* Select the control endpoint */\r
-       Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);\r
-\r
-       /* Enable the endpoint SETUP interrupt ISR for the control endpoint */\r
-       USB_INT_Enable(ENDPOINT_INT_SETUP);\r
-       #endif\r
-}\r
-\r
 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
  *  the status LEDs.\r
  */\r
-EVENT_HANDLER(USB_Disconnect)\r
+void EVENT_USB_Disconnect(void)\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
-       #endif\r
-\r
-       #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
        Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-       #endif\r
        \r
        /* Indicate USB not ready */\r
        UpdateStatus(Status_USBNotReady);\r
@@ -155,81 +128,56 @@ EVENT_HANDLER(USB_Disconnect)
 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration\r
  *  of the USB device after enumeration, and configures the keyboard device endpoints.\r
  */\r
-EVENT_HANDLER(USB_ConfigurationChanged)\r
+void EVENT_USB_ConfigurationChanged(void)\r
 {\r
        /* Setup Keyboard Keycode Report Endpoint */\r
        Endpoint_ConfigureEndpoint(KEYBOARD_EPNUM, EP_TYPE_INTERRUPT,\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
-       #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
-       #if !defined(INTERRUPT_DATA_ENDPOINT)\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
  *  control requests that are not handled internally by the USB library (including the HID commands, which are\r
  *  all issued via the control endpoint), so that they can be handled appropriately for the application.\r
  */\r
-EVENT_HANDLER(USB_UnhandledControlPacket)\r
+void EVENT_USB_UnhandledControlPacket(void)\r
 {\r
        /* Handle HID Class specific requests */\r
-       switch (bRequest)\r
+       switch (USB_ControlRequest.bRequest)\r
        {\r
                case REQ_GetReport:\r
-                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
                                USB_KeyboardReport_Data_t KeyboardReportData;\r
 \r
+                               Endpoint_ClearSETUP();\r
+       \r
                                /* Create the next keyboard report for transmission to the host */\r
                                CreateKeyboardReport(&KeyboardReportData);\r
 \r
-                               /* Ignore report type and ID number value */\r
-                               Endpoint_Discard_Word();\r
-                               \r
-                               /* Ignore unused Interface number value */\r
-                               Endpoint_Discard_Word();\r
-\r
-                               /* Read in the number of bytes in the report to send to the host */\r
-                               uint16_t wLength = Endpoint_Read_Word_LE();\r
-                               \r
-                               /* If trying to send more bytes than exist to the host, clamp the value at the report size */\r
-                               if (wLength > sizeof(KeyboardReportData))\r
-                                 wLength = sizeof(KeyboardReportData);\r
-\r
-                               Endpoint_ClearControlSETUP();\r
-       \r
                                /* Write the report data to the control endpoint */\r
-                               Endpoint_Write_Control_Stream_LE(&KeyboardReportData, wLength);\r
+                               Endpoint_Write_Control_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));\r
                                \r
                                /* Finalize the stream transfer to send the last packet or clear the host abort */\r
-                               Endpoint_ClearControlOUT();\r
+                               Endpoint_ClearOUT();\r
                        }\r
                \r
                        break;\r
                case REQ_SetReport:\r
-                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
-                               Endpoint_ClearControlSETUP();\r
+                               Endpoint_ClearSETUP();\r
                                \r
                                /* Wait until the LED report has been sent by the host */\r
                                while (!(Endpoint_IsOUTReceived()));\r
@@ -241,79 +189,73 @@ EVENT_HANDLER(USB_UnhandledControlPacket)
                                ProcessLEDReport(LEDStatus);\r
                        \r
                                /* Clear the endpoint data */\r
-                               Endpoint_ClearControlOUT();\r
+                               Endpoint_ClearOUT();\r
 \r
                                /* Acknowledge status stage */\r
                                while (!(Endpoint_IsINReady()));\r
-                               Endpoint_ClearControlIN();\r
+                               Endpoint_ClearIN();\r
                        }\r
                        \r
                        break;\r
                case REQ_GetProtocol:\r
-                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
-                               Endpoint_ClearControlSETUP();\r
+                               Endpoint_ClearSETUP();\r
                                \r
                                /* Write the current protocol flag to the host */\r
                                Endpoint_Write_Byte(UsingReportProtocol);\r
                                \r
                                /* Send the flag to the host */\r
-                               Endpoint_ClearControlIN();\r
+                               Endpoint_ClearIN();\r
 \r
                                /* Acknowledge status stage */\r
                                while (!(Endpoint_IsOUTReceived()));\r
-                               Endpoint_ClearControlOUT();\r
+                               Endpoint_ClearOUT();\r
                        }\r
                        \r
                        break;\r
                case REQ_SetProtocol:\r
-                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
-                               /* Read in the wValue parameter containing the new protocol mode */\r
-                               uint16_t wValue = Endpoint_Read_Word_LE();\r
-                                                               \r
-                               Endpoint_ClearControlSETUP();\r
+                               Endpoint_ClearSETUP();\r
 \r
                                /* Set or clear the flag depending on what the host indicates that the current Protocol should be */\r
-                               UsingReportProtocol = (wValue != 0x0000);\r
+                               UsingReportProtocol = (USB_ControlRequest.wValue != 0);\r
 \r
                                /* Acknowledge status stage */\r
                                while (!(Endpoint_IsINReady()));\r
-                               Endpoint_ClearControlIN();\r
+                               Endpoint_ClearIN();\r
                        }\r
                        \r
                        break;\r
                case REQ_SetIdle:\r
-                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
-                               /* Read in the wValue parameter containing the idle period */\r
-                               uint16_t wValue = Endpoint_Read_Word_LE();\r
-                               \r
-                               Endpoint_ClearControlSETUP();\r
+                               Endpoint_ClearSETUP();\r
                                \r
                                /* Get idle period in MSB */\r
-                               IdleCount = (wValue >> 8);\r
+                               IdleCount = (USB_ControlRequest.wValue >> 8);\r
                                \r
                                /* Acknowledge status stage */\r
                                while (!(Endpoint_IsINReady()));\r
-                               Endpoint_ClearControlIN();\r
+                               Endpoint_ClearIN();\r
                        }\r
                        \r
                        break;\r
                case REQ_GetIdle:\r
-                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {               \r
-                               Endpoint_ClearControlSETUP();\r
+                               Endpoint_ClearSETUP();\r
                                \r
                                /* Write the current idle duration to the host */\r
                                Endpoint_Write_Byte(IdleCount);\r
                                \r
                                /* Send the flag to the host */\r
-                               Endpoint_ClearControlIN();\r
+                               Endpoint_ClearIN();\r
 \r
                                /* Acknowledge status stage */\r
                                while (!(Endpoint_IsOUTReceived()));\r
-                               Endpoint_ClearControlOUT();\r
+                               Endpoint_ClearOUT();\r
                        }\r
 \r
                        break;\r
@@ -377,7 +319,7 @@ void ProcessLEDReport(uint8_t LEDReport)
 }\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
@@ -386,41 +328,38 @@ static inline void SendNextReport(void)
        /* 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
+       \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
-       /* 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
-\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
-static inline void ReceiveNextReport(void)\r
+void ReceiveNextReport(void)\r
 {\r
        /* Select the Keyboard LED Report Endpoint */\r
        Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);\r
@@ -470,7 +409,6 @@ void UpdateStatus(uint8_t CurrentStatus)
        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
@@ -484,62 +422,3 @@ TASK(USB_Keyboard_Report)
                ReceiveNextReport();\r
        }\r
 }\r
-#endif\r
-\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
- *  controller. It is also used to respond to standard and class specific requests send to the device on the control\r
- *  endpoint, by handing them off to the LUFA library when they are received.\r
- */\r
-ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
-{\r
-       #if defined(INTERRUPT_CONTROL_ENDPOINT)\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
-       #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