Make sure that the NVM bus/controller busy waits in the AVRISP MKII clone project...
[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / ConfigDescriptor.h
index 6b59289..a54727d 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 ConfigDescriptor.c.\r
+ */\r
+\r
 #ifndef _CONFIGDESCRIPTOR_H_\r
 #define _CONFIGDESCRIPTOR_H_\r
 \r
 #ifndef _CONFIGDESCRIPTOR_H_\r
 #define _CONFIGDESCRIPTOR_H_\r
 \r
                #include <LUFA/Drivers/USB/USB.h>\r
                \r
                #include "BluetoothHost.h"\r
                #include <LUFA/Drivers/USB/USB.h>\r
                \r
                #include "BluetoothHost.h"\r
-               \r
-       /* Macros: */\r
-               #define MAX_CONFIG_DESCRIPTOR_SIZE       512\r
 \r
        /* Enums: */\r
 \r
        /* Enums: */\r
+               /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */\r
                enum BluetoothHost_GetConfigDescriptorDataCodes_t\r
                {\r
                enum BluetoothHost_GetConfigDescriptorDataCodes_t\r
                {\r
-                       SuccessfulConfigRead                 = 0,\r
-                       ControlErrorDuringConfigRead         = 1,\r
-                       InvalidConfigDataReturned            = 2,\r
-                       DescriptorTooLarge                   = 3,\r
-                       NoInterfaceFound                     = 4,\r
-                       NoEndpointFound                      = 5,\r
+                       SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */\r
+                       DevControlError                 = 1, /**< A control request to the device failed to complete successfully */\r
+                       DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */\r
+                       InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */\r
+                       NoBTInterfaceFound              = 4, /**< A compatible Blutooth interface was not found in the device's Configuration Descriptor */\r
+                       NoEndpointFound                 = 5, /**< A compatible set of Bluetooth endpoints were not found in the\r
+                                                             *   device's Bluetooth interface\r
+                                                             */\r
                };\r
        \r
        /* Function Prototypes: */\r
                uint8_t ProcessConfigurationDescriptor(void);\r
                \r
                };\r
        \r
        /* Function Prototypes: */\r
                uint8_t ProcessConfigurationDescriptor(void);\r
                \r
-               uint8_t NextInterfaceBluetoothDataEndpoint(void* CurrentDescriptor);\r
+               uint8_t DComp_NextInterfaceBluetoothDataEndpoint(void* CurrentDescriptor);\r
 \r
 #endif\r
 \r
 #endif\r