--- /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 GenericHIDHost_GetConfigDescriptorDataCodes_t enum.\r
+ */\r
+uint8_t ProcessConfigurationDescriptor(void)\r
+{\r
+ uint8_t* ConfigDescriptorData;\r
+ uint16_t ConfigDescriptorSize;\r
+ \r
+ uint8_t FoundEndpoints = 0;\r
+ \r
+ /* Get Configuration Descriptor size from the device */\r
+ if (USB_Host_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_Host_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 HID interface from the configuration descriptor */\r
+ if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, NextHIDInterface))\r
+ {\r
+ /* Descriptor not found, error out */\r
+ return NoHIDInterfaceFound;\r
+ }\r
+\r
+ while (FoundEndpoints != ((1 << HID_DATA_IN_PIPE) | (1 << HID_DATA_OUT_PIPE)))\r
+ {\r
+ /* Get the next HID interface's data endpoint descriptor */\r
+ if (USB_Host_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ NextInterfaceHIDDataEndpoint))\r
+ {\r
+ /* Not all HID devices have an OUT endpoint - if we've reached the end of the HID descriptor\r
+ * but only found the mandatory IN endpoint, it's safe to continue with the device enumeration */\r
+ if (FoundEndpoints == (1 << HID_DATA_IN_PIPE))\r
+ break;\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
+ /* If the endpoint is a IN type endpoint */\r
+ if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
+ {\r
+ /* Configure the HID data IN pipe */\r
+ Pipe_ConfigurePipe(HID_DATA_IN_PIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,\r
+ EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);\r
+\r
+ Pipe_SetInfiniteINRequests();\r
+\r
+ #if defined(INTERRUPT_DATA_PIPE)\r
+ Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS);\r
+\r
+ /* Enable the pipe IN interrupt for the data pipe */\r
+ USB_INT_Enable(PIPE_INT_IN); \r
+ #endif\r
+ \r
+ FoundEndpoints |= (1 << HID_DATA_IN_PIPE);\r
+ }\r
+ else\r
+ {\r
+ /* Configure the HID data OUT pipe */\r
+ Pipe_ConfigurePipe(HID_DATA_OUT_PIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_OUT,\r
+ EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);\r
+ \r
+ FoundEndpoints |= (1 << HID_DATA_OUT_PIPE); \r
+ }\r
+ }\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 HID Class value.\r
+ *\r
+ * \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
+ */\r
+DESCRIPTOR_COMPARATOR(NextHIDInterface)\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 == HID_CLASS)\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 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
+DESCRIPTOR_COMPARATOR(NextInterfaceHIDDataEndpoint)\r
+{\r
+ /* Determine the type of the current descriptor */\r
+ if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
+ {\r
+ /* Indicate that the descriptor being searched for has been found */\r
+ return Descriptor_Search_Found;\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