Add user callback function to the Bluetooth host demo to filter out connections from...
[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / DeviceDescriptor.c
index f68f957..65d5b33 100644 (file)
@@ -1,21 +1,21 @@
 /*\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
-  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, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\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
+/** 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
          return InvalidDeviceDataReturned;\r
-         \r
+       \r
+       /* Validate returned device Class, SubClass and Protocol values against the Bluetooth spec values */\r
        if ((DeviceDescriptor.Class    != BLUETOOTH_DEVICE_CLASS)    ||\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