You can not select more than 25 topics
			Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
		
		
		
		
		
			
		
			
				
					287 lines
				
				9.5 KiB
			
		
		
			
		
	
	
					287 lines
				
				9.5 KiB
			|   
											8 years ago
										 | /*
 | ||
|  |              LUFA Library | ||
|  |      Copyright (C) Dean Camera, 2017. | ||
|  | 
 | ||
|  |   dean [at] fourwalledcubicle [dot] com | ||
|  |            www.lufa-lib.org | ||
|  | */ | ||
|  | 
 | ||
|  | /*
 | ||
|  |   Copyright 2017  Dean Camera (dean [at] fourwalledcubicle [dot] com) | ||
|  | 
 | ||
|  |   Permission to use, copy, modify, distribute, and sell this | ||
|  |   software and its documentation for any purpose is hereby granted | ||
|  |   without fee, 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 disclaims 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 JoystickHostWithParser demo. This file contains the main tasks of | ||
|  |  *  the demo and is responsible for the initial application hardware configuration. | ||
|  |  */ | ||
|  | 
 | ||
|  | #include "JoystickHostWithParser.h"
 | ||
|  | 
 | ||
|  | /** Processed HID report descriptor items structure, containing information on each HID report element */ | ||
|  | static 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 Joystick_HID_Interface = | ||
|  | 	{ | ||
|  | 		.Config = | ||
|  | 			{ | ||
|  | 				.DataINPipe             = | ||
|  | 					{ | ||
|  | 						.Address        = (PIPE_DIR_IN  | 1), | ||
|  | 						.Banks          = 1, | ||
|  | 					}, | ||
|  | 				.DataOUTPipe            = | ||
|  | 					{ | ||
|  | 						.Address        = (PIPE_DIR_OUT | 2), | ||
|  | 						.Banks          = 1, | ||
|  | 					}, | ||
|  | 				.HIDInterfaceProtocol   = HID_CSCP_NonBootProtocol, | ||
|  | 				.HIDParserData          = &HIDReportInfo | ||
|  | 			}, | ||
|  | 	}; | ||
|  | 
 | ||
|  | 
 | ||
|  | /** Main program entry point. This routine configures the hardware required by the application, then
 | ||
|  |  *  enters a loop to run the application tasks in sequence. | ||
|  |  */ | ||
|  | int main(void) | ||
|  | { | ||
|  | 	SetupHardware(); | ||
|  | 
 | ||
|  | 	puts_P(PSTR(ESC_FG_CYAN "Joystick Host Demo running.\r\n" ESC_FG_WHITE)); | ||
|  | 
 | ||
|  | 	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); | ||
|  | 	GlobalInterruptEnable(); | ||
|  | 
 | ||
|  | 	for (;;) | ||
|  | 	{ | ||
|  | 		JoystickHost_Task(); | ||
|  | 
 | ||
|  | 		HID_Host_USBTask(&Joystick_HID_Interface); | ||
|  | 		USB_USBTask(); | ||
|  | 	} | ||
|  | } | ||
|  | 
 | ||
|  | /** Configures the board hardware and chip peripherals for the demo's functionality. */ | ||
|  | void SetupHardware(void) | ||
|  | { | ||
|  | #if (ARCH == ARCH_AVR8)
 | ||
|  | 	/* Disable watchdog if enabled by bootloader/fuses */ | ||
|  | 	MCUSR &= ~(1 << WDRF); | ||
|  | 	wdt_disable(); | ||
|  | 
 | ||
|  | 	/* Disable clock division */ | ||
|  | 	clock_prescale_set(clock_div_1); | ||
|  | #endif
 | ||
|  | 
 | ||
|  | 	/* Hardware Initialization */ | ||
|  | 	Serial_Init(9600, false); | ||
|  | 	LEDs_Init(); | ||
|  | 	USB_Init(); | ||
|  | 
 | ||
|  | 	/* Create a stdio stream for the serial port for stdin and stdout */ | ||
|  | 	Serial_CreateStream(NULL); | ||
|  | } | ||
|  | 
 | ||
|  | /** Task to manage an enumerated USB joystick once connected, to display movement
 | ||
|  |  *  data as it is received. | ||
|  |  */ | ||
|  | void JoystickHost_Task(void) | ||
|  | { | ||
|  | 	if (USB_HostState != HOST_STATE_Configured) | ||
|  | 	  return; | ||
|  | 
 | ||
|  | 	if (HID_Host_IsReportReceived(&Joystick_HID_Interface)) | ||
|  | 	{ | ||
|  | 		uint8_t JoystickReport[Joystick_HID_Interface.State.LargestReportSize]; | ||
|  | 		HID_Host_ReceiveReport(&Joystick_HID_Interface, &JoystickReport); | ||
|  | 
 | ||
|  | 		uint8_t LEDMask = LEDS_NO_LEDS; | ||
|  | 
 | ||
|  | 		for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++) | ||
|  | 		{ | ||
|  | 			HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber]; | ||
|  | 
 | ||
|  | 			/* Update the report item value if it is contained within the current report */ | ||
|  | 			if (!(USB_GetHIDReportItemInfo(JoystickReport, ReportItem))) | ||
|  | 			  continue; | ||
|  | 
 | ||
|  | 			/* Determine what report item is being tested, process updated value as needed */ | ||
|  | 			if ((ReportItem->Attributes.Usage.Page        == USAGE_PAGE_BUTTON) && | ||
|  | 			    (ReportItem->ItemType                     == HID_REPORT_ITEM_In)) | ||
|  | 			{ | ||
|  | 				if (ReportItem->Value) | ||
|  | 				  LEDMask = LEDS_ALL_LEDS; | ||
|  | 			} | ||
|  | 			else if ((ReportItem->Attributes.Usage.Page   == USAGE_PAGE_GENERIC_DCTRL) && | ||
|  | 			         ((ReportItem->Attributes.Usage.Usage == USAGE_X)                  || | ||
|  | 			          (ReportItem->Attributes.Usage.Usage == USAGE_Y))                 && | ||
|  | 			         (ReportItem->ItemType                == HID_REPORT_ITEM_In)) | ||
|  | 			{ | ||
|  | 				int16_t DeltaMovement = HID_ALIGN_DATA(ReportItem, int16_t); | ||
|  | 
 | ||
|  | 				if (DeltaMovement) | ||
|  | 				{ | ||
|  | 					if (ReportItem->Attributes.Usage.Usage == USAGE_X) | ||
|  | 					  LEDMask |= ((DeltaMovement > 0) ? LEDS_LED1 : LEDS_LED2); | ||
|  | 					else | ||
|  | 					  LEDMask |= ((DeltaMovement > 0) ? LEDS_LED3 : LEDS_LED4); | ||
|  | 				} | ||
|  | 			} | ||
|  | 		} | ||
|  | 
 | ||
|  | 		LEDs_SetAllLEDs(LEDMask); | ||
|  | 	} | ||
|  | } | ||
|  | 
 | ||
|  | /** 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_ENUMERATING); | ||
|  | 
 | ||
|  | 	uint16_t ConfigDescriptorSize; | ||
|  | 	uint8_t  ConfigDescriptorData[512]; | ||
|  | 
 | ||
|  | 	if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData, | ||
|  | 	                                       sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful) | ||
|  | 	{ | ||
|  | 		puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n")); | ||
|  | 		LEDs_SetAllLEDs(LEDMASK_USB_ERROR); | ||
|  | 		return; | ||
|  | 	} | ||
|  | 
 | ||
|  | 	if (HID_Host_ConfigurePipes(&Joystick_HID_Interface, | ||
|  | 	                            ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError) | ||
|  | 	{ | ||
|  | 		puts_P(PSTR("Attached Device Not a Valid Joystick.\r\n")); | ||
|  | 		LEDs_SetAllLEDs(LEDMASK_USB_ERROR); | ||
|  | 		return; | ||
|  | 	} | ||
|  | 
 | ||
|  | 	if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful) | ||
|  | 	{ | ||
|  | 		puts_P(PSTR("Error Setting Device Configuration.\r\n")); | ||
|  | 		LEDs_SetAllLEDs(LEDMASK_USB_ERROR); | ||
|  | 		return; | ||
|  | 	} | ||
|  | 
 | ||
|  | 	if (HID_Host_SetReportProtocol(&Joystick_HID_Interface) != 0) | ||
|  | 	{ | ||
|  | 		puts_P(PSTR("Error Setting Report Protocol Mode or Not a Valid Joystick.\r\n")); | ||
|  | 		LEDs_SetAllLEDs(LEDMASK_USB_ERROR); | ||
|  | 		USB_Host_SetDeviceConfiguration(0); | ||
|  | 		return; | ||
|  | 	} | ||
|  | 
 | ||
|  | 	puts_P(PSTR("Joystick Enumerated.\r\n")); | ||
|  | 	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_Disable(); | ||
|  | 
 | ||
|  | 	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[in] CurrentItem  Pointer to the item the HID report parser is currently working with | ||
|  |  * | ||
|  |  *  \return Boolean \c true if the item should be stored into the HID report structure, \c false if it should be discarded | ||
|  |  */ | ||
|  | bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem) | ||
|  | { | ||
|  | 	bool IsJoystick = false; | ||
|  | 
 | ||
|  | 	/* Iterate through the item's collection path, until either the root collection node or a collection with the
 | ||
|  | 	 * Joystick Usage is found - this prevents Mice, which use identical descriptors except for the Joystick usage | ||
|  | 	 * parent node, from being erroneously treated as a joystick by the demo | ||
|  | 	 */ | ||
|  | 	for (HID_CollectionPath_t* CurrPath = CurrentItem->CollectionPath; CurrPath != NULL; CurrPath = CurrPath->Parent) | ||
|  | 	{ | ||
|  | 		if ((CurrPath->Usage.Page  == USAGE_PAGE_GENERIC_DCTRL) && | ||
|  | 		    (CurrPath->Usage.Usage == USAGE_JOYSTICK)) | ||
|  | 		{ | ||
|  | 			IsJoystick = true; | ||
|  | 			break; | ||
|  | 		} | ||
|  | 	} | ||
|  | 
 | ||
|  | 	/* If a collection with the joystick usage was not found, indicate that we are not interested in this item */ | ||
|  | 	if (!IsJoystick) | ||
|  | 	  return false; | ||
|  | 
 | ||
|  | 	/* Check the attributes of the current item - see if we are interested in it or not;
 | ||
|  | 	 * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report | ||
|  | 	 * structure to save RAM and ignore the rest | ||
|  | 	 */ | ||
|  | 	return ((CurrentItem->Attributes.Usage.Page == USAGE_PAGE_BUTTON) || | ||
|  | 	        (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_GENERIC_DCTRL)); | ||
|  | } | ||
|  | 
 |