commit 82a51b3d4993ec12d31357f8d21ce76d4351d9ad
author Emil Gydesen <emil.gydesen@nordicsemi.no> Mon Jul 05 13:30:51 2021 +0200
committer Carles Cufí <carles.cufi@nordicsemi.no> Tue Aug 03 13:56:04 2021 +0200
tree 8c289d96d4a07f68a65c5555e91c7ca1efd70347
parent 6bcb31d6ce642edc82083255bcf93274145c9f7d

Bluetooth: GATT: Update gatt.h _value doc description

The _value in BT_GATT_ATTRIBUTE was misleading as
it cannot be generically used a attribute value,
and actually is a user_data pointer.

The macros BT_GATT_CPF, BT_GATT_CEP and BT_GATT_CUD was
also update to more accurate describe the expected
type of value for the macros.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>

include/bluetooth/gatt.h

diff --git a/include/bluetooth/gatt.h b/include/bluetooth/gatt.h
index 337ed12..f3a6ed0 100644
--- a/include/bluetooth/gatt.h
+++ b/include/bluetooth/gatt.h
@@ -655,15 +655,15 @@
  *  @param _perm Characteristic Attribute access permissions.
  *  @param _read Characteristic Attribute read callback.
  *  @param _write Characteristic Attribute write callback.
- *  @param _value Characteristic Attribute value.
+ *  @param _user_data Characteristic Attribute user data.
  */
-#define BT_GATT_CHARACTERISTIC(_uuid, _props, _perm, _read, _write, _value)  \
-	BT_GATT_ATTRIBUTE(BT_UUID_GATT_CHRC, BT_GATT_PERM_READ,              \
-			  bt_gatt_attr_read_chrc, NULL,                      \
-			  ((struct bt_gatt_chrc[]) {                         \
-				BT_GATT_CHRC_INIT(_uuid, 0U, _props),        \
-						   })),                      \
-	BT_GATT_ATTRIBUTE(_uuid, _perm, _read, _write, _value)
+#define BT_GATT_CHARACTERISTIC(_uuid, _props, _perm, _read, _write, _user_data) \
+	BT_GATT_ATTRIBUTE(BT_UUID_GATT_CHRC, BT_GATT_PERM_READ,                 \
+			  bt_gatt_attr_read_chrc, NULL,                         \
+			  ((struct bt_gatt_chrc[]) {                            \
+				BT_GATT_CHRC_INIT(_uuid, 0U, _props),           \
+						   })),                         \
+	BT_GATT_ATTRIBUTE(_uuid, _perm, _read, _write, _user_data)
 
 #if defined(CONFIG_BT_SETTINGS_CCC_LAZY_LOADING)
 	#define BT_GATT_CCC_MAX (CONFIG_BT_MAX_CONN)
@@ -833,7 +833,7 @@
  *
  *  Helper macro to declare a CEP attribute.
  *
- *  @param _value Descriptor attribute value.
+ *  @param _value Pointer to a struct bt_gatt_cep.
  */
 #define BT_GATT_CEP(_value)						\
 	BT_GATT_DESCRIPTOR(BT_UUID_GATT_CEP, BT_GATT_PERM_READ,		\
@@ -897,7 +897,7 @@
  *
  *  Helper macro to declare a CPF attribute.
  *
- *  @param _value Descriptor attribute value.
+ *  @param _value Pointer to a struct bt_gatt_cpf.
  */
 #define BT_GATT_CPF(_value)						\
 	BT_GATT_DESCRIPTOR(BT_UUID_GATT_CPF, BT_GATT_PERM_READ,		\
@@ -912,10 +912,10 @@
  *  @param _perm Descriptor attribute access permissions.
  *  @param _read Descriptor attribute read callback.
  *  @param _write Descriptor attribute write callback.
- *  @param _value Descriptor attribute value.
+ *  @param _user_data Descriptor attribute user data.
  */
-#define BT_GATT_DESCRIPTOR(_uuid, _perm, _read, _write, _value)		\
-	BT_GATT_ATTRIBUTE(_uuid, _perm, _read, _write, _value)
+#define BT_GATT_DESCRIPTOR(_uuid, _perm, _read, _write, _user_data)	\
+	BT_GATT_ATTRIBUTE(_uuid, _perm, _read, _write, _user_data)
 
 /** @def BT_GATT_ATTRIBUTE
  *  @brief Attribute Declaration Macro.
@@ -926,14 +926,14 @@
  *  @param _perm Attribute access permissions.
  *  @param _read Attribute read callback.
  *  @param _write Attribute write callback.
- *  @param _value Attribute value.
+ *  @param _user_data Attribute user data.
  */
-#define BT_GATT_ATTRIBUTE(_uuid, _perm, _read, _write, _value)		\
+#define BT_GATT_ATTRIBUTE(_uuid, _perm, _read, _write, _user_data)	\
 {									\
 	.uuid = _uuid,							\
 	.read = _read,							\
 	.write = _write,						\
-	.user_data = _value,						\
+	.user_data = _user_data,					\
 	.handle = 0,							\
 	.perm = _perm,							\
 }