adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

Bluetooth: Document parallel scanner and initiator param selection

Browse source 
When scanning and connecting in parallel with
CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLEL enabled, a Bluetooth controller
may choose different scheduling approaches based upon the provided
parameters.

Nordic's SoftDevice Controller performs better when both roles
use the same scan window and scan interval. To help customers
choosing the right configuration, this should be documented.

Signed-off-by: Rubin Gerritsen <rubin.gerritsen@nordicsemi.no>
This commit is contained in:
Rubin Gerritsen 2024-09-03 14:35:29 +02:00 committed by Mahesh Mahadevan
parent 8f76cdd891
commit fe72c4b447
2 changed files with 32 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
include/zephyr/bluetooth/bluetooth.h
View file

@ -2067,10 +2067,24 @@ struct bt_le_scan_param {
/** Bit-field of scanning options. */
uint32_t options;
/** Scan interval (N * 0.625 ms) */
/** Scan interval (N * 0.625 ms).
*
* @note When @kconfig{CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLEL} is enabled
* and the application wants to scan and connect in parallel,
* the Bluetooth Controller may require the scan interval used
* for scanning and connection establishment to be equal to
* obtain the best performance.
*/
uint16_t interval;
/** Scan window (N * 0.625 ms) */
/** Scan window (N * 0.625 ms)
*
* @note When @kconfig{CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLEL} is enabled
* and the application wants to scan and connect in parallel,
* the Bluetooth Controller may require the scan window used
* for scanning and connection establishment to be equal to
* obtain the best performance.
*/
uint16_t window;
/**

18
include/zephyr/bluetooth/conn.h
View file

@ -847,10 +847,24 @@ struct bt_conn_le_create_param {
/** Bit-field of create connection options. */
uint32_t options;
/** Scan interval (N * 0.625 ms) */
/** Scan interval (N * 0.625 ms)
*
* @note When @kconfig{CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLEL} is enabled
* and the application wants to scan and connect in parallel,
* the Bluetooth Controller may require the scan interval used
* for scanning and connection establishment to be equal to
* obtain the best performance.
*/
uint16_t interval;
/** Scan window (N * 0.625 ms) */
/** Scan window (N * 0.625 ms)
*
* @note When @kconfig{CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLEL} is enabled
* and the application wants to scan and connect in parallel,
* the Bluetooth Controller may require the scan window used
* for scanning and connection establishment to be equal to
* obtain the best performance.
*/
uint16_t window;
/** @brief Scan interval LE Coded PHY (N * 0.625 MS)