Fixed incorrect comparison in the descriptor callback routine of the TeensyHID bootlo...

[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / ConfigDescriptor.c

diff --git a/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.c b/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.c
index ba4ac4d..a69b7b3 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.c
+++ b/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.c
@@ -28,8 +28,23 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *\r
+ *  USB Device Configuration Descriptor processing routines, to determine the correct pipe configurations\r
+ *  needed to communication with an attached USB device. Descriptors are special  computer-readable structures\r
+ *  which the host requests upon device enumeration, to determine the device's capabilities and functions.\r
+ */\r
+\r
 #include "ConfigDescriptor.h"\r
 \r
+/** Reads and processes an attached device's descriptors, to determine compatibility and pipe configurations. This\r
+ *  routine will read in the entire configuration descriptor, and configure the hosts pipes to correctly communicate\r
+ *  with compatible devices.\r
+ *\r
+ *  This routine searches for a BT interface descriptor containing bulk IN and OUT data endpoints.\r
+ *\r
+ *  \return An error code from the \ref BluetoothHost_GetConfigDescriptorDataCodes_t enum.\r
+ */\r
 uint8_t ProcessConfigurationDescriptor(void)\r
 {\r
        uint8_t  ConfigDescriptorData[512];\r
@@ -47,7 +62,7 @@ uint8_t ProcessConfigurationDescriptor(void)
                case HOST_GETCONFIG_BuffOverflow:\r
                        return DescriptorTooLarge;\r
                default:\r
-                       return ControlErrorDuringConfigRead;\r
+                       return ControlError;\r
        }\r
        \r
        /* The bluetooth USB transport addendum mandates that the data (not streaming voice) endpoints\r
@@ -56,7 +71,7 @@ uint8_t ProcessConfigurationDescriptor(void)
        \r
        /* Ensure that an interface was found, and the end of the descriptor was not reached */\r
        if (!(CurrConfigBytesRem))\r
-         return NoInterfaceFound;\r
+         return NoBTInterfaceFound;\r
 \r
        /* Get the data IN, data OUT and event notification endpoints for the bluetooth interface */\r
        while (FoundEndpoints != ((1 << BLUETOOTH_DATA_IN_PIPE) | (1 << BLUETOOTH_DATA_OUT_PIPE) |\r
@@ -64,7 +79,7 @@ uint8_t ProcessConfigurationDescriptor(void)
        {\r
                /* Fetch the next endpoint from the current bluetooth interface */\r
                if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation,\r
-                                             NextInterfaceBluetoothDataEndpoint))\r
+                                             DComp_NextInterfaceBluetoothDataEndpoint))\r
                {\r
                        /* Descriptor not found, error out */\r
                        return NoEndpointFound;\r
@@ -118,15 +133,30 @@ uint8_t ProcessConfigurationDescriptor(void)
        return SuccessfulConfigRead;\r
 }\r
 \r
-uint8_t NextInterfaceBluetoothDataEndpoint(void* CurrentDescriptor)\r
+/** Descriptor comparator function. This comparator function is can be called while processing an attached USB device's\r
+ *  configuration descriptor, to search for a specific sub descriptor. It can also be used to abort the configuration\r
+ *  descriptor processing if an incompatible descriptor configuration is found.\r
+ *\r
+ *  This comparator searches for the next Endpoint descriptor inside the current interface descriptor, aborting the \r
+ *  search if another interface descriptor is found before the required endpoint.\r
+ *\r
+ *  \return A value from the DSEARCH_Return_ErrorCodes_t enum\r
+ */\r
+uint8_t DComp_NextInterfaceBluetoothDataEndpoint(void* CurrentDescriptor)\r
 {\r
-       /* PURPOSE: Find next interface endpoint descriptor before next interface descriptor */\r
-\r
+       /* Determine the type of the current descriptor */\r
        if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
-         return DESCRIPTOR_SEARCH_Found;\r
+       {\r
+               /* Indicate that the descriptor being searched for has been found */\r
+               return DESCRIPTOR_SEARCH_Found;\r
+       }\r
        else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
-         return DESCRIPTOR_SEARCH_Fail;\r
+       {\r
+               /* Indicate that the search has failed prematurely and should be aborted */\r
+               return DESCRIPTOR_SEARCH_Fail;\r
+       }\r
 \r
+       /* Current descriptor does not match what this comparator is looking for */\r
        return DESCRIPTOR_SEARCH_NotFound;\r
 }\r
 \r