Added WIN_LIBUSB_COMPAT compile time option to the AVRISP programmer project to make...

[pub/USBasp.git] / Demos / Host / ClassDriver / KeyboardHostWithParser / KeyboardHostWithParser.c

diff --git a/Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c b/Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
index 620f158..14b6501 100644 (file)
--- a/Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
+++ b/Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all 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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -36,21 +36,145 @@
  \r
 #include "KeyboardHostWithParser.h"\r
 \r
  \r
 #include "KeyboardHostWithParser.h"\r
 \r

+/** Processed HID report descriptor items structure, containing information on each HID report element */\r
+HID_ReportInfo_t HIDReportInfo;\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_NON_BOOT_PROTOCOL,\r
+                               \r
+                               .HIDParserData          = &HIDReportInfo\r
+                       },\r
+       };\r
+\r
+       \r

 /** Main program entry point. This routine configures the hardware required by the application, then\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
  */\r
 int main(void)\r
 {\r
        SetupHardware();\r
 \r

-       puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY\r
-              "Keyboard HID Parser Host Demo running.\r\n" ESC_INVERSE_OFF));\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
 \r
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
 \r
        for (;;)\r
        {\r

-               Keyboard_HID_Task();\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_SetReportProtocol(&Keyboard_HID_Interface) != 0)\r
+                               {\r
+                                       printf("Error Setting Report Protocol Mode or Not a Valid Keyboard.\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
+                               LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+                               USB_HostState = HOST_STATE_Configured;\r
+                               break;\r
+                       case HOST_STATE_Configured:\r
+                               if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))\r
+                               {\r
+                                       uint8_t KeyboardReport[Keyboard_HID_Interface.State.LargestReportSize];\r
+                                       HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);\r
+                                       \r
+                                       for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)\r
+                                       {\r
+                                               HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];\r
+\r
+                                               /* Update the report item value if it is contained within the current report */\r
+                                               if (!(USB_GetHIDReportItemInfo(KeyboardReport, ReportItem)))\r
+                                                 continue;\r
+\r
+                                               /* Determine what report item is being tested, process updated value as needed */\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
+                                                       /* 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
+                                                               LEDs_ToggleLEDs(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
+                               break;\r
+               }\r
+       \r
+               HID_Host_USBTask(&Keyboard_HID_Interface);\r

                USB_USBTask();\r
        }\r
 }\r
                USB_USBTask();\r
        }\r
 }\r


@@ -74,7 +198,7 @@ void SetupHardware(void)
 /** 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 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
        LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
 {\r
        puts_P(PSTR("Device Attached.\r\n"));\r
        LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r


@@ -83,7 +207,7 @@ void EVENT_USB_DeviceAttached(void)
 /** 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 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
        puts_P(PSTR("\r\nDevice Unattached.\r\n"));\r
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
 {\r
        puts_P(PSTR("\r\nDevice Unattached.\r\n"));\r
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r


@@ -92,18 +216,18 @@ void EVENT_USB_DeviceUnattached(void)
 /** 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 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
        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
 {\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
 {\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
        LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
        for(;;);\r
 \r
        LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
        for(;;);\r


@@ -112,184 +236,30 @@ void EVENT_USB_HostError(const uint8_t ErrorCode)
 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while\r
  *  enumerating an attached USB device.\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
 {\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
+       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
        LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r
 \r
        \r
        LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\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
-void Keyboard_HID_Task(void)\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 via status LEDs */\r
-                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\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
-                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\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
-                       /* 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
-                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\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
-                       /* Select and unfreeze keyboard data pipe */\r
-                       Pipe_SelectPipe(KEYBOARD_DATAPIPE);     \r
-                       Pipe_Unfreeze();\r
-\r
-                       /* Check to see if a packet has been received */\r
-                       if (Pipe_IsINReceived())\r
-                       {\r
-                               /* Check if data has been received from the attached keyboard */\r
-                               if (Pipe_IsReadWriteAllowed())\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
-                                       /* Process the read in keyboard report from the device */\r
-                                       ProcessKeyboardReport(KeyboardReport);\r
-                               }\r
-                               \r
-                               /* Clear the IN endpoint, ready for next data packet */\r
-                               Pipe_ClearIN();\r
-                       }\r
-\r
-                       /* Freeze keyboard data pipe */\r
-                       Pipe_Freeze();\r
-                       break;\r
-       }\r
-}\r
-\r
-/** Processes a read HID report from an attached keyboard, extracting out elements via the HID parser results\r
- *  as required and prints pressed characters to the serial port. Each time a key is typed, a board LED is toggled.\r
+/** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store\r
+ *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items\r
+ *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would\r
+ *  have occupied).\r
+ *\r
+ *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with\r

  *\r
  *\r

- *  \param KeyboardReport  Pointer to a HID report from an attached keyboard device\r
+ *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded\r

  */\r
  */\r

-void ProcessKeyboardReport(uint8_t* KeyboardReport)\r
+bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* CurrentItem)\r

 {\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 temporary 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 = USB_GetHIDReportItemInfo(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
+       /* Check the attributes of the current item - see if we are interested in it or not;\r
+        * only store KEYBOARD usage page items into the Processed HID Report structure to\r
+        * save RAM and ignore the rest\r
+        */\r
+       return (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_KEYBOARD);\r

 }\r
 }\r