ConfigDescriptor.c 6.85 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 HID interface descriptor containing at least one Interrupt type IN endpoint and HID descriptor. *  Dean Camera committed Nov 04, 2009 46  * \return An error code from the \ref MouseHostWithParser_GetConfigDescriptorDataCodes_t enum.  Dean Camera committed Jun 05, 2009 47 48 49  */ uint8_t ProcessConfigurationDescriptor(void) {  Dean Camera committed Aug 31, 2009 50 51 52  uint8_t ConfigDescriptorData[512]; uint8_t* CurrConfigLocation = ConfigDescriptorData; uint16_t CurrConfigBytesRem;  Dean Camera committed Jun 05, 2009 53 54  /* 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 Aug 31, 2009 66   Dean Camera committed Jun 05, 2009 67  /* Get the mouse interface from the configuration descriptor */  Dean Camera committed Aug 31, 2009 68  if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,  Dean Camera committed Jun 05, 2009 69 70 71 72 73 74 75  DComp_NextMouseInterface) != DESCRIPTOR_SEARCH_COMP_Found) { /* Descriptor not found, error out */ return NoHIDInterfaceFound; } /* Get the mouse interface's HID descriptor */  Dean Camera committed Aug 31, 2009 76  if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,  Dean Camera committed Jun 05, 2009 77 78 79 80 81 82 83  DComp_NextHID) != DESCRIPTOR_SEARCH_COMP_Found) { /* Descriptor not found, error out */ return NoHIDDescriptorFound; } /* Save the HID report size for later use */  Dean Camera committed Aug 31, 2009 84 85  HIDReportSize = DESCRIPTOR_CAST(CurrConfigLocation, USB_Descriptor_HID_t).HIDReportLength;  Dean Camera committed Jun 05, 2009 86  /* Get the mouse interface's data endpoint descriptor */  Dean Camera committed Aug 31, 2009 87  if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,  Dean Camera committed Oct 08, 2009 88  DComp_NextMouseInterfaceDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)  Dean Camera committed Jun 05, 2009 89 90 91 92 93 94  { /* Descriptor not found, error out */ return NoEndpointFound; } /* Retrieve the endpoint address from the endpoint descriptor */  Dean Camera committed Aug 31, 2009 95  USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);  Dean Camera committed Jun 05, 2009 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110  /* Configure the mouse data pipe */ Pipe_ConfigurePipe(MOUSE_DATAPIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN, EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE); /* 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 Mouse HID Class and Protocol values. *  Dean Camera committed Nov 04, 2009 111  * \return A value from the DSEARCH_Return_ErrorCodes_t enum  Dean Camera committed Jun 05, 2009 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134  */ uint8_t DComp_NextMouseInterface(void* CurrentDescriptor) { if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface) { /* Check the HID descriptor class and protocol, break out if correct class/protocol interface found */ if ((DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class == MOUSE_CLASS) && (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Protocol == MOUSE_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 IN Endpoint descriptor inside the current interface descriptor, * aborting the search if another interface descriptor is found before the required endpoint. *  Dean Camera committed Nov 04, 2009 135  * \return A value from the DSEARCH_Return_ErrorCodes_t enum  Dean Camera committed Jun 05, 2009 136  */  Dean Camera committed Oct 08, 2009 137 uint8_t DComp_NextMouseInterfaceDataEndpoint(void* CurrentDescriptor)  Dean Camera committed Jun 05, 2009 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 { if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint) { if (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Endpoint_t).EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN) return DESCRIPTOR_SEARCH_Found; } else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface) { return DESCRIPTOR_SEARCH_Fail; } 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 HID descriptor within the current HID interface descriptor. *  Dean Camera committed Nov 04, 2009 158  * \return A value from the DSEARCH_Return_ErrorCodes_t enum  Dean Camera committed Jun 05, 2009 159 160 161 162 163 164 165 166  */ uint8_t DComp_NextHID(void* CurrentDescriptor) { if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_HID) return DESCRIPTOR_SEARCH_Found; else return DESCRIPTOR_SEARCH_NotFound; }