aboutsummaryrefslogtreecommitdiff
path: root/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h
diff options
context:
space:
mode:
Diffstat (limited to 'Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h')
-rw-r--r--Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h18
1 files changed, 14 insertions, 4 deletions
diff --git a/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h b/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h
index def9042b51..a87085a3a7 100644
--- a/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h
+++ b/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h
@@ -28,6 +28,11 @@
this software.
*/
+/** \file
+ *
+ * Header file for DeviceDescriptor.c.
+ */
+
#ifndef _DEVICEDESCRIPTOR_H_
#define _DEVICEDESCRIPTOR_H_
@@ -37,17 +42,22 @@
#include "BluetoothHost.h"
/* Macros: */
+ /** Device Class value for the Bluetooth Device class */
#define BLUETOOTH_DEVICE_CLASS 0xE0
+
+ /** Device Subclass value for the Bluetooth Device class */
#define BLUETOOTH_DEVICE_SUBCLASS 0x01
+
+ /** Device Protocol value for the Bluetooth Device class */
#define BLUETOOTH_DEVICE_PROTOCOL 0x01
/* Enums: */
enum BluetoothHost_GetDeviceDescriptorDataCodes_t
{
- SuccessfulDeviceRead = 0,
- ControlErrorDuringDeviceRead = 1,
- InvalidDeviceDataReturned = 2,
- IncorrectDevice = 3,
+ SuccessfulDeviceRead = 0, /**< Device Descriptor was processed successfully */
+ ControlError = 1, /**< A control request to the device failed to complete successfully */
+ InvalidDeviceDataReturned = 2, /**< The device returned an invalid Device Descriptor */
+ IncorrectBTDevice = 3, /**< The attached device is not a Bluetooth class device */
};
/* Function Prototypes: */