Combined Keyboard, KeyboardViaInt and KeyboardFullInt demos into a single unified...

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

diff --git a/Demos/Keyboard/Keyboard.c b/Demos/Keyboard/Keyboard.c
index 931f080..3884eeb 100644 (file)
--- a/Demos/Keyboard/Keyboard.c
+++ b/Demos/Keyboard/Keyboard.c
@@ -31,7 +31,7 @@
 \r
 /** \file\r
  *\r
 \r
 /** \file\r
  *\r

- *  Main source file for the Keyboard demo. This file contains the main tasks of the demo and\r
+ *  Main source file for the KeyboardFullInt demo. This file contains the main tasks of the demo and\r

  *  is responsible for the initial application hardware configuration.\r
  */\r
  \r
  *  is responsible for the initial application hardware configuration.\r
  */\r
  \r


@@ -46,8 +46,13 @@ BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);
 /* Scheduler Task List */\r
 TASK_LIST\r
 {\r
 /* Scheduler Task List */\r
 TASK_LIST\r
 {\r

+       #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r

        { Task: USB_USBTask          , TaskStatus: TASK_STOP },\r
        { Task: USB_USBTask          , TaskStatus: TASK_STOP },\r

+       #endif\r
+       \r
+       #if !defined(INTERRUPT_DATA_ENDPOINT)\r

        { Task: USB_Keyboard_Report  , TaskStatus: TASK_STOP },\r
        { Task: USB_Keyboard_Report  , TaskStatus: TASK_STOP },\r

+       #endif\r

 };\r
 \r
 /* Global Variables */\r
 };\r
 \r
 /* Global Variables */\r


@@ -69,7 +74,7 @@ uint16_t IdleMSRemaining = 0;
 \r
 \r
 /** Main program entry point. This routine configures the hardware required by the application, then\r
 \r
 \r
 /** Main program entry point. This routine configures the hardware required by the application, then\r

- *  starts the scheduler to run the application tasks.\r
+ *  starts the scheduler to run the USB management task.\r

  */\r
 int main(void)\r
 {\r
  */\r
 int main(void)\r
 {\r


@@ -92,7 +97,7 @@ int main(void)
 \r
        /* Indicate USB not ready */\r
        UpdateStatus(Status_USBNotReady);\r
 \r
        /* Indicate USB not ready */\r
        UpdateStatus(Status_USBNotReady);\r

-       \r
+\r

        /* Initialize Scheduler so that it can be used */\r
        Scheduler_Init();\r
 \r
        /* Initialize Scheduler so that it can be used */\r
        Scheduler_Init();\r
 \r


@@ -108,29 +113,40 @@ int main(void)
  */\r
 EVENT_HANDLER(USB_Connect)\r
 {\r
  */\r
 EVENT_HANDLER(USB_Connect)\r
 {\r

-       /* Start USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-\r

        /* Indicate USB enumerating */\r
        UpdateStatus(Status_USBEnumerating);\r
        /* Indicate USB enumerating */\r
        UpdateStatus(Status_USBEnumerating);\r

+\r
+       /* Default to report protocol on connect */\r
+       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
 }\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 and stops the USB management and Keyboard reporting tasks.\r
+ *  the status LEDs.\r

  */\r
 EVENT_HANDLER(USB_Disconnect)\r
 {\r
  */\r
 EVENT_HANDLER(USB_Disconnect)\r
 {\r

-       /* Stop running keyboard reporting and USB management tasks */\r
-       Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-\r

        /* Indicate USB not ready */\r
        UpdateStatus(Status_USBNotReady);\r
 }\r
 \r
        /* Indicate USB not ready */\r
        UpdateStatus(Status_USBNotReady);\r
 }\r
 \r

-/** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration\r
- *  of the USB device after enumeration - the device endpoints are configured and the keyboard reporting task started.\r
- */ \r
+/** 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
 {\r
        /* Setup Keyboard Keycode Report Endpoint */\r
 EVENT_HANDLER(USB_ConfigurationChanged)\r
 {\r
        /* Setup Keyboard Keycode Report Endpoint */\r


@@ -138,19 +154,23 @@ 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
        /* Indicate USB connected and ready */\r
        UpdateStatus(Status_USBReady);\r

-       \r
-       /* Default to report protocol on connect */\r
-       UsingReportProtocol = true;\r
-\r
-       /* Start Keyboard reporting task */\r
-       Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_RUN);\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


@@ -168,7 +188,7 @@ EVENT_HANDLER(USB_UnhandledControlPacket)
                                USB_KeyboardReport_Data_t KeyboardReportData;\r
 \r
                                /* Create the next keyboard report for transmission to the host */\r
                                USB_KeyboardReport_Data_t KeyboardReportData;\r
 \r
                                /* Create the next keyboard report for transmission to the host */\r

-                               GetNextReport(&KeyboardReportData);\r
+                               CreateKeyboardReport(&KeyboardReportData);\r

 \r
                                /* Ignore report type and ID number value */\r
                                Endpoint_Discard_Word();\r
 \r
                                /* Ignore report type and ID number value */\r
                                Endpoint_Discard_Word();\r


@@ -226,7 +246,7 @@ EVENT_HANDLER(USB_UnhandledControlPacket)
                                \r
                                /* Send the flag to the host */\r
                                Endpoint_ClearSetupIN();\r
                                \r
                                /* Send the flag to the host */\r
                                Endpoint_ClearSetupIN();\r

-                               \r
+\r

                                /* Acknowledge status stage */\r
                                while (!(Endpoint_IsSetupOUTReceived()));\r
                                Endpoint_ClearSetupOUT();\r
                                /* Acknowledge status stage */\r
                                while (!(Endpoint_IsSetupOUTReceived()));\r
                                Endpoint_ClearSetupOUT();\r


@@ -238,12 +258,12 @@ EVENT_HANDLER(USB_UnhandledControlPacket)
                        {\r
                                /* Read in the wValue parameter containing the new protocol mode */\r
                                uint16_t wValue = Endpoint_Read_Word_LE();\r
                        {\r
                                /* Read in the wValue parameter containing the new protocol mode */\r
                                uint16_t wValue = Endpoint_Read_Word_LE();\r

-                               \r
+                                                               \r

                                Endpoint_ClearSetupReceived();\r
 \r
                                /* Set or clear the flag depending on what the host indicates that the current Protocol should be */\r
                                UsingReportProtocol = (wValue != 0x0000);\r
                                Endpoint_ClearSetupReceived();\r
 \r
                                /* Set or clear the flag depending on what the host indicates that the current Protocol should be */\r
                                UsingReportProtocol = (wValue != 0x0000);\r

-                               \r
+\r

                                /* Acknowledge status stage */\r
                                while (!(Endpoint_IsSetupINReady()));\r
                                Endpoint_ClearSetupIN();\r
                                /* Acknowledge status stage */\r
                                while (!(Endpoint_IsSetupINReady()));\r
                                Endpoint_ClearSetupIN();\r


@@ -303,7 +323,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
  *\r
  *  \return Boolean true if the new report differs from the last report, false otherwise\r
  */\r
  *\r
  *  \return Boolean true if the new report differs from the last report, false otherwise\r
  */\r

-bool GetNextReport(USB_KeyboardReport_Data_t* ReportData)\r
+bool CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData)\r

 {\r
        static uint8_t PrevJoyStatus = 0;\r
        uint8_t        JoyStatus_LCL        = Joystick_GetStatus();\r
 {\r
        static uint8_t PrevJoyStatus = 0;\r
        uint8_t        JoyStatus_LCL        = Joystick_GetStatus();\r


@@ -335,13 +355,13 @@ bool GetNextReport(USB_KeyboardReport_Data_t* ReportData)
        return InputChanged;\r
 }\r
 \r
        return InputChanged;\r
 }\r
 \r

-/** Processes a given LED report mask from the host and sets the board LEDs to match.\r
+/** Processes a received LED report, and updates the board LEDs states to match.\r

  *\r
  *\r

- *  \param LEDReport  LED mask from the host, containing a mask of what LEDs are set\r
+ *  \param LEDReport  LED status report from the host\r

  */\r
 void ProcessLEDReport(uint8_t LEDReport)\r
 {\r
  */\r
 void ProcessLEDReport(uint8_t LEDReport)\r
 {\r

-       uint8_t LEDMask   = LEDS_LED2;\r
+       uint8_t LEDMask = LEDS_LED2;\r

        \r
        if (LEDReport & 0x01) // NUM Lock\r
          LEDMask |= LEDS_LED1;\r
        \r
        if (LEDReport & 0x01) // NUM Lock\r
          LEDMask |= LEDS_LED1;\r


@@ -356,10 +376,63 @@ void ProcessLEDReport(uint8_t LEDReport)
        LEDs_SetAllLEDs(LEDMask);\r
 }\r
 \r
        LEDs_SetAllLEDs(LEDMask);\r
 }\r
 \r

+/** Sends the next HID report to the host, via the keyboard data endpoint. */\r
+static inline void SendNextReport(void)\r
+{\r
+       USB_KeyboardReport_Data_t KeyboardReportData;\r
+       bool                      SendReport;\r
+       \r
+       /* Create the next keyboard report for transmission to the host */\r
+       SendReport = CreateKeyboardReport(&KeyboardReportData);\r
+       \r
+       /* Check if the idle period is set and has elapsed */\r
+       if (IdleCount && !(IdleMSRemaining))\r
+       {\r
+               /* Idle period elapsed, indicate that a report must be sent */\r
+               SendReport = true;\r
+               \r
+               /* Reset the idle time remaining counter, must multiply by 4 to get the duration in milliseconds */\r
+               IdleMSRemaining = (IdleCount << 2);\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
+       if (Endpoint_ReadWriteAllowed() && SendReport)\r
+       {\r
+               /* Write Keyboard Report Data */\r
+               Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));\r
+\r
+               /* Finalize the stream transfer to send the last packet */\r
+               Endpoint_ClearCurrentBank();\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
+{\r
+       /* Select the Keyboard LED Report Endpoint */\r
+       Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);\r
+\r
+       /* Check if Keyboard LED Endpoint Ready for Read/Write */\r
+       if (!(Endpoint_ReadWriteAllowed()))\r
+         return;\r
+\r
+       /* Read in the LED report from the host */\r
+       uint8_t LEDReport = Endpoint_Read_Byte();\r
+\r
+       /* Handshake the OUT Endpoint - clear endpoint and ready for next report */\r
+       Endpoint_ClearCurrentBank();\r
+\r
+       /* Process the read LED report from the host */\r
+       ProcessLEDReport(LEDReport);\r
+}\r
+\r

 /** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
  *  log to a serial port, or anything else that is suitable for status updates.\r
  *\r
 /** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
  *  log to a serial port, or anything else that is suitable for status updates.\r
  *\r

- *  \param CurrentStatus  Current status of the system, from the Keyboard_StatusCodes_t enum\r
+ *  \param CurrentStatus  Current status of the system, from the KeyboardFullInt_StatusCodes_t enum\r

  */\r
 void UpdateStatus(uint8_t CurrentStatus)\r
 {\r
  */\r
 void UpdateStatus(uint8_t CurrentStatus)\r
 {\r


@@ -383,55 +456,77 @@ 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

-       USB_KeyboardReport_Data_t KeyboardReportData;\r
-       bool                      SendReport;\r
-       \r
-       /* Create the next keyboard report for transmission to the host */\r
-       SendReport = GetNextReport(&KeyboardReportData);\r
-       \r
-       /* Check if the idle period is set and has elapsed */\r
-       if (IdleCount && !(IdleMSRemaining))\r
+       /* Check if the USB system is connected to a host */\r
+       if (USB_IsConnected)\r

        {\r
        {\r

-               /* Idle period elapsed, indicate that a report must be sent */\r
-               SendReport = true;\r
+               /* Send the next keypress report to the host */\r
+               SendNextReport();\r

                \r
                \r

-               /* Reset the idle time remaining counter, must multiply by 4 to get the duration in milliseconds */\r
-               IdleMSRemaining = (IdleCount << 2);\r
+               /* Process the LED report sent from the host */\r
+               ReceiveNextReport();\r

        }\r
        }\r

-       \r
-       /* Check if the USB system is connected to a host */\r
-       if (USB_IsConnected)\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
        {\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
-               if (Endpoint_ReadWriteAllowed() && SendReport)\r
-               {\r
-                       /* Write Keyboard Report Data */\r
-                       Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));\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
 \r

-                       /* Finalize the stream transfer to send the last packet */\r
-                       Endpoint_ClearCurrentBank();\r
-               }\r
+               /* Send the next keypress report to the host */\r
+               SendNextReport();\r
+       }\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
                /* Select the Keyboard LED Report Endpoint */\r
                Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);\r
 \r

-               /* Check if Keyboard LED Endpoint Ready for Read/Write */\r
-               if (Endpoint_ReadWriteAllowed())\r
-               {\r
-                       /* Read in the LED report from the host */\r
-                       uint8_t LEDStatus = Endpoint_Read_Byte();\r
+               /* Clear the endpoint OUT interrupt flag */\r
+               USB_INT_Clear(ENDPOINT_INT_OUT);\r

 \r
 \r

-                       /* Process the incomming LED report */\r
-                       ProcessLEDReport(LEDStatus);\r
+               /* Clear the Keyboard LED Report endpoint interrupt */\r
+               Endpoint_ClearEndpointInterrupt(KEYBOARD_LEDS_EPNUM);\r

 \r
 \r

-                       /* Handshake the OUT Endpoint - clear endpoint and ready for next report */\r
-                       Endpoint_ClearCurrentBank();\r
-               }\r
+               /* Process the LED report sent from the host */\r
+               ReceiveNextReport();\r

        }\r
        }\r

+       #endif\r

 }\r
 }\r

+\r