Rename PDIProtocol.c/.h to XPROGProtocol.c/.h as it will now handle both TPI and...
[pub/USBasp.git] / Demos / Host / ClassDriver / KeyboardHost / KeyboardHost.c
index 2b9bb2b..ed8f723 100644 (file)
  \r
 #include "KeyboardHost.h"\r
 \r
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },\r
-       { .Task = USB_Keyboard_Host    , .TaskStatus = TASK_STOP },\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_Host_t Keyboard_HID_Interface =\r
+       {\r
+               .Config =\r
+                       {\r
+                               .DataINPipeNumber       = 1,\r
+                               .DataINPipeDoubleBank   = false,\r
 \r
+                               .DataOUTPipeNumber      = 2,\r
+                               .DataOUTPipeDoubleBank  = false,\r
+                               \r
+                               .HIDInterfaceProtocol   = HID_BOOT_KEYBOARD_PROTOCOL,\r
+                       },\r
+       };\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
+ *  enters a loop to run the application tasks in sequence.\r
  */\r
 int main(void)\r
 {\r
+       SetupHardware();\r
+\r
+       puts_P(PSTR(ESC_FG_CYAN "Keyboard Host Demo running.\r\n" ESC_FG_WHITE));\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+       for (;;)\r
+       {\r
+               switch (USB_HostState)\r
+               {\r
+                       case HOST_STATE_Addressed:\r
+                               LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+                       \r
+                               uint16_t ConfigDescriptorSize;\r
+                               uint8_t  ConfigDescriptorData[512];\r
+\r
+                               if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,\r
+                                                                      sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)\r
+                               {\r
+                                       printf("Error Retrieving Configuration Descriptor.\r\n");\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+\r
+                               if (HID_Host_ConfigurePipes(&Keyboard_HID_Interface,\r
+                                                           ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)\r
+                               {\r
+                                       printf("Attached Device Not a Valid Keyboard.\r\n");\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+                               \r
+                               if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)\r
+                               {\r
+                                       printf("Error Setting Device Configuration.\r\n");\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+\r
+                               if (HID_Host_SetBootProtocol(&Keyboard_HID_Interface) != 0)\r
+                               {\r
+                                       printf("Could not Set Boot Protocol Mode.\r\n");\r
+                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;\r
+                               }\r
+                               \r
+                               printf("Keyboard Enumerated.\r\n");\r
+                               USB_HostState = HOST_STATE_Configured;\r
+                               break;\r
+                       case HOST_STATE_Configured:\r
+                               if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))\r
+                               {\r
+                                       USB_KeyboardReport_Data_t KeyboardReport;                                       \r
+                                       HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);\r
+\r
+                                       LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);\r
+                                       \r
+                                       uint8_t PressedKeyCode = KeyboardReport.KeyCode[0];\r
+\r
+                                       if (PressedKeyCode)\r
+                                       {\r
+                                               char PressedKey = 0;\r
+\r
+                                               LEDs_ToggleLEDs(LEDS_LED2);\r
+                                                         \r
+                                               /* Retrieve pressed key character if alphanumeric */\r
+                                               if ((PressedKeyCode >= 0x04) && (PressedKeyCode <= 0x1D))\r
+                                                 PressedKey = (PressedKeyCode - 0x04) + 'A';\r
+                                               else if ((PressedKeyCode >= 0x1E) && (PressedKeyCode <= 0x27))\r
+                                                 PressedKey = (PressedKeyCode - 0x1E) + '0';\r
+                                               else if (PressedKeyCode == 0x2C)\r
+                                                 PressedKey = ' ';                                             \r
+                                               else if (PressedKeyCode == 0x28)\r
+                                                 PressedKey = '\n';\r
+                                                        \r
+                                               if (PressedKey)\r
+                                                 putchar(PressedKey);\r
+                                       }\r
+                               }\r
+                               \r
+                               break;\r
+               }\r
+       \r
+               HID_Host_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(void)\r
+{\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r
@@ -59,277 +165,56 @@ int main(void)
        /* Hardware Initialization */\r
        SerialStream_Init(9600, false);\r
        LEDs_Init();\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
-\r
-       /* Start-up message */\r
-       puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY\r
-              "Keyboard Host Demo running.\r\n" ESC_INVERSE_OFF));\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_DeviceAttached event. This indicates that a device has been attached to the host, and\r
  *  starts the library USB task to begin the enumeration and USB management process.\r
  */\r
-void EVENT_USB_DeviceAttached(void)\r
+void EVENT_USB_Host_DeviceAttached(void)\r
 {\r
        puts_P(PSTR("Device Attached.\r\n"));\r
-       UpdateStatus(Status_USBEnumerating);\r
-\r
-       /* Start USB management task to enumerate the device */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
 }\r
 \r
 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and\r
  *  stops the library USB task management process.\r
  */\r
-void EVENT_USB_DeviceUnattached(void)\r
+void EVENT_USB_Host_DeviceUnattached(void)\r
 {\r
-       /* Stop Keyboard and USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_Keyboard_Host, TASK_STOP);\r
-\r
-       puts_P(PSTR("Device Unattached.\r\n"));\r
-       UpdateStatus(Status_USBNotReady);\r
+       puts_P(PSTR("\r\nDevice Unattached.\r\n"));\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
 }\r
 \r
 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully\r
  *  enumerated by the host and is now ready to be used by the application.\r
  */\r
-void EVENT_USB_DeviceEnumerationComplete(void)\r
+void EVENT_USB_Host_DeviceEnumerationComplete(void)\r
 {\r
-       /* Start Keyboard Host task */\r
-       Scheduler_SetTaskMode(USB_Keyboard_Host, TASK_RUN);\r
-       \r
-       /* Indicate device enumeration complete */\r
-       UpdateStatus(Status_USBReady);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
 }\r
 \r
 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r
-void EVENT_USB_HostError(const uint8_t ErrorCode)\r
+void EVENT_USB_Host_HostError(const uint8_t ErrorCode)\r
 {\r
        USB_ShutDown();\r
 \r
-       puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));\r
-       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
+       printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"\r
+                                " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);\r
 \r
-       UpdateStatus(Status_HardwareError);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
        for(;;);\r
 }\r
 \r
 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while\r
  *  enumerating an attached USB device.\r
  */\r
-void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
+void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
 {\r
-       puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));\r
-       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
-       printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);\r
-       printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);\r
-\r
-       UpdateStatus(Status_EnumerationError);\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
- *  \param CurrentStatus  Current status of the system, from the KeyboardHost_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
-{\r
-       uint8_t LEDMask = LEDS_NO_LEDS;\r
+       printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"\r
+                                " -- Error Code %d\r\n"\r
+                                " -- Sub Error Code %d\r\n"\r
+                                " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);\r
        \r
-       /* Set the LED mask to the appropriate LED mask based on the given status code */\r
-       switch (CurrentStatus)\r
-       {\r
-               case Status_USBNotReady:\r
-                       LEDMask = (LEDS_LED1);\r
-                       break;\r
-               case Status_USBEnumerating:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED2);\r
-                       break;\r
-               case Status_USBReady:\r
-                       LEDMask = (LEDS_LED2);\r
-                       break;\r
-               case Status_EnumerationError:\r
-               case Status_HardwareError:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED3);\r
-                       break;\r
-       }\r
-       \r
-       /* Set the board LEDs to the new LED mask */\r
-       LEDs_SetAllLEDs(LEDMask);\r
-}\r
-\r
-/** Reads in and processes the next report from the attached device, displaying the report\r
- *  contents on the board LEDs and via the serial port.\r
- */\r
-void ReadNextReport(void)\r
-{\r
-       USB_KeyboardReport_Data_t KeyboardReport;\r
-               \r
-       /* Select keyboard data pipe */\r
-       Pipe_SelectPipe(KEYBOARD_DATAPIPE);     \r
-\r
-       /* Unfreeze keyboard data pipe */\r
-       Pipe_Unfreeze();\r
-\r
-       /* Check to see if a packet has been received */\r
-       if (!(Pipe_IsINReceived()))\r
-       {\r
-               /* Refreeze HID data IN pipe */\r
-               Pipe_Freeze();\r
-                       \r
-               return;\r
-       }\r
-       \r
-       /* Ensure pipe contains data before trying to read from it */\r
-       if (Pipe_IsReadWriteAllowed())\r
-       {\r
-               /* Read in keyboard report data */\r
-               Pipe_Read_Stream_LE(&KeyboardReport, sizeof(KeyboardReport));\r
-\r
-               /* Indicate if the modifier byte is non-zero (special key such as shift is being pressed) */\r
-               LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);\r
-               \r
-               /* Check if a key has been pressed */\r
-               if (KeyboardReport.KeyCode)\r
-               {\r
-                       /* Toggle status LED to indicate keypress */\r
-                       if (LEDs_GetLEDs() & LEDS_LED2)\r
-                         LEDs_TurnOffLEDs(LEDS_LED2);\r
-                       else\r
-                         LEDs_TurnOnLEDs(LEDS_LED2);\r
-                                 \r
-                       char PressedKey = 0;\r
-\r
-                       /* Retrieve pressed key character if alphanumeric */\r
-                       if ((KeyboardReport.KeyCode >= 0x04) && (KeyboardReport.KeyCode <= 0x1D))\r
-                         PressedKey = (KeyboardReport.KeyCode - 0x04) + 'A';\r
-                       else if ((KeyboardReport.KeyCode >= 0x1E) && (KeyboardReport.KeyCode <= 0x27))\r
-                         PressedKey = (KeyboardReport.KeyCode - 0x1E) + '0';\r
-                       else if (KeyboardReport.KeyCode == 0x2C)\r
-                         PressedKey = ' ';                                             \r
-                       else if (KeyboardReport.KeyCode == 0x28)\r
-                         PressedKey = '\n';\r
-                                \r
-                       /* Print the pressed key character out through the serial port if valid */\r
-                       if (PressedKey)\r
-                         putchar(PressedKey);\r
-               }\r
-       }\r
-               \r
-       /* Clear the IN endpoint, ready for next data packet */\r
-       Pipe_ClearIN();\r
-\r
-       /* Refreeze keyboard data pipe */\r
-       Pipe_Freeze();\r
-}\r
-\r
-/** Task to set the configuration of the attached device after it has been enumerated, and to read and process\r
- *  HID reports from the device and display the results onto the board LEDs.\r
- */\r
-TASK(USB_Keyboard_Host)\r
-{\r
-       uint8_t ErrorCode;\r
-\r
-       switch (USB_HostState)\r
-       {\r
-               case HOST_STATE_Addressed:\r
-                       /* Standard request to set the device configuration to configuration 1 */\r
-                       USB_ControlRequest = (USB_Request_Header_t)\r
-                               {\r
-                                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),\r
-                                       .bRequest      = REQ_SetConfiguration,\r
-                                       .wValue        = 1,\r
-                                       .wIndex        = 0,\r
-                                       .wLength       = 0,\r
-                               };\r
-\r
-                       /* Select the control pipe for the request transfer */\r
-                       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
-                       /* Send the request, display error and wait for device detach if request fails */\r
-                       if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
-                       {\r
-                               puts_P(PSTR("Control Error (Set Configuration).\r\n"));\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
-\r
-                               /* Indicate error status */\r
-                               UpdateStatus(Status_EnumerationError);\r
-\r
-                               /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
-                               break;\r
-                       }\r
-                               \r
-                       USB_HostState = HOST_STATE_Configured;\r
-                       break;\r
-               case HOST_STATE_Configured:\r
-                       puts_P(PSTR("Getting Config Data.\r\n"));\r
-               \r
-                       /* Get and process the configuration descriptor data */\r
-                       if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)\r
-                       {\r
-                               if (ErrorCode == ControlError)\r
-                                 puts_P(PSTR("Control Error (Get Configuration).\r\n"));\r
-                               else\r
-                                 puts_P(PSTR("Invalid Device.\r\n"));\r
-\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
-                               \r
-                               /* Indicate error status */\r
-                               UpdateStatus(Status_EnumerationError);\r
-\r
-                               /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
-                               break;\r
-                       }\r
-               \r
-                       /* HID class request to set the keyboard protocol to the Boot Protocol */\r
-                       USB_ControlRequest = (USB_Request_Header_t)\r
-                               {\r
-                                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
-                                       .bRequest      = REQ_SetProtocol,\r
-                                       .wValue        = 0,\r
-                                       .wIndex        = 0,\r
-                                       .wLength       = 0,\r
-                               };\r
-\r
-                       /* Select the control pipe for the request transfer */\r
-                       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
-                       /* Send the request, display error and wait for device detach if request fails */\r
-                       if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
-                       {\r
-                               puts_P(PSTR("Control Error (Set Protocol).\r\n"));\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
-\r
-                               /* Indicate error status */\r
-                               UpdateStatus(Status_EnumerationError);\r
-                               \r
-                               /* Wait until USB device disconnected */\r
-                               while (USB_IsConnected);\r
-                               break;\r
-                       }\r
-\r
-                       puts_P(PSTR("Keyboard Enumerated.\r\n"));\r
-\r
-                       USB_HostState = HOST_STATE_Ready;\r
-                       break;\r
-               case HOST_STATE_Ready:\r
-                       /* If a report has been received, read and process it */\r
-                       ReadNextReport();\r
-\r
-                       break;\r
-       }\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r