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

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

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

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

 #ifndef _DEVICEDESCRIPTOR_H_\r
 #define _DEVICEDESCRIPTOR_H_\r
 \r
 #ifndef _DEVICEDESCRIPTOR_H_\r
 #define _DEVICEDESCRIPTOR_H_\r
 \r


@@ -37,17 +42,22 @@
                #include "BluetoothHost.h"\r
                \r
        /* Macros: */\r
                #include "BluetoothHost.h"\r
                \r
        /* Macros: */\r

+               /** Device Class value for the Bluetooth Device class */\r

                #define BLUETOOTH_DEVICE_CLASS           0xE0\r
                #define BLUETOOTH_DEVICE_CLASS           0xE0\r

+\r
+               /** Device Subclass value for the Bluetooth Device class */\r

                #define BLUETOOTH_DEVICE_SUBCLASS        0x01\r
                #define BLUETOOTH_DEVICE_SUBCLASS        0x01\r

+\r
+               /** Device Protocol value for the Bluetooth Device class */\r

                #define BLUETOOTH_DEVICE_PROTOCOL        0x01\r
 \r
        /* Enums: */\r
                enum BluetoothHost_GetDeviceDescriptorDataCodes_t\r
                {\r
                #define BLUETOOTH_DEVICE_PROTOCOL        0x01\r
 \r
        /* Enums: */\r
                enum BluetoothHost_GetDeviceDescriptorDataCodes_t\r
                {\r

-                       SuccessfulDeviceRead                 = 0,\r
-                       ControlErrorDuringDeviceRead         = 1,\r
-                       InvalidDeviceDataReturned            = 2,\r
-                       IncorrectDevice                      = 3,\r
+                       SuccessfulDeviceRead            = 0, /**< Device Descriptor was processed successfully */\r
+                       ControlError                    = 1, /**< A control request to the device failed to complete successfully */\r
+                       InvalidDeviceDataReturned       = 2, /**< The device returned an invalid Device Descriptor */\r
+                       IncorrectBTDevice               = 3, /**< The attached device is not a Bluetooth class device */\r

                };\r
 \r
        /* Function Prototypes: */\r
                };\r
 \r
        /* Function Prototypes: */\r