Changed GenericHID device demo to use the LUFA scheduler, added INTERRUPT_DATA_ENDPOI...
authorDean Camera <dean@fourwalledcubicle.com>
Wed, 1 Apr 2009 07:43:50 +0000 (07:43 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Wed, 1 Apr 2009 07:43:50 +0000 (07:43 +0000)
Demos/Device/GenericHID/GenericHID.c
Demos/Device/GenericHID/GenericHID.h
Demos/Device/GenericHID/GenericHID.txt
Demos/Device/Keyboard/Keyboard.c
Demos/Host/GenericHIDHost/GenericHIDHost.c
Demos/Host/KeyboardHost/KeyboardHost.c
Demos/Host/MouseHost/MouseHost.c
LUFA/ChangeLog.txt

index fcd0e4d..cacbdc5 100644 (file)
@@ -42,6 +42,18 @@ BUTTLOADTAG(BuildTime,   __TIME__);
 BUTTLOADTAG(BuildDate,   __DATE__);\r
 BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
 \r
 BUTTLOADTAG(BuildDate,   __DATE__);\r
 BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
 \r
+/* 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_HID_Report       , TaskStatus: TASK_STOP },\r
+       #endif\r
+};\r
+\r
 /** Static buffer to hold the last received report from the host, so that it can be echoed back in the next sent report */\r
 static uint8_t LastReceived[GENERIC_REPORT_SIZE];\r
 \r
 /** Static buffer to hold the last received report from the host, so that it can be echoed back in the next sent report */\r
 static uint8_t LastReceived[GENERIC_REPORT_SIZE];\r
 \r
@@ -61,11 +73,14 @@ int main(void)
        /* Indicate USB not ready */\r
        UpdateStatus(Status_USBNotReady);\r
 \r
        /* Indicate USB not ready */\r
        UpdateStatus(Status_USBNotReady);\r
 \r
+       /* Initialize Scheduler so that it can be used */\r
+       Scheduler_Init();\r
+\r
        /* Initialize USB Subsystem */\r
        USB_Init();\r
        /* Initialize USB Subsystem */\r
        USB_Init();\r
-\r
-       /* >> APPLICATION INIT CODE HERE << */\r
-       for (;;);\r
+       \r
+       /* Scheduling - routine never returns, so put this last in the main function */\r
+       Scheduler_Start();\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
 }\r
 \r
 /** Event handler for the USB_Reset event. This fires when the USB interface is reset by the USB host, before the\r
@@ -74,11 +89,13 @@ int main(void)
  */\r
 EVENT_HANDLER(USB_Reset)\r
 {\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
        /* 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_Connect event. This indicates that the device is enumerating via the status LEDs and\r
 }\r
 \r
 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and\r
@@ -109,16 +126,20 @@ EVENT_HANDLER(USB_ConfigurationChanged)
                                       ENDPOINT_DIR_IN, GENERIC_EPSIZE,\r
                                   ENDPOINT_BANK_SINGLE);\r
 \r
                                       ENDPOINT_DIR_IN, GENERIC_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
        /* Enable the endpoint IN interrupt ISR for the report endpoint */\r
        USB_INT_Enable(ENDPOINT_INT_IN);\r
+       #endif\r
 \r
        /* Setup Generic OUT Report Endpoint */\r
        Endpoint_ConfigureEndpoint(GENERIC_OUT_EPNUM, EP_TYPE_INTERRUPT,\r
                                       ENDPOINT_DIR_OUT, GENERIC_EPSIZE,\r
                                   ENDPOINT_BANK_SINGLE);\r
 \r
 \r
        /* Setup Generic OUT Report Endpoint */\r
        Endpoint_ConfigureEndpoint(GENERIC_OUT_EPNUM, EP_TYPE_INTERRUPT,\r
                                       ENDPOINT_DIR_OUT, GENERIC_EPSIZE,\r
                                   ENDPOINT_BANK_SINGLE);\r
 \r
+       #if defined(INTERRUPT_DATA_ENDPOINT)\r
        /* Enable the endpoint OUT interrupt ISR for the report endpoint */\r
        USB_INT_Enable(ENDPOINT_INT_OUT);\r
        /* Enable the endpoint OUT interrupt ISR for the 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
@@ -237,6 +258,49 @@ void CreateGenericHIDReport(uint8_t* DataArray)
          DataArray[i] = LastReceived[i];\r
 }\r
 \r
          DataArray[i] = LastReceived[i];\r
 }\r
 \r
+#if !defined(INTERRUPT_DATA_ENDPOINT)\r
+TASK(USB_HID_Report)\r
+{\r
+       /* Check if the USB system is connected to a host */\r
+       if (USB_IsConnected)\r
+       {\r
+               Endpoint_SelectEndpoint(GENERIC_OUT_EPNUM);\r
+               \r
+               if (Endpoint_ReadWriteAllowed())\r
+               {\r
+                       /* Create a tempoary buffer to hold the read in report from the host */\r
+                       uint8_t GenericData[GENERIC_REPORT_SIZE];\r
+                       \r
+                       /* Read Generic Report Data */\r
+                       Endpoint_Read_Stream_LE(&GenericData, sizeof(GenericData));\r
+                       \r
+                       /* Process Generic Report Data */\r
+                       ProcessGenericHIDReport(GenericData);\r
+\r
+                       /* Finalize the stream transfer to send the last packet */\r
+                       Endpoint_ClearCurrentBank();\r
+               }       \r
+\r
+               Endpoint_SelectEndpoint(GENERIC_IN_EPNUM);\r
+               \r
+               if (Endpoint_ReadWriteAllowed())\r
+               {\r
+                       /* Create a tempoary buffer to hold the report to send to the host */\r
+                       uint8_t GenericData[GENERIC_REPORT_SIZE];\r
+                       \r
+                       /* Create Generic Report Data */\r
+                       CreateGenericHIDReport(GenericData);\r
+\r
+                       /* Write Generic Report Data */\r
+                       Endpoint_Write_Stream_LE(&GenericData, sizeof(GenericData));\r
+\r
+                       /* Finalize the stream transfer to send the last packet */\r
+                       Endpoint_ClearCurrentBank();\r
+               }\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
 /** 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
@@ -247,6 +311,7 @@ ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
        /* Save previously selected endpoint before selecting a new endpoint */\r
        uint8_t PrevSelectedEndpoint = Endpoint_GetCurrentEndpoint();\r
 \r
        /* Save previously selected endpoint before selecting a new endpoint */\r
        uint8_t PrevSelectedEndpoint = Endpoint_GetCurrentEndpoint();\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
        /* Check if the control endpoint has received a request */\r
        if (Endpoint_HasEndpointInterrupted(ENDPOINT_CONTROLEP))\r
        {\r
@@ -259,7 +324,9 @@ ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
                /* Handshake the endpoint setup interrupt - must be after the call to USB_USBTask() */\r
                USB_INT_Clear(ENDPOINT_INT_SETUP);\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
 \r
+       #if defined(INTERRUPT_DATA_ENDPOINT)\r
        /* Check if Generic IN endpoint has interrupted */\r
        if (Endpoint_HasEndpointInterrupted(GENERIC_IN_EPNUM))\r
        {\r
        /* Check if Generic IN endpoint has interrupted */\r
        if (Endpoint_HasEndpointInterrupted(GENERIC_IN_EPNUM))\r
        {\r
@@ -272,7 +339,7 @@ ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
                /* Clear the Generic IN Report endpoint interrupt and select the endpoint */\r
                Endpoint_ClearEndpointInterrupt(GENERIC_IN_EPNUM);\r
 \r
                /* Clear the Generic IN Report endpoint interrupt and select the endpoint */\r
                Endpoint_ClearEndpointInterrupt(GENERIC_IN_EPNUM);\r
 \r
-               /* Create a tempoary buffer to hold the report to send to the host */\r
+               /* Create a temporary buffer to hold the report to send to the host */\r
                uint8_t GenericData[GENERIC_REPORT_SIZE];\r
                \r
                /* Create Generic Report Data */\r
                uint8_t GenericData[GENERIC_REPORT_SIZE];\r
                \r
                /* Create Generic Report Data */\r
@@ -297,7 +364,7 @@ ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
                /* Clear the Generic OUT Report endpoint interrupt and select the endpoint */\r
                Endpoint_ClearEndpointInterrupt(GENERIC_OUT_EPNUM);\r
 \r
                /* Clear the Generic OUT Report endpoint interrupt and select the endpoint */\r
                Endpoint_ClearEndpointInterrupt(GENERIC_OUT_EPNUM);\r
 \r
-               /* Create a tempoary buffer to hold the read in report from the host */\r
+               /* Create a temporary buffer to hold the read in report from the host */\r
                uint8_t GenericData[GENERIC_REPORT_SIZE];\r
                \r
                /* Read Generic Report Data */\r
                uint8_t GenericData[GENERIC_REPORT_SIZE];\r
                \r
                /* Read Generic Report Data */\r
@@ -309,6 +376,7 @@ ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
                /* Finalize the stream transfer to send the last packet */\r
                Endpoint_ClearCurrentBank();\r
        }\r
                /* Finalize the stream transfer to send the last packet */\r
                Endpoint_ClearCurrentBank();\r
        }\r
+       #endif\r
 \r
        /* Restore previously selected endpoint */\r
        Endpoint_SelectEndpoint(PrevSelectedEndpoint);\r
 \r
        /* Restore previously selected endpoint */\r
        Endpoint_SelectEndpoint(PrevSelectedEndpoint);\r
index 4bdf236..d13e6de 100644 (file)
@@ -47,6 +47,7 @@
                #include "Descriptors.h"\r
 \r
                #include <LUFA/Version.h>                    // Library Version Information\r
                #include "Descriptors.h"\r
 \r
                #include <LUFA/Version.h>                    // Library Version Information\r
+               #include <LUFA/Scheduler/Scheduler.h>        // Simple scheduler for task management\r
                #include <LUFA/Common/ButtLoadTag.h>         // PROGMEM tags readable by the ButtLoad project\r
                #include <LUFA/Drivers/USB/USB.h>            // USB Functionality\r
                #include <LUFA/Drivers/Board/LEDs.h>         // LEDs driver\r
                #include <LUFA/Common/ButtLoadTag.h>         // PROGMEM tags readable by the ButtLoad project\r
                #include <LUFA/Drivers/USB/USB.h>            // USB Functionality\r
                #include <LUFA/Drivers/Board/LEDs.h>         // LEDs driver\r
@@ -79,6 +80,9 @@
 \r
                /** Indicates that this module will catch the USB_ConfigurationChanged event when thrown by the library. */\r
                HANDLES_EVENT(USB_ConfigurationChanged);\r
 \r
                /** Indicates that this module will catch the USB_ConfigurationChanged event when thrown by the library. */\r
                HANDLES_EVENT(USB_ConfigurationChanged);\r
+       \r
+       /* Task Definitions: */\r
+               TASK(USB_HID_Report);\r
 \r
        /* Function Prototypes: */\r
                void UpdateStatus(uint8_t CurrentStatus);\r
 \r
        /* Function Prototypes: */\r
                void UpdateStatus(uint8_t CurrentStatus);\r
index 22e28be..e6c2fbc 100644 (file)
  *    <td>This token defines the size of the device reports, both sent and received. The value must be an\r
  *        integer ranging from 1 to 255.</td>\r
  *   </tr>\r
  *    <td>This token defines the size of the device reports, both sent and received. The value must be an\r
  *        integer ranging from 1 to 255.</td>\r
  *   </tr>\r
+ *   <tr>\r
+ *    <td>INTERRUPT_CONTROL_ENDPOINT</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this causes the demo to enable interrupts for the control endpoint,\r
+ *        which services control requests from the host. If not defined, the control endpoint\r
+ *        is serviced via polling using the task scheduler.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>INTERRUPT_DATA_ENDPOINT</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, this causes the demo to enable interrupts for the data endpoints,\r
+ *        which services incomming LED reports and outgoing key status reports to and from the host.\r
+ *        If not defined, the data endpoints are serviced via polling using the task scheduler.</td>\r
+ *   </tr>\r
  *  </table>\r
  */
\ No newline at end of file
  *  </table>\r
  */
\ No newline at end of file
index d0ea18f..265e950 100644 (file)
@@ -545,4 +545,3 @@ ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
        }\r
        #endif\r
 }\r
        }\r
        #endif\r
 }\r
-\r
index 625ca70..c703039 100644 (file)
@@ -350,6 +350,9 @@ TASK(USB_HID_Host)
  */\r
 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
 {\r
  */\r
 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
 {\r
+       /* Save previously selected pipe before selecting a new pipe */\r
+       uint8_t PrevSelectedPipe = Pipe_GetCurrentPipe();\r
+\r
        /* Check to see if the HID data IN pipe has caused the interrupt */\r
        if (Pipe_HasPipeInterrupted(HID_DATA_IN_PIPE))\r
        {\r
        /* Check to see if the HID data IN pipe has caused the interrupt */\r
        if (Pipe_HasPipeInterrupted(HID_DATA_IN_PIPE))\r
        {\r
@@ -367,5 +370,8 @@ ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
                        ReadNextReport();\r
                }\r
        }\r
                        ReadNextReport();\r
                }\r
        }\r
+\r
+       /* Restore previously selected pipe */\r
+       Pipe_SelectPipe(PrevSelectedPipe);\r
 }\r
 #endif\r
 }\r
 #endif\r
index fe95c34..13aed7e 100644 (file)
@@ -350,6 +350,9 @@ TASK(USB_Keyboard_Host)
  */\r
 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
 {\r
  */\r
 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
 {\r
+       /* Save previously selected pipe before selecting a new pipe */\r
+       uint8_t PrevSelectedPipe = Pipe_GetCurrentPipe();\r
+\r
        /* Check to see if the keyboard data pipe has caused the interrupt */\r
        if (Pipe_HasPipeInterrupted(KEYBOARD_DATAPIPE))\r
        {\r
        /* Check to see if the keyboard data pipe has caused the interrupt */\r
        if (Pipe_HasPipeInterrupted(KEYBOARD_DATAPIPE))\r
        {\r
@@ -366,5 +369,8 @@ ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
                        /* Read and process the next report from the device */\r
                        ReadNextReport();\r
        }\r
                        /* Read and process the next report from the device */\r
                        ReadNextReport();\r
        }\r
+       \r
+       /* Restore previously selected pipe */\r
+       Pipe_SelectPipe(PrevSelectedPipe);\r
 }\r
 #endif\r
 }\r
 #endif\r
index dda4d62..dd7ff73 100644 (file)
@@ -346,6 +346,9 @@ TASK(USB_Mouse_Host)
  */\r
 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
 {\r
  */\r
 ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
 {\r
+       /* Save previously selected pipe before selecting a new pipe */\r
+       uint8_t PrevSelectedPipe = Pipe_GetCurrentPipe();\r
+\r
        /* Check to see if the mouse data pipe has caused the interrupt */\r
        if (Pipe_HasPipeInterrupted(MOUSE_DATAPIPE))\r
        {\r
        /* Check to see if the mouse data pipe has caused the interrupt */\r
        if (Pipe_HasPipeInterrupted(MOUSE_DATAPIPE))\r
        {\r
@@ -363,5 +366,8 @@ ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
                        ReadNextReport();\r
                }\r
        }\r
                        ReadNextReport();\r
                }\r
        }\r
+\r
+       /* Restore previously selected pipe */\r
+       Pipe_SelectPipe(PrevSelectedPipe);\r
 }\r
 #endif\r
 }\r
 #endif\r
index b61af34..4365350 100644 (file)
@@ -7,8 +7,12 @@
  /** \page Page_ChangeLog Project Changelog\r
   *\r
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX\r
  /** \page Page_ChangeLog Project Changelog\r
   *\r
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX\r
+  *\r
   *  - Added new GenericHIDHost demo\r
   *  - Corrections to the KeyboardHost and MouseHost demos' pipe handling to freeze and unfreeze the data pipes at the point of use\r
   *  - Added new GenericHIDHost demo\r
   *  - Corrections to the KeyboardHost and MouseHost demos' pipe handling to freeze and unfreeze the data pipes at the point of use\r
+  *  - KeyboardHost, MouseHost and GenericHIDHost demos now save and restore the currently selected pipe inside the pipe ISR\r
+  *  - Changed GenericHID device demo to use the LUFA scheduler, added INTERRUPT_DATA_ENDPOINT and INTERRUPT_CONTROL_ENDPOINT compile\r
+  *    time options\r
   *\r
   *  \section Sec_ChangeLog090401 Version 090401\r
   *\r
   *\r
   *  \section Sec_ChangeLog090401 Version 090401\r
   *\r