Bluetooth: Host: Add advertising state to bt_le_ext_adv_info

The bt_le_ext_adv_info struct has been extended to also
contain the advertising and periodic advertising states.

Additionally, the function verifies the input to avoid
NULL pointer access, and the addr field is more
properly documented.

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

Author: Thalley

include/zephyr/bluetooth/bluetooth.h

@@ -1714,6 +1714,31 @@ int bt_le_ext_adv_delete(struct bt_le_ext_adv *adv);
  */
 uint8_t bt_le_ext_adv_get_index(struct bt_le_ext_adv *adv);
 
+enum bt_le_ext_adv_state {
+	/** No state */
+	BT_LE_EXT_ADV_STATE_NONE,
+
+	/** The advertising set has been created but not started */
+	BT_LE_EXT_ADV_STATE_CREATED,
+
+	/** The advertising set is started */
+	BT_LE_EXT_ADV_STATE_STARTED,
+
+	/** Ther advertising set is temporarily paused */
+	BT_LE_EXT_ADV_STATE_PAUSED,
+};
+
+enum bt_le_per_adv_state {
+	/** No state */
+	BT_LE_PER_ADV_STATE_NONE,
+
+	/** The advertising set has been configured for periodic advertising */
+	BT_LE_PER_ADV_STATE_CONFIGURED,
+
+	/** Periodic advertising is started */
+	BT_LE_PER_ADV_STATE_STARTED,
+};
+
 /** @brief Advertising set info structure. */
 struct bt_le_ext_adv_info {
 	/** Local identity handle. */
@@ -1722,8 +1747,19 @@ struct bt_le_ext_adv_info {
 	/** Currently selected Transmit Power (dBM). */
 	int8_t                     tx_power;
 
-	/** Current local advertising address used. */
+	/**
+	 * @brief Current local advertising address used.
+	 *
+	 * If @ref bt_le_ext_adv_info.ext_adv_state is not BT_LE_EXT_ADV_STATE_STARTED the value
+	 * of this address may change when bt_le_ext_adv_start() is called.
+	 */
 	const bt_addr_le_t         *addr;
+
+	/** Extended advertising state */
+	enum bt_le_ext_adv_state ext_adv_state;
+
+	/** Periodic advertising state */
+	enum bt_le_per_adv_state per_adv_state;
 };
 
 /**
@@ -1732,7 +1768,9 @@ struct bt_le_ext_adv_info {
  * @param adv Advertising set object
  * @param info Advertising set info object
  *
- * @return Zero on success or (negative) error code on failure.
+ * @retval 0 Success
+ * @retval -EINVAL @p adv or @p info is NULL
+ * @retval -ENXIO @p adv is not a created advertising set
  */
 int bt_le_ext_adv_get_info(const struct bt_le_ext_adv *adv,
 			   struct bt_le_ext_adv_info *info);

subsys/bluetooth/host/adv.c

@@ -1592,10 +1592,45 @@ void bt_le_adv_resume(void)
 int bt_le_ext_adv_get_info(const struct bt_le_ext_adv *adv,
 			   struct bt_le_ext_adv_info *info)
 {
+	if (adv == NULL) {
+		LOG_DBG("adv is NULL");
+		return -EINVAL;
+	}
+
+	if (info == NULL) {
+		LOG_DBG("info is NULL");
+		return -EINVAL;
+	}
+
+	if (!atomic_test_bit(adv->flags, BT_ADV_CREATED)) {
+		LOG_DBG("Advertising set %p is not created", adv);
+		return -ENXIO;
+	}
+
+	(void)memset(info, 0, sizeof(*info));
+
 	info->id = adv->id;
 	info->tx_power = adv->tx_power;
 	info->addr = &adv->random_addr;
 
+	if (atomic_test_bit(adv->flags, BT_ADV_ENABLED)) {
+		info->ext_adv_state = BT_LE_EXT_ADV_STATE_STARTED;
+	} else if (atomic_test_bit(adv->flags, BT_ADV_PAUSED)) {
+		info->ext_adv_state = BT_LE_EXT_ADV_STATE_PAUSED;
+	} else {
+		info->ext_adv_state = BT_LE_EXT_ADV_STATE_CREATED;
+	}
+
+	if (IS_ENABLED(CONFIG_BT_PER_ADV)) {
+		if (atomic_test_bit(adv->flags, BT_PER_ADV_PARAMS_SET)) {
+			info->per_adv_state = BT_LE_PER_ADV_STATE_CONFIGURED;
+		} else if (atomic_test_bit(adv->flags, BT_PER_ADV_ENABLED)) {
+			info->per_adv_state = BT_LE_PER_ADV_STATE_STARTED;
+		} else {
+			info->per_adv_state = BT_LE_PER_ADV_STATE_NONE;
+		}
+	}
+
 	return 0;
 }
 

subsys/bluetooth/host/shell/bt.c

@@ -2566,7 +2566,11 @@ static int cmd_adv_info(const struct shell *sh, size_t argc, char *argv[])
 
 	shell_print(sh, "Advertiser[%d] %p", selected_adv, adv);
 	shell_print(sh, "Id: %d, TX power: %d dBm", info.id, info.tx_power);
-	print_le_addr("Address", info.addr);
+	shell_print(sh, "Adv state: %d", info.ext_adv_state);
+	if (info.ext_adv_state == BT_LE_EXT_ADV_STATE_STARTED) {
+		print_le_addr("Address", info.addr);
+	}
+	shell_print(sh, "Per Adv state: %d", info.per_adv_state);
 
 	return 0;
 }