--- /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 CDC interface descriptor containing bulk data IN and OUT endpoints, and an interrupt event endpoint.\r
+ *\r
+ * \return An error code from the CDCHost_GetConfigDescriptorDataCodes_t enum.\r
+ */\r
+uint8_t ProcessConfigurationDescriptor(void)\r
+{\r
+ uint8_t* ConfigDescriptorData;\r
+ uint16_t ConfigDescriptorSize;\r
+ uint8_t FoundEndpoints = 0;\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 CDC control interface from the configuration descriptor */\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ DComp_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)\r
+ {\r
+ /* Descriptor not found, error out */\r
+ return NoCDCInterfaceFound;\r
+ }\r
+\r
+ /* Get the IN and OUT data endpoints for the CDC interface */\r
+ while (FoundEndpoints != ((1 << CDC_NOTIFICATIONPIPE) | (1 << CDC_DATAPIPE_IN) | (1 << CDC_DATAPIPE_OUT)))\r
+ {\r
+ /* Fetch the next bulk or interrupt endpoint from the current CDC interface */\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ DComp_NextInterfaceCDCDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)\r
+ {\r
+ /* Check to see if the control interface's notification pipe has been found, if so search for the data interface */\r
+ if (FoundEndpoints & (1 << CDC_NOTIFICATIONPIPE))\r
+ {\r
+ /* Get the next CDC data interface from the configuration descriptor (CDC class has two CDC interfaces) */\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, \r
+ DComp_NextCDCDataInterface) != DESCRIPTOR_SEARCH_COMP_Found)\r
+ {\r
+ /* Descriptor not found, error out */\r
+ return NoCDCInterfaceFound;\r
+ }\r
+ }\r
+ else\r
+ {\r
+ /* Clear the found endpoints mask, since any already processed endpoints aren't in the CDC interface we need */\r
+ FoundEndpoints = 0;\r
+\r
+ /* Disable any already configured pipes from the invalid CDC interfaces */\r
+ Pipe_SelectPipe(CDC_NOTIFICATIONPIPE);\r
+ Pipe_DisablePipe();\r
+ Pipe_SelectPipe(CDC_DATAPIPE_IN);\r
+ Pipe_DisablePipe();\r
+ Pipe_SelectPipe(CDC_DATAPIPE_OUT);\r
+ Pipe_DisablePipe();\r
+ \r
+ /* Get the next CDC control interface from the configuration descriptor (CDC class has two CDC interfaces) */\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ DComp_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found)\r
+ {\r
+ /* Descriptor not found, error out */\r
+ return NoCDCInterfaceFound;\r
+ }\r
+ }\r
+\r
+ /* Fetch the next bulk or interrupt endpoint from the current CDC interface */\r
+ if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
+ DComp_NextInterfaceCDCDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)\r
+ {\r
+ /* Descriptor not found, error out */\r
+ return NoEndpointFound;\r
+ }\r
+ }\r
+ \r
+ USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);\r
+\r
+ /* Check if the found endpoint is a interrupt or bulk type descriptor */\r
+ if ((EndpointData->Attributes & EP_TYPE_MASK) == EP_TYPE_INTERRUPT)\r
+ {\r
+ /* If the endpoint is a IN type interrupt endpoint */\r
+ if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
+ { \r
+ /* Configure the notification pipe */\r
+ Pipe_ConfigurePipe(CDC_NOTIFICATIONPIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,\r
+ EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);\r
+\r
+ Pipe_SetInfiniteINRequests();\r
+ Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS);\r
+ \r
+ /* Set the flag indicating that the notification pipe has been found */\r
+ FoundEndpoints |= (1 << CDC_NOTIFICATIONPIPE);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ /* Check if the endpoint is a bulk IN or bulk OUT endpoint */\r
+ if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
+ {\r
+ /* Configure the data IN pipe */\r
+ Pipe_ConfigurePipe(CDC_DATAPIPE_IN, EP_TYPE_BULK, PIPE_TOKEN_IN,\r
+ EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);\r
+\r
+ Pipe_SetInfiniteINRequests();\r
+ Pipe_Unfreeze();\r
+ \r
+ /* Set the flag indicating that the data IN pipe has been found */\r
+ FoundEndpoints |= (1 << CDC_DATAPIPE_IN);\r
+ }\r
+ else\r
+ {\r
+ /* Configure the data OUT pipe */\r
+ Pipe_ConfigurePipe(CDC_DATAPIPE_OUT, EP_TYPE_BULK, PIPE_TOKEN_OUT,\r
+ EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);\r
+ \r
+ Pipe_Unfreeze();\r
+ \r
+ /* Set the flag indicating that the data OUT pipe has been found */\r
+ FoundEndpoints |= (1 << CDC_DATAPIPE_OUT);\r
+ }\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 CDC control Class, Subclass and Protocol values.\r
+ *\r
+ * \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
+ */\r
+uint8_t DComp_NextCDCControlInterface(void* CurrentDescriptor)\r
+{\r
+ if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
+ {\r
+ /* Check the CDC descriptor class, subclass and protocol, break out if correct control interface found */\r
+ if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class == CDC_CONTROL_CLASS) &&\r
+ (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == CDC_CONTROL_SUBCLASS) &&\r
+ (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == CDC_CONTROL_PROTOCOL))\r
+ {\r
+ return DESCRIPTOR_SEARCH_Found;\r
+ }\r
+ }\r
+ \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 Interface descriptor of the correct CDC data Class, Subclass and Protocol values.\r
+ *\r
+ * \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
+ */\r
+uint8_t DComp_NextCDCDataInterface(void* CurrentDescriptor)\r
+{\r
+ if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
+ {\r
+ /* Check the CDC descriptor class, subclass and protocol, break out if correct data interface found */\r
+ if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class == CDC_DATA_CLASS) &&\r
+ (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == CDC_DATA_SUBCLASS) &&\r
+ (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == CDC_DATA_PROTOCOL))\r
+ {\r
+ return DESCRIPTOR_SEARCH_Found;\r
+ }\r
+ }\r
+ \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 bulk IN or OUT endpoint, or interrupt IN endpoint within the current interface,\r
+ * aborting the search if another interface descriptor is found before the required endpoint (so that it may be compared\r
+ * using a different comparator to determine if it is another CDC class interface).\r
+ *\r
+ * \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
+ */\r
+uint8_t DComp_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor)\r
+{\r
+ if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
+ {\r
+ uint8_t EndpointType = (DESCRIPTOR_CAST(CurrentDescriptor,\r
+ USB_Descriptor_Endpoint_t).Attributes & EP_TYPE_MASK);\r
+ \r
+ if ((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT))\r
+ return DESCRIPTOR_SEARCH_Found;\r
+ }\r
+ else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
+ {\r
+ return DESCRIPTOR_SEARCH_Fail;\r
+ }\r
+\r
+ return DESCRIPTOR_SEARCH_NotFound;\r
+}\r
projects / pub / lufa.git / blobdiff