Add user callback function to the Bluetooth host demo to filter out connections from...
[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / DeviceDescriptor.c
index 2138c17..65d5b33 100644 (file)
@@ -1,13 +1,13 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \r
   Permission to use, copy, modify, distribute, and sell this \r
   software and its documentation for any purpose is hereby granted\r
 \r
   Permission to use, copy, modify, distribute, and sell this \r
   software and its documentation for any purpose is hereby granted\r
   this software.\r
 */\r
 \r
   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
 #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
 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
          \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
            (DeviceDescriptor.SubClass != BLUETOOTH_DEVICE_SUBCLASS) ||\r
            (DeviceDescriptor.Protocol != BLUETOOTH_DEVICE_PROTOCOL))\r
        {\r
-               return IncorrectDevice;\r
+               return IncorrectBTDevice;\r
        }\r
        \r
        return SuccessfulDeviceRead;\r
        }\r
        \r
        return SuccessfulDeviceRead;\r