doxygen: remove redundant usages of def

The def command Indicates that a comment block contains documentation
for a #define macro. This is useful if the comment block documents a
macro not adjacent to it, e.g.

```c
/**
 * @def MAX(x,y)
 * @brief Computes the maximum of @a x and @a y.
 */
 #ifdef XXX
 #define MAX(x,y) ...
 #endif
```

However, it is not necessary if the comment is adjacent to the
definition, e.g.

```c
/**
 * @brief Computes the maximum of @a x and @a y.
 */
 #define MAX(x,y) ...
```

This patch removes all unnecessary def entries in-tree.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2022-08-05 16:10:35 +02:00 committed by Carles Cufí
commit a7c3e7e84a
75 changed files with 779 additions and 955 deletions

View file

@ -41,7 +41,6 @@ typedef struct {
typedef VL53L0X_Dev_t *VL53L0X_DEV;
/**
* @def PALDevDataGet
* @brief Get ST private structure @a VL53L0X_DevData_t data access
*
* @param Dev Device Handle
@ -53,7 +52,6 @@ typedef VL53L0X_Dev_t *VL53L0X_DEV;
#define PALDevDataGet(Dev, field) (Dev->Data.field)
/**
* @def PALDevDataSet(Dev, field, data)
* @brief Set ST private structure @a VL53L0X_DevData_t data field
* @param Dev Device Handle
* @param field ST structure field name

View file

@ -164,8 +164,7 @@ static inline bool bt_addr_le_is_identity(const bt_addr_le_t *addr)
return BT_ADDR_IS_STATIC(&addr->a);
}
/** @def BT_ADDR_STR_LEN
*
/**
* @brief Recommended length of user string buffer for Bluetooth address
*
* @details The recommended length guarantee the output of address
@ -174,8 +173,7 @@ static inline bool bt_addr_le_is_identity(const bt_addr_le_t *addr)
*/
#define BT_ADDR_STR_LEN 18
/** @def BT_ADDR_LE_STR_LEN
*
/**
* @brief Recommended length of user string buffer for Bluetooth LE address
*
* @details The recommended length guarantee the output of address

View file

@ -52,8 +52,7 @@ enum bt_audio_context {
BT_AUDIO_CONTEXT_TYPE_EMERGENCY_ALARM = BIT(11),
};
/** @def BT_AUDIO_CONTEXT_TYPE_ANY
*
/**
* Any known context.
*/
#define BT_AUDIO_CONTEXT_TYPE_ANY (BT_AUDIO_CONTEXT_TYPE_UNSPECIFIED | \
@ -177,7 +176,7 @@ struct bt_codec_data {
uint8_t value[CONFIG_BT_CODEC_MAX_DATA_LEN];
};
/** @def BT_CODEC_DATA
/**
* @brief Helper to declare elements of bt_codec_data arrays
*
* This macro is mainly for creating an array of struct bt_codec_data
@ -193,7 +192,7 @@ struct bt_codec_data {
sizeof((uint8_t []) { _bytes })) \
}
/** @def BT_CODEC
/**
* @brief Helper to declare bt_codec structure
*
* @param _id Codec ID
@ -307,7 +306,7 @@ enum bt_audio_dir {
BT_AUDIO_DIR_SOURCE = 0x02,
};
/** @def BT_CODEC_QOS
/**
* @brief Helper to declare elements of bt_codec_qos
*
* @param _interval SDU interval (usec)
@ -343,7 +342,7 @@ enum {
BT_CODEC_QOS_CODED = BIT(2),
};
/** @def BT_CODEC_QOS_UNFRAMED
/**
* @brief Helper to declare Input Unframed bt_codec_qos
*
* @param _interval SDU interval (usec)
@ -356,7 +355,7 @@ enum {
BT_CODEC_QOS(_interval, BT_CODEC_QOS_UNFRAMED, BT_CODEC_QOS_2M, _sdu, \
_rtn, _latency, _pd)
/** @def BT_CODEC_QOS_FRAMED
/**
* @brief Helper to declare Input Framed bt_codec_qos
*
* @param _interval SDU interval (usec)
@ -392,7 +391,7 @@ struct bt_codec_qos {
uint32_t pd;
};
/** @def BT_CODEC_QOS_PREF
/**
* @brief Helper to declare elements of @ref bt_codec_qos_pref
*
* @param _unframed_supported Unframed PDUs supported
@ -473,7 +472,7 @@ struct bt_audio_lc3_preset {
/* LC3 Unicast presets defined by table 5.2 in the BAP v1.0 specification */
/** @def BT_AUDIO_LC3_UNICAST_PRESET_8_1_1
/**
* @brief Helper to declare LC3 Unicast 8_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -485,7 +484,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(26u, 2u, 8u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_8_2_1
/**
* @brief Helper to declare LC3 Unicast 8_2_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -497,7 +496,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(30u, 2u, 10u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_16_1_1
/**
* @brief Helper to declare LC3 Unicast 16_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -509,7 +508,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(30u, 2u, 8u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_16_2_1
/**
* @brief Helper to declare LC3 Unicast 16_2_1 codec configuration
*
* Mandatory to support as both unicast client and server
@ -523,7 +522,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(40u, 2u, 10u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_24_1_1
/**
* @brief Helper to declare LC3 Unicast 24_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -535,7 +534,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(45u, 2u, 8u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_24_2_1
/**
* @brief Helper to declare LC3 Unicast 24_2_1 codec configuration
*
* Mandatory to support as unicast server
@ -549,7 +548,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(60u, 2u, 10u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_32_1_1
/**
* @brief Helper to declare LC3 Unicast 32_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -561,7 +560,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(60u, 2u, 8u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_32_2_1
/**
* @brief Helper to declare LC3 Unicast 32_2_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -573,7 +572,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(80u, 2u, 10u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_441_1_1
/**
* @brief Helper to declare LC3 Unicast 441_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -586,7 +585,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_QOS_2M, 97u, 5u, 24u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_441_2_1
/**
* @brief Helper to declare LC3 Unicast 441_2_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -599,7 +598,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_QOS_2M, 130u, 5u, 31u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_1_1
/**
* @brief Helper to declare LC3 Unicast 48_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -611,7 +610,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(75u, 5u, 15u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_2_1
/**
* @brief Helper to declare LC3 Unicast 48_2_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -623,7 +622,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(100u, 5u, 20u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_3_1
/**
* @brief Helper to declare LC3 Unicast 48_3_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -635,7 +634,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(90u, 5u, 15u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_4_1
/**
* @brief Helper to declare LC3 Unicast 48_4_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -647,7 +646,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(120u, 5u, 20u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_5_1
/**
* @brief Helper to declare LC3 Unicast 8_5_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -659,7 +658,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(117u, 5u, 15u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_6_1
/**
* @brief Helper to declare LC3 Unicast 48_6_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -671,7 +670,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(155u, 5u, 20u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_8_1_2
/**
* @brief Helper to declare LC3 Unicast 8_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -684,7 +683,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(26u, 13u, 75u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_8_2_2
/**
* @brief Helper to declare LC3 Unicast 8_2_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -696,7 +695,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(30u, 13u, 95u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_16_1_2
/**
* @brief Helper to declare LC3 Unicast 16_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -708,7 +707,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(30u, 13u, 75u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_16_2_2
/**
* @brief Helper to declare LC3 Unicast 16_2_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -720,7 +719,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(40u, 13u, 95u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_24_1_2
/**
* @brief Helper to declare LC3 Unicast 24_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -732,7 +731,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(45u, 13u, 75u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_24_2_2
/**
* @brief Helper to declare LC3 Unicast 24_2_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -744,7 +743,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(60u, 13u, 95u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_32_1_2
/**
* @brief Helper to declare LC3 Unicast 32_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -756,7 +755,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(60u, 13u, 75u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_32_2_2
/**
* @brief Helper to declare LC3 Unicast 32_2_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -768,7 +767,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(80u, 13u, 95u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_441_1_2
/**
* @brief Helper to declare LC3 Unicast 441_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -781,7 +780,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_QOS_2M, 97u, 13u, 80u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_441_2_2
/**
* @brief Helper to declare LC3 Unicast 441_2_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -794,7 +793,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_QOS_2M, 130u, 13u, 85u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_1_2
/**
* @brief Helper to declare LC3 Unicast 48_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -806,7 +805,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(75u, 13u, 75u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_2_2
/**
* @brief Helper to declare LC3 Unicast 48_2_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -818,7 +817,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(100u, 13u, 95u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_3_2
/**
* @brief Helper to declare LC3 Unicast 48_3_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -830,7 +829,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(90u, 13u, 75u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_4_2
/**
* @brief Helper to declare LC3 Unicast 48_4_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -842,7 +841,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(120u, 13u, 100u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_5_2
/**
* @brief Helper to declare LC3 Unicast 48_5_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -854,7 +853,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(117u, 13u, 75u, 40000u) \
)
/** @def BT_AUDIO_LC3_UNICAST_PRESET_48_6_2
/**
* @brief Helper to declare LC3 Unicast 48_6_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -866,7 +865,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(155u, 13u, 100u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_8_1_1
/**
* @brief Helper to declare LC3 Broadcast 8_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -879,7 +878,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(26u, 2u, 8u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_8_2_1
/**
* @brief Helper to declare LC3 Broadcast 8_2_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -891,7 +890,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(30u, 2u, 10u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_16_1_1
/**
* @brief Helper to declare LC3 Broadcast 16_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -903,7 +902,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(30u, 2u, 8u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_16_2_1
/**
* @brief Helper to declare LC3 Broadcast 16_2_1 codec configuration
*
* Mandatory to support as both broadcast source and sink
@ -917,7 +916,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(40u, 2u, 10u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_24_1_1
/**
* @brief Helper to declare LC3 Broadcast 24_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -929,7 +928,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(45u, 2u, 8u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_24_2_1
/**
* @brief Helper to declare LC3 Broadcast 24_2_1 codec configuration
*
* Mandatory to support as broadcast sink
@ -943,7 +942,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(60u, 2u, 10u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_32_1_1
/**
* @brief Helper to declare LC3 Broadcast 32_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -955,7 +954,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(60u, 2u, 8u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_32_2_1
/**
* @brief Helper to declare LC3 Broadcast 32_2_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -967,7 +966,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(80u, 2u, 10u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_441_1_1
/**
* @brief Helper to declare LC3 Broadcast 441_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -980,7 +979,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_QOS_2M, 97u, 4u, 24u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_441_2_1
/**
* @brief Helper to declare LC3 Broadcast 441_2_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -993,7 +992,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_QOS_2M, 130u, 4u, 31u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_1_1
/**
* @brief Helper to declare LC3 Broadcast 48_1_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1005,7 +1004,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(75u, 4u, 15u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_2_1
/**
* @brief Helper to declare LC3 Broadcast 48_2_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1017,7 +1016,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(100u, 4u, 20u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_3_1
/**
* @brief Helper to declare LC3 Broadcast 48_3_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1029,7 +1028,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(90u, 4u, 15u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_4_1
/**
* @brief Helper to declare LC3 Broadcast 48_4_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1041,7 +1040,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(120u, 4u, 20u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_5_1
/**
* @brief Helper to declare LC3 Broadcast 48_5_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1053,7 +1052,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(117u, 4u, 15u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_6_1
/**
* @brief Helper to declare LC3 Broadcast 48_6_1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1065,7 +1064,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(155u, 4u, 20u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_8_1_2
/**
* @brief Helper to declare LC3 Broadcast 8_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1078,7 +1077,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(26u, 4u, 45u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_8_2_2
/**
* @brief Helper to declare LC3 Broadcast 8_2_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1090,7 +1089,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(30u, 4u, 60u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_16_1_2
/**
* @brief Helper to declare LC3 Broadcast 16_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1102,7 +1101,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(30u, 4u, 45u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_16_2_2
/**
* @brief Helper to declare LC3 Broadcast 16_2_2 codec configuration
*
* Mandatory to support as both broadcast source and sink
@ -1116,7 +1115,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(40u, 4u, 60u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_24_1_2
/**
* @brief Helper to declare LC3 Broadcast 24_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1128,7 +1127,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(45u, 4u, 45u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_24_2_2
/**
* @brief Helper to declare LC3 Broadcast 24_2_2 codec configuration
*
* Mandatory to support as broadcast sink
@ -1142,7 +1141,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(60u, 4u, 60u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_32_1_2
/**
* @brief Helper to declare LC3 Broadcast 32_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1154,7 +1153,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(60u, 4u, 45u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_32_2_2
/**
* @brief Helper to declare LC3 Broadcast 32_2_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1166,7 +1165,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(80u, 4u, 60u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_441_1_2
/**
* @brief Helper to declare LC3 Broadcast 441_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1179,7 +1178,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_QOS_2M, 97u, 4u, 54u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_441_2_2
/**
* @brief Helper to declare LC3 Broadcast 441_2_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1192,7 +1191,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_QOS_2M, 130u, 4u, 60u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_1_2
/**
* @brief Helper to declare LC3 Broadcast 48_1_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1204,7 +1203,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(75u, 4u, 50u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_2_2
/**
* @brief Helper to declare LC3 Broadcast 48_2_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1216,7 +1215,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(100u, 4u, 65u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_3_2
/**
* @brief Helper to declare LC3 Broadcast 48_3_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1228,7 +1227,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(90u, 4u, 50u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_4_2
/**
* @brief Helper to declare LC3 Broadcast 48_4_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1240,7 +1239,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_10_UNFRAMED(120u, 4u, 65u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_5_2
/**
* @brief Helper to declare LC3 Broadcast 48_5_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -1252,7 +1251,7 @@ struct bt_audio_lc3_preset {
BT_CODEC_LC3_QOS_7_5_UNFRAMED(117u, 4u, 50u, 40000u) \
)
/** @def BT_AUDIO_LC3_BROADCAST_PRESET_48_6_2
/**
* @brief Helper to declare LC3 Broadcast 48_6_2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)

View file

@ -26,7 +26,7 @@ enum bt_audio_capability_framing {
BT_AUDIO_CAPABILITY_UNFRAMED_NOT_SUPPORTED = 0x01,
};
/** @def BT_AUDIO_CAPABILITY_PREF
/**
* @brief Helper to declare elements of @ref bt_audio_capability_pref
*
* @param _framing Framing Support

View file

@ -25,7 +25,7 @@
extern "C" {
#endif
/** @def BT_CODEC_LC3_ID
/**
* @brief LC3 codec ID
*/
#define BT_CODEC_LC3_ID 0x06
@ -40,65 +40,65 @@ extern "C" {
*/
enum bt_codec_capability_type {
/** @def BT_CODEC_LC3_FREQ
/**
* @brief LC3 sample frequency capability type
*/
BT_CODEC_LC3_FREQ = 0x01,
/** @def BT_CODEC_LC3_DURATION
/**
* @brief LC3 frame duration capability type
*/
BT_CODEC_LC3_DURATION = 0x02,
/** @def BT_CODEC_LC3_CHAN_COUNT
/**
* @brief LC3 channel count capability type
*/
BT_CODEC_LC3_CHAN_COUNT = 0x03,
/** @def BT_CODEC_LC3_FRAME_LEN
/**
* @brief LC3 frame length capability type
*/
BT_CODEC_LC3_FRAME_LEN = 0x04,
/** @def BT_CODEC_LC3_FRAME_COUNT
/**
* @brief Max codec frame count per SDU capability type
*/
BT_CODEC_LC3_FRAME_COUNT = 0x05,
};
/** @def BT_CODEC_LC3_FREQ_8KHZ
/**
* @brief LC3 8 Khz frequency capability
*/
#define BT_CODEC_LC3_FREQ_8KHZ BIT(0)
/** @def BT_CODEC_LC3_FREQ_11KHZ
/**
* @brief LC3 11.025 Khz frequency capability
*/
#define BT_CODEC_LC3_FREQ_11KHZ BIT(1)
/** @def BT_CODEC_LC3_FREQ_16KHZ
/**
* @brief LC3 16 Khz frequency capability
*/
#define BT_CODEC_LC3_FREQ_16KHZ BIT(2)
/** @def BT_CODEC_LC3_FREQ_22KHZ
/**
* @brief LC3 22.05 Khz frequency capability
*/
#define BT_CODEC_LC3_FREQ_22KHZ BIT(3)
/** @def BT_CODEC_LC3_FREQ_24KHZ
/**
* @brief LC3 24 Khz frequency capability
*/
#define BT_CODEC_LC3_FREQ_24KHZ BIT(4)
/** @def BT_CODEC_LC3_FREQ_32KHZ
/**
* @brief LC3 32 Khz frequency capability
*/
#define BT_CODEC_LC3_FREQ_32KHZ BIT(5)
/** @def BT_CODEC_LC3_FREQ_44KHZ
/**
* @brief LC3 44.1 Khz frequency capability
*/
#define BT_CODEC_LC3_FREQ_44KHZ BIT(6)
/** @def BT_CODEC_LC3_FREQ_48KHZ
/**
* @brief LC3 48 Khz frequency capability
*/
#define BT_CODEC_LC3_FREQ_48KHZ BIT(7)
/** @def BT_CODEC_LC3_FREQ_ANY
/**
* @brief LC3 any frequency capability
*/
#define BT_CODEC_LC3_FREQ_ANY (BT_CODEC_LC3_FREQ_8KHZ | \
@ -108,37 +108,37 @@ enum bt_codec_capability_type {
BT_CODEC_LC3_FREQ_44KHZ | \
BT_CODEC_LC3_FREQ_48KHZ)
/** @def BT_CODEC_LC3_DURATION_7_5
/**
* @brief LC3 7.5 msec frame duration capability
*/
#define BT_CODEC_LC3_DURATION_7_5 BIT(0)
/** @def BT_CODEC_LC3_DURATION_10
/**
* @brief LC3 10 msec frame duration capability
*/
#define BT_CODEC_LC3_DURATION_10 BIT(1)
/** @def BT_CODEC_LC3_DURATION_ANY
/**
* @brief LC3 any frame duration capability
*/
#define BT_CODEC_LC3_DURATION_ANY (BT_CODEC_LC3_DURATION_7_5 | \
BT_CODEC_LC3_DURATION_10)
/** @def BT_CODEC_LC3_DURATION_PREFER_7_5
/**
* @brief LC3 7.5 msec preferred frame duration capability
*/
#define BT_CODEC_LC3_DURATION_PREFER_7_5 BIT(4)
/** @def BT_CODEC_LC3_DURATION_PREFER_10
/**
* @brief LC3 10 msec preferred frame duration capability
*/
#define BT_CODEC_LC3_DURATION_PREFER_10 BIT(5)
/** @def BT_CODEC_LC3_CHAN_COUNT_MIN
/**
* @brief LC3 minimum supported channel counts
*/
#define BT_CODEC_LC3_CHAN_COUNT_MIN 1
/** @def BT_CODEC_LC3_CHAN_COUNT_MIN
/**
* @brief LC3 maximum supported channel counts
*/
#define BT_CODEC_LC3_CHAN_COUNT_MAX 8
/** @def BT_CODEC_LC3_CHAN_COUNT_SUPPORT
/**
* @brief LC3 channel count support capability
*
* Macro accepts variable number of channel counts.
@ -181,70 +181,70 @@ enum bt_codec_config_type {
BT_CODEC_CONFIG_LC3_FRAME_BLKS_PER_SDU = 0x05,
};
/** @def BT_CODEC_CONFIG_LC3_FREQ_8KHZ
/**
* @brief 8 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_8KHZ 0x01
/** @def BT_CODEC_CONFIG_LC3_FREQ_11KHZ
/**
* @brief 11.025 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_11KHZ 0x02
/** @def BT_CODEC_CONFIG_LC3_FREQ_16KHZ
/**
* @brief 16 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_16KHZ 0x03
/** @def BT_CODEC_CONFIG_LC3_FREQ_22KHZ
/**
* @brief 22.05 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_22KHZ 0x04
/** @def BT_CODEC_CONFIG_LC3_FREQ_24KHZ
/**
* @brief 24 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_24KHZ 0x05
/** @def BT_CODEC_CONFIG_LC3_FREQ_32KHZ
/**
* @brief 32 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_32KHZ 0x06
/** @def BT_CODEC_CONFIG_LC3_FREQ_44KHZ
/**
* @brief 44.1 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_44KHZ 0x07
/** @def BT_CODEC_CONFIG_LC3_FREQ_48KHZ
/**
* @brief 48 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_48KHZ 0x08
/** @def BT_CODEC_CONFIG_LC3_FREQ_88KHZ
/**
* @brief 88.2 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_88KHZ 0x09
/** @def BT_CODEC_CONFIG_LC3_FREQ_96KHZ
/**
* @brief 96 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_96KHZ 0x0a
/** @def BT_CODEC_CONFIG_LC3_FREQ_176KHZ
/**
* @brief 176.4 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_176KHZ 0x0b
/** @def BT_CODEC_CONFIG_LC3_FREQ_192KHZ
/**
* @brief 192 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_192KHZ 0x0c
/** @def BT_CODEC_CONFIG_LC3_FREQ_384KHZ
/**
* @brief 384 Khz codec Sample Frequency configuration
*/
#define BT_CODEC_CONFIG_LC3_FREQ_384KHZ 0x0d
/** @def BT_CODEC_CONFIG_LC3_DURATION_7_5
/**
* @brief LC3 7.5 msec Frame Duration configuration
*/
#define BT_CODEC_CONFIG_LC3_DURATION_7_5 0x00
/** @def BT_CODEC_CONFIG_LC3_DURATION_10
/**
* @brief LC3 10 msec Frame Duration configuration
*/
#define BT_CODEC_CONFIG_LC3_DURATION_10 0x01
/** @def BT_CODEC_LC3_DATA
/**
* @brief Helper to declare LC3 codec capability
*
* _max_frames_per_sdu value is optional and will be included only if != 1
@ -266,7 +266,7 @@ enum bt_codec_config_type {
(, BT_CODEC_DATA(BT_CODEC_LC3_FRAME_COUNT, _max_frames_per_sdu))) \
}
/** @def BT_CODEC_LC3_META
/**
* @brief Helper to declare LC3 codec metadata
*/
#define BT_CODEC_LC3_META(_prefer_context) \
@ -276,7 +276,7 @@ enum bt_codec_config_type {
(_prefer_context) >> 8) \
}
/** @def BT_CODEC_LC3
/**
* @brief Helper to declare LC3 codec
*/
#define BT_CODEC_LC3(_freq, _duration, _chan_count, _len_min, _len_max, \
@ -286,7 +286,7 @@ enum bt_codec_config_type {
_len_max, _max_frames_per_sdu), \
BT_CODEC_LC3_META(_prefer_context))
/** @def BT_CODEC_LC3_CONFIG_DATA
/**
* @brief Helper to declare LC3 codec data configuration
*
* _frame_blocks_per_sdu value is optional and will be included only if != 1
@ -308,7 +308,7 @@ enum bt_codec_config_type {
(, BT_CODEC_DATA(BT_CODEC_CONFIG_LC3_FRAME_BLKS_PER_SDU, _frames_per_sdu))) \
}
/** @def BT_CODEC_LC3_CONFIG_DATA
/**
* @brief Helper to declare LC3 codec metadata configuration
*/
#define BT_CODEC_LC3_CONFIG_META(_stream_context) \
@ -318,7 +318,7 @@ enum bt_codec_config_type {
_stream_context >> 8), \
}
/** @def BT_CODEC_LC3_CONFIG
/**
* @brief Helper to declare LC3 codec configuration.
*
* @param _freq Sampling frequency (BT_CODEC_CONFIG_LC3_FREQ_*)
@ -334,7 +334,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG_DATA(_freq, _duration, _loc, _len, _frames_per_sdu), \
BT_CODEC_LC3_CONFIG_META(_stream_context))
/** @def BT_CODEC_LC3_CONFIG_8_1
/**
* @brief Helper to declare LC3 8.1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -344,7 +344,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_8KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_7_5, _loc, 26u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_8_2
/**
* @brief Helper to declare LC3 8.2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -354,7 +354,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_8KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_10, _loc, 30u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_16_1
/**
* @brief Helper to declare LC3 16.1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -364,7 +364,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_16KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_7_5, _loc, 30u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_16_2
/**
* @brief Helper to declare LC3 16.2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -375,7 +375,7 @@ enum bt_codec_config_type {
BT_CODEC_CONFIG_LC3_DURATION_10, _loc, 40u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_24_1
/**
* @brief Helper to declare LC3 24.1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -385,7 +385,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_24KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_7_5, _loc, 45u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_24_2
/**
* @brief Helper to declare LC3 24.2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -395,7 +395,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_24KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_10, _loc, 60u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_32_1
/**
* @brief Helper to declare LC3 32.1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -405,7 +405,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_32KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_7_5, _loc, 60u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_32_2
/**
* @brief Helper to declare LC3 32.2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -415,7 +415,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_32KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_10, _loc, 80u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_441_1
/**
* @brief Helper to declare LC3 441.1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -425,7 +425,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_44KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_7_5, _loc, 98u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_441_2
/**
* @brief Helper to declare LC3 441.2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -435,7 +435,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_44KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_10, _loc, 130u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_48_1
/**
* @brief Helper to declare LC3 48.1 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -445,7 +445,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_7_5, _loc, 75u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_48_2
/**
* @brief Helper to declare LC3 48.2 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -455,7 +455,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_10, _loc, 100u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_48_3
/**
* @brief Helper to declare LC3 48.3 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -465,7 +465,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_7_5, _loc, 90u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_48_4
/**
* @brief Helper to declare LC3 48.4 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -475,7 +475,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_10, _loc, 120u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_48_5
/**
* @brief Helper to declare LC3 48.5 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -485,7 +485,7 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_7_5, _loc, 117u, \
1, _stream_context)
/** @def BT_CODEC_LC3_CONFIG_48_6
/**
* @brief Helper to declare LC3 48.6 codec configuration
*
* @param _loc Audio channel location bitfield (@ref bt_audio_location)
@ -495,24 +495,24 @@ enum bt_codec_config_type {
BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
BT_CODEC_CONFIG_LC3_DURATION_10, _loc, 155u, \
1, _stream_context)
/** @def BT_CODEC_LC3_QOS_7_5
/**
* @brief Helper to declare LC3 codec QoS for 7.5ms interval
*/
#define BT_CODEC_LC3_QOS_7_5(_framing, _sdu, _rtn, _latency, _pd) \
BT_CODEC_QOS(7500u, _framing, BT_CODEC_QOS_2M, _sdu, _rtn, \
_latency, _pd)
/** @def BT_CODEC_LC3_QOS_7_5_UNFRAMED
/**
* @brief Helper to declare LC3 codec QoS for 7.5ms interval unframed input
*/
#define BT_CODEC_LC3_QOS_7_5_UNFRAMED(_sdu, _rtn, _latency, _pd) \
BT_CODEC_QOS_UNFRAMED(7500u, _sdu, _rtn, _latency, _pd)
/** @def BT_CODEC_LC3_QOS_10
/**
* @brief Helper to declare LC3 codec QoS for 10ms frame internal
*/
#define BT_CODEC_LC3_QOS_10(_framing, _sdu, _rtn, _latency, _pd) \
BT_CODEC_QOS(10000u, _framing, BT_CODEC_QOS_2M, _sdu, _rtn, \
_latency, _pd)
/** @def BT_CODEC_LC3_QOS_10_UNFRAMED
/**
* @brief Helper to declare LC3 codec QoS for 10ms interval unframed input
*/
#define BT_CODEC_LC3_QOS_10_UNFRAMED(_sdu, _rtn, _latency, _pd) \

View file

@ -37,8 +37,6 @@ extern "C" {
*/
/**
* @def BT_ID_DEFAULT
*
* Convenience macro for specifying the default identity. This helps
* make the code more readable, especially when only one identity is
* supported.

View file

@ -971,8 +971,7 @@ struct bt_conn_cb {
*/
void bt_conn_cb_register(struct bt_conn_cb *cb);
/** @def BT_CONN_CB_DEFINE
*
/**
* @brief Register a callback structure for connection events.
*
* @param _name Name of callback structure.
@ -1058,8 +1057,7 @@ int bt_le_oob_get_sc_data(struct bt_conn *conn,
const struct bt_le_oob_sc_data **oobd_local,
const struct bt_le_oob_sc_data **oobd_remote);
/** @def BT_PASSKEY_INVALID
*
/**
* Special passkey value that can be used to disable a previously
* set fixed passkey.
*/

View file

@ -86,7 +86,7 @@ enum bt_gatt_perm {
BT_GATT_PERM_WRITE_LESC = BIT(8),
};
/** @def BT_GATT_ERR
/**
* @brief Construct error return value for attribute read and write callbacks.
*
* @param _att_err ATT error code
@ -230,51 +230,51 @@ struct bt_gatt_cb {
/** Characteristic Properties Bit field values */
/** @def BT_GATT_CHRC_BROADCAST
/**
* @brief Characteristic broadcast property.
*
* If set, permits broadcasts of the Characteristic Value using Server
* Characteristic Configuration Descriptor.
*/
#define BT_GATT_CHRC_BROADCAST 0x01
/** @def BT_GATT_CHRC_READ
/**
* @brief Characteristic read property.
*
* If set, permits reads of the Characteristic Value.
*/
#define BT_GATT_CHRC_READ 0x02
/** @def BT_GATT_CHRC_WRITE_WITHOUT_RESP
/**
* @brief Characteristic write without response property.
*
* If set, permits write of the Characteristic Value without response.
*/
#define BT_GATT_CHRC_WRITE_WITHOUT_RESP 0x04
/** @def BT_GATT_CHRC_WRITE
/**
* @brief Characteristic write with response property.
*
* If set, permits write of the Characteristic Value with response.
*/
#define BT_GATT_CHRC_WRITE 0x08
/** @def BT_GATT_CHRC_NOTIFY
/**
* @brief Characteristic notify property.
*
* If set, permits notifications of a Characteristic Value without
* acknowledgment.
*/
#define BT_GATT_CHRC_NOTIFY 0x10
/** @def BT_GATT_CHRC_INDICATE
/**
* @brief Characteristic indicate property.
*
* If set, permits indications of a Characteristic Value with acknowledgment.
*/
#define BT_GATT_CHRC_INDICATE 0x20
/** @def BT_GATT_CHRC_AUTH
/**
* @brief Characteristic Authenticated Signed Writes property.
*
* If set, permits signed writes to the Characteristic Value.
*/
#define BT_GATT_CHRC_AUTH 0x40
/** @def BT_GATT_CHRC_EXT_PROP
/**
* @brief Characteristic Extended Properties property.
*
* If set, additional characteristic properties are defined in the
@ -304,13 +304,13 @@ struct bt_gatt_cep {
/** Client Characteristic Configuration Values */
/** @def BT_GATT_CCC_NOTIFY
/**
* @brief Client Characteristic Configuration Notification.
*
* If set, changes to Characteristic Value shall be notified.
*/
#define BT_GATT_CCC_NOTIFY 0x0001
/** @def BT_GATT_CCC_INDICATE
/**
* @brief Client Characteristic Configuration Indication.
*
* If set, changes to Characteristic Value shall be indicated.
@ -325,7 +325,7 @@ struct bt_gatt_ccc {
/** Server Characteristic Configuration Values */
/** @def BT_GATT_SCC_BROADCAST
/**
* @brief Server Characteristic Configuration Broadcast
*
* If set, the characteristic value shall be broadcast in the advertising data
@ -548,7 +548,7 @@ ssize_t bt_gatt_attr_read_service(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
void *buf, uint16_t len, uint16_t offset);
/** @def BT_GATT_SERVICE_DEFINE
/**
* @brief Statically define and register a service.
*
* Helper macro to statically define and register a service.
@ -565,7 +565,7 @@ ssize_t bt_gatt_attr_read_service(struct bt_conn *conn,
#define _BT_GATT_SERVICE_ARRAY_ITEM(_n, _) BT_GATT_SERVICE(attrs_##_n)
/** @def BT_GATT_SERVICE_INSTANCE_DEFINE
/**
* @brief Statically define service structure array.
*
* Helper macro to statically define service structure array. Each element
@ -590,7 +590,7 @@ ssize_t bt_gatt_attr_read_service(struct bt_conn *conn,
LISTIFY(_instance_num, _BT_GATT_SERVICE_ARRAY_ITEM, (,)) \
}
/** @def BT_GATT_SERVICE
/**
* @brief Service Structure Declaration Macro.
*
* Helper macro to declare a service structure.
@ -603,7 +603,7 @@ ssize_t bt_gatt_attr_read_service(struct bt_conn *conn,
.attr_count = ARRAY_SIZE(_attrs), \
}
/** @def BT_GATT_PRIMARY_SERVICE
/**
* @brief Primary Service Declaration Macro.
*
* Helper macro to declare a primary service attribute.
@ -614,7 +614,7 @@ ssize_t bt_gatt_attr_read_service(struct bt_conn *conn,
BT_GATT_ATTRIBUTE(BT_UUID_GATT_PRIMARY, BT_GATT_PERM_READ, \
bt_gatt_attr_read_service, NULL, _service)
/** @def BT_GATT_SECONDARY_SERVICE
/**
* @brief Secondary Service Declaration Macro.
*
* Helper macro to declare a secondary service attribute.
@ -644,7 +644,7 @@ ssize_t bt_gatt_attr_read_included(struct bt_conn *conn,
const struct bt_gatt_attr *attr,
void *buf, uint16_t len, uint16_t offset);
/** @def BT_GATT_INCLUDE_SERVICE
/**
* @brief Include Service Declaration Macro.
*
* Helper macro to declare database internal include service attribute.
@ -681,7 +681,7 @@ ssize_t bt_gatt_attr_read_chrc(struct bt_conn *conn,
.properties = _props, \
}
/** @def BT_GATT_CHARACTERISTIC
/**
* @brief Characteristic and Value Declaration Macro.
*
* Helper macro to declare a characteristic attribute along with its
@ -807,7 +807,7 @@ ssize_t bt_gatt_attr_write_ccc(struct bt_conn *conn,
uint16_t len, uint16_t offset, uint8_t flags);
/** @def BT_GATT_CCC_INITIALIZER
/**
* @brief Initialize Client Characteristic Configuration Declaration Macro.
*
* Helper macro to initialize a Managed CCC attribute value.
@ -824,7 +824,7 @@ ssize_t bt_gatt_attr_write_ccc(struct bt_conn *conn,
.cfg_match = _match, \
}
/** @def BT_GATT_CCC_MANAGED
/**
* @brief Managed Client Characteristic Configuration Declaration Macro.
*
* Helper macro to declare a Managed CCC attribute.
@ -838,7 +838,7 @@ ssize_t bt_gatt_attr_write_ccc(struct bt_conn *conn,
bt_gatt_attr_read_ccc, bt_gatt_attr_write_ccc, \
_ccc)
/** @def BT_GATT_CCC
/**
* @brief Client Characteristic Configuration Declaration Macro.
*
* Helper macro to declare a CCC attribute.
@ -871,7 +871,7 @@ ssize_t bt_gatt_attr_read_cep(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset);
/** @def BT_GATT_CEP
/**
* @brief Characteristic Extended Properties Declaration Macro.
*
* Helper macro to declare a CEP attribute.
@ -903,7 +903,7 @@ ssize_t bt_gatt_attr_read_cud(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset);
/** @def BT_GATT_CUD
/**
* @brief Characteristic User Format Descriptor Declaration Macro.
*
* Helper macro to declare a CUD attribute.
@ -936,7 +936,7 @@ ssize_t bt_gatt_attr_read_cpf(struct bt_conn *conn,
const struct bt_gatt_attr *attr, void *buf,
uint16_t len, uint16_t offset);
/** @def BT_GATT_CPF
/**
* @brief Characteristic Presentation Format Descriptor Declaration Macro.
*
* Helper macro to declare a CPF attribute.
@ -947,7 +947,7 @@ ssize_t bt_gatt_attr_read_cpf(struct bt_conn *conn,
BT_GATT_DESCRIPTOR(BT_UUID_GATT_CPF, BT_GATT_PERM_READ, \
bt_gatt_attr_read_cpf, NULL, (void *)_value)
/** @def BT_GATT_DESCRIPTOR
/**
* @brief Descriptor Declaration Macro.
*
* Helper macro to declare a descriptor attribute.
@ -964,7 +964,7 @@ ssize_t bt_gatt_attr_read_cpf(struct bt_conn *conn,
#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.
*
* Helper macro to declare an attribute.

View file

@ -27,13 +27,12 @@ extern "C" {
#include <zephyr/bluetooth/conn.h>
#include <zephyr/bluetooth/hci.h>
/** @def BT_ISO_CHAN_SEND_RESERVE
/**
* @brief Headroom needed for outgoing ISO SDUs
*/
#define BT_ISO_CHAN_SEND_RESERVE BT_BUF_ISO_SIZE(0)
/** @def BT_ISO_SDU_BUF_SIZE
*
/**
* @brief Helper to calculate needed buffer size for ISO SDUs.
* Useful for creating buffer pools.
*

View file

@ -69,7 +69,7 @@ extern "C" {
*/
#define BT_L2CAP_SDU_RX_MTU (BT_L2CAP_RX_MTU - BT_L2CAP_SDU_HDR_SIZE)
/** @def BT_L2CAP_SDU_BUF_SIZE
/**
*
* @brief Helper to calculate needed buffer size for L2CAP SDUs.
* Useful for creating buffer pools.
@ -199,7 +199,7 @@ struct bt_l2cap_le_chan {
#endif
};
/** @def BT_L2CAP_LE_CHAN(_ch)
/**
* @brief Helper macro getting container object of type bt_l2cap_le_chan
* address having the same container chan member address as object in question.
*
@ -345,12 +345,12 @@ struct bt_l2cap_chan_ops {
void (*reconfigured)(struct bt_l2cap_chan *chan);
};
/** @def BT_L2CAP_CHAN_SEND_RESERVE
/**
* @brief Headroom needed for outgoing L2CAP PDUs.
*/
#define BT_L2CAP_CHAN_SEND_RESERVE (BT_L2CAP_BUF_SIZE(0))
/** @def BT_L2CAP_SDU_CHAN_SEND_RESERVE
/**
* @brief Headroom needed for outgoing L2CAP SDUs.
*/
#define BT_L2CAP_SDU_CHAN_SEND_RESERVE (BT_L2CAP_SDU_BUF_SIZE(0))

View file

@ -228,8 +228,7 @@ struct bt_mesh_model_op {
/** Helper to define an empty model array */
#define BT_MESH_MODEL_NONE ((struct bt_mesh_model []){})
/** @def BT_MESH_MODEL_CB
*
/**
* @brief Composition data SIG model entry with callback functions.
*
* @param _id Model ID.
@ -249,8 +248,7 @@ struct bt_mesh_model_op {
.user_data = _user_data, \
}
/** @def BT_MESH_MODEL_VND_CB
*
/**
* @brief Composition data vendor model entry with callback functions.
*
* @param _company Company ID.
@ -273,8 +271,7 @@ struct bt_mesh_model_op {
}
/** @def BT_MESH_MODEL
*
/**
* @brief Composition data SIG model entry.
*
* @param _id Model ID.
@ -285,8 +282,7 @@ struct bt_mesh_model_op {
#define BT_MESH_MODEL(_id, _op, _pub, _user_data) \
BT_MESH_MODEL_CB(_id, _op, _pub, _user_data, NULL)
/** @def BT_MESH_MODEL_VND
*
/**
* @brief Composition data vendor model entry.
*
* @param _company Company ID.
@ -298,8 +294,7 @@ struct bt_mesh_model_op {
#define BT_MESH_MODEL_VND(_company, _id, _op, _pub, _user_data) \
BT_MESH_MODEL_VND_CB(_company, _id, _op, _pub, _user_data, NULL)
/** @def BT_MESH_TRANSMIT
*
/**
* @brief Encode transmission count & interval steps.
*
* @param count Number of retransmissions (first transmission is excluded).
@ -311,8 +306,7 @@ struct bt_mesh_model_op {
*/
#define BT_MESH_TRANSMIT(count, int_ms) ((count) | (((int_ms / 10) - 1) << 3))
/** @def BT_MESH_TRANSMIT_COUNT
*
/**
* @brief Decode transmit count from a transmit value.
*
* @param transmit Encoded transmit count & interval value.
@ -321,8 +315,7 @@ struct bt_mesh_model_op {
*/
#define BT_MESH_TRANSMIT_COUNT(transmit) (((transmit) & (uint8_t)BIT_MASK(3)))
/** @def BT_MESH_TRANSMIT_INT
*
/**
* @brief Decode transmit interval from a transmit value.
*
* @param transmit Encoded transmit count & interval value.
@ -331,8 +324,7 @@ struct bt_mesh_model_op {
*/
#define BT_MESH_TRANSMIT_INT(transmit) ((((transmit) >> 3) + 1) * 10)
/** @def BT_MESH_PUB_TRANSMIT
*
/**
* @brief Encode Publish Retransmit count & interval steps.
*
* @param count Number of retransmissions (first transmission is excluded).
@ -345,8 +337,7 @@ struct bt_mesh_model_op {
#define BT_MESH_PUB_TRANSMIT(count, int_ms) BT_MESH_TRANSMIT(count, \
(int_ms) / 5)
/** @def BT_MESH_PUB_TRANSMIT_COUNT
*
/**
* @brief Decode Publish Retransmit count from a given value.
*
* @param transmit Encoded Publish Retransmit count & interval value.
@ -355,8 +346,7 @@ struct bt_mesh_model_op {
*/
#define BT_MESH_PUB_TRANSMIT_COUNT(transmit) BT_MESH_TRANSMIT_COUNT(transmit)
/** @def BT_MESH_PUB_TRANSMIT_INT
*
/**
* @brief Decode Publish Retransmit interval from a given value.
*
* @param transmit Encoded Publish Retransmit count & interval value.
@ -365,8 +355,7 @@ struct bt_mesh_model_op {
*/
#define BT_MESH_PUB_TRANSMIT_INT(transmit) ((((transmit) >> 3) + 1) * 50)
/** @def BT_MESH_PUB_MSG_TOTAL
*
/**
* @brief Get total number of messages within one publication interval including initial
* publication.
*
@ -376,8 +365,7 @@ struct bt_mesh_model_op {
*/
#define BT_MESH_PUB_MSG_TOTAL(pub) (BT_MESH_PUB_TRANSMIT_COUNT((pub)->retransmit) + 1)
/** @def BT_MESH_PUB_MSG_NUM
*
/**
* @brief Get message number within one publication interval.
*
* Meant to be used inside @ref bt_mesh_model_pub.update.
@ -445,8 +433,7 @@ struct bt_mesh_model_pub {
struct k_work_delayable timer;
};
/** @def BT_MESH_MODEL_PUB_DEFINE
*
/**
* Define a model publication context.
*
* @param _name Variable name given to the context.

View file

@ -196,8 +196,7 @@ struct bt_mesh_cfg_cli {
struct bt_mesh_msg_ack_ctx ack_ctx;
};
/** @def BT_MESH_MODEL_CFG_CLI
*
/**
* @brief Generic Configuration Client model composition data entry.
*
* @param cli_data Pointer to a @ref bt_mesh_cfg_cli instance.
@ -731,7 +730,7 @@ int bt_mesh_cfg_mod_app_get_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_a
uint16_t mod_id, uint16_t cid, uint8_t *status,
uint16_t *apps, size_t *app_cnt);
/** @def BT_MESH_PUB_PERIOD_100MS
/**
*
* @brief Helper macro to encode model publication period in units of 100ms
*
@ -741,8 +740,7 @@ int bt_mesh_cfg_mod_app_get_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_a
*/
#define BT_MESH_PUB_PERIOD_100MS(steps) ((steps) & BIT_MASK(6))
/** @def BT_MESH_PUB_PERIOD_SEC
*
/**
* @brief Helper macro to encode model publication period in units of 1 second
*
* @param steps Number of 1 second steps.
@ -751,7 +749,7 @@ int bt_mesh_cfg_mod_app_get_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_a
*/
#define BT_MESH_PUB_PERIOD_SEC(steps) (((steps) & BIT_MASK(6)) | (1 << 6))
/** @def BT_MESH_PUB_PERIOD_10SEC
/**
*
* @brief Helper macro to encode model publication period in units of 10
* seconds
@ -762,7 +760,7 @@ int bt_mesh_cfg_mod_app_get_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_a
*/
#define BT_MESH_PUB_PERIOD_10SEC(steps) (((steps) & BIT_MASK(6)) | (2 << 6))
/** @def BT_MESH_PUB_PERIOD_10MIN
/**
*
* @brief Helper macro to encode model publication period in units of 10
* minutes

View file

@ -21,8 +21,7 @@
extern "C" {
#endif
/** @def BT_MESH_MODEL_CFG_SRV
*
/**
* @brief Generic Configuration Server model composition data entry.
*/
#define BT_MESH_MODEL_CFG_SRV \

View file

@ -101,8 +101,7 @@ struct bt_mesh_health_cli {
struct bt_mesh_msg_ack_ctx ack_ctx;
};
/** @def BT_MESH_MODEL_HEALTH_CLI
*
/**
* @brief Generic Health Client model composition data entry.
*
* @param cli_data Pointer to a @ref bt_mesh_health_cli instance.

View file

@ -134,8 +134,7 @@ struct bt_mesh_health_srv_cb {
void (*attn_off)(struct bt_mesh_model *model);
};
/** @def BT_MESH_HEALTH_PUB_DEFINE
*
/**
* A helper to define a health publication context
*
* @param _name Name given to the publication context variable.
@ -156,8 +155,7 @@ struct bt_mesh_health_srv {
struct k_work_delayable attn_timer;
};
/** @def BT_MESH_MODEL_HEALTH_SRV
*
/**
* Define a new health server model. Note that this API needs to be
* repeated for each element that the application wants to have a
* health server model on. Each instance also needs a unique

View file

@ -109,8 +109,7 @@ struct bt_mesh_hb_cb {
void (*pub_sent)(const struct bt_mesh_hb_pub *pub);
};
/** @def BT_MESH_HB_CB_DEFINE
*
/**
* @brief Register a callback structure for Heartbeat events.
*
* Registers a callback structure that will be called whenever Heartbeat

View file

@ -616,8 +616,7 @@ struct bt_mesh_lpn_cb {
void (*polled)(uint16_t net_idx, uint16_t friend_addr, bool retry);
};
/** @def BT_MESH_LPN_CB_DEFINE
*
/**
* @brief Register a callback structure for Friendship events.
*
* @param _name Name of callback structure.
@ -666,8 +665,7 @@ struct bt_mesh_friend_cb {
void (*polled)(uint16_t net_idx, uint16_t lpn_addr);
};
/** @def BT_MESH_FRIEND_CB_DEFINE
*
/**
* @brief Register a callback structure for Friendship events.
*
* Registers a callback structure that will be called whenever Friendship

View file

@ -29,16 +29,14 @@ extern "C" {
/** Length of a long Mesh MIC. */
#define BT_MESH_MIC_LONG 8
/** @def BT_MESH_MODEL_OP_LEN
*
/**
* @brief Helper to determine the length of an opcode.
*
* @param _op Opcode.
*/
#define BT_MESH_MODEL_OP_LEN(_op) ((_op) <= 0xff ? 1 : (_op) <= 0xffff ? 2 : 3)
/** @def BT_MESH_MODEL_BUF_LEN
*
/**
* @brief Helper for model message buffer length.
*
* Returns the length of a Mesh model message buffer, including the opcode
@ -50,8 +48,7 @@ extern "C" {
#define BT_MESH_MODEL_BUF_LEN(_op, _payload_len) \
(BT_MESH_MODEL_OP_LEN(_op) + (_payload_len) + BT_MESH_MIC_SHORT)
/** @def BT_MESH_MODEL_BUF_LEN_LONG_MIC
*
/**
* @brief Helper for model message buffer length.
*
* Returns the length of a Mesh model message buffer, including the opcode
@ -63,8 +60,7 @@ extern "C" {
#define BT_MESH_MODEL_BUF_LEN_LONG_MIC(_op, _payload_len) \
(BT_MESH_MODEL_OP_LEN(_op) + (_payload_len) + BT_MESH_MIC_LONG)
/** @def BT_MESH_MODEL_BUF_DEFINE
*
/**
* @brief Define a Mesh model message buffer using @ref NET_BUF_SIMPLE_DEFINE.
*
* @param _buf Buffer name.

View file

@ -40,8 +40,7 @@ struct bt_mesh_proxy_cb {
void (*identity_disabled)(uint16_t net_idx);
};
/** @def BT_MESH_PROXY_CB_DEFINE
*
/**
* @brief Register a callback structure for Proxy events.
*
* Registers a structure with callback functions that gets called on various

View file

@ -15,8 +15,7 @@ extern "C" {
/** Maximum number of faults the health server can have. */
#define BT_MESH_SHELL_CUR_FAULTS_MAX 4
/** @def BT_MESH_SHELL_HEALTH_PUB_DEFINE
*
/**
* A helper to define a health publication context for shell with the shell's
* maximum number of faults the element can have.
*

View file

@ -298,22 +298,22 @@ struct bt_sdp_record {
* --------------------------------------------------- ------------------
*/
/** @def BT_SDP_ARRAY_8
/**
* @brief Declare an array of 8-bit elements in an attribute.
*/
#define BT_SDP_ARRAY_8(...) ((uint8_t[]) {__VA_ARGS__})
/** @def BT_SDP_ARRAY_16
/**
* @brief Declare an array of 16-bit elements in an attribute.
*/
#define BT_SDP_ARRAY_16(...) ((uint16_t[]) {__VA_ARGS__})
/** @def BT_SDP_ARRAY_32
/**
* @brief Declare an array of 32-bit elements in an attribute.
*/
#define BT_SDP_ARRAY_32(...) ((uint32_t[]) {__VA_ARGS__})
/** @def BT_SDP_TYPE_SIZE
/**
* @brief Declare a fixed-size data element header.
*
* @param _type Data element header containing type and size descriptors.
@ -322,7 +322,7 @@ struct bt_sdp_record {
.data_size = BIT(_type & BT_SDP_SIZE_DESC_MASK), \
.total_size = BIT(_type & BT_SDP_SIZE_DESC_MASK) + 1
/** @def BT_SDP_TYPE_SIZE_VAR
/**
* @brief Declare a variable-size data element header.
*
* @param _type Data element header containing type and size descriptors.
@ -333,13 +333,13 @@ struct bt_sdp_record {
.total_size = BIT((_type & BT_SDP_SIZE_DESC_MASK) - \
BT_SDP_SIZE_INDEX_OFFSET) + _size + 1
/** @def BT_SDP_DATA_ELEM_LIST
/**
* @brief Declare a list of data elements.
*/
#define BT_SDP_DATA_ELEM_LIST(...) ((struct bt_sdp_data_elem[]) {__VA_ARGS__})
/** @def BT_SDP_NEW_SERVICE
/**
* @brief SDP New Service Record Declaration Macro.
*
* Helper macro to declare a new service record.
@ -378,7 +378,7 @@ struct bt_sdp_record {
}
/** @def BT_SDP_LIST
/**
* @brief Generic SDP List Attribute Declaration Macro.
*
* Helper macro to declare a list attribute.
@ -392,7 +392,7 @@ struct bt_sdp_record {
_att_id, { _type_size, _data_elem_seq } \
}
/** @def BT_SDP_SERVICE_ID
/**
* @brief SDP Service ID Attribute Declaration Macro.
*
* Helper macro to declare a service ID attribute.
@ -405,7 +405,7 @@ struct bt_sdp_record {
{ BT_SDP_TYPE_SIZE(BT_SDP_UUID16), &((struct bt_uuid_16) _uuid) } \
}
/** @def BT_SDP_SERVICE_NAME
/**
* @brief SDP Name Attribute Declaration Macro.
*
* Helper macro to declare a service name attribute.
@ -418,7 +418,7 @@ struct bt_sdp_record {
{ BT_SDP_TYPE_SIZE_VAR(BT_SDP_TEXT_STR8, (sizeof(_name)-1)), _name } \
}
/** @def BT_SDP_SUPPORTED_FEATURES
/**
* @brief SDP Supported Features Attribute Declaration Macro.
*
* Helper macro to declare supported features of a profile/protocol.
@ -431,7 +431,7 @@ struct bt_sdp_record {
{ BT_SDP_TYPE_SIZE(BT_SDP_UINT16), BT_SDP_ARRAY_16(_features) } \
}
/** @def BT_SDP_RECORD
/**
* @brief SDP Service Declaration Macro.
*
* Helper macro to declare a service.

View file

@ -51,8 +51,7 @@ struct bt_ias_cb {
*/
int bt_ias_local_alert_stop(void);
/** @def BT_IAS_CB_DEFINE
*
/**
* @brief Register a callback structure for immediate alert events.
*
* @param _name Name of callback structure.

File diff suppressed because it is too large Load diff

View file

@ -11,8 +11,6 @@
#include <zephyr/kernel_structs.h>
/**
* @def SYS_THREAD_MONITOR_HEAD
*
* @brief Head element of the thread monitor list.
*
* @details Access the head element of the thread monitor list.
@ -21,8 +19,6 @@
#define SYS_THREAD_MONITOR_HEAD ((struct k_thread *)(_kernel.threads))
/**
* @def SYS_THREAD_MONITOR_NEXT
*
* @brief Gets a thread node's next element.
*
* @details Given a node in a thread monitor list, gets the next

View file

@ -73,8 +73,6 @@ typedef int16_t device_handle_t;
#define Z_DEVICE_MAX_NAME_LEN 48
/**
* @def DEVICE_NAME_GET
*
* @brief Expands to the name of a global device object.
*
* @details Return the full name of a device object symbol created by
@ -122,8 +120,6 @@ typedef int16_t device_handle_t;
__attribute__((__section__(".z_devstate")));
/**
* @def DEVICE_DEFINE
*
* @brief Create a device object and set it up for boot time initialization.
*
* @details This macro defines a <tt>struct device</tt> that is
@ -173,8 +169,6 @@ typedef int16_t device_handle_t;
&Z_DEVICE_STATE_NAME(dev_name))
/**
* @def DEVICE_DT_NAME
*
* @brief Return a string name for a devicetree node.
*
* @details This macro returns a string literal usable as a device's
@ -189,8 +183,6 @@ typedef int16_t device_handle_t;
DT_PROP_OR(node_id, label, DT_NODE_FULL_NAME(node_id))
/**
* @def DEVICE_DT_DEFINE
*
* @brief Create a device object from a devicetree node identifier and
* set it up for boot time initialization.
*
@ -244,8 +236,6 @@ typedef int16_t device_handle_t;
__VA_ARGS__)
/**
* @def DEVICE_DT_INST_DEFINE
*
* @brief Like DEVICE_DT_DEFINE(), but uses an instance of a
* DT_DRV_COMPAT compatible instead of a node identifier.
*
@ -258,8 +248,6 @@ typedef int16_t device_handle_t;
DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
/**
* @def DEVICE_DT_NAME_GET
*
* @brief The name of the global device object for @p node_id
*
* @details Returns the name of the global device structure as a C
@ -277,8 +265,6 @@ typedef int16_t device_handle_t;
#define DEVICE_DT_NAME_GET(node_id) DEVICE_NAME_GET(Z_DEVICE_DT_DEV_NAME(node_id))
/**
* @def DEVICE_DT_GET
*
* @brief Get a <tt>const struct device*</tt> from a devicetree node
* identifier
*
@ -296,8 +282,7 @@ typedef int16_t device_handle_t;
*/
#define DEVICE_DT_GET(node_id) (&DEVICE_DT_NAME_GET(node_id))
/** @def DEVICE_DT_INST_GET
*
/**
* @brief Get a <tt>const struct device*</tt> for an instance of a
* DT_DRV_COMPAT compatible
*
@ -309,8 +294,6 @@ typedef int16_t device_handle_t;
#define DEVICE_DT_INST_GET(inst) DEVICE_DT_GET(DT_DRV_INST(inst))
/**
* @def DEVICE_DT_GET_ANY
*
* @brief Get a <tt>const struct device*</tt> from a devicetree compatible
*
* If an enabled devicetree node has the given compatible and a device
@ -332,8 +315,6 @@ typedef int16_t device_handle_t;
(NULL))
/**
* @def DEVICE_DT_GET_ONE
*
* @brief Get a <tt>const struct device*</tt> from a devicetree compatible
*
* @details If an enabled devicetree node has the given compatible and
@ -356,8 +337,6 @@ typedef int16_t device_handle_t;
(ZERO_OR_COMPILE_ERROR(0)))
/**
* @def DEVICE_DT_GET_OR_NULL
*
* @brief Utility macro to obtain an optional reference to a device.
*
* @details If the node identifier refers to a node with status
@ -374,8 +353,6 @@ typedef int16_t device_handle_t;
(DEVICE_DT_GET(node_id)), (NULL))
/**
* @def DEVICE_GET
*
* @brief Obtain a pointer to a device object by name
*
* @details Return the address of a device object created by
@ -387,8 +364,7 @@ typedef int16_t device_handle_t;
*/
#define DEVICE_GET(name) (&DEVICE_NAME_GET(name))
/** @def DEVICE_DECLARE
*
/**
* @brief Declare a static device object
*
* This macro can be used at the top-level to declare a device, such
@ -405,8 +381,6 @@ typedef int16_t device_handle_t;
#define DEVICE_DECLARE(name) static const struct device DEVICE_NAME_GET(name)
/**
* @def DEVICE_INIT_DT_GET
*
* @brief Get a <tt>const struct init_entry*</tt> from a devicetree node
*
* @param node_id A devicetree node identifier
@ -416,8 +390,6 @@ typedef int16_t device_handle_t;
#define DEVICE_INIT_DT_GET(node_id) (&Z_INIT_ENTRY_NAME(DEVICE_DT_NAME_GET(node_id)))
/**
* @def DEVICE_INIT_GET
*
* @brief Get a <tt>const struct init_entry*</tt> from a device by name
*
* @param name The same as dev_name provided to DEVICE_DEFINE()

View file

@ -32,8 +32,6 @@
#ifdef DT_DOXYGEN
/**
* @def DT_CHOSEN_ZEPHYR_ENTROPY_LABEL
*
* @deprecated Use @c DT_LABEL(DT_CHOSEN(zephyr_entropy)) instead. If used to
* to obtain a device instance with device_get_binding(), consider using
* @c DEVICE_DT_GET(DT_CHOSEN(zephyr_entropy)).
@ -44,8 +42,6 @@
#define DT_CHOSEN_ZEPHYR_ENTROPY_LABEL ""
/**
* @def DT_CHOSEN_ZEPHYR_FLASH_CONTROLLER_LABEL
*
* @deprecated Use @c DT_LABEL(DT_CHOSEN(zephyr_flash_controller)) instead. If
* used to to obtain a device instance with device_get_binding(), consider using
* @c DEVICE_DT_GET(DT_CHOSEN(zephyr_flash_controller)).

View file

@ -69,7 +69,7 @@ enum mb_display_mode {
};
/**
* @def MB_IMAGE
*
* @brief Generate an image object from a given array rows/columns.
*
* This helper takes an array of 5 rows, each consisting of 5 0/1 values which

View file

@ -54,8 +54,6 @@ struct init_entry {
void z_sys_init_run_level(int32_t level);
/**
* @def Z_SYS_NAME
*
* @brief Construct a namespaced identifier for SYS_INIT instance
*
* @param _name Base unique name
@ -63,8 +61,6 @@ void z_sys_init_run_level(int32_t level);
#define Z_SYS_NAME(_name) _CONCAT(sys_init_, _name)
/**
* @def Z_INIT_ENTRY_NAME
*
* @brief Construct a namespaced identifier for @ref init_entry instance
*
* @param _entry_name Base unique name
@ -72,8 +68,6 @@ void z_sys_init_run_level(int32_t level);
#define Z_INIT_ENTRY_NAME(_entry_name) _CONCAT(__init_, _entry_name)
/**
* @def Z_INIT_ENTRY_DEFINE
*
* @brief Create an init entry object and set it up for boot time initialization
*
* @details This macro defines an init entry object that will be automatically
@ -104,8 +98,6 @@ void z_sys_init_run_level(int32_t level);
}
/**
* @def SYS_INIT
*
* @ingroup device_model
*
* @brief Run an initialization function at boot at specified priority
@ -149,8 +141,6 @@ void z_sys_init_run_level(int32_t level);
SYS_INIT_NAMED(_init_fn, _init_fn, _level, _prio)
/**
* @def SYS_INIT_NAMED
*
* @ingroup device_model
*
* @brief Run an initialization function at boot at specified priority

View file

@ -257,8 +257,6 @@ void z_smp_global_unlock(unsigned int key);
/**
* @brief Return IRQ level
* @def irq_get_level()
*
* This routine returns the interrupt level number of the provided interrupt.
*
* @param irq IRQ number in its zephyr format
@ -282,7 +280,7 @@ static inline unsigned int irq_get_level(unsigned int irq)
#ifdef CONFIG_2ND_LEVEL_INTERRUPTS
/**
* @brief Return the 2nd level interrupt number
* @def irq_from_level_2()
*
*
* This routine returns the second level irq number of the zephyr irq
* number passed in
@ -302,7 +300,7 @@ static inline unsigned int irq_from_level_2(unsigned int irq)
/**
* @brief Converts irq from level 1 to level 2 format
* @def irq_to_level_2()
*
*
* This routine converts the input into the level 2 irq number format
*
@ -319,7 +317,7 @@ static inline unsigned int irq_to_level_2(unsigned int irq)
/**
* @brief Returns the parent IRQ of the level 2 raw IRQ number
* @def irq_parent_level_2()
*
*
* The parent of a 2nd level interrupt is in the 1st byte
*
@ -336,7 +334,7 @@ static inline unsigned int irq_parent_level_2(unsigned int irq)
#ifdef CONFIG_3RD_LEVEL_INTERRUPTS
/**
* @brief Return the 3rd level interrupt number
* @def irq_from_level_3()
*
*
* This routine returns the third level irq number of the zephyr irq
* number passed in
@ -352,7 +350,7 @@ static inline unsigned int irq_from_level_3(unsigned int irq)
/**
* @brief Converts irq from level 1 to level 3 format
* @def irq_to_level_3()
*
*
* This routine converts the input into the level 3 irq number format
*
@ -369,7 +367,7 @@ static inline unsigned int irq_to_level_3(unsigned int irq)
/**
* @brief Returns the parent IRQ of the level 3 raw IRQ number
* @def irq_parent_level_3()
*
*
* The parent of a 3rd level interrupt is in the 2nd byte
*

View file

@ -95,7 +95,7 @@ extern "C" {
#define _LOG_ZZZZ4U _LOG_YYYY,
/**
* @def LOG_CURRENT_MODULE_ID
*
* @brief Macro for getting ID of current module.
*/
#define LOG_CURRENT_MODULE_ID() (__log_level != 0 ? \

View file

@ -19,7 +19,7 @@
*/
/**
* @def ilog2_compile_time_const_u32(n)
*
* @brief Calculate the floor of log2 for compile time constant
*
* This calculates the floor of log2 (integer log2) for 32-bit
@ -73,7 +73,7 @@
)
/**
* @def ilog2(n)
*
* @brief Calculate integer log2
*
* This calculates the floor of log2 (integer of log2).

View file

@ -63,7 +63,7 @@ struct ec_host_cmd_handler {
};
/**
* @def EC_HOST_CMD_HANDLER
*
* @brief Statically define and register a host command handler.
*
* Helper macro to statically define and register a host command handler that
@ -88,7 +88,7 @@ struct ec_host_cmd_handler {
}
/**
* @def EC_HOST_CMD_HANDLER_UNBOUND
*
* @brief Statically define and register a host command handler without sizes.
*
* Helper macro to statically define and register a host command handler whose

View file

@ -30,7 +30,6 @@ extern "C" {
#define __net_buf_align __aligned(sizeof(void *))
/**
* @def NET_BUF_SIMPLE_DEFINE
* @brief Define a net_buf_simple stack variable.
*
* This is a helper macro which is used to define a net_buf_simple object
@ -49,7 +48,7 @@ extern "C" {
}
/**
* @def NET_BUF_SIMPLE_DEFINE_STATIC
*
* @brief Define a static net_buf_simple variable.
*
* This is a helper macro which is used to define a static net_buf_simple
@ -101,7 +100,7 @@ struct net_buf_simple {
};
/**
* @def NET_BUF_SIMPLE
*
* @brief Define a net_buf_simple stack variable and get a pointer to it.
*
* This is a helper macro which is used to define a net_buf_simple object on
@ -1062,7 +1061,7 @@ extern const struct net_buf_data_alloc net_buf_heap_alloc;
/** @endcond */
/**
* @def NET_BUF_POOL_HEAP_DEFINE
*
* @brief Define a new pool for buffers using the heap for the data.
*
* Defines a net_buf_pool struct and the necessary memory storage (array of
@ -1105,7 +1104,7 @@ extern const struct net_buf_data_cb net_buf_fixed_cb;
/** @endcond */
/**
* @def NET_BUF_POOL_FIXED_DEFINE
*
* @brief Define a new pool for buffers based on fixed-size data
*
* Defines a net_buf_pool struct and the necessary memory storage (array of
@ -1153,7 +1152,7 @@ extern const struct net_buf_data_cb net_buf_var_cb;
/** @endcond */
/**
* @def NET_BUF_POOL_VAR_DEFINE
*
* @brief Define a new pool for buffers with variable size payloads
*
* Defines a net_buf_pool struct and the necessary memory storage (array of
@ -1189,7 +1188,7 @@ extern const struct net_buf_data_cb net_buf_var_cb;
_destroy)
/**
* @def NET_BUF_POOL_DEFINE
*
* @brief Define a new pool for buffers
*
* Defines a net_buf_pool struct and the necessary memory storage (array of

View file

@ -851,8 +851,6 @@ static inline bool net_eth_get_vlan_status(struct net_if *iface)
#endif /* CONFIG_NET_VLAN */
/**
* @def ETH_NET_DEVICE_INIT
*
* @brief Create an Ethernet network interface and bind it to network device.
*
* @param dev_name Network device name.
@ -876,8 +874,6 @@ static inline bool net_eth_get_vlan_status(struct net_if *iface)
api, mtu)
/**
* @def ETH_NET_DEVICE_DT_DEFINE
*
* @brief Like ETH_NET_DEVICE_INIT but taking metadata from a devicetree.
* Create an Ethernet network interface and bind it to network device.
*
@ -901,8 +897,6 @@ static inline bool net_eth_get_vlan_status(struct net_if *iface)
api, mtu)
/**
* @def ETH_NET_DEVICE_DT_INST_DEFINE
*
* @brief Like ETH_NET_DEVICE_DT_DEFINE for an instance of a DT_DRV_COMPAT
* compatible
*

View file

@ -2319,8 +2319,6 @@ struct net_if_api {
NET_IF_INIT(dev_name, 0, l2, mtu, NET_IF_MAX_CONFIGS)
/**
* @def NET_DEVICE_INIT
*
* @brief Create a network interface and bind it to network device.
*
* @param dev_name Network device name.
@ -2347,8 +2345,6 @@ struct net_if_api {
l2_ctx_type, mtu)
/**
* @def NET_DEVICE_DT_DEFINE
*
* @brief Like NET_DEVICE_INIT but taking metadata from a devicetree node.
* Create a network interface and bind it to network device.
*
@ -2374,8 +2370,6 @@ struct net_if_api {
l2_ctx_type, mtu)
/**
* @def NET_DEVICE_DT_INST_DEFINE
*
* @brief Like NET_DEVICE_DT_DEFINE for an instance of a DT_DRV_COMPAT compatible
*
* @param inst instance number. This is replaced by
@ -2398,8 +2392,6 @@ struct net_if_api {
NET_IF_INIT(dev_name, instance, l2, mtu, NET_IF_MAX_CONFIGS)
/**
* @def NET_DEVICE_INIT_INSTANCE
*
* @brief Create multiple network interfaces and bind them to network device.
* If your network device needs more than one instance of a network interface,
* use this macro below and provide a different instance suffix each time
@ -2431,8 +2423,6 @@ struct net_if_api {
l2_ctx_type, mtu)
/**
* @def NET_DEVICE_DT_DEFINE_INSTANCE
*
* @brief Like NET_DEVICE_OFFLOAD_INIT but taking metadata from a devicetree.
* Create multiple network interfaces and bind them to network device.
* If your network device needs more than one instance of a network interface,
@ -2465,8 +2455,6 @@ struct net_if_api {
l2, l2_ctx_type, mtu)
/**
* @def NET_DEVICE_DT_INST_DEFINE_INSTANCE
*
* @brief Like NET_DEVICE_DT_DEFINE_INSTANCE for an instance of a DT_DRV_COMPAT
* compatible
*
@ -2488,8 +2476,6 @@ struct net_if_api {
NET_IF_OFFLOAD_INIT(dev_name, 0, mtu)
/**
* @def NET_DEVICE_OFFLOAD_INIT
*
* @brief Create a offloaded network interface and bind it to network device.
* The offloaded network interface is implemented by a device vendor HAL or
* similar.
@ -2515,8 +2501,6 @@ struct net_if_api {
api, mtu)
/**
* @def NET_DEVICE_DT_OFFLOAD_DEFINE
*
* @brief Like NET_DEVICE_OFFLOAD_INIT but taking metadata from a devicetree
* node. Create a offloaded network interface and bind it to network device.
* The offloaded network interface is implemented by a device vendor HAL or
@ -2542,8 +2526,6 @@ struct net_if_api {
prio, api, mtu)
/**
* @def NET_DEVICE_DT_INST_OFFLOAD_DEFINE
*
* @brief Like NET_DEVICE_DT_OFFLOAD_DEFINE for an instance of a DT_DRV_COMPAT
* compatible
*

View file

@ -731,7 +731,6 @@ static inline bool net_ipv4_is_ll_addr(const struct in_addr *addr)
}
/**
* @def net_ipaddr_copy
* @brief Copy an IPv4 or IPv6 address
*
* @param dest Destination IP address.

View file

@ -283,8 +283,6 @@ net_virtual_get_iface_capabilities(struct net_if *iface)
/** @endcond */
/**
* @def NET_VIRTUAL_INTERFACE_INIT
*
* @brief Create a virtual network interface. Binding to another interface
* is done at runtime by calling net_virtual_interface_attach().
* The attaching is done automatically when setting up tunneling

View file

@ -33,8 +33,6 @@ struct sys_bitarray {
typedef struct sys_bitarray sys_bitarray_t;
/**
* @def _SYS_BITARRAY_DEFINE
*
* @brief Create a bitarray object.
*
* @param name Name of the bitarray object.
@ -54,8 +52,6 @@ typedef struct sys_bitarray sys_bitarray_t;
}
/**
* @def SYS_BITARRAY_DEFINE
*
* @brief Create a bitarray object.
*
* @param name Name of the bitarray object.
@ -65,8 +61,6 @@ typedef struct sys_bitarray sys_bitarray_t;
_SYS_BITARRAY_DEFINE(name, total_bits,)
/**
* @def SYS_BITARRAY_DEFINE_STATIC
*
* @brief Create a static bitarray object.
*
* @param name Name of the bitarray object.

View file

@ -173,8 +173,6 @@ struct z_device_mmio_rom {
#ifdef DEVICE_MMIO_IS_IN_RAM
/**
* @def DEVICE_MMIO_RAM_PTR(device)
*
* Return a pointer to the RAM-based storage area for a device's MMIO
* address.
*
@ -188,8 +186,6 @@ struct z_device_mmio_rom {
#endif /* DEVICE_MMIO_IS_IN_RAM */
/**
* @def DEVICE_MMIO_ROM
*
* @brief Declare storage for MMIO data within a device's config struct
*
* This gets accessed by DEVICE_MMIO_MAP() and DEVICE_MMIO_GET() macros.
@ -218,8 +214,6 @@ struct z_device_mmio_rom {
#define DEVICE_MMIO_ROM struct z_device_mmio_rom _mmio
/**
* @def DEVICE_MMIO_ROM_PTR(dev)
*
* Return a pointer to the ROM-based storage area for a device's MMIO
* information. This macro will not work properly if the ROM storage
* was omitted from the config struct declaration, and should not
@ -232,8 +226,6 @@ struct z_device_mmio_rom {
((struct z_device_mmio_rom *)((dev)->config))
/**
* @def DEVICE_MMIO_ROM_INIT(node_id)
*
* @brief Initialize a DEVICE_MMIO_ROM member
*
* Initialize MMIO-related information within a specific instance of
@ -354,8 +346,6 @@ struct z_device_mmio_rom {
#ifdef DEVICE_MMIO_IS_IN_RAM
/**
* @def DEVICE_MMIO_NAMED_RAM_PTR(dev, name)
*
* @brief Return a pointer to the RAM storage for a device's named MMIO address
*
* This macro requires that the macro DEV_DATA is locally defined and returns
@ -370,8 +360,6 @@ struct z_device_mmio_rom {
#endif /* DEVICE_MMIO_IS_IN_RAM */
/**
* @def DEVICE_MMIO_NAMED_ROM(name)
*
* @brief Declare storage for MMIO data within a device's config struct.
*
* This gets accessed by DEVICE_MMIO_NAMED_MAP() and
@ -405,8 +393,6 @@ struct z_device_mmio_rom {
#define DEVICE_MMIO_NAMED_ROM(name) struct z_device_mmio_rom name
/**
* @def DEVICE_MMIO_NAMED_ROM_PTR(dev, name)
*
* Return a pointer to the ROM-based storage area for a device's MMIO
* information.
*
@ -421,8 +407,6 @@ struct z_device_mmio_rom {
#define DEVICE_MMIO_NAMED_ROM_PTR(dev, name) (&(DEV_CFG(dev)->name))
/**
* @def DEVICE_MMIO_NAMED_ROM_INIT(name, node_id)
*
* @brief Initialize a named DEVICE_MMIO_NAMED_ROM member
*
* Initialize MMIO-related information within a specific instance of
@ -448,8 +432,6 @@ struct z_device_mmio_rom {
.name = Z_DEVICE_MMIO_ROM_INITIALIZER(node_id)
/**
* @def DEVICE_MMIO_NAMED_ROM_INIT_BY_NAME(name, node_id)
*
* @brief Initialize a named DEVICE_MMIO_NAMED_ROM member using a named DT
* reg property.
*
@ -491,8 +473,6 @@ struct z_device_mmio_rom {
.name = Z_DEVICE_MMIO_NAMED_ROM_INITIALIZER(name, node_id)
/**
* @def DEVICE_MMIO_NAMED_MAP(dev, name, flags)
*
* @brief Set up memory for a named MMIO region
*
* This performs the necessary PCI probing and/or MMU virtual memory mapping
@ -661,8 +641,6 @@ struct z_device_mmio_rom {
#ifdef DEVICE_MMIO_IS_IN_RAM
/**
* @def DEVICE_MMIO_TOPLEVEL_RAM_PTR(name)
*
* @brief Return a pointer to the RAM storage for a device's toplevel MMIO
* address.
*
@ -673,8 +651,6 @@ struct z_device_mmio_rom {
#endif /* DEVICE_MMIO_IS_IN_RAM */
/**
* @def DEVICE_MMIO_TOPLEVEL_ROM_PTR(name)
*
* Return a pointer to the ROM-based storage area for a toplevel MMIO region.
*
* @param name MMIO region name

View file

@ -112,8 +112,6 @@ struct sys_multi_mem_blocks {
};
/**
* @def _SYS_MEM_BLOCKS_DEFINE_WITH_EXT_BUF
*
* @brief Create a memory block object with a providing backing buffer.
*
* @param name Name of the memory block object.
@ -133,8 +131,6 @@ struct sys_multi_mem_blocks {
}
/**
* @def _SYS_MEM_BLOCKS_DEFINE
*
* @brief Create a memory block object with a new backing buffer.
*
* @param name Name of the memory block object.
@ -156,8 +152,6 @@ struct sys_multi_mem_blocks {
*/
/**
* @def SYS_MEM_BLOCKS_DEFINE
*
* @brief Create a memory block object with a new backing buffer.
*
* @param name Name of the memory block object.
@ -169,8 +163,6 @@ struct sys_multi_mem_blocks {
_SYS_MEM_BLOCKS_DEFINE(name, blk_sz, num_blks, buf_align,)
/**
* @def SYS_MEM_BLOCKS_DEFINE_STATIC
*
* @brief Create a static memory block object with a new backing buffer.
*
* @param name Name of the memory block object.
@ -183,8 +175,6 @@ struct sys_multi_mem_blocks {
/**
* @def SYS_MEM_BLOCKS_DEFINE_WITH_EXT_BUF
*
* @brief Create a memory block object with a providing backing buffer.
*
* @param name Name of the memory block object.
@ -196,8 +186,6 @@ struct sys_multi_mem_blocks {
_SYS_MEM_BLOCKS_DEFINE_WITH_EXT_BUF(name, blk_sz, num_blks, buf,)
/**
* @def SYS_MEM_BLOCKS_DEFINE_STATIC_WITH_EXT_BUF
*
* @brief Create a static memory block object with a providing backing buffer.
*
* @param name Name of the memory block object.

View file

@ -251,8 +251,6 @@ void z_phys_unmap(uint8_t *virt, size_t size);
*/
/**
* @def K_MEM_MAP_UNINIT
*
* @brief The mapped region is not guaranteed to be zeroed.
*
* This may improve performance. The associated page frames may contain
@ -264,8 +262,6 @@ void z_phys_unmap(uint8_t *virt, size_t size);
#define K_MEM_MAP_UNINIT BIT(16)
/**
* @def K_MEM_MAP_LOCK
*
* Region will be pinned in memory and never paged
*
* Such memory is guaranteed to never produce a page fault due to page-outs
@ -275,8 +271,6 @@ void z_phys_unmap(uint8_t *virt, size_t size);
#define K_MEM_MAP_LOCK BIT(17)
/**
* @def K_MEM_MAP_GUARD
*
* A un-mapped virtual guard page will be placed in memory immediately preceding
* the mapped region. This page will still be noted as being used by the
* virtual memory manager. The total size of the allocation will be the

View file

@ -185,8 +185,6 @@
_SYS_PORT_TRACING_TYPE_MASK(type)(trace_call)
/**
* @def SYS_PORT_TRACING_FUNC
*
* @brief Tracing macro for function calls which are not directly
* associated with a specific type of object.
*
@ -202,8 +200,6 @@
} while (false)
/**
* @def SYS_PORT_TRACING_FUNC_ENTER
*
* @brief Tracing macro for the entry into a function that might or might not return
* a value.
*
@ -219,8 +215,6 @@
} while (false)
/**
* @def SYS_PORT_TRACING_FUNC_BLOCKING
*
* @brief Tracing macro for when a function blocks during its execution.
*
* @param type Type of tracing event or object type
@ -235,8 +229,6 @@
} while (false)
/**
* @def SYS_PORT_TRACING_FUNC_EXIT
*
* @brief Tracing macro for when a function ends its execution. Potential return values
* can be given as additional arguments.
*
@ -252,8 +244,6 @@
} while (false)
/**
* @def SYS_PORT_TRACING_OBJ_INIT
*
* @brief Tracing macro for the initialization of an object.
*
* @param obj_type The type of object associated with the call (k_thread, k_sem, k_mutex etc.)

View file

@ -20,8 +20,7 @@ struct bt_mesh_app_key_cb {
enum bt_mesh_key_evt evt);
};
/** @def BT_MESH_APP_KEY_CB
*
/**
* @brief Register an AppKey event callback.
*
* @param _handler Handler function, see @ref bt_mesh_app_key_cb::evt_handler.

View file

@ -73,8 +73,7 @@ struct bt_mesh_subnet_cb {
enum bt_mesh_key_evt evt);
};
/** @def BT_MESH_SUBNET_CB
*
/**
* @brief Register a subnet event callback.
*
* @param _name Handler name.

View file

@ -22,7 +22,7 @@ extern "C" {
#include <zephyr/bluetooth/gatt.h>
/** @def BT_GATT_H_ATTRIBUTE
/**
* @brief Attribute Declaration Macro.
*
* Helper macro to declare an attribute.
@ -44,7 +44,7 @@ extern "C" {
.handle = _handle \
}
/** @def BT_GATT_H_CHARACTERISTIC
/**
* @brief Characteristic and Value Declaration Macro.
*
* Helper macro to declare a characteristic attribute along with its attribute
@ -70,7 +70,7 @@ extern "C" {
_handle), \
BT_GATT_H_ATTRIBUTE(_uuid, _perm, _read, _write, _value, _handle + 1)
/** @def BT_GATT_H_PRIMARY_SERVICE
/**
* @brief Primary Service Declaration Macro.
*
* Helper macro to declare a primary service attribute.
@ -86,7 +86,7 @@ extern "C" {
_service, \
_handle)
/** @def BT_GATT_H_SECONDARY_SERVICE
/**
* @brief Secondary Service Declaration Macro.
*
* Helper macro to declare a secondary service attribute.
@ -102,7 +102,7 @@ extern "C" {
_service, \
_handle)
/** @def BT_GATT_H_INCLUDE_SERVICE
/**
* @brief Include Service Declaration Macro.
*
* Helper macro to declare database internal include service attribute.
@ -118,7 +118,7 @@ extern "C" {
_service_incl, \
_handle)
/** @def BT_GATT_H_DESCRIPTOR
/**
* @brief Descriptor Declaration Macro.
*
* Helper macro to declare a descriptor attribute.
@ -133,7 +133,7 @@ extern "C" {
#define BT_GATT_H_DESCRIPTOR(_uuid, _perm, _read, _write, _value, _handle) \
BT_GATT_H_ATTRIBUTE(_uuid, _perm, _read, _write, _value, _handle)
/** @def BT_GATT_H_MANAGED
/**
* @brief Managed Client Characteristic Configuration Declaration Macro.
*
* Helper macro to declare a Managed CCC attribute.
@ -146,7 +146,7 @@ extern "C" {
BT_GATT_H_ATTRIBUTE(BT_UUID_GATT_CCC, _perm,\
bt_gatt_attr_read_ccc, bt_gatt_attr_write_ccc, _ccc, _handle)
/** @def BT_GATT_H_CCC
/**
* @brief Client Characteristic Configuration Change Declaration Macro.
*
* Helper macro to declare a CCC attribute.
@ -168,7 +168,7 @@ extern "C" {
* } ), \
* _handle)
*/
/** @def BT_GATT_H_CCC
/**
* @brief Client Characteristic Configuration Change Declaration Macro.
*
* Helper macro to declare a CCC attribute.
@ -182,7 +182,7 @@ extern "C" {
BT_GATT_CCC_INITIALIZER(_cfg_changed, NULL, NULL)),\
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE, _handle)
/** @def BT_GATT_H_CEP
/**
* @brief Characteristic Extended Properties Declaration Macro.
*
* Helper macro to declare a CEP attribute.
@ -198,7 +198,7 @@ extern "C" {
(void *)_value, \
_handle)
/** @def BT_GATT_H_CUD
/**
* @brief Characteristic User Format Descriptor Declaration Macro.
*
* Helper macro to declare a CUD attribute.
@ -215,7 +215,7 @@ extern "C" {
(void *)_value, \
_handle)
/** @def BT_GATT_H_CPF
/**
* @brief Characteristic Presentation Format Descriptor Declaration Macro.
*
* Helper macro to declare a CPF attribute.

View file

@ -18,22 +18,22 @@
extern struct bt_gatt_attr service_d_1_attrs[];
/** @def BT_UUID_SERVICE_A
/**
* @brief UUID for the Service A
*/
#define BT_UUID_SERVICE_A BT_UUID_DECLARE_16(0xa00a)
/** @def BT_UUID_VALUE_V1
/**
* @brief UUID for the Value V1 Characteristic
*/
#define BT_UUID_VALUE_V1 BT_UUID_DECLARE_16(0xb001)
/** @def BT_UUID_VALUE_V2
/**
* @brief UUID for the Value V2 Characteristic
*/
#define BT_UUID_VALUE_V2 BT_UUID_DECLARE_16(0xb002)
/** @def BT_UUID_VALUE_V3
/**
* @brief UUID for the Value V3 Characteristic
*/
#define BT_UUID_VALUE_V3 BT_UUID_DECLARE_16(0xb003)

View file

@ -19,22 +19,22 @@
extern struct bt_gatt_attr service_d_2_attrs[];
extern struct bt_gatt_attr service_c_1_2_attrs[];
/** @def BT_UUID_SERVICE_A
/**
* @brief UUID for the Service A
*/
#define BT_UUID_SERVICE_A BT_UUID_DECLARE_16(0xa00a)
/** @def BT_UUID_VALUE_V1
/**
* @brief UUID for the Value V1 Characteristic
*/
#define BT_UUID_VALUE_V1 BT_UUID_DECLARE_16(0xb001)
/** @def BT_UUID_VALUE_V2
/**
* @brief UUID for the Value V2 Characteristic
*/
#define BT_UUID_VALUE_V2 BT_UUID_DECLARE_16(0xb002)
/** @def BT_UUID_VALUE_V3
/**
* @brief UUID for the Value V3 Characteristic
*/
#define BT_UUID_VALUE_V3 BT_UUID_DECLARE_16(0xb003)

View file

@ -19,22 +19,22 @@
extern struct bt_gatt_attr service_d_3_attrs[];
extern struct bt_gatt_attr service_c_1_3_attrs[];
/** @def BT_UUID_SERVICE_A
/**
* @brief UUID for the Service A
*/
#define BT_UUID_SERVICE_A BT_UUID_DECLARE_16(0xa00a)
/** @def BT_UUID_VALUE_V1
/**
* @brief UUID for the Value V1 Characteristic
*/
#define BT_UUID_VALUE_V1 BT_UUID_DECLARE_16(0xb001)
/** @def BT_UUID_VALUE_V2
/**
* @brief UUID for the Value V2 Characteristic
*/
#define BT_UUID_VALUE_V2 BT_UUID_DECLARE_16(0xb002)
/** @def BT_UUID_VALUE_V3
/**
* @brief UUID for the Value V3 Characteristic
*/
#define BT_UUID_VALUE_V3 BT_UUID_DECLARE_16(0xb003)

View file

@ -16,17 +16,17 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_1
/**
* @brief UUID for the Service B.1
*/
#define BT_UUID_SERVICE_B_1 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V4
/**
* @brief UUID for the Value V4 Characteristic
*/
#define BT_UUID_VALUE_V4 BT_UUID_DECLARE_16(0xb004)
/** @def BT_UUID_LONG_DES_V2D1
/**
* @brief UUID for the Long descriptor V2D1 Characteristic
*/
#define BT_UUID_LONG_DES_V2D1 BT_UUID_DECLARE_16(0xb012)

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_1
/**
* @brief UUID for the Service B.1
*/
#define BT_UUID_SERVICE_B_1 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V4
/**
* @brief UUID for the Value V4 Characteristic
*/
#define BT_UUID_VALUE_V4 BT_UUID_DECLARE_16(0xb004)

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_1
/**
* @brief UUID for the Service B.1
*/
#define BT_UUID_SERVICE_B_1 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V4
/**
* @brief UUID for the Value V4 Characteristic
*/
#define BT_UUID_VALUE_V4 BT_UUID_DECLARE_16(0xb004)

View file

@ -16,17 +16,17 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_2
/**
* @brief UUID for the Service B.2
*/
#define BT_UUID_SERVICE_B_2 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V5
/**
* @brief UUID for the Value V5 Characteristic
*/
#define BT_UUID_VALUE_V5 BT_UUID_DECLARE_16(0xb005)
/** @def BT_UUID_DES_V5D4__128_BIT_UUID
/**
* @brief UUID for the Descriptor V5D4 (128-bit UUID) Characteristic
*/
#define BT_UUID_DES_V5D4__128_BIT_UUID BT_UUID_DECLARE_128( \

View file

@ -16,17 +16,17 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_2
/**
* @brief UUID for the Service B.2
*/
#define BT_UUID_SERVICE_B_2 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V5
/**
* @brief UUID for the Value V5 Characteristic
*/
#define BT_UUID_VALUE_V5 BT_UUID_DECLARE_16(0xb005)
/** @def BT_UUID_DES_V5D4__128_BIT_UUID
/**
* @brief UUID for the Descriptor V5D4 (128-bit UUID) Characteristic
*/
#define BT_UUID_DES_V5D4__128_BIT_UUID BT_UUID_DECLARE_128( \

View file

@ -16,17 +16,17 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_2
/**
* @brief UUID for the Service B.2
*/
#define BT_UUID_SERVICE_B_2 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V5
/**
* @brief UUID for the Value V5 Characteristic
*/
#define BT_UUID_VALUE_V5 BT_UUID_DECLARE_16(0xb005)
/** @def BT_UUID_DES_V5D4__128_BIT_UUID
/**
* @brief UUID for the Descriptor V5D4 (128-bit UUID) Characteristic
*/
#define BT_UUID_DES_V5D4__128_BIT_UUID BT_UUID_DECLARE_128( \

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_3
/**
* @brief UUID for the Service B.3
*/
#define BT_UUID_SERVICE_B_3 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V6
/**
* @brief UUID for the Value V6 Characteristic
*/
#define BT_UUID_VALUE_V6 BT_UUID_DECLARE_16(0xb006)

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_3
/**
* @brief UUID for the Service B.3
*/
#define BT_UUID_SERVICE_B_3 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V6
/**
* @brief UUID for the Value V6 Characteristic
*/
#define BT_UUID_VALUE_V6 BT_UUID_DECLARE_16(0xb006)

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_3
/**
* @brief UUID for the Service B.3
*/
#define BT_UUID_SERVICE_B_3 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V6
/**
* @brief UUID for the Value V6 Characteristic
*/
#define BT_UUID_VALUE_V6 BT_UUID_DECLARE_16(0xb006)

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_4
/**
* @brief UUID for the Service B.4
*/
#define BT_UUID_SERVICE_B_4 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V7
/**
* @brief UUID for the Value V7 Characteristic
*/
#define BT_UUID_VALUE_V7 BT_UUID_DECLARE_16(0xb007)

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_4
/**
* @brief UUID for the Service B.4
*/
#define BT_UUID_SERVICE_B_4 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V7
/**
* @brief UUID for the Value V7 Characteristic
*/
#define BT_UUID_VALUE_V7 BT_UUID_DECLARE_16(0xb007)

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_4
/**
* @brief UUID for the Service B.4
*/
#define BT_UUID_SERVICE_B_4 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V7
/**
* @brief UUID for the Value V7 Characteristic
*/
#define BT_UUID_VALUE_V7 BT_UUID_DECLARE_16(0xb007)

View file

@ -16,27 +16,27 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_5
/**
* @brief UUID for the Service B.5
*/
#define BT_UUID_SERVICE_B_5 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V8
/**
* @brief UUID for the Value V8 Characteristic
*/
#define BT_UUID_VALUE_V8 BT_UUID_DECLARE_16(0xb008)
/** @def BT_UUID_DES_V8D1
/**
* @brief UUID for the Descriptor V8D1 Characteristic
*/
#define BT_UUID_DES_V8D1 BT_UUID_DECLARE_16(0xb015)
/** @def BT_UUID_DES_V8D2
/**
* @brief UUID for the Descriptor V8D2 Characteristic
*/
#define BT_UUID_DES_V8D2 BT_UUID_DECLARE_16(0xb016)
/** @def BT_UUID_DES_V8D3
/**
* @brief UUID for the Descriptor V8D3 Characteristic
*/
#define BT_UUID_DES_V8D3 BT_UUID_DECLARE_16(0xb017)

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_5
/**
* @brief UUID for the Service B.5
*/
#define BT_UUID_SERVICE_B_5 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V8
/**
* @brief UUID for the Value V8 Characteristic
*/
#define BT_UUID_VALUE_V8 BT_UUID_DECLARE_16(0xb008)

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_B_5
/**
* @brief UUID for the Service B.5
*/
#define BT_UUID_SERVICE_B_5 BT_UUID_DECLARE_16(0xa00b)
/** @def BT_UUID_VALUE_V8
/**
* @brief UUID for the Value V8 Characteristic
*/
#define BT_UUID_VALUE_V8 BT_UUID_DECLARE_16(0xb008)

View file

@ -18,28 +18,28 @@
extern struct bt_gatt_attr service_d_1_attrs[];
/** @def BT_UUID_SERVICE_C_1
/**
* @brief UUID for the Service C.1
*/
#define BT_UUID_SERVICE_C_1 BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0x0c, 0xa0, 0x00, 0x00)
/** @def BT_UUID_VALUE_V9__128_BIT_UUID
/**
* @brief UUID for the Value V9 (128-bit UUID) Characteristic
*/
#define BT_UUID_VALUE_V9__128_BIT_UUID BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0x09, 0xb0, 0x00, 0x00)
/** @def BT_UUID_DES_V9D2__128_BIT_UUID
/**
* @brief UUID for the Descriptor V9D2 (128-bit UUID) Characteristic
*/
#define BT_UUID_DES_V9D2__128_BIT_UUID BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0xd2, 0xd9, 0x00, 0x00)
/** @def BT_UUID_DES_V9D3__128_BIT_UUID
/**
* @brief UUID for the Descriptor V9D3 (128-bit UUID) Characteristic
*/
#define BT_UUID_DES_V9D3__128_BIT_UUID BT_UUID_DECLARE_128( \

View file

@ -18,28 +18,28 @@
extern struct bt_gatt_attr service_d_2_attrs[];
/** @def BT_UUID_SERVICE_C_1
/**
* @brief UUID for the Service C.1
*/
#define BT_UUID_SERVICE_C_1 BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0x0c, 0xa0, 0x00, 0x00)
/** @def BT_UUID_VALUE_V9__128_BIT_UUID
/**
* @brief UUID for the Value V9 (128-bit UUID) Characteristic
*/
#define BT_UUID_VALUE_V9__128_BIT_UUID BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0x09, 0xb0, 0x00, 0x00)
/** @def BT_UUID_DES_V9D2__128_BIT_UUID
/**
* @brief UUID for the Descriptor V9D2 (128-bit UUID) Characteristic
*/
#define BT_UUID_DES_V9D2__128_BIT_UUID BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0xd2, 0xd9, 0x00, 0x00)
/** @def BT_UUID_DES_V9D3__128_BIT_UUID
/**
* @brief UUID for the Descriptor V9D3 (128-bit UUID) Characteristic
*/
#define BT_UUID_DES_V9D3__128_BIT_UUID BT_UUID_DECLARE_128( \

View file

@ -16,28 +16,28 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_C_1
/**
* @brief UUID for the Service C.1
*/
#define BT_UUID_SERVICE_C_1 BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0x0c, 0xa0, 0x00, 0x00)
/** @def BT_UUID_VALUE_V9__128_BIT_UUID
/**
* @brief UUID for the Value V9 (128-bit UUID) Characteristic
*/
#define BT_UUID_VALUE_V9__128_BIT_UUID BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0x09, 0xb0, 0x00, 0x00)
/** @def BT_UUID_DES_V9D2__128_BIT_UUID
/**
* @brief UUID for the Descriptor V9D2 (128-bit UUID) Characteristic
*/
#define BT_UUID_DES_V9D2__128_BIT_UUID BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0xd2, 0xd9, 0x00, 0x00)
/** @def BT_UUID_DES_V9D3__128_BIT_UUID
/**
* @brief UUID for the Descriptor V9D3 (128-bit UUID) Characteristic
*/
#define BT_UUID_DES_V9D3__128_BIT_UUID BT_UUID_DECLARE_128( \

View file

@ -16,34 +16,34 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_C_2
/**
* @brief UUID for the Service C.2
*/
#define BT_UUID_SERVICE_C_2 BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0x0c, 0xa0, 0x00, 0x00)
/** @def BT_UUID_VALUE_V10
/**
* @brief UUID for the Value V10 Characteristic
*/
#define BT_UUID_VALUE_V10 BT_UUID_DECLARE_16(0xb00a)
/** @def BT_UUID_VALUE_V2
/**
* @brief UUID for the Value V2 Characteristic
*/
#define BT_UUID_VALUE_V2 BT_UUID_DECLARE_16(0xb002)
/** @def BT_UUID_LONG_DES_V2D1
/**
* @brief UUID for the Long descriptor V2D1 Characteristic
*/
#define BT_UUID_LONG_DES_V2D1 BT_UUID_DECLARE_16(0xb012)
/** @def BT_UUID_LONG_DES_V2D2
/**
* @brief UUID for the Long descriptor V2D2 Characteristic
*/
#define BT_UUID_LONG_DES_V2D2 BT_UUID_DECLARE_16(0xb013)
/** @def BT_UUID_LONG_DES_V2D3
/**
* @brief UUID for the Long descriptor V2D3 Characteristic
*/
#define BT_UUID_LONG_DES_V2D3 BT_UUID_DECLARE_16(0xb014)

View file

@ -16,19 +16,19 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_C_2
/**
* @brief UUID for the Service C.2
*/
#define BT_UUID_SERVICE_C_2 BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0x0c, 0xa0, 0x00, 0x00)
/** @def BT_UUID_VALUE_V10
/**
* @brief UUID for the Value V10 Characteristic
*/
#define BT_UUID_VALUE_V10 BT_UUID_DECLARE_16(0xb00a)
/** @def BT_UUID_VALUE_V2
/**
* @brief UUID for the Value V2 Characteristic
*/
#define BT_UUID_VALUE_V2 BT_UUID_DECLARE_16(0xb002)

View file

@ -16,19 +16,19 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_C_2
/**
* @brief UUID for the Service C.2
*/
#define BT_UUID_SERVICE_C_2 BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0x0c, 0xa0, 0x00, 0x00)
/** @def BT_UUID_VALUE_V10
/**
* @brief UUID for the Value V10 Characteristic
*/
#define BT_UUID_VALUE_V10 BT_UUID_DECLARE_16(0xb00a)
/** @def BT_UUID_VALUE_V2
/**
* @brief UUID for the Value V2 Characteristic
*/
#define BT_UUID_VALUE_V2 BT_UUID_DECLARE_16(0xb002)

View file

@ -18,17 +18,17 @@
extern struct bt_gatt_attr service_b_5_1_attrs[];
/** @def BT_UUID_SERVICE_D
/**
* @brief UUID for the Service D
*/
#define BT_UUID_SERVICE_D BT_UUID_DECLARE_16(0xa00d)
/** @def BT_UUID_VALUE_V12
/**
* @brief UUID for the Value V12 Characteristic
*/
#define BT_UUID_VALUE_V12 BT_UUID_DECLARE_16(0xb00c)
/** @def BT_UUID_VALUE_V11__128_BIT_UUID
/**
* @brief UUID for the Value V11 (128-bit UUID) Characteristic
*/
#define BT_UUID_VALUE_V11__128_BIT_UUID BT_UUID_DECLARE_128( \

View file

@ -18,19 +18,19 @@
extern struct bt_gatt_attr service_b_1_2_attrs[];
/** @def BT_UUID_SERVICE_D
/**
* @brief UUID for the Service D
*/
#define BT_UUID_SERVICE_D BT_UUID_DECLARE_16(0xa00d)
/** @def BT_UUID_VALUE_V11__128_BIT_UUID
/**
* @brief UUID for the Value V11 (128-bit UUID) Characteristic
*/
#define BT_UUID_VALUE_V11__128_BIT_UUID BT_UUID_DECLARE_128( \
0xef, 0xcd, 0xab, 0x89, 0x67, 0x45, 0x23, 0x01, \
0x00, 0x00, 0x00, 0x00, 0x0b, 0xb0, 0x00, 0x00)
/** @def BT_UUID_VALUE_V12
/**
* @brief UUID for the Value V12 Characteristic
*/
#define BT_UUID_VALUE_V12 BT_UUID_DECLARE_16(0xb00c)

View file

@ -18,17 +18,17 @@
extern struct bt_gatt_attr service_c_1_3_attrs[];
/** @def BT_UUID_SERVICE_D
/**
* @brief UUID for the Service D
*/
#define BT_UUID_SERVICE_D BT_UUID_DECLARE_16(0xa00d)
/** @def BT_UUID_VALUE_V12
/**
* @brief UUID for the Value V12 Characteristic
*/
#define BT_UUID_VALUE_V12 BT_UUID_DECLARE_16(0xb00c)
/** @def BT_UUID_VALUE_V11__128_BIT_UUID
/**
* @brief UUID for the Value V11 (128-bit UUID) Characteristic
*/
#define BT_UUID_VALUE_V11__128_BIT_UUID BT_UUID_DECLARE_128( \

View file

@ -16,12 +16,12 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_E
/**
* @brief UUID for the Service E
*/
#define BT_UUID_SERVICE_E BT_UUID_DECLARE_16(0xa00e)
/** @def BT_UUID_VALUE_V13
/**
* @brief UUID for the Value V13 Characteristic
*/
#define BT_UUID_VALUE_V13 BT_UUID_DECLARE_16(0xb00d)

View file

@ -16,7 +16,7 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_E
/**
* @brief UUID for the Service E
*/
#define BT_UUID_SERVICE_E BT_UUID_DECLARE_16(0xa00e)

View file

@ -16,42 +16,42 @@
#include "gatt_macs.h"
/** @def BT_UUID_SERVICE_F
/**
* @brief UUID for the Service F
*/
#define BT_UUID_SERVICE_F BT_UUID_DECLARE_16(0xa00f)
/** @def BT_UUID_VALUE_V14
/**
* @brief UUID for the Value V14 Characteristic
*/
#define BT_UUID_VALUE_V14 BT_UUID_DECLARE_16(0xb00e)
/** @def BT_UUID_VALUE_V15
/**
* @brief UUID for the Value V15 Characteristic
*/
#define BT_UUID_VALUE_V15 BT_UUID_DECLARE_16(0xb00f)
/** @def BT_UUID_VALUE_V6
/**
* @brief UUID for the Value V6 Characteristic
*/
#define BT_UUID_VALUE_V6 BT_UUID_DECLARE_16(0xb006)
/** @def BT_UUID_VALUE_V7
/**
* @brief UUID for the Value V7 Characteristic
*/
#define BT_UUID_VALUE_V7 BT_UUID_DECLARE_16(0xb007)
/** @def BT_UUID_VALUE_V16
/**
* @brief UUID for the Value V16 Characteristic
*/
#define BT_UUID_VALUE_V16 BT_UUID_DECLARE_16(0xb010)
/** @def BT_UUID_AGG_FORMAT
/**
* @brief UUID for the Aggregate Format Characteristic
*/
#define BT_UUID_AGG_FORMAT BT_UUID_DECLARE_16(0x2905)
/** @def BT_UUID_VALUE_V17
/**
* @brief UUID for the Value V17 Characteristic
*/
#define BT_UUID_VALUE_V17 BT_UUID_DECLARE_16(0xb011)