nimble/ll: Add address provider APIs

This adds 2 new APIs that can be implemented by packages: provide public
or static device address. This allows for better support of provisioning
of Bluetooth devices address on different devices.

The nrf5x driver can act as a provider of both public and static address
which is configurable by syscfg settings. By default provider for a
static address is enabled since all nRF5x have factory programmed random
address in FICR registers. The provider for a public address can be
optionally enabled since the same registers can be also be factory
programmed with a public address (on request).

Author: andrzej-kaczmarek

nimble/controller/include/controller/ble_hw.h

@@ -97,12 +97,6 @@ uint8_t ble_hw_resolv_list_size(void);
 /* Returns index of resolved address; -1 if not resolved */
 int ble_hw_resolv_list_match(void);
 
-/* Returns public device address or -1 if not present */
-int ble_hw_get_public_addr(ble_addr_t *addr);
-
-/* Returns random static address or -1 if not present */
-int ble_hw_get_static_addr(ble_addr_t *addr);
-
 #ifdef __cplusplus
 }
 #endif

nimble/controller/include/controller/ble_ll_addr.h

@@ -26,6 +26,12 @@ extern "C" {
 
 int ble_ll_addr_init(void);
 
+/* Address provider APIs - should be implemented by packages supporting
+ * relevant APIs
+ */
+int ble_ll_addr_provide_public(uint8_t *addr);
+int ble_ll_addr_provide_static(uint8_t *addr);
+
 #ifdef __cplusplus
 }
 #endif

nimble/controller/src/ble_ll_addr.c

@@ -20,49 +20,33 @@
 #include <stdint.h>
 #include <syscfg/syscfg.h>
 #include <controller/ble_ll.h>
-#include <controller/ble_hw.h>
+#include <controller/ble_ll_addr.h>
 
 /* FIXME: both should be static and accessible only via dedicated set/get APIs;
  *        extern declared in nimble/ble.h should be removed
  */
 uint8_t g_dev_addr[BLE_DEV_ADDR_LEN];
 uint8_t g_random_addr[BLE_DEV_ADDR_LEN];
 
-static bool
-ble_ll_addr_is_empty(const uint8_t *addr)
-{
-    return memcmp(addr, BLE_ADDR_ANY, BLE_DEV_ADDR_LEN) == 0;
-}
-
 int
 ble_ll_addr_init(void)
 {
-#if MYNEWT_VAL(BLE_LL_PUBLIC_DEV_ADDR)
     uint64_t pub_dev_addr;
     int i;
-#endif
-    ble_addr_t addr;
-    int rc;
 
-    /* Set public device address if not already set */
-    if (ble_ll_addr_is_empty(g_dev_addr)) {
-#if MYNEWT_VAL(BLE_LL_PUBLIC_DEV_ADDR)
-        pub_dev_addr = MYNEWT_VAL(BLE_LL_PUBLIC_DEV_ADDR);
+    /* Set public device address from syscfg. It should be all-zero in normal
+     * build so no need to add special check for that.
+     */
+    pub_dev_addr = MYNEWT_VAL(BLE_LL_PUBLIC_DEV_ADDR);
+    for (i = 0; i < BLE_DEV_ADDR_LEN; i++) {
+        g_dev_addr[i] = pub_dev_addr & 0xff;
+        pub_dev_addr >>= 8;
+    }
 
-        for (i = 0; i < BLE_DEV_ADDR_LEN; i++) {
-            g_dev_addr[i] = pub_dev_addr & 0xff;
-            pub_dev_addr >>= 8;
-        }
-#else
-        memcpy(g_dev_addr, MYNEWT_VAL(BLE_PUBLIC_DEV_ADDR), BLE_DEV_ADDR_LEN);
+    /* Set public address from provider API, if available */
+#if MYNEWT_API_ble_addr_provider_public
+    ble_ll_addr_provide_public(g_dev_addr);
 #endif
-        if (ble_ll_addr_is_empty(g_dev_addr)) {
-            rc = ble_hw_get_public_addr(&addr);
-            if (!rc) {
-                memcpy(g_dev_addr, &addr.val[0], BLE_DEV_ADDR_LEN);
-            }
-        }
-    }
 
     return 0;
 }

nimble/controller/src/ble_ll_hci_vs.c

@@ -18,6 +18,8 @@
  */
 
 #include <stdint.h>
+#include <controller/ble_ll_addr.h>
+
 #include "syscfg/syscfg.h"
 #include "controller/ble_ll_utils.h"
 #include "controller/ble_ll.h"
@@ -42,17 +44,18 @@ ble_ll_hci_vs_rd_static_addr(uint16_t ocf,
                              uint8_t *rspbuf, uint8_t *rsplen)
 {
     struct ble_hci_vs_rd_static_addr_rp *rsp = (void *) rspbuf;
-    ble_addr_t addr;
 
     if (cmdlen != 0) {
         return BLE_ERR_INV_HCI_CMD_PARMS;
     }
 
-    if (ble_hw_get_static_addr(&addr) < 0) {
+#if MYNEWT_API_ble_addr_provider_static
+    if (ble_ll_addr_provide_static(rsp->addr) < 0) {
         return BLE_ERR_UNSPECIFIED;
     }
-
-    memcpy(rsp->addr, addr.val, sizeof(rsp->addr));
+#else
+    return BLE_ERR_UNSUPPORTED;
+#endif
 
     *rsplen = sizeof(*rsp);
 

nimble/drivers/dialog_cmac/src/ble_hw.c

@@ -77,18 +77,6 @@ struct ble_hw_resolv_proc {
 static struct ble_hw_resolv_list g_ble_hw_resolv_list;
 static struct ble_hw_resolv_proc g_ble_hw_resolv_proc;
 
-int
-ble_hw_get_public_addr(ble_addr_t *addr)
-{
-    return -1;
-}
-
-int
-ble_hw_get_static_addr(ble_addr_t *addr)
-{
-    return -1;
-}
-
 void
 ble_hw_whitelist_clear(void)
 {

nimble/drivers/native/src/ble_hw.c

@@ -37,20 +37,6 @@ static uint8_t g_ble_hw_whitelist_mask;
 static ble_rng_isr_cb_t rng_cb;
 static bool rng_started;
 
-/* Returns public device address or -1 if not present */
-int
-ble_hw_get_public_addr(ble_addr_t *addr)
-{
-    return -1;
-}
-
-/* Returns random static address or -1 if not present */
-int
-ble_hw_get_static_addr(ble_addr_t *addr)
-{
-    return -1;
-}
-
 /**
  * Clear the whitelist
  *

nimble/drivers/nrf51/pkg.yml

@@ -25,10 +25,16 @@ pkg.keywords:
     - ble
     - bluetooth
 
-pkg.apis: ble_driver
 pkg.deps:
     - nimble
     - nimble/controller
 
+pkg.apis:
+    - ble_driver
+pkg.apis.BLE_PHY_ADDR_PROVIDER_PUBLIC:
+    - ble_addr_provider_public
+pkg.apis.BLE_PHY_ADDR_PROVIDER_STATIC:
+    - ble_addr_provider_static
+
 # allows to override nimble/controller settings
 pkg.subpriority: 1

nimble/drivers/nrf51/src/ble_hw.c

@@ -62,52 +62,47 @@ uint8_t g_nrf_num_irks;
 
 #endif
 
-/* Returns public device address or -1 if not present */
+#if MYNEWT_VAL(BLE_PHY_ADDR_PROVIDER_PUBLIC)
 int
-ble_hw_get_public_addr(ble_addr_t *addr)
+ble_ll_addr_provide_public(uint8_t *addr)
 {
     uint32_t addr_high;
     uint32_t addr_low;
 
-    /* Does FICR have a public address */
     if ((NRF_FICR->DEVICEADDRTYPE & 1) != 0) {
         return -1;
     }
 
-    /* Copy into device address. We can do this because we know platform */
     addr_low = NRF_FICR->DEVICEADDR[0];
     addr_high = NRF_FICR->DEVICEADDR[1];
-    memcpy(addr->val, &addr_low, 4);
-    memcpy(&addr->val[4], &addr_high, 2);
-    addr->type = BLE_ADDR_PUBLIC;
+
+    memcpy(&addr[0], &addr_low, 4);
+    memcpy(&addr[4], &addr_high, 2);
 
     return 0;
 }
+#endif
 
-/* Returns random static address or -1 if not present */
+#if MYNEWT_VAL(BLE_PHY_ADDR_PROVIDER_STATIC)
 int
-ble_hw_get_static_addr(ble_addr_t *addr)
+ble_ll_addr_provide_static(uint8_t *addr)
 {
     uint32_t addr_high;
     uint32_t addr_low;
-    int rc;
 
-    if ((NRF_FICR->DEVICEADDRTYPE & 1) == 1) {
-        addr_low = NRF_FICR->DEVICEADDR[0];
-        addr_high = NRF_FICR->DEVICEADDR[1];
+    if ((NRF_FICR->DEVICEADDRTYPE & 1) == 0) {
+        return -1;
+    }
 
-        memcpy(addr->val, &addr_low, 4);
-        memcpy(&addr->val[4], &addr_high, 2);
+    addr_low = NRF_FICR->DEVICEADDR[0];
+    addr_high = NRF_FICR->DEVICEADDR[1];
 
-        addr->val[5] |= 0xc0;
-        addr->type = BLE_ADDR_RANDOM;
-        rc = 0;
-    } else {
-        rc = -1;
-    }
+    memcpy(&addr[0], &addr_low, 4);
+    memcpy(&addr[4], &addr_high, 2);
 
-    return rc;
+    return 0;
 }
+#endif
 
 /**
  * Clear the whitelist

nimble/drivers/nrf51/syscfg.yml

@@ -16,6 +16,13 @@
 # under the License.
 #
 
+syscfg.defs:
+    BLE_PHY_ADDR_PROVIDER_PUBLIC:
+        description: Enables public address provider API
+        value: 0
+    BLE_PHY_ADDR_PROVIDER_STATIC:
+        description: Enables static address provider API
+        value: 1
 
 syscfg.vals.!BLE_LL_CFG_FEAT_LL_EXT_ADV:
     BLE_LL_STACK_SIZE: 96

nimble/drivers/nrf5x/pkg.yml

@@ -25,11 +25,17 @@ pkg.keywords:
     - ble
     - bluetooth
 
-pkg.apis: ble_driver
 pkg.deps:
     - nimble
     - nimble/controller
 
+pkg.apis:
+    - ble_driver
+pkg.apis.BLE_PHY_ADDR_PROVIDER_PUBLIC:
+    - ble_addr_provider_public
+pkg.apis.BLE_PHY_ADDR_PROVIDER_STATIC:
+    - ble_addr_provider_static
+
 pkg.ign_dirs.'MCU_TARGET=="nRF5340_NET"':
     - nrf52
 pkg.ign_dirs.'MCU_TARGET!="nRF5340_NET"':