Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / Demos / Host / LowLevel / GenericHIDHost / ConfigDescriptor.c

diff --git a/Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.c b/Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.c
index f5d8e5c..7361d73 100644 (file)
--- a/Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.c
+++ b/Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.c
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   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 
+  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 without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -50,7 +50,10 @@ uint8_t ProcessConfigurationDescriptor(void)
        uint8_t  ConfigDescriptorData[512];
        void*    CurrConfigLocation = ConfigDescriptorData;
        uint16_t CurrConfigBytesRem;
        uint8_t  ConfigDescriptorData[512];
        void*    CurrConfigLocation = ConfigDescriptorData;
        uint16_t CurrConfigBytesRem;

-       uint8_t  FoundEndpoints = 0;
+
+       USB_Descriptor_Interface_t* HIDInterface    = NULL;
+       USB_Descriptor_Endpoint_t*  DataINEndpoint  = NULL;
+       USB_Descriptor_Endpoint_t*  DataOUTEndpoint = NULL;

 
        /* Retrieve the entire configuration descriptor into the allocated buffer */
        switch (USB_Host_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData)))
 
        /* Retrieve the entire configuration descriptor into the allocated buffer */
        switch (USB_Host_GetDeviceConfigDescriptor(1, &CurrConfigBytesRem, ConfigDescriptorData, sizeof(ConfigDescriptorData)))


@@ -64,52 +67,60 @@ uint8_t ProcessConfigurationDescriptor(void)
                default:
                        return ControlError;
        }
                default:
                        return ControlError;
        }

-       
-       /* Get the HID interface from the configuration descriptor */
-       if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
-                                     DComp_NextHIDInterface) != DESCRIPTOR_SEARCH_COMP_Found)
-       {
-               /* Descriptor not found, error out */
-               return NoHIDInterfaceFound;
-       }

 
 

-       while (FoundEndpoints != ((1 << HID_DATA_IN_PIPE) | (1 << HID_DATA_OUT_PIPE)))
+       while (!(DataINEndpoint) || !(DataOUTEndpoint))

        {
        {

-               /* Get the next HID interface's data endpoint descriptor */
-               if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
+               /* See if we've found a likely compatible interface, and if there is an endpoint within that interface */
+               if (!(HIDInterface) ||
+                   USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,

                                              DComp_NextHIDInterfaceDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
                {
                        /* Not all HID devices have an OUT endpoint - if we've reached the end of the HID descriptor
                         * but only found the mandatory IN endpoint, it's safe to continue with the device enumeration */
                                              DComp_NextHIDInterfaceDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
                {
                        /* Not all HID devices have an OUT endpoint - if we've reached the end of the HID descriptor
                         * but only found the mandatory IN endpoint, it's safe to continue with the device enumeration */

-                       if (FoundEndpoints == (1 << HID_DATA_IN_PIPE))
+                       if (DataINEndpoint)

                          break;
                          break;

-                               
-                       /* Descriptor not found, error out */
-                       return NoEndpointFound;
+
+                       /* Get the next HID interface from the configuration descriptor */
+                       if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,
+                                                                                 DComp_NextHIDInterface) != DESCRIPTOR_SEARCH_COMP_Found)
+                       {
+                               /* Descriptor not found, error out */
+                               return NoCompatibleInterfaceFound;
+                       }
+
+                       /* Save the interface in case we need to refer back to it later */
+                       HIDInterface = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Interface_t);
+
+                       /* Clear any found endpoints */
+                       DataOUTEndpoint = NULL;
+
+                       /* Skip the remainder of the loop as we have not found an endpoint yet */
+                       continue;

                }
                }

-               
+

                /* Retrieve the endpoint address from the endpoint descriptor */
                USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);
 
                /* If the endpoint is a IN type endpoint */
                if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
                /* Retrieve the endpoint address from the endpoint descriptor */
                USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(CurrConfigLocation, USB_Descriptor_Endpoint_t);
 
                /* If the endpoint is a IN type endpoint */
                if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)

-               {
-                       /* Configure the HID data IN pipe */
-                       Pipe_ConfigurePipe(HID_DATA_IN_PIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
-                                                          EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
-                       
-                       FoundEndpoints |= (1 << HID_DATA_IN_PIPE);
-               }
+                 DataINEndpoint = EndpointData;

                else
                else

-               {
-                       /* Configure the HID data OUT pipe */
-                       Pipe_ConfigurePipe(HID_DATA_OUT_PIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_OUT,
-                                                          EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
-                       
-                       FoundEndpoints |= (1 << HID_DATA_OUT_PIPE);             
-               }
+                 DataOUTEndpoint = EndpointData;
+       }
+
+       /* Configure the HID data IN pipe */
+       Pipe_ConfigurePipe(HID_DATA_IN_PIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
+                          DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize, PIPE_BANK_SINGLE);
+       Pipe_SetInterruptPeriod(DataINEndpoint->PollingIntervalMS);
+
+       /* Check if the HID interface contained an optional OUT data endpoint */
+       if (DataOUTEndpoint)
+       {
+               /* Configure the HID data OUT pipe */
+               Pipe_ConfigurePipe(HID_DATA_OUT_PIPE, EP_TYPE_INTERRUPT, PIPE_TOKEN_OUT,
+                                                  DataOUTEndpoint->EndpointAddress, DataOUTEndpoint->EndpointSize, PIPE_BANK_SINGLE);

        }
        }

-                       
+

        /* Valid data found, return success */
        return SuccessfulConfigRead;
 }
        /* Valid data found, return success */
        return SuccessfulConfigRead;
 }


@@ -124,17 +135,21 @@ uint8_t ProcessConfigurationDescriptor(void)
  */
 uint8_t DComp_NextHIDInterface(void* CurrentDescriptor)
 {
  */
 uint8_t DComp_NextHIDInterface(void* CurrentDescriptor)
 {

+       USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+

        /* Determine if the current descriptor is an interface descriptor */
        /* Determine if the current descriptor is an interface descriptor */

-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
+       if (Header->Type == DTYPE_Interface)

        {
        {

+               USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);
+

                /* Check the HID descriptor class, break out if correct class/protocol interface found */
                /* Check the HID descriptor class, break out if correct class/protocol interface found */

-               if (DESCRIPTOR_CAST(CurrentDescriptor, USB_Descriptor_Interface_t).Class == HID_CLASS)
+               if (Interface->Class == HID_CSCP_HIDClass)

                {
                        /* Indicate that the descriptor being searched for has been found */
                        return DESCRIPTOR_SEARCH_Found;
                }
        }
                {
                        /* Indicate that the descriptor being searched for has been found */
                        return DESCRIPTOR_SEARCH_Found;
                }
        }

-       
+

        /* Current descriptor does not match what this comparator is looking for */
        return DESCRIPTOR_SEARCH_NotFound;
 }
        /* Current descriptor does not match what this comparator is looking for */
        return DESCRIPTOR_SEARCH_NotFound;
 }


@@ -150,13 +165,15 @@ uint8_t DComp_NextHIDInterface(void* CurrentDescriptor)
  */
 uint8_t DComp_NextHIDInterfaceDataEndpoint(void* CurrentDescriptor)
 {
  */
 uint8_t DComp_NextHIDInterfaceDataEndpoint(void* CurrentDescriptor)
 {

+       USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+

        /* Determine the type of the current descriptor */
        /* Determine the type of the current descriptor */

-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
+       if (Header->Type == DTYPE_Endpoint)

        {
                /* Indicate that the descriptor being searched for has been found */
                return DESCRIPTOR_SEARCH_Found;
        }
        {
                /* Indicate that the descriptor being searched for has been found */
                return DESCRIPTOR_SEARCH_Found;
        }

-       else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
+       else if (Header->Type == DTYPE_Interface)

        {
                /* Indicate that the search has failed prematurely and should be aborted */
                return DESCRIPTOR_SEARCH_Fail;
        {
                /* Indicate that the search has failed prematurely and should be aborted */
                return DESCRIPTOR_SEARCH_Fail;


@@ -165,3 +182,4 @@ uint8_t DComp_NextHIDInterfaceDataEndpoint(void* CurrentDescriptor)
        /* Current descriptor does not match what this comparator is looking for */
        return DESCRIPTOR_SEARCH_NotFound;
 }
        /* Current descriptor does not match what this comparator is looking for */
        return DESCRIPTOR_SEARCH_NotFound;
 }

+