diff options
| author | Jack Humbert <[email protected]> | 2017-07-07 11:55:23 -0400 | 
|---|---|---|
| committer | Jack Humbert <[email protected]> | 2017-07-07 11:55:23 -0400 | 
| commit | 60b30c036397cb5627fa374bb930794b225daa29 (patch) | |
| tree | e156c2d6b27f01db6985f2cc560c9c345d48fdac /Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.c | |
| download | qmk_firmware-60b30c036397cb5627fa374bb930794b225daa29.tar.gz qmk_firmware-60b30c036397cb5627fa374bb930794b225daa29.zip | |
Squashed 'lib/lufa/' content from commit 385d40300
git-subtree-dir: lib/lufa
git-subtree-split: 385d4030035dbaf41591309dbde47653bd03841b
Diffstat (limited to 'Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.c')
| -rw-r--r-- | Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.c | 155 | 
1 files changed, 155 insertions, 0 deletions
| diff --git a/Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.c b/Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.c new file mode 100644 index 0000000000..1c152b7402 --- /dev/null +++ b/Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.c @@ -0,0 +1,155 @@ +/* +             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 + * + *  USB Device Configuration Descriptor processing routines, to determine the correct pipe configurations + *  needed to communication with an attached USB device. Descriptors are special  computer-readable structures + *  which the host requests upon device enumeration, to determine the device's capabilities and functions. + */ + +#include "ConfigDescriptor.h" + +/** Reads and processes an attached device's descriptors, to determine compatibility and pipe configurations. This + *  routine will read in the entire configuration descriptor, and configure the hosts pipes to correctly communicate + *  with compatible devices. + * + *  This routine searches for a HID interface descriptor containing at least one Interrupt type IN endpoint. + * + *  \return An error code from the \ref KeyboardHost_GetConfigDescriptorDataCodes_t enum. + */ +uint8_t ProcessConfigurationDescriptor(void) +{ +	uint8_t  ConfigDescriptorData[512]; +	void*    CurrConfigLocation = ConfigDescriptorData; +	uint16_t CurrConfigBytesRem; + +	USB_Descriptor_Interface_t* HIDInterface   = NULL; +	USB_Descriptor_Endpoint_t*  DataINEndpoint = NULL; + +	/* Retrieve the entire configuration descriptor into the allocated buffer */ +	switch (USB_Host_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData))) +	{ +		case HOST_GETCONFIG_Successful: +			break; +		case HOST_GETCONFIG_InvalidData: +			return InvalidConfigDataReturned; +		case HOST_GETCONFIG_BuffOverflow: +			return DescriptorTooLarge; +		default: +			return ControlError; +	} + +	while (!(DataINEndpoint)) +	{ +		/* See if we've found a likely compatible interface, and if there is an endpoint within that interface */ +		if (!(HIDInterface) || +		    USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation, +		                              DComp_NextKeyboardInterfaceDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found) +		{ +			/* Get the next HID interface from the configuration descriptor */ +			if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation, +										  DComp_NextKeyboardInterface) != DESCRIPTOR_SEARCH_COMP_Found) +			{ +				/* Descriptor not found, error out */ +				return NoCompatibleInterfaceFound; +			} + +			/* Save the interface in case we need to refer back to it later */ +			HIDInterface = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Interface_t); + +			/* Skip the remainder of the loop as we have not found an endpoint yet */ +			continue; +		} + +		/* Retrieve the endpoint address from the endpoint descriptor */ +		USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t); + +		/* If the endpoint is a IN type endpoint */ +		if ((EndpointData->EndpointAddress & ENDPOINT_DIR_MASK) == ENDPOINT_DIR_IN) +		  DataINEndpoint = EndpointData; +	} + +	/* Configure the HID data IN pipe */ +	Pipe_ConfigurePipe(KEYBOARD_DATA_IN_PIPE, EP_TYPE_INTERRUPT, DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize, 1); +	Pipe_SetInterruptPeriod(DataINEndpoint->PollingIntervalMS); + +	/* Valid data found, return success */ +	return SuccessfulConfigRead; +} + +/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's + *  configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration + *  descriptor processing if an incompatible descriptor configuration is found. + * + *  This comparator searches for the next Interface descriptor of the correct Keyboard HID Class and Protocol values. + * + *  \return A value from the DSEARCH_Return_ErrorCodes_t enum + */ +uint8_t DComp_NextKeyboardInterface(void* CurrentDescriptor) +{ +	USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t); + +	if (Header->Type == DTYPE_Interface) +	{ +		USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t); + +		/* Check the HID descriptor class and protocol, break out if correct class/protocol interface found */ +		if ((Interface->Class    == HID_CSCP_HIDClass) && +		    (Interface->Protocol == HID_CSCP_KeyboardBootProtocol)) +		{ +			return DESCRIPTOR_SEARCH_Found; +		} +	} + +	return DESCRIPTOR_SEARCH_NotFound; +} + +/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's + *  configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration + *  descriptor processing if an incompatible descriptor configuration is found. + * + *  This comparator searches for the next Endpoint descriptor inside the current interface descriptor, aborting the + *  search if another interface descriptor is found before the required endpoint. + * + *  \return A value from the DSEARCH_Return_ErrorCodes_t enum + */ +uint8_t DComp_NextKeyboardInterfaceDataEndpoint(void* CurrentDescriptor) +{ +	USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t); + +	if (Header->Type == DTYPE_Endpoint) +	  return DESCRIPTOR_SEARCH_Found; +	else if (Header->Type == DTYPE_Interface) +	  return DESCRIPTOR_SEARCH_Fail; +	else +	  return DESCRIPTOR_SEARCH_NotFound; +} + | 
