ConfigDescriptor.c 6.97 KB
 Dean Camera committed Jul 11, 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 /* 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. */ #include "ConfigDescriptor.h"  Dean Camera committed Nov 04, 2009 33 /** Interface number for the bidirectional Printer interface found within the device. */  Dean Camera committed Jul 19, 2009 34 35 uint8_t PrinterInterfaceNumber;  Dean Camera committed Nov 04, 2009 36 37 /** Interface Alternate Setting number for the bidirectional Printer interface found within the device. */ uint8_t PrinterAltSetting;  Dean Camera committed Jul 19, 2009 38   Dean Camera committed Nov 04, 2009 39 40 41 42 43 44 45 46 /** 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 bidirectional Printer interface descriptor containing bulk IN and OUT data endpoints. * * \return An error code from the \ref PrinterHost_GetConfigDescriptorDataCodes_t enum. */  Dean Camera committed Jul 11, 2009 47 48 uint8_t ProcessConfigurationDescriptor(void) {  Dean Camera committed Aug 31, 2009 49  uint8_t ConfigDescriptorData[512];  Dean Camera committed Nov 07, 2009 50  void* CurrConfigLocation = ConfigDescriptorData;  Dean Camera committed Aug 31, 2009 51  uint16_t CurrConfigBytesRem;  Dean Camera committed Jul 11, 2009 52 53 54  uint8_t FoundEndpoints = 0; /* Retrieve the entire configuration descriptor into the allocated buffer */  Dean Camera committed Aug 31, 2009 55 56 57 58 59 60 61 62 63 64 65  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 Jul 11, 2009 66 67  /* Get the printer interface from the configuration descriptor */  Dean Camera committed Aug 31, 2009 68  if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation, DComp_NextBidirectionalPrinterInterface))  Dean Camera committed Jul 11, 2009 69 70 71 72 73  { /* Descriptor not found, error out */ return NoInterfaceFound; }  Dean Camera committed Aug 31, 2009 74 75  PrinterInterfaceNumber = DESCRIPTOR_CAST(CurrConfigLocation, USB_Descriptor_Interface_t).InterfaceNumber; PrinterAltSetting = DESCRIPTOR_CAST(CurrConfigLocation, USB_Descriptor_Interface_t).AlternateSetting;  Dean Camera committed Jul 11, 2009 76   Dean Camera committed Jul 19, 2009 77  /* Get the IN and OUT data endpoints for the printer interface */  Dean Camera committed Jul 19, 2009 78  while (FoundEndpoints != ((1 << PRINTER_DATA_OUT_PIPE) | (1 << PRINTER_DATA_IN_PIPE)))  Dean Camera committed Jul 11, 2009 79 80  { /* Fetch the next bulk endpoint from the current printer interface */  Dean Camera committed Oct 08, 2009 81  if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation, DComp_NextPrinterInterfaceBulkDataEndpoint))  Dean Camera committed Jul 11, 2009 82 83 84 85 86  { /* Descriptor not found, error out */ return NoEndpointFound; }  Dean Camera committed Aug 31, 2009 87  USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);  Dean Camera committed Jul 11, 2009 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117  /* Check if the endpoint is a bulk IN or bulk OUT endpoint, set appropriate globals */ if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN) { /* Configure the data IN pipe */ Pipe_ConfigurePipe(PRINTER_DATA_IN_PIPE, EP_TYPE_BULK, PIPE_TOKEN_IN, EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE); Pipe_SetInfiniteINRequests(); /* Set the flag indicating that the data IN pipe has been found */ FoundEndpoints |= (1 << PRINTER_DATA_IN_PIPE); } else { /* Configure the data OUT pipe */ Pipe_ConfigurePipe(PRINTER_DATA_OUT_PIPE, 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 << PRINTER_DATA_OUT_PIPE); } } /* Valid data found, return success */ return SuccessfulConfigRead; }  Dean Camera committed Nov 04, 2009 118 119 120 121 122 123 124 /** 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 Bidirectional Printer Interface descriptor of the current Printer interface, * aborting the search if the end of the descriptors is found. *  Dean Camera committed Nov 04, 2009 125  * \return A value from the DSEARCH_Return_ErrorCodes_t enum  Dean Camera committed Nov 04, 2009 126  */  Dean Camera committed Jul 19, 2009 127 uint8_t DComp_NextBidirectionalPrinterInterface(void* CurrentDescriptor)  Dean Camera committed Jul 11, 2009 128 129 130 131 132 { if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface) { /* Check the descriptor class and protocol, break out if correct class/protocol interface found */ if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class == PRINTER_CLASS) &&  Dean Camera committed Jul 19, 2009 133  (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).SubClass == PRINTER_SUBCLASS) &&  Dean Camera committed Jul 19, 2009 134  (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == PRINTER_PROTOCOL))  Dean Camera committed Jul 11, 2009 135 136 137 138 139 140 141 142  { return DESCRIPTOR_SEARCH_Found; } } return DESCRIPTOR_SEARCH_NotFound; }  Dean Camera committed Nov 04, 2009 143 144 145 146 147 148 149 /** 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 Endpoint descriptor of the current Printer interface, aborting the * search if another interface descriptor is found before the next endpoint. *  Dean Camera committed Nov 04, 2009 150  * \return A value from the DSEARCH_Return_ErrorCodes_t enum  Dean Camera committed Nov 04, 2009 151  */  Dean Camera committed Oct 08, 2009 152 uint8_t DComp_NextPrinterInterfaceBulkDataEndpoint(void* CurrentDescriptor)  Dean Camera committed Jul 11, 2009 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 { if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint) { uint8_t EndpointType = (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Endpoint_t).Attributes & EP_TYPE_MASK); /* Check the endpoint type, break out if correct BULK type endpoint found */ if (EndpointType == EP_TYPE_BULK) return DESCRIPTOR_SEARCH_Found; } else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface) { return DESCRIPTOR_SEARCH_Fail; } return DESCRIPTOR_SEARCH_NotFound; }