More improvements to the incomplete BluetoothHost demo - add Disconnection Event...

[pub/lufa.git] / Demos / Host / Incomplete / BluetoothHost / ConfigDescriptor.h

diff --git a/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h b/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h
index c72f010..a54727d 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h
+++ b/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h
@@ -28,6 +28,11 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *\r
+ *  Header file for ConfigDescriptor.c.\r
+ */\r
+\r

 #ifndef _CONFIGDESCRIPTOR_H_\r
 #define _CONFIGDESCRIPTOR_H_\r
 \r
 #ifndef _CONFIGDESCRIPTOR_H_\r
 #define _CONFIGDESCRIPTOR_H_\r
 \r


@@ -35,24 +40,24 @@
                #include <LUFA/Drivers/USB/USB.h>\r
                \r
                #include "BluetoothHost.h"\r
                #include <LUFA/Drivers/USB/USB.h>\r
                \r
                #include "BluetoothHost.h"\r

-               \r
-       /* Macros: */\r
-               #define MAX_CONFIG_DESCRIPTOR_SIZE       512\r

 \r
        /* Enums: */\r
 \r
        /* Enums: */\r

+               /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */\r

                enum BluetoothHost_GetConfigDescriptorDataCodes_t\r
                {\r
                enum BluetoothHost_GetConfigDescriptorDataCodes_t\r
                {\r

-                       SuccessfulConfigRead                 = 0,\r
-                       ControlErrorDuringConfigRead         = 1,\r
-                       InvalidConfigDataReturned            = 2,\r
-                       DescriptorTooLarge                   = 3,\r
-                       NoInterfaceFound                     = 4,\r
-                       NoEndpointFound                      = 5,\r
+                       SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */\r
+                       DevControlError                 = 1, /**< A control request to the device failed to complete successfully */\r
+                       DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */\r
+                       InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */\r
+                       NoBTInterfaceFound              = 4, /**< A compatible Blutooth interface was not found in the device's Configuration Descriptor */\r
+                       NoEndpointFound                 = 5, /**< A compatible set of Bluetooth endpoints were not found in the\r
+                                                             *   device's Bluetooth interface\r
+                                                             */\r

                };\r
        \r
        /* Function Prototypes: */\r
                uint8_t ProcessConfigurationDescriptor(void);\r
                \r
                };\r
        \r
        /* Function Prototypes: */\r
                uint8_t ProcessConfigurationDescriptor(void);\r
                \r

-               uint8_t NextInterfaceBluetoothDataEndpoint(void* CurrentDescriptor);\r
+               uint8_t DComp_NextInterfaceBluetoothDataEndpoint(void* CurrentDescriptor);\r

 \r
 #endif\r
 \r
 #endif\r