Removed invalid dfu and flip related targets from the bootloaders - bootloaders can...
[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / DeviceDescriptor.h
index 46edbdb..a87085a 100644 (file)
@@ -1,21 +1,21 @@
 /*\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
-\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
+  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
+  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
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   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
        /* Includes: */\r
 #ifndef _DEVICEDESCRIPTOR_H_\r
 #define _DEVICEDESCRIPTOR_H_\r
 \r
        /* Includes: */\r
-               #include <LUFA/Drivers/USB/USB.h>                        // USB Functionality\r
+               #include <LUFA/Drivers/USB/USB.h>\r
                \r
                #include "BluetoothHost.h"\r
                \r
        /* Macros: */\r
                \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