ATLEDGE-358 - BLE Broadcast name must read the product name in the OTP

Author: manoelramonintel

libraries/CurieBle/examples/AutomationIO/AutomationIO.ino

@@ -29,7 +29,7 @@
  * For more information: https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx
  */
 
-/* Device name: Appears in advertising packets. Must not exceed 16 characters in length */
+/* Device name: Appears in advertising packets. Must not exceed 20 characters in length */
 #define DEVICE_NAME               "AE_IO"
 /* UUID for Automation I/O service */
 #define SERVICE_UUID_AUTOMATIONIO (0x1815)

libraries/CurieBle/examples/BatteryMonitor/BatteryMonitor.ino

@@ -109,7 +109,7 @@ void setup() {
   /* Set a name for the BLE device
    * We give it an arbitrary name which will appear in advertising packets
    * and can be used by remote peers to identify this BLE device
-   * The name can be changed but must not exceed 16 characters in length */
+   * The name can be changed but must not exceed 20 characters in length */
   CHECK_STATUS(bleDevice.setName("AE_BATTMON"));
 
   /* First, initialise the BLE device */

libraries/CurieBle/src/BleDevice.h

@@ -91,7 +91,7 @@ class BlePeripheral {
      * If broadcast name is not set, a default name will be used instead
      *
      * @param name       User-defined name string for this device.  Truncated if
-     *                   more than maximum allowed string length (16 bytes).
+     *                   more than maximum allowed string length (20 bytes).
      *
      * @note This method must be called before the init method
      */
@@ -101,7 +101,7 @@ class BlePeripheral {
      * Get the current broadcast name for the BLE Peripheral Device
      *
      * @param name       Array to be filled with a copy of the name string.
-     *                   Array size must be at least 17 bytes.
+     *                   Array size must be at least 20 bytes.
      */
     void getName(char name[]) const;
 

libraries/CurieBle/src/internal/ble_client.c

@@ -46,6 +46,7 @@
 #include "infra/ipc_uart.h"
 
 #include "ble_client.h"
+#include "platform.h"
 
 enum {
     UNIT_0_625_MS = 625,                            /**< Number of microseconds in 0.625 milliseconds. */
@@ -402,14 +403,47 @@ void ble_client_get_factory_config(ble_addr_t *bda, char *name)
 
     /* Set a default name if one has not been specified */
     if (name) {
-        char *suffix = name + strlen(BLE_DEVICE_NAME_DEFAULT_PREFIX);
-        strcpy(name, BLE_DEVICE_NAME_DEFAULT_PREFIX);
-		if (bda && bda->type != BLE_DEVICE_ADDR_INVALID) {
+
+        // Need to check in the OTP if there is some board name set
+        // If yes, let's read it, otherwise let's keep the default
+        // name set in BLE_DEVICE_NAME_DEFAULT_PREFIX
+        const struct customer_data* otp_data_ptr = (struct customer_data*)(FACTORY_DATA_ADDR + 0x200);
+        char *suffix;
+
+        // checking the presence of key patterns
+        if ((otp_data_ptr->patternKeyStart == PATTERN_KEY_START) &&
+            (otp_data_ptr->patternKeyEnd == PATTERN_KEY_END))
+        {
+           // The board name is with OTP ar programmed
+           uint8_t len = otp_data_ptr->board_name_len;
+
+           // We need to reserve 5 bytes for '-' and 4 last MAC address in ASCII 
+           if (len > BLE_MAX_DEVICE_NAME - 5) len = BLE_MAX_DEVICE_NAME - 5;
+           strncpy(name, (const char *)otp_data_ptr->board_name, len);
+           suffix = name + len;
+        }
+        else
+        {
+            // There is no board name in the OTP area
+            suffix = name + strlen(BLE_DEVICE_NAME_DEFAULT_PREFIX);
+            strcpy(name, BLE_DEVICE_NAME_DEFAULT_PREFIX);
+        }
+
+        // Adding the four last digits of MAC address separated by '-' sufix
+        if (bda && bda->type != BLE_DEVICE_ADDR_INVALID) 
+        {
             *suffix++ = '-';
-            BYTE_TO_STR(suffix, p_oem->bt_address[4]);
-            BYTE_TO_STR(suffix, p_oem->bt_address[5]);
+             BYTE_TO_STR(suffix, p_oem->bt_address[4]);
+             BYTE_TO_STR(suffix, p_oem->bt_address[5]);
+	     *suffix = 0; /* NULL-terminate the string. Note the macro BYTE_TO_STR 
+                             automatically move the pointer */
+        }
+        else
+        {
+	     /* This code segment will be only reached if Curie module was not 
+                provisioned properly with a BLE MAC address*/
+             *suffix++ = 0; /* NULL-terminate the string */
         }
-        *suffix = 0; /* NULL-terminate the string */
     }
 }
 

system/libarc32_edu/framework/include/infra/factory_data.h

@@ -51,6 +51,12 @@
  * the factory_data struct is modified */
 #define FACTORY_DATA_VERSION 0x01
 
+/** Key Patterns in the OTP area */
+#define PATTERN_KEY_START  0xA5A5A5A5
+#define PATTERN_KEY_END    0x5A5A5A5A
+const char INVALID_SN_F[4] = {0xFF, 0xFF, 0xFF, 0xFF};
+const char INVALID_SN_0[4] = {0,0,0,0};
+
 enum hardware_type {
     EVT = 0x00,  /*!< Engineering hardware */
     DVT = 0x04,  /*!< Comes after EVT */
@@ -140,7 +146,28 @@ struct customer_data {
      * hexadecimal value, left-padded */
     uint8_t product_hw_ver[4];
 
-    uint8_t reserved[492];
+    uint8_t reserved[12];
+
+    uint8_t board_name[32];
+
+    uint8_t vendor_name[32];
+
+    uint32_t product_sn_len;
+
+    uint32_t board_name_len;
+
+    uint32_t vendor_name_len;
+
+    uint8_t reserved_1[388];
+
+    uint32_t patternKeyStart;
+
+    uint32_t blockVersionHi;
+
+    uint32_t blockVersionLow;
+
+    uint32_t patternKeyEnd;
+
 } __packed;
 
 /**

system/libarc32_edu/framework/src/services/ble/ble_protocol.h

@@ -40,7 +40,7 @@
  *
  * Bluetooth SIG defined macros and enum extracted from Bluetooth Spec 4.2
  */
-#define BLE_MAX_DEVICE_NAME 16 /**< Max BLE device name length, spec size: 248 */
+#define BLE_MAX_DEVICE_NAME  20 /**< Max BLE device name length, spec size: 248 */
 #define BLE_MAX_ADV_SIZE     31
 
 /** Advertising Data Type. */