host privacy config option to enable it

Author: paul-szczepanek-arm

connectivity/FEATURE_BLE/include/ble/gap/Types.h

@@ -455,8 +455,8 @@ struct scanning_filter_policy_t : SafeEnum<scanning_filter_policy_t, uint8_t> {
         NO_FILTER = 0x00,
 
         /**
-        * Accept only advertising packets from devices in the whitelist except
-        * directed advertising packets not addressed to this device.
+        * Accept only advertising packets from devices in the whitelist.
+        * Directed advertising packets not addressed to this device will be ignored.
         */
         FILTER_ADVERTISING = 0x01,
 

connectivity/FEATURE_BLE/mbed_lib.json

@@ -93,10 +93,25 @@
             "value": 15,
             "macro_name": "BLE_GAP_MAX_ADVERTISING_SETS"
         },
+        "ble-gap-host-based-privacy": {
+            "help": "Perform address resolution on the host, not the controller. Controller based privacy is preferred as it happens lower down the stack but this can be used in case controller based privacy is unavailable. If this is enabled the controller will not be used for privacy.",
+            "value": true,
+            "macro_name": "BLE_GAP_HOST_BASED_PRIVACY"
+        },
         "ble-gap-max-advertising-reports-pending-address-resolution": {
             "help": "How many advertising reports can be pending while awaiting private address resolution. This is only used if host privacy is enabled and controller privacy is disabled. Must be non-zero",
             "value": 16,
             "macro_name": "BLE_GAP_MAX_ADVERTISING_REPORTS_PENDING_ADDRESS_RESOLUTION"
+        },
+        "ble-gap-host-privacy-resolving-list-size": {
+            "help": "Used for host privacy. How many pairs of resolvable private addresses and identity address to store.",
+            "value": 8,
+            "macro_name": "BLE_GAP_HOST_PRIVACY_RESOLVED_LIST_SIZE"
+        },
+        "ble-gap-host-privacy-resolved-cache-size": {
+            "help": "Used for host privacy. How many last resolved addresses to store to speed up resolution. This is especially valuable for resolving advertising which creates repeated queries for the same address.",
+            "value": 16,
+            "macro_name": "BLE_GAP_HOST_PRIVACY_RESOLVED_CACHE_SIZE"
         }
     }
 }

connectivity/FEATURE_BLE/source/cordio/source/PalPrivateAddressControllerImpl.cpp

@@ -1,7 +1,7 @@
 /* mbed Microcontroller Library
  * Copyright (c) 2020 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -193,6 +193,7 @@ bool PalPrivateAddressController::cordio_handler(const wsfMsgHdr_t *msg)
             return true;
         }
 
+#if BLE_GAP_HOST_BASED_PRIVACY
         case DM_PRIV_RESOLVED_ADDR_IND: {
             instance()._resolving_rpa = false;
 
@@ -203,6 +204,7 @@ bool PalPrivateAddressController::cordio_handler(const wsfMsgHdr_t *msg)
             handler->on_private_address_resolved(msg->status == HCI_SUCCESS);
             return true;
         }
+#endif // BLE_GAP_HOST_BASED_PRIVACY
 
         case DM_PRIV_ADD_DEV_TO_RES_LIST_IND: // Device added to resolving list
         case DM_PRIV_REM_DEV_FROM_RES_LIST_IND: // Device removed from resolving list

connectivity/FEATURE_BLE/source/generic/GapImpl.cpp

@@ -880,6 +880,12 @@ ble_error_t Gap::setWhitelist(const whitelist_t &whitelist)
 
 ble_error_t Gap::enablePrivacy(bool enable)
 {
+#if (BLE_GAP_HOST_BASED_PRIVACY == 0)
+    /* we need either privacy on host or controller to enable it */
+    if (enable && !_address_registry.is_controller_privacy_supported()) {
+        return BLE_ERROR_NOT_IMPLEMENTED;
+    }
+#endif
     if (enable == _privacy_enabled) {
         // No change
         return BLE_ERROR_NONE;
@@ -1444,8 +1450,11 @@ ble_error_t Gap::update_ll_address_resolution_setting()
         }
 #endif // BLE_ROLE_OBSERVER
     }
-
+#if BLE_GAP_HOST_BASED_PRIVACY
+    return BLE_ERROR_NONE;
+#else
     return _address_registry.enable_controller_address_resolution(enable);
+#endif // BLE_GAP_HOST_BASED_PRIVACY
 }
 
 uint8_t Gap::getMaxAdvertisingSetNumber()
@@ -2213,7 +2222,7 @@ void Gap::signal_connection_complete(
     ConnectionCompleteEvent& event
 )
 {
-#if BLE_FEATURE_PRIVACY
+#if BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
     bool address_resolved = false;
 
     /* if address resolution is not needed or already handled then the address is already resolved */
@@ -2246,7 +2255,7 @@ void Gap::signal_connection_complete(
 
     /* first try to resolve synchronously in cache */
     if (!address_resolved) {
-        address_resolved = _address_registry.resolve_address_in_cache(
+        address_resolved = _address_registry.resolve_address_in_host_cache(
             event.getPeerAddress(),
             &peer_address_type,
             &peer_address
@@ -2268,7 +2277,7 @@ void Gap::signal_connection_complete(
         _event_handler->onConnectionComplete(event);
     } else {
         bool resolution_pending = false;
-        ble_error_t ret = _address_registry.queue_resolve_address(event.getPeerAddress());
+        ble_error_t ret = _address_registry.queue_resolve_address_on_host(event.getPeerAddress());
 
         if (ret == BLE_ERROR_NONE) {
             ConnectionCompleteEvent* event_copy = new(std::nothrow) ConnectionCompleteEvent(event);
@@ -2293,10 +2302,10 @@ void Gap::signal_connection_complete(
 #else
     report_internal_connection_complete(event);
     _event_handler->onConnectionComplete(event);
-#endif // BLE_FEATURE_PRIVACY
+#endif // BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
 }
 
-#if BLE_FEATURE_PRIVACY
+#if BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
 void Gap::conclude_signal_connection_complete_after_address_resolution(
     ConnectionCompleteEvent &event,
     target_peer_address_type_t identity_address_type,
@@ -2354,21 +2363,20 @@ void Gap::conclude_signal_connection_complete_after_address_resolution(
 #endif // BLE_FEATURE_SECURITY
 #endif // BLE_ROLE_PERIPHERAL
 }
-#endif // BLE_FEATURE_PRIVACY
+#endif // BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
 #endif // BLE_FEATURE_CONNECTABLE
 
 #if BLE_ROLE_OBSERVER
 void Gap::signal_advertising_report(
     AdvertisingReportEvent& event
 )
 {
-#if BLE_FEATURE_PRIVACY
+#if BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
     bool address_resolved = false;
 
     /* if address resolution is not needed or already handled then the address is already resolved */
     if (!_privacy_enabled ||
         _central_privacy_configuration.resolution_strategy == central_privacy_configuration_t::DO_NOT_RESOLVE ||
-        _address_registry.is_controller_privacy_supported() ||
         event.getPeerAddressType() == peer_address_type_t::PUBLIC ||
         !is_random_private_resolvable_address(event.getPeerAddress())) {
         address_resolved = true;
@@ -2379,7 +2387,7 @@ void Gap::signal_advertising_report(
         const address_t *peer_address = nullptr;
         target_peer_address_type_t peer_address_type(target_peer_address_type_t::RANDOM);
 
-        address_resolved = _address_registry.resolve_address_in_cache(
+        address_resolved = _address_registry.resolve_address_in_host_cache(
             event.getPeerAddress(),
             &peer_address_type,
             &peer_address
@@ -2412,7 +2420,7 @@ void Gap::signal_advertising_report(
 
         /* if there is already an item with the same address pending don't kick off resolution*/
         if (!duplicate_pending_event) {
-            ret = _address_registry.queue_resolve_address(event.getPeerAddress());
+            ret = _address_registry.queue_resolve_address_on_host(event.getPeerAddress());
         }
 
         if (ret == BLE_ERROR_NONE) {
@@ -2429,11 +2437,11 @@ void Gap::signal_advertising_report(
     _event_handler->onAdvertisingReport(
         event
     );
-#endif // BLE_FEATURE_PRIVACY
+#endif // BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
 }
 #endif //BLE_ROLE_OBSERVER
 
-#if BLE_FEATURE_PRIVACY
+#if BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
 #if BLE_ROLE_OBSERVER
 void Gap::conclude_signal_advertising_report_after_address_resolution(
     AdvertisingReportEvent &event,
@@ -2457,7 +2465,7 @@ void Gap::conclude_signal_advertising_report_after_address_resolution(
     _event_handler->onAdvertisingReport(event);
 }
 #endif // BLE_ROLE_OBSERVER
-#endif // BLE_FEATURE_PRIVACY
+#endif // BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
 
 void Gap::on_periodic_advertising_sync_established(
     hci_error_code_t error,
@@ -3135,7 +3143,7 @@ const address_t *Gap::get_random_address(controller_operation_t operation, size_
 #if BLE_FEATURE_EXTENDED_ADVERTISING
     if (is_extended_advertising_available()) {
         if (operation == controller_operation_t::advertising) {
-            if (_set_is_connectable.get(set_id) == false && peripheral_non_resolvable) {
+            if (!_set_is_connectable.get(set_id) && peripheral_non_resolvable) {
                 return &non_resolvable_address;
             } else {
                 return &resolvable_address;

connectivity/FEATURE_BLE/source/generic/GapImpl.h

@@ -610,7 +610,7 @@ class Gap :
      */
     void signal_connection_complete(ConnectionCompleteEvent& report);
 
-#if BLE_FEATURE_PRIVACY
+#if BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
     /** Pass the connection complete event to the application after privacy resolution completed.
      *
      * @param event Event to be passed to the user application.
@@ -622,7 +622,7 @@ class Gap :
         target_peer_address_type_t identity_address_type,
         const address_t *identity_address
     );
-#endif // BLE_FEATURE_PRIVACY
+#endif // BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
 #endif // BLE_FEATURE_CONNECTABLE
 
 #if BLE_ROLE_OBSERVER
@@ -632,7 +632,7 @@ class Gap :
      */
     void signal_advertising_report(AdvertisingReportEvent& report);
 
-#if BLE_FEATURE_PRIVACY
+#if BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
     /** Pass the advertising report to the application after privacy resolution completed.
      *
      * @param event Event to be passed to the user application.
@@ -644,7 +644,7 @@ class Gap :
         target_peer_address_type_t identity_address_type,
         const address_t *identity_address
     );
-#endif // BLE_FEATURE_PRIVACY
+#endif // BLE_FEATURE_PRIVACY && BLE_GAP_HOST_BASED_PRIVACY
 #endif // BLE_ROLE_OBSERVER
 
     /* implements PalGap::EventHandler */