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

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

diff --git a/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.c b/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.c
index 8776840..65d5b33 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.c
+++ b/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.c
@@ -28,15 +28,28 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *\r
+ *  USB Device Descriptor processing routines, to determine the overall device parameters. Descriptors are special \r
+ *  computer-readable structures which the host requests upon device enumeration, to determine information about\r
+ *  the attached device.\r
+ */\r
+\r
 #include "DeviceDescriptor.h"\r
 \r
+/** Reads and processes an attached device's Device Descriptor, to determine compatibility\r
+ *\r
+ *  This routine checks to ensure that the attached device's class codes match those for Bluetooth devices.\r
+ *\r
+ *  \return An error code from the \ref BluetoothHost_GetDeviceDescriptorDataCodes_t enum.\r
+ */\r
 uint8_t ProcessDeviceDescriptor(void)\r
 {\r
        USB_Descriptor_Device_t DeviceDescriptor;\r
 \r
        /* Send the request to retrieve the device descriptor */\r
        if (USB_Host_GetDeviceDescriptor(&DeviceDescriptor) != HOST_SENDCONTROL_Successful)\r
-         return ControlErrorDuringDeviceRead;\r
+         return DevControlError;\r
          \r
        /* Validate returned data - ensure the returned data is a device descriptor */\r
        if (DeviceDescriptor.Header.Type != DTYPE_Device)\r
@@ -47,7 +60,7 @@ uint8_t ProcessDeviceDescriptor(void)
            (DeviceDescriptor.SubClass != BLUETOOTH_DEVICE_SUBCLASS) ||\r
            (DeviceDescriptor.Protocol != BLUETOOTH_DEVICE_PROTOCOL))\r
        {\r
-               return IncorrectDevice;\r
+               return IncorrectBTDevice;\r
        }\r
        \r
        return SuccessfulDeviceRead;\r