Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / DeviceDescriptor.c
index 9943521..3485a05 100644 (file)
@@ -1,54 +1,68 @@
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\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
-\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
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-#include "DeviceDescriptor.h"\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
-         \r
-       /* Validate returned data - ensure the returned data is a device descriptor */\r
-       if (DeviceDescriptor.Header.Type != DTYPE_Device)\r
-         return InvalidDeviceDataReturned;\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
-       }\r
-       \r
-       return SuccessfulDeviceRead;\r
-}\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  USB Device Descriptor processing routines, to determine the overall device parameters. Descriptors are special
+ *  computer-readable structures which the host requests upon device enumeration, to determine information about
+ *  the attached device.
+ */
+
+#include "DeviceDescriptor.h"
+
+/** Reads and processes an attached device's Device Descriptor, to determine compatibility
+ *
+ *  This routine checks to ensure that the attached device's class codes match those for Bluetooth devices.
+ *
+ *  \return An error code from the \ref BluetoothHost_GetDeviceDescriptorDataCodes_t enum.
+ */
+uint8_t ProcessDeviceDescriptor(void)
+{
+       USB_Descriptor_Device_t DeviceDescriptor;
+
+       /* Send the request to retrieve the device descriptor */
+       if (USB_Host_GetDeviceDescriptor(&DeviceDescriptor) != HOST_SENDCONTROL_Successful)
+         return DevControlError;
+
+       /* Validate returned data - ensure the returned data is a device descriptor */
+       if (DeviceDescriptor.Header.Type != DTYPE_Device)
+         return InvalidDeviceDataReturned;
+
+       /* Validate returned device Class, SubClass and Protocol values against the Bluetooth spec values */
+       if ((DeviceDescriptor.Class    != BLUETOOTH_DEVICE_CLASS)    ||
+           (DeviceDescriptor.SubClass != BLUETOOTH_DEVICE_SUBCLASS) ||
+           (DeviceDescriptor.Protocol != BLUETOOTH_DEVICE_PROTOCOL))
+       {
+               return IncorrectBTDevice;
+       }
+
+       return SuccessfulDeviceRead;
+}
+