Feature/nrf52 release script (ARMmbed#113)

* Add release script features for nrf52_dk
* Add binary naming info in release process doc

Author: LiyouZhou

configs/nrf52_mbed_app.json renamed to configs/nrf52_block_device_fake_rot.json

@@ -33,17 +33,17 @@
             "update-client.firmware-header-version": "2"
         },
         "NRF52_DK": {
-            "minimal-printf.console-output"    : "SWO",
-            "target.app_offset"                : "0x74000",
-            "update-client.application-details": "(508*1024)",
-            "application-start-address"        : "(152*1024)",
-            "max-application-size"             : "((456-152)*1024)",
-            "target.extra_labels_remove"       : ["SOFTDEVICE_S132_FULL", "SOFTDEVICE_COMMON"],
-            "target.extra_labels_add"          : ["SOFTDEVICE_S132_MBR"],
-            "update-client.storage-address"    : "(64*1024*1024)",
-            "update-client.storage-size"       : "(2*1024*1024)",
-            "update-client.storage-locations"  : 1,
-            "update-client.storage-page"       : 512
+            "minimal-printf.console-output"     : "SWO",
+            "target.app_offset"                 : "0x74000",
+            "update-client.application-details" : "(508*1024)",
+            "application-start-address"         : "(152*1024)",
+            "max-application-size"              : "((456-152)*1024)",
+            "target.extra_labels_remove"        : ["SOFTDEVICE_S132_FULL", "SOFTDEVICE_COMMON"],
+            "target.extra_labels_add"           : ["SOFTDEVICE_S132_MBR"],
+            "update-client.storage-address"     : "(64*1024*1024)",
+            "update-client.storage-size"        : "(2*1024*1024)",
+            "update-client.storage-locations"   : 1,
+            "update-client.storage-page"        : 512
         }
     }
 }

configs/nrf52_internal_flash_fake_rot.json

@@ -0,0 +1,49 @@
+{
+    "macros": [
+        "MBEDTLS_USER_CONFIG_FILE=\"mbedtls_mbed_client_config.h\"",
+        "PAL_USER_DEFINED_CONFIGURATION=\"sotp_fs_config_MbedOS.h\"",
+        "MAX_COPY_RETRIES=1",
+        "SHOW_PROGRESS_BAR=1",
+        "MAX_BOOT_RETRIES=3",
+        "ARM_UC_USE_PAL_CRYPTO=0",
+        "Mutex=PlatformMutex",
+        "PAL_USE_INTERNAL_FLASH=1",
+        "PAL_THREAD_SAFETY=0",
+        "ARM_UC_USE_SOTP=0",
+        "MBED_CLOUD_CLIENT_UPDATE_STORAGE=ARM_UCP_FLASHIAP",
+        "ARM_UC_USE_PAL_BLOCKDEVICE=1",
+        "PAL_INT_FLASH_NUM_SECTIONS=2"
+    ],
+    "config": {
+        "application-start-address": {
+            "help": "Address of the active application firmware in flash",
+            "value": null
+        },
+        "max-application-size": {
+            "help": "Maximum size of the active application",
+            "value": null
+        }
+    },
+    "target_overrides": {
+        "*": {
+            "target.features_remove": ["LWIP"],
+            "target.features_add": ["COMMON_PAL"],
+            "platform.stdio-baud-rate": 115200,
+            "platform.stdio-flush-at-exit": false,
+            "update-client.firmware-header-version": "2"
+        },
+        "NRF52_DK": {
+            "minimal-printf.console-output"     : "SWO",
+            "target.app_offset"                 : "0x74000",
+            "update-client.application-details" : "(508*1024)",
+            "application-start-address"         : "(152*1024)",
+            "max-application-size"              : "(156*1024)",
+            "update-client.storage-address"     : "(308*1024)",
+            "update-client.storage-size"        : "(156*1024)",
+            "update-client.storage-locations"   : 1,
+            "update-client.storage-page"        : 4,
+            "target.extra_labels_remove"        : ["SOFTDEVICE_S132_FULL", "SOFTDEVICE_COMMON"],
+            "target.extra_labels_add"           : ["SOFTDEVICE_S132_MBR"]
+        }
+    }
+}

scripts/make_release.py

@@ -18,11 +18,13 @@
 # ----------------------------------------------------------------------------
 
 from subprocess import check_output, call
+from intelhex import IntelHex
 import re, os
 
 # the memory start address of platforms
 mem_starts = {
     "K64F": 0,
+    "NRF52_DK": 0,
     "NUCLEO_F429ZI": 0x08000000,
     "UBLOX_EVK_ODIN_W2": 0x08000000,
     "UBLOX_C030_U201": 0x08000000
@@ -34,15 +36,27 @@
     ),
     "internal_flash_sotp": (
         "configs/internal_flash_sotp.json", "internal-flash", "sotp"
+    ),
+    "internal_flash_fake_rot": (
+        "configs/internal_flash_fake_rot.json", "internal-flash", "fake-rot"
+    ),
+    "nrf52_block_device_fake_rot": (
+        "configs/nrf52_block_device_fake_rot.json", "block-device", "fake-rot"
+    ),
+    "nrf52_internal_flash_fake_rot": (
+        "configs/nrf52_internal_flash_fake_rot.json", "internal-flash", "fake-rot"
     )
 }
 # format: ("target", "config_name")
 targets = [
     ("K64F", "default"),
     ("K64F", "internal_flash_sotp"),
+    ("K64F", "internal_flash_fake_rot"),
     ("NUCLEO_F429ZI", "default"),
     ("UBLOX_EVK_ODIN_W2", "default"),
-    ("UBLOX_C030_U201", "default")
+    ("UBLOX_C030_U201", "default"),
+    ("NRF52_DK", "nrf52_block_device_fake_rot"),
+    ("NRF52_DK", "nrf52_internal_flash_fake_rot")
 ]
 toolchain = "GCC_ARM"
 profile = "tiny.json" # default value, changed via command line arg --profile
@@ -187,6 +201,16 @@ def find_offset(map_file, symbol):
 
     return int(match.groups()[0], 16)
 
+def mergehex(fn_1, fn_2):
+    """
+    merge two hex files write back to file 1.
+    """
+    ih_1 = IntelHex(fn_1)
+    ih_2 = IntelHex(fn_2)
+    ih_1.merge(ih_2)
+
+    ih_1.tofile(fn_1, format='hex')
+
 if __name__ == '__main__':
     import shutil, os, glob,json, pprint, argparse, sys
     from collections import OrderedDict
@@ -253,7 +277,11 @@ def find_offset(map_file, symbol):
 
         build_dir = "./BUILD/{}/{}/".format(target, toolchain)
         map_file = path.join(build_dir, bootloader_repo_name+'.map')
-        bin_file = path.join(build_dir, bootloader_repo_name+'.bin')
+        bin_file_type = "bin"
+        if target == "NRF52_DK":
+            map_file = path.join(build_dir, bootloader_repo_name+'_application.map')
+            bin_file_type = "hex"
+        bin_file = path.join(build_dir, bootloader_repo_name+'.'+bin_file_type)
 
         # find bootloader details offset
         bootloader_offset = find_offset(map_file, "bootloader")
@@ -296,12 +324,17 @@ def find_offset(map_file, symbol):
                     addr = app_config_js['target_overrides'][target][field]
                     s = s.replace(addr, "0x{:08X}".format(bootloader_offset))
 
-                    # validation
-                    if validate_config(bootloader_config_js,
-                                       app_config_js, target, bin_file):
-                        target_config_exist = True
+                    bootloader_storage = bootloader_configs[bootloader_config_name][1]
+                    if target != "NRF52_DK" and update_storage != "fake-rot":
+                        # validation
+                        if validate_config(bootloader_config_js,
+                                           app_config_js, target, bin_file):
+                            target_config_exist = True
+                        else:
+                            print("Config validation failed")
+                            sys.exit(1)
                     else:
-                        sys.exit(1)
+                        target_config_exist = True
                 except KeyError:
                     print "no config in this file for target", target
 
@@ -318,9 +351,16 @@ def find_offset(map_file, symbol):
             git_desc = get_git_desc()
             release_desc = git_desc.replace('.', '_')
 
-            fn = 'mbed-bootloader-{}-{}-{}-{}.bin'.format(
-                target_name, bootloader_storage, bootloader_rot, release_desc)
+            fn = 'mbed-bootloader-{}-{}-{}-{}.{}'.format(
+                target_name, bootloader_storage, bootloader_rot,
+                release_desc, bin_file_type)
             dst = path.join(example_dir, 'tools', fn)
 
+            if target == "NRF52_DK":
+                print "merging uicr with bootloader"
+                # merge bootloader with uicr
+                uicr_fn = "scripts/uicr-0x74000.hex"
+                mergehex(bin_file, uicr_fn)
+
             print dst, path.isfile(dst)
             shutil.copyfile(bin_file, dst)

scripts/release_process.md

@@ -26,7 +26,7 @@
 1. Combine the bootloaer and the example application
 1. Perform an full e2e update to make sure bootloader works correctly. Some of this is automated in the CI but need to make sure each binary is tested in at least one of the configurations.
    1. Make sure the bootloader details is correctly read. Look for the trace `ARM_UC_HUB_STATE_REPORT_INSTALLER_DETAILS`
-1. Submit pull request to [example app](https://github.com/ARMmbed/mbed-cloud-client-example-internal/) best to mention the SHA-1 of the binary's origin. The file name of the generated binary now contain `git describe` information, make sure you add new bin and remove the old ones.
+1. Submit pull request to [example app](https://github.com/ARMmbed/mbed-cloud-client-example-internal/) best to mention the SHA-1 of the binary's origin. The file name of the generated binary now contain `git describe` information, make sure you add new bin and remove the old ones. The naming scheme is `mbed-bootloader-{target}-{storage_option}-{rot_option}-{git describe --tags --abbrev=4}.bin`
 1. Repeat the same for [testapp](https://github.com/ARMmbed/mbed-client-testapp)
 
 # External release to restricted repo