X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/f51017f8fb5a02029bce577e3d7226cb5158d830..f1199200e167a737a4676378da184387e543830c:/Demos/Host/ClassDriver/GenericHIDHost/GenericHIDHost.c?ds=sidebyside

diff --git a/Demos/Host/ClassDriver/GenericHIDHost/GenericHIDHost.c b/Demos/Host/ClassDriver/GenericHIDHost/GenericHIDHost.c
new file mode 100644
index 000000000..e731f90cf
--- /dev/null
+++ b/Demos/Host/ClassDriver/GenericHIDHost/GenericHIDHost.c
@@ -0,0 +1,343 @@
+/*
+             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 GenericHIDHost demo. This file contains the main tasks of
+ *  the demo and is responsible for the initial application hardware configuration.
+ */
+ 
+#include "GenericHIDHost.h"
+
+/* Scheduler Task List */
+TASK_LIST
+{
+	{ .Task = USB_USBTask          , .TaskStatus = TASK_STOP },
+	{ .Task = USB_HID_Host         , .TaskStatus = TASK_STOP },
+};
+
+
+/** 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)
+{
+	/* 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();
+	
+	/* Indicate USB not ready */
+	UpdateStatus(Status_USBNotReady);
+	
+	/* Initialize Scheduler so that it can be used */
+	Scheduler_Init();
+
+	/* Initialize USB Subsystem */
+	USB_Init();
+
+	/* Start-up message */
+	puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY
+	       "Generic HID Host Demo running.\r\n" ESC_INVERSE_OFF));
+		   
+	/* Scheduling - routine never returns, so put this last in the main function */
+	Scheduler_Start();
+}
+
+/** 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_DeviceAttached(void)
+{
+	puts_P(PSTR("Device Attached.\r\n"));
+	UpdateStatus(Status_USBEnumerating);
+
+	/* Start USB management task to enumerate the device */
+	Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
+}
+
+/** 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_DeviceUnattached(void)
+{
+	/* Stop HID and USB management task */
+	Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
+	Scheduler_SetTaskMode(USB_HID_Host, TASK_STOP);
+
+	puts_P(PSTR("Device Unattached.\r\n"));
+	UpdateStatus(Status_USBNotReady);
+}
+
+/** 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_DeviceEnumerationComplete(void)
+{
+	/* Start HID Host task */
+	Scheduler_SetTaskMode(USB_HID_Host, TASK_RUN);
+
+	/* Indicate device enumeration complete */
+	UpdateStatus(Status_USBReady);
+}
+
+/** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
+void EVENT_USB_HostError(const uint8_t ErrorCode)
+{
+	USB_ShutDown();
+
+	puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));
+	printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
+
+	UpdateStatus(Status_HardwareError);
+	for(;;);
+}
+
+/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
+ *  enumerating an attached USB device.
+ */
+void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
+{
+	puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));
+	printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
+	printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
+	printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);
+
+	UpdateStatus(Status_EnumerationError);
+}
+
+/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
+ *  log to a serial port, or anything else that is suitable for status updates.
+ *
+ *  \param CurrentStatus  Current status of the system, from the GenericHIDHost_StatusCodes_t enum
+ */
+void UpdateStatus(uint8_t CurrentStatus)
+{
+	uint8_t LEDMask = LEDS_NO_LEDS;
+	
+	/* Set the LED mask to the appropriate LED mask based on the given status code */
+	switch (CurrentStatus)
+	{
+		case Status_USBNotReady:
+			LEDMask = (LEDS_LED1);
+			break;
+		case Status_USBEnumerating:
+			LEDMask = (LEDS_LED1 | LEDS_LED2);
+			break;
+		case Status_USBReady:
+			LEDMask = (LEDS_LED2);
+			break;
+		case Status_EnumerationError:
+		case Status_HardwareError:
+			LEDMask = (LEDS_LED1 | LEDS_LED3);
+			break;
+	}
+	
+	/* Set the board LEDs to the new LED mask */
+	LEDs_SetAllLEDs(LEDMask);
+}
+
+/** Reads in and processes the next report from the attached device, displaying the report
+ *  contents on the board LEDs and via the serial port.
+ */
+void ReadNextReport(void)
+{
+	/* Select and unfreeze HID data IN pipe */
+	Pipe_SelectPipe(HID_DATA_IN_PIPE);
+	Pipe_Unfreeze();
+
+	/* Check to see if a packet has been received */
+	if (!(Pipe_IsINReceived()))
+	{
+		/* Refreeze HID data IN pipe */
+		Pipe_Freeze();
+			
+		return;
+	}
+	
+	/* Ensure pipe contains data before trying to read from it */
+	if (Pipe_IsReadWriteAllowed())
+	{
+		uint8_t ReportINData[Pipe_BytesInPipe()];
+
+		/* Read in HID report data */
+		Pipe_Read_Stream_LE(&ReportINData, sizeof(ReportINData));
+	
+		/* Print report data through the serial port */
+		for (uint16_t CurrByte = 0; CurrByte < sizeof(ReportINData); CurrByte++)
+		  printf_P(PSTR("0x%02X "), ReportINData[CurrByte]);
+		
+		puts_P(PSTR("\r\n"));
+	}
+		
+	/* Clear the IN endpoint, ready for next data packet */
+	Pipe_ClearIN();
+	
+	/* Refreeze HID data IN pipe */
+	Pipe_Freeze();
+}
+
+/** Writes a report to the attached device.
+ *
+ *  \param ReportOUTData  Buffer containing the report to send to the device
+ *  \param ReportIndex  Index of the report in the device (zero if the device does not use multiple reports)
+ *  \param ReportType  Type of report to send, either HID_REPORTTYPE_OUTPUT or HID_REPORTTYPE_FEATURE
+ *  \param ReportLength  Length of the report to send
+ */
+void WriteNextReport(uint8_t* ReportOUTData, uint8_t ReportIndex, uint8_t ReportType, uint16_t ReportLength)
+{
+	/* Select and unfreeze HID data OUT pipe */
+	Pipe_SelectPipe(HID_DATA_OUT_PIPE);
+	
+	/* Not all HID devices have an OUT endpoint (some require OUT reports to be sent over the
+	 * control endpoint instead) - check to see if the OUT endpoint has been initialized */
+	if (Pipe_IsConfigured())
+	{
+		Pipe_Unfreeze();
+
+		/* Ensure pipe is ready to be written to before continuing */
+		if (!(Pipe_IsOUTReady()))
+		{
+			/* Refreeze the data OUT pipe */
+			Pipe_Freeze();
+			
+			return;
+		}
+		
+		/* If the report index is used, send it before the report data */
+		if (ReportIndex)
+		  Pipe_Write_Byte(ReportIndex);
+
+		/* Write out HID report data */
+		Pipe_Write_Stream_LE(ReportOUTData, ReportLength);				
+			
+		/* Clear the OUT endpoint, send last data packet */
+		Pipe_ClearOUT();
+
+		/* Refreeze the data OUT pipe */
+		Pipe_Freeze();
+	}
+	else
+	{
+		/* Class specific request to send a HID report to the device */
+		USB_ControlRequest = (USB_Request_Header_t)
+			{
+				.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
+				.bRequest      = REQ_SetReport,
+				.wValue        = ((ReportType << 8) | ReportIndex),
+				.wIndex        = 0,
+				.wLength       = ReportLength,
+			};
+
+		/* Select the control pipe for the request transfer */
+		Pipe_SelectPipe(PIPE_CONTROLPIPE);
+
+		/* Send the request to the device */
+		USB_Host_SendControlRequest(ReportOUTData);
+	}
+}
+
+/** Task to set the configuration of the attached device after it has been enumerated, and to read and process
+ *  HID reports from the device and to send reports if desired.
+ */
+TASK(USB_HID_Host)
+{
+	uint8_t ErrorCode;
+
+	/* Switch to determine what user-application handled host state the host state machine is in */
+	switch (USB_HostState)
+	{
+		case HOST_STATE_Addressed:
+			/* Standard request to set the device configuration to configuration 1 */
+			USB_ControlRequest = (USB_Request_Header_t)
+				{
+					.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),
+					.bRequest      = REQ_SetConfiguration,
+					.wValue        = 1,
+					.wIndex        = 0,
+					.wLength       = 0,
+				};
+
+			/* Select the control pipe for the request transfer */
+			Pipe_SelectPipe(PIPE_CONTROLPIPE);
+
+			/* Send the request, display error and wait for device detach if request fails */
+			if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
+			{
+				puts_P(PSTR("Control Error (Set Configuration).\r\n"));
+				printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
+
+				/* Indicate error status */
+				UpdateStatus(Status_EnumerationError);
+				
+				/* Wait until USB device disconnected */
+				while (USB_IsConnected);
+				break;
+			}
+			
+			USB_HostState = HOST_STATE_Configured;
+			break;
+		case HOST_STATE_Configured:
+			puts_P(PSTR("Getting Config Data.\r\n"));
+		
+			/* Get and process the configuration descriptor data */
+			if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
+			{
+				if (ErrorCode == ControlError)
+				  puts_P(PSTR("Control Error (Get Configuration).\r\n"));
+				else
+				  puts_P(PSTR("Invalid Device.\r\n"));
+
+				printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);
+				
+				/* Indicate error status */
+				UpdateStatus(Status_EnumerationError);
+
+				/* Wait until USB device disconnected */
+				while (USB_IsConnected);
+				break;
+			}
+		
+			puts_P(PSTR("HID Device Enumerated.\r\n"));
+					
+			USB_HostState = HOST_STATE_Ready;
+			break;
+		case HOST_STATE_Ready:
+			ReadNextReport();
+
+			break;
+	}
+}