From 74298f8ca11dc8d3b0359d1d4e124d6494c3eeac Mon Sep 17 00:00:00 2001 From: Nicolas Schodet Date: Fri, 10 Apr 2009 01:15:42 +0200 Subject: * digital/avr/modules/usb: - imported LUFA. --- .../usb/lufa/Demos/KeyboardHost/ConfigDescriptor.c | 144 +++++++++++++++++++++ 1 file changed, 144 insertions(+) create mode 100644 digital/avr/modules/usb/lufa/Demos/KeyboardHost/ConfigDescriptor.c (limited to 'digital/avr/modules/usb/lufa/Demos/KeyboardHost/ConfigDescriptor.c') diff --git a/digital/avr/modules/usb/lufa/Demos/KeyboardHost/ConfigDescriptor.c b/digital/avr/modules/usb/lufa/Demos/KeyboardHost/ConfigDescriptor.c new file mode 100644 index 00000000..7a704cfc --- /dev/null +++ b/digital/avr/modules/usb/lufa/Demos/KeyboardHost/ConfigDescriptor.c @@ -0,0 +1,144 @@ +/* + 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 + * + * 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 KeyboardHost_GetConfigDescriptorDataCodes_t enum. + */ +uint8_t ProcessConfigurationDescriptor(void) +{ + uint8_t* ConfigDescriptorData; + uint16_t ConfigDescriptorSize; + + /* Get Configuration Descriptor size from the device */ + if (USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful) + return ControlError; + + /* Ensure that the Configuration Descriptor isn't too large */ + if (ConfigDescriptorSize > MAX_CONFIG_DESCRIPTOR_SIZE) + return DescriptorTooLarge; + + /* Allocate enough memory for the entire config descriptor */ + ConfigDescriptorData = alloca(ConfigDescriptorSize); + + /* Retrieve the entire configuration descriptor into the allocated buffer */ + USB_Host_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData); + + /* Validate returned data - ensure first entry is a configuration header descriptor */ + if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration) + return InvalidConfigDataReturned; + + /* Get the keyboard interface from the configuration descriptor */ + if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextKeyboardInterface)) + { + /* Descriptor not found, error out */ + return NoHIDInterfaceFound; + } + + /* Get the keyboard interface's data endpoint descriptor */ + if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, + NextInterfaceKeyboardDataEndpoint)) + { + /* Descriptor not found, error out */ + return NoEndpointFound; + } + + /* Retrieve the endpoint address from the endpoint descriptor */ + USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t); + + /* Configure the keyboard data pipe */ + Pipe_ConfigurePipe(KEYBOARD_DATAPIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN, + EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE); + + Pipe_SetInfiniteINRequests(); + + /* 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 + */ +DESCRIPTOR_COMPARATOR(NextKeyboardInterface) +{ + if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface) + { + /* Check the HID descriptor class and protocol, break out if correct class/protocol interface found */ + if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class == KEYBOARD_CLASS) && + (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == KEYBOARD_PROTOCOL)) + { + 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 IN 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 + */ +DESCRIPTOR_COMPARATOR(NextInterfaceKeyboardDataEndpoint) +{ + if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint) + { + if (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Endpoint_t).EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN) + return Descriptor_Search_Found; + } + else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface) + { + return Descriptor_Search_Fail; + } + + return Descriptor_Search_NotFound; +} -- cgit v1.2.3