Skip to content

Commit ec43b64

Browse files
Thalleycarlescufi
authored andcommitted
Bluetooth: host: Add documentation for OPT_EXT_ADV and bt_le_adv_start
The bt_le_adv_start function can (currently) not be used together with BT_LE_ADV_OPT_EXT_ADV, and it will return an -EINVAL error if attempted, but this behavior is not documented, and several people have asked about why it does not work. Signed-off-by: Emil Gydesen <[email protected]>
1 parent 07d9e52 commit ec43b64

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

include/zephyr/bluetooth/bluetooth.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -628,6 +628,8 @@ enum {
628628
*
629629
* @note Enabling this option requires extended advertising support in
630630
* the peer devices scanning for advertisement packets.
631+
*
632+
* @note This cannot be used with bt_le_adv_start().
631633
*/
632634
BT_LE_ADV_OPT_EXT_ADV = BIT(10),
633635

@@ -1055,6 +1057,9 @@ struct bt_le_per_adv_param {
10551057
* response data parameters are ignored. If the mode is high duty cycle
10561058
* the timeout will be @ref BT_GAP_ADV_HIGH_DUTY_CYCLE_MAX_TIMEOUT.
10571059
*
1060+
* This function cannot be used with @ref BT_LE_ADV_OPT_EXT_ADV in the @p param.options.
1061+
* For extended advertising, the bt_le_ext_adv_* functions must be used.
1062+
*
10581063
* @param param Advertising parameters.
10591064
* @param ad Data to be used in advertisement packets.
10601065
* @param ad_len Number of elements in ad

0 commit comments

Comments
 (0)