Finish initial draft of the Host Mode HID Class driver.

Add new MouseHostWithParser and KeyboardHostWithParser Host Class driver demos.

Demos/Device/ClassDriver/MassStorageKeyboard/Descriptors.c

@@ -8,7 +8,7 @@
 
 /*
   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
-  Copyright 2009  Matthias Hullin (matthias [at] hullin [dot] net)
+  Copyright 2009  Matthias Hullin (lufa [at] matthias [dot] hullin [dot] net)
 
   Permission to use, copy, modify, and distribute this software
   and its documentation for any purpose and without fee is hereby

Demos/Device/ClassDriver/MassStorageKeyboard/Descriptors.h

@@ -8,7 +8,7 @@
 
 /*
   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
-  Copyright 2009  Matthias Hullin (matthias [at] hullin [dot] net)
+  Copyright 2009  Matthias Hullin (lufa [at] matthias [dot] hullin [dot] net)
 
   Permission to use, copy, modify, and distribute this software
   and its documentation for any purpose and without fee is hereby

Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c

@@ -8,7 +8,7 @@
 
 /*
   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
-  Copyright 2009  Matthias Hullin (matthias [at] hullin [dot] net)
+  Copyright 2009  Matthias Hullin (lufa [at] matthias [dot] hullin [dot] net)
 
   Permission to use, copy, modify, and distribute this software
   and its documentation for any purpose and without fee is hereby

Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.h

@@ -8,7 +8,7 @@
 
 /*
   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
-  Copyright 2009  Matthias Hullin (matthias [at] hullin [dot] net)
+  Copyright 2009  Matthias Hullin (lufa [at] matthias [dot] hullin [dot] net)
 
   Permission to use, copy, modify, and distribute this software
   and its documentation for any purpose and without fee is hereby

Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.c

@@ -113,10 +113,8 @@ int main(void)
 			case HOST_STATE_Configured:
 				if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))
 				{
-					USB_KeyboardReport_Data_t KeyboardReport;
-					uint8_t ReportID = 0;
-					
-					HID_Host_ReceiveReport(&Keyboard_HID_Interface, false, &ReportID, &KeyboardReport);
+					USB_KeyboardReport_Data_t KeyboardReport;					
+					HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
 
 					LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 					

Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c

+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2009.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, and distribute this software
+  and its documentation for any purpose and without fee is hereby
+  granted, provided that the above copyright notice appear in all
+  copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Main source file for the KeyboardHostWithParser demo. This file contains the main tasks of
+ *  the demo and is responsible for the initial application hardware configuration.
+ */
+ 
+#include "KeyboardHostWithParser.h"
+
+/** Processed HID report descriptor items structure, containing information on each HID report element */
+HID_ReportInfo_t HIDReportInfo;
+
+/** LUFA HID Class driver interface configuration and state information. This structure is
+ *  passed to all HID Class driver functions, so that multiple instances of the same class
+ *  within a device can be differentiated from one another.
+ */
+USB_ClassInfo_HID_Host_t Keyboard_HID_Interface =
+	{
+		.Config =
+			{
+				.DataINPipeNumber       = 1,
+				.DataOUTPipeNumber      = 2,
+				
+				.HIDInterfaceProtocol   = HID_NON_BOOT_PROTOCOL,
+				
+				.HIDParserData          = &HIDReportInfo
+			},
+	};
+
+	
+/** Main program entry point. This routine configures the hardware required by the application, then
+ *  starts the scheduler to run the application tasks.
+ */
+int main(void)
+{
+	SetupHardware();
+
+	puts_P(PSTR(ESC_FG_CYAN "Keyboard Host Demo running.\r\n" ESC_FG_WHITE));
+
+	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+
+	for (;;)
+	{
+		switch (USB_HostState)
+		{
+			case HOST_STATE_Addressed:
+				LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+			
+				uint16_t ConfigDescriptorSize;
+				uint8_t  ConfigDescriptorData[512];
+
+				if (USB_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
+				                                  sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
+				{
+					printf("Error Retrieving Configuration Descriptor.\r\n");
+					LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+					USB_HostState = HOST_STATE_WaitForDeviceRemoval;
+					break;
+				}
+
+				if (HID_Host_ConfigurePipes(&Keyboard_HID_Interface,
+				                            ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
+				{
+					printf("Attached Device Not a Valid Keyboard.\r\n");
+					LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+					USB_HostState = HOST_STATE_WaitForDeviceRemoval;
+					break;
+				}
+				
+				if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
+				{
+					printf("Error Setting Device Configuration.\r\n");
+					LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+					USB_HostState = HOST_STATE_WaitForDeviceRemoval;
+					break;
+				}
+
+				if (USB_HID_Host_SetReportProtocol(&Keyboard_HID_Interface) != 0)
+				{
+					printf("Could not Set Report Protocol Mode.\r\n");
+					LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+					USB_HostState = HOST_STATE_WaitForDeviceRemoval;
+					break;
+				}
+				
+				LEDs_SetAllLEDs(LEDS_NO_LEDS);
+
+				printf("HID Device Enumerated.\r\n");
+				USB_HostState = HOST_STATE_Configured;
+				break;
+			case HOST_STATE_Configured:
+				if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))
+				{
+					uint8_t KeyboardReport[50];
+					HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
+					
+					for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
+					{
+						HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
+
+						/* Check if the current report item is a keyboard scancode */
+						if ((ReportItem->Attributes.Usage.Page      == USAGE_PAGE_KEYBOARD) &&
+							(ReportItem->Attributes.BitSize         == 8)                   &&
+							(ReportItem->Attributes.Logical.Maximum > 1)                    &&
+							(ReportItem->ItemType                   == REPORT_ITEM_TYPE_In))
+						{
+							/* Retrieve the keyboard scancode from the report data retrieved from the device if it is
+							 * contained within the current report, if not, skip to the next item in the parser list
+							 */
+							if (!(USB_GetHIDReportItemInfo(KeyboardReport, ReportItem)))
+							  continue;
+
+							/* Key code is an unsigned char in length, cast to the appropriate type */
+							uint8_t KeyCode = (uint8_t)ReportItem->Value;
+
+							/* If scancode is non-zero, a key is being pressed */
+							if (KeyCode)
+							{
+								/* Toggle status LED to indicate keypress */
+								LEDs_ToggleLEDs(LEDS_LED2);
+
+								char PressedKey = 0;
+
+								/* Convert scancode to printable character if alphanumeric */
+								if ((KeyCode >= 0x04) && (KeyCode <= 0x1D))
+								  PressedKey = (KeyCode - 0x04) + 'A';
+								else if ((KeyCode >= 0x1E) && (KeyCode <= 0x27))
+								  PressedKey = (KeyCode - 0x1E) + '0';
+								else if (KeyCode == 0x2C)
+								  PressedKey = ' ';						
+								else if (KeyCode == 0x28)
+								  PressedKey = '\n';
+									 
+								/* Print the pressed key character out through the serial port if valid */
+								if (PressedKey)
+								  putchar(PressedKey);
+							}
+							
+							/* Once a scancode is found, stop scanning through the report items */
+							break;
+						}
+					}
+				}
+				
+				break;
+		}
+	
+		HID_Host_USBTask(&Keyboard_HID_Interface);
+		USB_USBTask();
+	}
+}
+
+/** Configures the board hardware and chip peripherals for the demo's functionality. */
+void SetupHardware(void)
+{
+	/* Disable watchdog if enabled by bootloader/fuses */
+	MCUSR &= ~(1 << WDRF);
+	wdt_disable();
+
+	/* Disable clock division */
+	clock_prescale_set(clock_div_1);
+
+	/* Hardware Initialization */
+	SerialStream_Init(9600, false);
+	LEDs_Init();
+	USB_Init();
+}
+
+/** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
+ *  starts the library USB task to begin the enumeration and USB management process.
+ */
+void EVENT_USB_Host_DeviceAttached(void)
+{
+	puts_P(PSTR("Device Attached.\r\n"));
+	LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+}
+
+/** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
+ *  stops the library USB task management process.
+ */
+void EVENT_USB_Host_DeviceUnattached(void)
+{
+	puts_P(PSTR("\r\nDevice Unattached.\r\n"));
+	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+}
+
+/** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
+ *  enumerated by the host and is now ready to be used by the application.
+ */
+void EVENT_USB_Host_DeviceEnumerationComplete(void)
+{
+	LEDs_SetAllLEDs(LEDMASK_USB_READY);
+}
+
+/** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
+void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
+{
+	USB_ShutDown();
+
+	printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
+	                         " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
+
+	LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+	for(;;);
+}
+
+/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
+ *  enumerating an attached USB device.
+ */
+void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
+{
+	printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
+	                         " -- Error Code %d\r\n"
+	                         " -- Sub Error Code %d\r\n"
+	                         " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
+	
+	LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+}
+
+/** Callback for the HID Report Parser. This function is called each time the HID report parser is about to store
+ *  an IN, OUT or FEATURE item into the HIDReportInfo structure. To save on RAM, we are able to filter out items
+ *  we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
+ *  have occupied).
+ *
+ *  \param CurrentItemAttributes  Pointer to the attrbutes of the item the HID report parser is currently working with
+ *
+ *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
+ */
+bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_Attributes_t* CurrentItemAttributes)
+{
+	/* Check the attributes of the current item - see if we are interested in it or not */
+	if (CurrentItemAttributes->Usage.Page == USAGE_PAGE_KEYBOARD)
+	{
+		/* Only store KEYBOARD usage page items into the Processed HID Report structure to save RAM */
+		return true;
+	}
+	else
+	{
+		return false;
+	}
+}

Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.h

+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2009.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, and distribute this software
+  and its documentation for any purpose and without fee is hereby
+  granted, provided that the above copyright notice appear in all
+  copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Header file for KeyboardHostWithParser.c.
+ */
+
+#ifndef _KEYBOARD_HOST_H_
+#define _KEYBOARD_HOST_H_
+
+	/* Includes: */
+		#include <avr/io.h>
+		#include <avr/wdt.h>
+		#include <avr/pgmspace.h>
+		#include <avr/power.h>
+		#include <stdio.h>
+
+		#include <LUFA/Version.h>
+		#include <LUFA/Drivers/Misc/TerminalCodes.h>
+		#include <LUFA/Drivers/Peripheral/SerialStream.h>
+		#include <LUFA/Drivers/Board/LEDs.h>
+		#include <LUFA/Drivers/USB/USB.h>
+		#include <LUFA/Drivers/USB/Class/HID.h>
+		
+	/* Macros: */
+		/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
+		#define LEDMASK_USB_NOTREADY      LEDS_LED1
+
+		/** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
+		#define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
+
+		/** LED mask for the library LED driver, to indicate that the USB interface is ready. */
+		#define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
+
+		/** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
+		#define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
+		
+		/** HID Report Descriptor Usage Page value for a desktop keyboard */
+		#define USAGE_PAGE_KEYBOARD      0x07
+
+	/* Function Prototypes: */
+		void SetupHardware(void);
+	
+		void EVENT_USB_Host_HostError(const uint8_t ErrorCode);
+		void EVENT_USB_Host_DeviceAttached(void);
+		void EVENT_USB_Host_DeviceUnattached(void);
+		void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);
+		void EVENT_USB_Host_DeviceEnumerationComplete(void);
+		
+#endif

Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.txt

+/** \file
+ *
+ *  This file contains special DoxyGen information for the generation of the main page and other special
+ *  documentation pages. It is not a project source file.
+ */
+ 
+/** \mainpage Keyboard Host With HID Descriptor Parser Demo
+ *
+ *  \section SSec_Compat Demo Compatibility:
+ *
+ *  The following table indicates what microcontrollers are compatible with this demo.
+ *
+ *  - AT90USB1287
+ *  - AT90USB647
+ *
+ *  \section SSec_Info USB Information:
+ *
+ *  The following table gives a rundown of the USB utilization of this demo.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>USB Mode:</b></td>
+ *    <td>Host</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Class:</b></td>
+ *    <td>Human Interface Device (HID)</td>
+ *   </tr>
+ *   <tr> 
+ *    <td><b>USB Subclass:</b></td>
+ *    <td>N/A</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Usable Speeds:</b></td>
+ *    <td>Low Speed Mode, Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_Description Project Description: 
+ *
+ *  Keyboard host demonstration application. This gives a simple reference
+ *  application for implementing a USB Keyboard host, for USB keyboards using
+ *  the standard Keyboard HID profile. It uses a HID parser for the HID reports,
+ *  allowing for correct operation across all USB keyboards. This demo supports
+ *  keyboards with a single HID report.
+ *  
+ *  Pressed alpha-numeric, enter or space key is transmitted through the serial
+ *  USART at serial settings 9600, 8, N, 1. On connection to a USB keyboard, the
+ *  report items will be processed and printed as a formatted list through the
+ *  USART before the keyboard is fully enumerated.
+ *  
+ *  Currently only single interface keyboards are supported.	
+ *
+ *  \section SSec_Options Project Options
+ *
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ *  <table>
+ *   <tr>
+ *    <td>
+ *     None
+ *    </td>
+ *   </tr>
+ *  </table>
+ */
\ No newline at end of file

Demos/Host/ClassDriver/MouseHost/MouseHost.c

@@ -113,18 +113,14 @@ int main(void)
 			case HOST_STATE_Configured:
 				if (HID_Host_IsReportReceived(&Mouse_HID_Interface))
 				{
-					USB_MouseReport_Data_t MouseReport;
-					uint8_t ReportID = 0;
 					uint8_t LEDMask  = LEDS_NO_LEDS;
 				
-					/* Receive next boot protocol mouse report from the device */
-					HID_Host_ReceiveReport(&Mouse_HID_Interface, false, &ReportID, &MouseReport);
+					USB_MouseReport_Data_t MouseReport;
+					HID_Host_ReceiveReport(&Mouse_HID_Interface, &MouseReport);
 					
-					/* Print mouse report data through the serial port */
 					printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,
 																  MouseReport.Y,
 																  MouseReport.Button);
-
 					if (MouseReport.X > 0)
 					  LEDMask |= LEDS_LED1;
 					else if (MouseReport.X < 0)

Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c

+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2009.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, and distribute this software
+  and its documentation for any purpose and without fee is hereby
+  granted, provided that the above copyright notice appear in all
+  copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Main source file for the MouseHostWithParser demo. This file contains the main tasks of
+ *  the demo and is responsible for the initial application hardware configuration.
+ */
+ 
+#include "MouseHostWithParser.h"
+
+/** Processed HID report descriptor items structure, containing information on each HID report element */
+HID_ReportInfo_t HIDReportInfo;
+
+/** LUFA HID Class driver interface configuration and state information. This structure is
+ *  passed to all HID Class driver functions, so that multiple instances of the same class
+ *  within a device can be differentiated from one another.
+ */
+USB_ClassInfo_HID_Host_t Mouse_HID_Interface =
+	{
+		.Config =
+			{
+				.DataINPipeNumber       = 1,
+				.DataOUTPipeNumber      = 2,
+				
+				.HIDInterfaceProtocol   = HID_NON_BOOT_PROTOCOL,
+				
+				.HIDParserData          = &HIDReportInfo
+			},
+	};
+
+	
+/** Main program entry point. This routine configures the hardware required by the application, then
+ *  starts the scheduler to run the application tasks.
+ */
+int main(void)
+{
+	SetupHardware();
+
+	puts_P(PSTR(ESC_FG_CYAN "Mouse Host Demo running.\r\n" ESC_FG_WHITE));
+
+	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+
+	for (;;)
+	{
+		switch (USB_HostState)
+		{
+			case HOST_STATE_Addressed:
+				LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+			
+				uint16_t ConfigDescriptorSize;
+				uint8_t  ConfigDescriptorData[512];
+
+				if (USB_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
+				                                  sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
+				{
+					printf("Error Retrieving Configuration Descriptor.\r\n");
+					LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+					USB_HostState = HOST_STATE_WaitForDeviceRemoval;
+					break;
+				}
+
+				if (HID_Host_ConfigurePipes(&Mouse_HID_Interface,
+				                            ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
+				{
+					printf("Attached Device Not a Valid Mouse.\r\n");
+					LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+					USB_HostState = HOST_STATE_WaitForDeviceRemoval;