michaelh/zephyr
1
0
Fork 0
Code Releases Activity

bluetooth: host: Clarify docs about reading remote FAE table

Browse source 
There was some confusion about why this function doesn't work with
nordic devices. The explanation is that the controller is required
to return an error code if the remote device doesn't need an FAE table.

Signed-off-by: Olivier Lesage <olivier.lesage@nordicsemi.no>
This commit is contained in:
Olivier Lesage 2025-04-29 15:02:40 +02:00 • committed by Benjamin Cabé
commit 36aa80337b
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
include/zephyr/bluetooth/cs.h
View file

@ -603,6 +603,12 @@ int bt_le_cs_set_default_settings(struct bt_conn *conn,
* This command is used to read the per-channel mode-0 Frequency Actuation Error
* table of the remote Controller.
*
* If the remote controller supports a Frequency Actuation Error of zero relative
* to its mode-0 transmissions in the reflector role
* (see @ref bt_conn_le_cs_capabilities::cs_without_fae_supported), calling this
* function is not needed and the read remote FAE table complete event will be
* generated with an error code.
*
* @note To use this API @kconfig{CONFIG_BT_CHANNEL_SOUNDING} must be set.
*
* @param conn Connection Object.
@ -871,6 +877,11 @@ int bt_le_cs_write_cached_remote_supported_capabilities(
* This command is used to write a cached copy of the per-channel mode-0
* Frequency Actuation Error table of the remote device in the local Controller.
*
* If the remote controller supports a Frequency Actuation Error of zero relative
* to its mode-0 transmissions in the reflector role
* (see @ref bt_conn_le_cs_capabilities::cs_without_fae_supported), calling this
* function is not needed. An error code will be returned.
*
* @note To use this API @kconfig{CONFIG_BT_CHANNEL_SOUNDING} must be set.
*
* @param conn Connection Object.