+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * USB Device Configuration Descriptor processing routines, to determine the correct pipe configurations\r
- * needed to communication with an attached USB device. Descriptors are special computer-readable structures\r
- * which the host requests upon device enumeration, to determine the device's capabilities and functions.\r
- */\r
-\r
-#include "ConfigDescriptor.h"\r
-\r
-/** Reads and processes an attached device's descriptors, to determine compatibility and pipe configurations. This\r
- * routine will read in the entire configuration descriptor, and configure the hosts pipes to correctly communicate\r
- * with compatible devices.\r
- *\r
- * This routine searches for a HID interface descriptor containing at least one Interrupt type IN endpoint.\r
- *\r
- * \return An error code from the MouseHost_GetConfigDescriptorDataCodes_t enum.\r
- */\r
-uint8_t ProcessConfigurationDescriptor(void)\r
-{\r
- uint8_t* ConfigDescriptorData;\r
- uint16_t ConfigDescriptorSize;\r
- \r
- /* Get Configuration Descriptor size from the device */\r
- if (USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, NULL) != HOST_SENDCONTROL_Successful)\r
- return ControlError;\r
- \r
- /* Ensure that the Configuration Descriptor isn't too large */\r
- if (ConfigDescriptorSize > MAX_CONFIG_DESCRIPTOR_SIZE)\r
- return DescriptorTooLarge;\r
- \r
- /* Allocate enough memory for the entire config descriptor */\r
- ConfigDescriptorData = alloca(ConfigDescriptorSize);\r
-\r
- /* Retrieve the entire configuration descriptor into the allocated buffer */\r
- USB_GetDeviceConfigDescriptor(&ConfigDescriptorSize, ConfigDescriptorData);\r
- \r
- /* Validate returned data - ensure first entry is a configuration header descriptor */\r
- if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
- return InvalidConfigDataReturned;\r
- \r
- /* Get the mouse interface from the configuration descriptor */\r
- if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
- DComp_NextMouseInterface) != DESCRIPTOR_SEARCH_COMP_Found)\r
- {\r
- /* Descriptor not found, error out */\r
- return NoHIDInterfaceFound;\r
- }\r
-\r
- /* Get the mouse interface's data endpoint descriptor */\r
- if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
- DComp_NextInterfaceMouseDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)\r
- {\r
- /* Descriptor not found, error out */\r
- return NoEndpointFound;\r
- }\r
- \r
- /* Retrieve the endpoint address from the endpoint descriptor */\r
- USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);\r
-\r
- /* Configure the mouse data pipe */\r
- Pipe_ConfigurePipe(MOUSE_DATAPIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,\r
- EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);\r
-\r
- Pipe_SetInfiniteINRequests();\r
- \r
- /* Valid data found, return success */\r
- return SuccessfulConfigRead;\r
-}\r
-\r
-/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's\r
- * configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration\r
- * descriptor processing if an incompatible descriptor configuration is found.\r
- *\r
- * This comparator searches for the next Interface descriptor of the correct Mouse HID Class and Protocol values.\r
- *\r
- * \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
- */\r
-uint8_t DComp_NextMouseInterface(void* CurrentDescriptor)\r
-{\r
- /* Determine if the current descriptor is an interface descriptor */\r
- if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
- {\r
- /* Check the HID descriptor class and protocol, break out if correct class/protocol interface found */\r
- if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class == MOUSE_CLASS) &&\r
- (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == MOUSE_PROTOCOL))\r
- {\r
- /* Indicate that the descriptor being searched for has been found */\r
- return DESCRIPTOR_SEARCH_Found;\r
- }\r
- }\r
- \r
- /* Current descriptor does not match what this comparator is looking for */\r
- return DESCRIPTOR_SEARCH_NotFound;\r
-}\r
-\r
-/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's\r
- * configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration\r
- * descriptor processing if an incompatible descriptor configuration is found.\r
- *\r
- * This comparator searches for the next IN Endpoint descriptor inside the current interface descriptor,\r
- * aborting the search if another interface descriptor is found before the required endpoint.\r
- *\r
- * \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
- */\r
-uint8_t DComp_NextInterfaceMouseDataEndpoint(void* CurrentDescriptor)\r
-{\r
- /* Determine the type of the current descriptor */\r
- if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
- {\r
- /* Check if the current Endpoint descriptor is of type IN */\r
- if (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Endpoint_t).EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
- {\r
- /* Indicate that the descriptor being searched for has been found */\r
- return DESCRIPTOR_SEARCH_Found;\r
- }\r
- }\r
- else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
- {\r
- /* Indicate that the search has failed prematurely and should be aborted */\r
- return DESCRIPTOR_SEARCH_Fail;\r
- }\r
-\r
- /* Current descriptor does not match what this comparator is looking for */\r
- return DESCRIPTOR_SEARCH_NotFound;\r
-}\r
projects / pub / lufa.git / blobdiff