ConfigDescriptor.c 10.4 KB
 Dean Camera committed Jun 05, 2009 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 /* 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 CDC interface descriptor containing bulk data IN and OUT endpoints, and an interrupt event endpoint. *  Dean Camera committed Nov 04, 2009 46  * \return An error code from the \ref CDCHost_GetConfigDescriptorDataCodes_t enum.  Dean Camera committed Jun 05, 2009 47 48 49  */ uint8_t ProcessConfigurationDescriptor(void) {  Dean Camera committed Aug 31, 2009 50  uint8_t ConfigDescriptorData[512];  Dean Camera committed Nov 07, 2009 51  void* CurrConfigLocation = ConfigDescriptorData;  Dean Camera committed Aug 31, 2009 52  uint16_t CurrConfigBytesRem;  Dean Camera committed Jun 05, 2009 53 54 55  uint8_t FoundEndpoints = 0; /* Retrieve the entire configuration descriptor into the allocated buffer */  Dean Camera committed Aug 31, 2009 56 57 58 59 60 61 62 63 64 65 66  switch (USB_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; }  Dean Camera committed Jun 05, 2009 67 68  /* Get the CDC control interface from the configuration descriptor */  Dean Camera committed Aug 31, 2009 69  if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,  Dean Camera committed Jun 05, 2009 70 71 72 73 74 75  DComp_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found) { /* Descriptor not found, error out */ return NoCDCInterfaceFound; }  Dean Camera committed Oct 08, 2009 76  /* Get the IN and OUT data and IN notification endpoints for the CDC interface */  Dean Camera committed Jun 05, 2009 77 78 79  while (FoundEndpoints != ((1 << CDC_NOTIFICATIONPIPE) | (1 << CDC_DATAPIPE_IN) | (1 << CDC_DATAPIPE_OUT))) { /* Fetch the next bulk or interrupt endpoint from the current CDC interface */  Dean Camera committed Aug 31, 2009 80  if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,  Dean Camera committed Oct 08, 2009 81  DComp_NextCDCDataInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)  Dean Camera committed Jun 05, 2009 82 83 84 85 86  { /* Check to see if the control interface's notification pipe has been found, if so search for the data interface */ if (FoundEndpoints & (1 << CDC_NOTIFICATIONPIPE)) { /* Get the next CDC data interface from the configuration descriptor (CDC class has two CDC interfaces) */  Dean Camera committed Aug 31, 2009 87  if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,  Dean Camera committed Jun 05, 2009 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107  DComp_NextCDCDataInterface) != DESCRIPTOR_SEARCH_COMP_Found) { /* Descriptor not found, error out */ return NoCDCInterfaceFound; } } else { /* Clear the found endpoints mask, since any already processed endpoints aren't in the CDC interface we need */ FoundEndpoints = 0; /* Disable any already configured pipes from the invalid CDC interfaces */ Pipe_SelectPipe(CDC_NOTIFICATIONPIPE); Pipe_DisablePipe(); Pipe_SelectPipe(CDC_DATAPIPE_IN); Pipe_DisablePipe(); Pipe_SelectPipe(CDC_DATAPIPE_OUT); Pipe_DisablePipe(); /* Get the next CDC control interface from the configuration descriptor (CDC class has two CDC interfaces) */  Dean Camera committed Aug 31, 2009 108  if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,  Dean Camera committed Jun 05, 2009 109 110 111 112 113 114 115 116  DComp_NextCDCControlInterface) != DESCRIPTOR_SEARCH_COMP_Found) { /* Descriptor not found, error out */ return NoCDCInterfaceFound; } } /* Fetch the next bulk or interrupt endpoint from the current CDC interface */  Dean Camera committed Aug 31, 2009 117  if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,  Dean Camera committed Oct 08, 2009 118  DComp_NextCDCDataInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)  Dean Camera committed Jun 05, 2009 119 120 121 122 123 124  { /* Descriptor not found, error out */ return NoEndpointFound; } }  Dean Camera committed Aug 31, 2009 125  USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);  Dean Camera committed Jun 05, 2009 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176  /* Check if the found endpoint is a interrupt or bulk type descriptor */ if ((EndpointData->Attributes & EP_TYPE_MASK) == EP_TYPE_INTERRUPT) { /* If the endpoint is a IN type interrupt endpoint */ if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN) { /* Configure the notification pipe */ Pipe_ConfigurePipe(CDC_NOTIFICATIONPIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN, EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE); Pipe_SetInterruptPeriod(EndpointData->PollingIntervalMS); /* Set the flag indicating that the notification pipe has been found */ FoundEndpoints |= (1 << CDC_NOTIFICATIONPIPE); } } else { /* Check if the endpoint is a bulk IN or bulk OUT endpoint */ if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN) { /* Configure the data IN pipe */ Pipe_ConfigurePipe(CDC_DATAPIPE_IN, EP_TYPE_BULK, PIPE_TOKEN_IN, EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE); /* Set the flag indicating that the data IN pipe has been found */ FoundEndpoints |= (1 << CDC_DATAPIPE_IN); } else { /* Configure the data OUT pipe */ Pipe_ConfigurePipe(CDC_DATAPIPE_OUT, EP_TYPE_BULK, PIPE_TOKEN_OUT, EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE); /* Set the flag indicating that the data OUT pipe has been found */ FoundEndpoints |= (1 << CDC_DATAPIPE_OUT); } } } /* 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 CDC control Class, Subclass and Protocol values. *  Dean Camera committed Nov 04, 2009 177  * \return A value from the DSEARCH_Return_ErrorCodes_t enum  Dean Camera committed Jun 05, 2009 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200  */ uint8_t DComp_NextCDCControlInterface(void* CurrentDescriptor) { if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface) { /* Check the CDC descriptor class, subclass and protocol, break out if correct control interface found */ if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class == CDC_CONTROL_CLASS) && (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == CDC_CONTROL_SUBCLASS) && (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == CDC_CONTROL_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 Interface descriptor of the correct CDC data Class, Subclass and Protocol values. *  Dean Camera committed Nov 04, 2009 201  * \return A value from the DSEARCH_Return_ErrorCodes_t enum  Dean Camera committed Jun 05, 2009 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226  */ uint8_t DComp_NextCDCDataInterface(void* CurrentDescriptor) { if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface) { /* Check the CDC descriptor class, subclass and protocol, break out if correct data interface found */ if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class == CDC_DATA_CLASS) && (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == CDC_DATA_SUBCLASS) && (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == CDC_DATA_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 bulk IN or OUT endpoint, or interrupt IN endpoint within the current interface, * aborting the search if another interface descriptor is found before the required endpoint (so that it may be compared * using a different comparator to determine if it is another CDC class interface). *  Dean Camera committed Nov 04, 2009 227  * \return A value from the DSEARCH_Return_ErrorCodes_t enum  Dean Camera committed Jun 05, 2009 228  */  Dean Camera committed Oct 08, 2009 229 uint8_t DComp_NextCDCDataInterfaceEndpoint(void* CurrentDescriptor)  Dean Camera committed Jun 05, 2009 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 { if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint) { uint8_t EndpointType = (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Endpoint_t).Attributes & EP_TYPE_MASK); if ((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT)) return DESCRIPTOR_SEARCH_Found; } else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface) { return DESCRIPTOR_SEARCH_Fail; } return DESCRIPTOR_SEARCH_NotFound; }