Bluetooth: host: Document privacy-disabled directed advertising reports

Document why a privacy-disabled scanner will not notify about directed
advertising reports. This is the default behaviour of the
privacy-disabled scanner. In order to receive the reports the option
BT_SCAN_WITH_IDENTITY must be enabled.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2020-01-30 18:44:46 +01:00 committed by Johan Hedberg
commit 499b4e0ce0
2 changed files with 11 additions and 2 deletions

View file

@ -509,6 +509,13 @@ struct bt_le_scan_cb {
* Start LE scanning with given parameters and provide results through
* the specified callback.
*
* Note: The LE scanner by default does not use the Identity Address of the
* local device when :option:`CONFIG_BT_PRIVACY` is disabled. This is to
* prevent the active scanner from disclosing the identity information
* when requesting additional information from advertisers.
* In order to enable directed advertiser reports then
* :option:`CONFIG_BT_SCAN_WITH_IDENTITY` must be enabled.
*
* @param param Scan parameters.
* @param cb Callback to notify scan results. May be NULL if callback
* registration through @ref bt_le_scan_cb_register is preferred.