Seperated out OTG, Device and Host mode demos into seperate folders for clarity....
[pub/lufa.git] / Demos / Host / KeyboardHostWithParser / KeyboardHostWithParser.c
diff --git a/Demos/Host/KeyboardHostWithParser/KeyboardHostWithParser.c b/Demos/Host/KeyboardHostWithParser/KeyboardHostWithParser.c
new file mode 100644 (file)
index 0000000..f7a0087
--- /dev/null
@@ -0,0 +1,340 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Main source file for the KeyboardHostWithParser demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r
+ */\r
\r
+#include "KeyboardHostWithParser.h"\r
+\r
+/* Project Tags, for reading out using the ButtLoad project */\r
+BUTTLOADTAG(ProjName,    "LUFA KBD Host App");\r
+BUTTLOADTAG(BuildTime,   __TIME__);\r
+BUTTLOADTAG(BuildDate,   __DATE__);\r
+BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\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
+\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
+ */\r
+int main(void)\r
+{\r
+       /* Disable watchdog if enabled by bootloader/fuses */\r
+       MCUSR &= ~(1 << WDRF);\r
+       wdt_disable();\r
+\r
+       /* Disable clock division */\r
+       clock_prescale_set(clock_div_1);\r
+\r
+       /* 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
+       /* Startup 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
+EVENT_HANDLER(USB_DeviceAttached)\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
+}\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
+EVENT_HANDLER(USB_DeviceUnattached)\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("\r\nDevice Unattached.\r\n"));\r
+       UpdateStatus(Status_USBNotReady);\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
+EVENT_HANDLER(USB_DeviceEnumerationComplete)\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
+}\r
+\r
+/** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r
+EVENT_HANDLER(USB_HostError)\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
+\r
+       UpdateStatus(Status_HardwareError);\r
+       for(;;);\r
+}\r
+\r
+/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occured while\r
+ *  enumerating an attached USB device.\r
+ */\r
+EVENT_HANDLER(USB_DeviceEnumerationFailed)\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 KeyboardHostWithParser_StatusCodes_t enum\r
+ */\r
+void UpdateStatus(uint8_t CurrentStatus)\r
+{\r
+       uint8_t LEDMask = LEDS_NO_LEDS;\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
+               case Status_Busy:\r
+                       LEDMask = (LEDS_LED1 | LEDS_LED4);\r
+                       break;\r
+       }\r
+       \r
+       /* Set the board LEDs to the new LED mask */\r
+       LEDs_SetAllLEDs(LEDMask);\r
+}\r
+\r
+/** Task to set the configuration of the attached device after it has been enumerated, and to read and process\r
+ *  the HID report descriptor and 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_HostRequest = (USB_Host_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
+                       /* Send the request, display error and wait for device detatch 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 via status LEDs */\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 via status LEDs */\r
+                               UpdateStatus(Status_EnumerationError);\r
+\r
+                               /* Wait until USB device disconnected */\r
+                               while (USB_IsConnected);\r
+                               break;\r
+                       }\r
+                                       \r
+                       puts_P(PSTR("Processing HID Report.\r\n"));\r
+\r
+                       /* LEDs one and two on to indicate busy processing */\r
+                       UpdateStatus(Status_Busy);\r
+\r
+                       /* Get and process the device's first HID report descriptor */\r
+                       if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)\r
+                       {\r
+                               puts_P(PSTR("Report Parse Error.\r\n"));\r
+                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
+                       \r
+                               /* Indicate error via status LEDs */\r
+                               UpdateStatus(Status_EnumerationError);\r
+                               \r
+                               /* Wait until USB device disconnected */\r
+                               while (USB_IsConnected);\r
+                               break;  \r
+                       }\r
+                       \r
+                       /* All LEDs off - ready to indicate keypresses */\r
+                       UpdateStatus(Status_USBReady);\r
+\r
+                       puts_P(PSTR("Keyboard Enumerated.\r\n"));\r
+\r
+                       USB_HostState = HOST_STATE_Ready;\r
+                       break;\r
+               case HOST_STATE_Ready:\r
+                       /* Select and unfreeze keyboard data pipe */\r
+                       Pipe_SelectPipe(KEYBOARD_DATAPIPE);     \r
+                       Pipe_Unfreeze();\r
+\r
+                       /* Check if data has been received from the attached keyboard */\r
+                       if (Pipe_ReadWriteAllowed())\r
+                       {\r
+                               /* Create buffer big enough for the report */\r
+                               uint8_t KeyboardReport[Pipe_BytesInPipe()];\r
+\r
+                               /* Load in the keyboard report */\r
+                               Pipe_Read_Stream_LE(KeyboardReport, Pipe_BytesInPipe());\r
+                               \r
+                               /* Clear the IN endpoint, ready for next data packet */\r
+                               Pipe_ClearCurrentBank();\r
+\r
+                               /* Check each HID report item in turn, looking for keyboard scan code reports */\r
+                               for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)\r
+                               {\r
+                                       /* Create a tempoary item pointer to the next report item */\r
+                                       HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];\r
+\r
+                                       /* Check if the current report item is a keyboard scancode */\r
+                                       if ((ReportItem->Attributes.Usage.Page      == USAGE_PAGE_KEYBOARD) &&\r
+                                           (ReportItem->Attributes.BitSize         == 8)                   &&\r
+                                           (ReportItem->Attributes.Logical.Maximum > 1)                    &&\r
+                                           (ReportItem->ItemType                   == REPORT_ITEM_TYPE_In))\r
+                                       {\r
+                                               /* Retrieve the keyboard scancode from the report data retrieved from the device */\r
+                                               bool FoundData = GetReportItemInfo(KeyboardReport, ReportItem);\r
+                                               \r
+                                               /* For multi-report devices - if the requested data was not in the issued report, continue */\r
+                                               if (!(FoundData))\r
+                                                 continue;\r
+                                               \r
+                                               /* Key code is an unsigned char in length, cast to the appropriate type */\r
+                                               uint8_t KeyCode = (uint8_t)ReportItem->Value;\r
+\r
+                                               /* If scancode is non-zero, a key is being pressed */\r
+                                               if (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
+                                                       /* Convert scancode to printable character if alphanumeric */\r
+                                                       if ((KeyCode >= 0x04) && (KeyCode <= 0x1D))\r
+                                                         PressedKey = (KeyCode - 0x04) + 'A';\r
+                                                       else if ((KeyCode >= 0x1E) && (KeyCode <= 0x27))\r
+                                                         PressedKey = (KeyCode - 0x1E) + '0';\r
+                                                       else if (KeyCode == 0x2C)\r
+                                                         PressedKey = ' ';                                             \r
+                                                       else if (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
+                                               /* Once a scancode is found, stop scanning through the report items */\r
+                                               break;\r
+                                       }\r
+                               }\r
+                       }\r
+\r
+                       /* Freeze keyboard data pipe */\r
+                       Pipe_Freeze();\r
+                       break;\r
+       }\r
+}\r