nimble/util: Add public address provider for u-blox modules

Modules from u-blox AG are preprogrammed with a valid public device
address stored in UICR registers. This package makes this address usable
by NimBLE LL.

Author: andrzej-kaczmarek

nimble/drivers/nrf5x/src/ble_hw.c

@@ -77,29 +77,12 @@ ble_ll_addr_provide_public(uint8_t *addr)
     uint32_t addr_high;
     uint32_t addr_low;
 
-#if MYNEWT_VAL(BLE_PHY_UBLOX_BMD345_PUBLIC_ADDR)
-    /*
-    * The BMD-345 modules are preprogrammed from the factory with a unique public
-    * The  Bluetooth device address stored in the CUSTOMER[0] and CUSTOMER[1]
-    * registers of the User Information Configuration Registers (UICR).
-    * The Bluetooth device address consists of the IEEE Organizationally Unique
-    * Identifier (OUI) combined with the hexadecimal digits that are printed on
-    * a 2D barcode and in human-readable text on the module label.The Bluetooth
-    * device address is stored in little endian format. The most significant
-    * bytes of the CUSTOMER[1] register are 0xFF to complete the 32-bit register.
-    */
-
-    /* Copy into device address. We can do this because we know platform */
-    addr_low = NRF_UICR->CUSTOMER[0];
-    addr_high = NRF_UICR->CUSTOMER[1];
-#else
     if ((NRF_FICR->DEVICEADDRTYPE & 1) != 0) {
         return -1;
     }
 
     addr_low = NRF_FICR->DEVICEADDR[0];
     addr_high = NRF_FICR->DEVICEADDR[1];
-#endif
 
     memcpy(&addr[0], &addr_low, 4);
     memcpy(&addr[4], &addr_high, 2);

nimble/drivers/nrf5x/syscfg.yml

@@ -83,12 +83,9 @@ syscfg.defs:
        value: 0
 
     BLE_PHY_UBLOX_BMD345_PUBLIC_ADDR:
-        description: >
-            Ublox BMD-345 modules come with public address preprogrammed
-            in UICR register. If enabled public address will be read from
-            custom UICR instead of FICR register.
+        description: use nimble/util/addr_ublox package instead
         value: 0
-        restrictions: BLE_PHY_ADDR_PROVIDER_PUBLIC
+        defunct: 1
 
     BLE_PHY_ADDR_PROVIDER_PUBLIC:
         description: Enables public address provider API

nimble/util/addr_ublox/pkg.yml

@@ -0,0 +1,26 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+pkg.name: nimble/util/addr_ublox
+pkg.description: Public address provider for u-blox modules
+pkg.author: "Apache Mynewt <[email protected]>"
+pkg.homepage: "https://mynewt.apache.org/"
+
+pkg.apis:
+    - ble_addr_provider_public

nimble/util/addr_ublox/src/addr_ublox.c

@@ -0,0 +1,46 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+#include <stdint.h>
+#include <nrfx.h>
+
+int
+ble_ll_addr_provide_public(uint8_t *addr)
+{
+    uint32_t addr_high;
+    uint32_t addr_low;
+
+    /* The u-blox modules are preprogrammed from the factory with a unique public
+     * device address. The address is stored in the CUSTOMER[0] and CUSTOMER[1]
+     * registers of the UICR in little endian format. The most significant bytes
+     * of the CUSTOMER[1] register are 0xFF to complete the 32-bit register value.
+     *
+     * The Bluetooth device address consists of the registered OUI combined with
+     * the hexadecimal digits printed on a 2D barcode and as a human-readable
+     * text on the module label.
+     */
+
+    addr_low = NRF_UICR->CUSTOMER[0];
+    addr_high = NRF_UICR->CUSTOMER[1];
+
+    memcpy(&addr[0], &addr_low, 4);
+    memcpy(&addr[4], &addr_high, 2);
+
+    return 0;
+}