tmk_core/protocol/lufa/LUFA-git/Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  USB Device Configuration Descriptor processing routines, to determine the correct pipe configurations
  34  *  needed to communication with an attached USB device. Descriptors are special  computer-readable structures
  35  *  which the host requests upon device enumeration, to determine the device's capabilities and functions.
  36  */
  37
  38 #include "ConfigDescriptor.h"
  39
  40 /** Reads and processes an attached device's descriptors, to determine compatibility and pipe configurations. This
  41  *  routine will read in the entire configuration descriptor, and configure the hosts pipes to correctly communicate
  42  *  with compatible devices.
  43  *
  44  *  This routine searches for a HID interface descriptor containing at least one Interrupt type IN endpoint.
  45  *
  46  *  \return An error code from the \ref KeyboardHost_GetConfigDescriptorDataCodes_t enum.
  47  */
  48 uint8_t ProcessConfigurationDescriptor(void)
  49 {
  50         uint8_t  ConfigDescriptorData[512];
  51         void*    CurrConfigLocation = ConfigDescriptorData;
  52         uint16_t CurrConfigBytesRem;
  53
  54         USB_Descriptor_Interface_t* HIDInterface   = NULL;
  55         USB_Descriptor_Endpoint_t*  DataINEndpoint = NULL;
  56
  57         /* Retrieve the entire configuration descriptor into the allocated buffer */
  58         switch (USB_Host_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData)))
  59         {
  60                 case HOST_GETCONFIG_Successful:
  61                         break;
  62                 case HOST_GETCONFIG_InvalidData:
  63                         return InvalidConfigDataReturned;
  64                 case HOST_GETCONFIG_BuffOverflow:
  65                         return DescriptorTooLarge;
  66                 default:
  67                         return ControlError;
  68         }
  69
  70         while (!(DataINEndpoint))
  71         {
  72                 /* See if we've found a likely compatible interface, and if there is an endpoint within that interface */
  73                 if (!(HIDInterface) ||
  74                     USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
  75                                               DComp_NextKeyboardInterfaceDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  76                 {
  77                         /* Get the next HID interface from the configuration descriptor */
  78                         if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
  79                                                                                   DComp_NextKeyboardInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  80                         {
  81                                 /* Descriptor not found, error out */
  82                                 return NoCompatibleInterfaceFound;
  83                         }
  84
  85                         /* Save the interface in case we need to refer back to it later */
  86                         HIDInterface = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Interface_t);
  87
  88                         /* Skip the remainder of the loop as we have not found an endpoint yet */
  89                         continue;
  90                 }
  91
  92                 /* Retrieve the endpoint address from the endpoint descriptor */
  93                 USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);
  94
  95                 /* If the endpoint is a IN type endpoint */
  96                 if ((EndpointData->EndpointAddress & ENDPOINT_DIR_MASK) == ENDPOINT_DIR_IN)
  97                   DataINEndpoint = EndpointData;
  98         }
  99
 100         /* Configure the HID data IN pipe */
 101         Pipe_ConfigurePipe(KEYBOARD_DATA_IN_PIPE, EP_TYPE_INTERRUPT, DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize, 1);
 102         Pipe_SetInterruptPeriod(DataINEndpoint->PollingIntervalMS);
 103
 104         /* Valid data found, return success */
 105         return SuccessfulConfigRead;
 106 }
 107
 108 /** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's
 109  *  configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration
 110  *  descriptor processing if an incompatible descriptor configuration is found.
 111  *
 112  *  This comparator searches for the next Interface descriptor of the correct Keyboard HID Class and Protocol values.
 113  *
 114  *  \return A value from the DSEARCH_Return_ErrorCodes_t enum
 115  */
 116 uint8_t DComp_NextKeyboardInterface(void* CurrentDescriptor)
 117 {
 118         USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
 119
 120         if (Header->Type == DTYPE_Interface)
 121         {
 122                 USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);
 123
 124                 /* Check the HID descriptor class and protocol, break out if correct class/protocol interface found */
 125                 if ((Interface->Class    == HID_CSCP_HIDClass) &&
 126                     (Interface->Protocol == HID_CSCP_KeyboardBootProtocol))
 127                 {
 128                         return DESCRIPTOR_SEARCH_Found;
 129                 }
 130         }
 131
 132         return DESCRIPTOR_SEARCH_NotFound;
 133 }
 134
 135 /** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's
 136  *  configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration
 137  *  descriptor processing if an incompatible descriptor configuration is found.
 138  *
 139  *  This comparator searches for the next Endpoint descriptor inside the current interface descriptor, aborting the
 140  *  search if another interface descriptor is found before the required endpoint.
 141  *
 142  *  \return A value from the DSEARCH_Return_ErrorCodes_t enum
 143  */
 144 uint8_t DComp_NextKeyboardInterfaceDataEndpoint(void* CurrentDescriptor)
 145 {
 146         USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
 147
 148         if (Header->Type == DTYPE_Endpoint)
 149           return DESCRIPTOR_SEARCH_Found;
 150         else if (Header->Type == DTYPE_Interface)
 151           return DESCRIPTOR_SEARCH_Fail;
 152         else
 153           return DESCRIPTOR_SEARCH_NotFound;
 154 }
 155