applications: nrf5340_audio: Buildprog, pristine and flashing issue

Buildprog issues with building and programming single cores.

Signed-off-by: Graham Wacey <graham.wacey@nordicsemi.no>

Author: gWacey

applications/nrf5340_audio/doc/building.rst

@@ -113,7 +113,7 @@ The command can be run from any location, as long as the correct path to :file:`
 
 The build files are saved in separate subdirectories in the :file:`applications/nrf5340_audio/build` directory.
 The script creates a directory for each application version and device type combination.
-For example, when running the command above, the script creates the :file:`dev_gateway/build_debug` and :file:`dev_headset/build_debug` directories.
+For example, when running the command above, the script creates the :file:`unicast/gateway/app` and :file:`unicast/headset/app` directories.
 
 Script parameters for programming
 ---------------------------------
@@ -259,6 +259,13 @@ Complete the following steps to build the application:
       * For headset device: ``-DCONFIG_AUDIO_DEV=1``
       * For gateway device: ``-DCONFIG_AUDIO_DEV=2``
 
+   #. Choose the configuration file for the device selected by using one of the following options:
+
+      * For unicast headset: ``-DEXTRA_CONF_FILE=".\unicast_server\overlay-unicast_server.conf"``
+      * For unicast gateway: ``-DEXTRA_CONF_FILE=".\unicast_client\overlay-unicast_client.conf"``
+      * For broadcast headset: ``-DEXTRA_CONF_FILE=".\broadcast_sink\overlay-broadcast_sink.conf"``
+      * For broadcast gateway: ``-DEXTRA_CONF_FILE=".\broadcast_source\overlay-broadcast_source.conf"``
+
    #. Choose the application version (:ref:`nrf53_audio_app_building_config_files`) by using one of the following options:
 
       * For the debug version: No build flag needed.
@@ -269,9 +276,9 @@ Complete the following steps to build the application:
 
    .. code-block:: console
 
-      west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -DCONFIG_AUDIO_DEV=1 -DFILE_SUFFIX=release
+      west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -DCONFIG_AUDIO_DEV=1 -DEXTRA_CONF_FILE=".\unicast_server\overlay-unicast_server.conf" -DFILE_SUFFIX=release
 
-   This command creates the build files for headset device directly in the :file:`build` directory.
+   This command creates the build files for a unicast headset device directly in the :file:`build` directory.
    What this means is that you cannot create build files for all devices you want to program, because the subsequent commands will overwrite the files in the :file:`build` directory.
 
    To work around this standard west behavior, you can add the ``-d`` parameter to the ``west`` command to specify a custom build folder for each device.

applications/nrf5340_audio/doc/configuration.rst

@@ -13,6 +13,17 @@ By default, if you have not made any changes to :file:`.conf` files at :file:`ap
 
 .. _nrf53_audio_app_configuration_select_build:
 
+Selecting broadcast or unicast build
+************************************
+
+Given the nRF5340 Audio :ref:`application architecture <nrf53_audio_app_overview>`, the nRF5340 Audio applications can be built for :ref:`either the broadcast or the unicast role <nrf53_audio_app_overview_broadcast_unicast>`:
+
+* The unicast build is identified with :kconfig:option:`CONFIG_TRANSPORT_CIS` Kconfig option set to ``y``.
+  This is the default configuration.
+* The broadcast build can be selected by adding :kconfig:option:`CONFIG_TRANSPORT_BIS` Kconfig option set to ``y`` to the :file:`prj.conf` file.
+
+.. _nrf53_audio_app_configuration_select_transport:
+
 Selecting gateway or headset build
 **********************************
 

applications/nrf5340_audio/tools/buildprog/buildprog.py

@@ -42,9 +42,7 @@
         os.getenv("AUDIO_KIT_SERIAL_NUMBERS_JSON"))
 TARGET_BOARD_NRF5340_AUDIO_DK_APP_NAME = "nrf5340_audio_dk/nrf5340/cpuapp"
 
-TARGET_CORE_APP_FOLDER = NRF5340_AUDIO_FOLDER
-TARGET_DEV_HEADSET_FOLDER = NRF5340_AUDIO_FOLDER / "build/dev_headset"
-TARGET_DEV_GATEWAY_FOLDER = NRF5340_AUDIO_FOLDER / "build/dev_gateway"
+TARGET_AUDIO_FOLDER = NRF5340_AUDIO_FOLDER
 
 UNICAST_SERVER_OVERLAY = NRF5340_AUDIO_FOLDER / "unicast_server/overlay-unicast_server.conf"
 UNICAST_CLIENT_OVERLAY = NRF5340_AUDIO_FOLDER / "unicast_client/overlay-unicast_client.conf"
@@ -90,38 +88,34 @@ def __print_dev_conf(device_list):
     print(table)
 
 
-def __build_cmd_get(cores: Core, device: AudioDevice, build: BuildType,
+def __build_cmd_get(core: Core, device: AudioDevice, build: BuildType,
                     pristine, options):
 
-    build_cmd = (f"west build {TARGET_CORE_APP_FOLDER} "
+    build_cmd = (f"west build {TARGET_AUDIO_FOLDER} "
                  f"-b {TARGET_BOARD_NRF5340_AUDIO_DK_APP_NAME} "
                  f"--sysbuild")
-    if Core.app in cores and Core.net in cores:
-        # No changes to build command, build both cores
-        pass
-    elif Core.app in cores:
+
+    if core == Core.app:
         build_cmd += " --domain nrf5340_audio"
-    elif Core.net in cores:
+    elif core == Core.net:
         build_cmd += " --domain ipc_radio"
     else:
         raise Exception("Invalid core!")
 
     if device == AudioDevice.headset:
         device_flag = "-DCONFIG_AUDIO_DEV=1"
-        dest_folder = TARGET_DEV_HEADSET_FOLDER
     elif device == AudioDevice.gateway:
         device_flag = "-DCONFIG_AUDIO_DEV=2"
-        dest_folder = TARGET_DEV_GATEWAY_FOLDER
     else:
         raise Exception("Invalid device!")
+
     if build == BuildType.debug:
         release_flag = ""
-        dest_folder /= TARGET_DEBUG_FOLDER
     elif build == BuildType.release:
         release_flag = " -DFILE_SUFFIX=release"
-        dest_folder /= TARGET_RELEASE_FOLDER
     else:
         raise Exception("Invalid build type!")
+
     if options.nrf21540:
         device_flag += " -Dnrf5340_audio_SHIELD=nrf21540ek"
         device_flag += " -Dipc_radio_SHIELD=nrf21540ek"
@@ -139,17 +133,22 @@ def __build_cmd_get(cores: Core, device: AudioDevice, build: BuildType,
     if options.transport == Transport.broadcast.name:
         if device == AudioDevice.headset:
             overlay_flag = f" -DEXTRA_CONF_FILE={BROADCAST_SINK_OVERLAY}"
-        elif device == AudioDevice.gateway:
+        else:
             overlay_flag = f" -DEXTRA_CONF_FILE={BROADCAST_SOURCE_OVERLAY}"
     elif options.transport == Transport.unicast.name:
         if device == AudioDevice.headset:
             overlay_flag = f" -DEXTRA_CONF_FILE={UNICAST_SERVER_OVERLAY}"
-        elif device == AudioDevice.gateway:
+        else:
             overlay_flag = f" -DEXTRA_CONF_FILE={UNICAST_CLIENT_OVERLAY}"
+    else:
+        raise Exception("Invalid transport type!")
+
     if os.name == 'nt':
         release_flag = release_flag.replace('\\', '/')
     if pristine:
-        build_cmd += " -p"
+        build_cmd += " --pristine=auto"
+
+    dest_folder = TARGET_AUDIO_FOLDER / "build" / options.transport / device / core / build
 
     return build_cmd, dest_folder, device_flag, release_flag, overlay_flag
 
@@ -196,12 +195,11 @@ def __find_snr():
 def __populate_hex_paths(dev, options):
     """Poplulate hex paths where relevant"""
 
-    _, temp_dest_folder, _, _, _ = __build_cmd_get(
-        Core.app, dev.nrf5340_audio_dk_dev, options.build, options.pristine, options
-    )
+    _, temp_dest_folder, _, _, _ = __build_cmd_get(Core.app, dev.nrf5340_audio_dk_dev, options.build, options.pristine, options)
+    dev.hex_path_app = temp_dest_folder / "nrf5340_audio/zephyr/zephyr.hex"
 
-    dev.hex_path_app = temp_dest_folder / "merged.hex"
-    dev.hex_path_net = temp_dest_folder / "merged_CPUNET.hex"
+    _, temp_dest_folder, _, _, _ = __build_cmd_get(Core.net, dev.nrf5340_audio_dk_dev, options.build, options.pristine, options)
+    dev.hex_path_net = temp_dest_folder / "ipc_radio/zephyr/zephyr.hex"
 
 
 def __finish(device_list):
@@ -245,7 +243,10 @@ def __main():
         help="Select which cores to include in build",
     )
     parser.add_argument(
-        "--pristine", default=False, action="store_true", help="Will build cleanly"
+        "--pristine",
+        default=False,
+        action="store_true",
+        help="Will build cleanly"
     )
     parser.add_argument(
         "-b",
@@ -312,7 +313,7 @@ def __main():
     parser.add_argument(
         "-t",
         "--transport",
-        type=str,
+        required=True,
         choices=[i.name for i in Transport],
         default=Transport.unicast.name,
         help="Select the transport type",
@@ -381,23 +382,25 @@ def __main():
         build_configs = []
 
         if AudioDevice.headset in devices:
-            build_configs.append(
-                BuildConf(
-                    core=cores,
-                    device=AudioDevice.headset,
-                    pristine=options.pristine,
-                    build=options.build,
+            for c in cores:
+                build_configs.append(
+                    BuildConf(
+                        core=c,
+                        device=AudioDevice.headset,
+                        pristine=options.pristine,
+                        build=options.build,
+                    )
                 )
-            )
         if AudioDevice.gateway in devices:
-            build_configs.append(
-                BuildConf(
-                    core=cores,
-                    device=AudioDevice.gateway,
-                    pristine=options.pristine,
-                    build=options.build,
-                )
-            )
+            for c in cores:
+                build_configs.append(
+                        BuildConf(
+                            core=c,
+                            device=AudioDevice.gateway,
+                            pristine=options.pristine,
+                            build=options.build,
+                        )
+                    )
 
         for build_cfg in build_configs:
             __build_module(build_cfg, options)
@@ -409,6 +412,7 @@ def __main():
         for dev in device_list:
             if dev.snr_connected:
                 __populate_hex_paths(dev, options)
+
         program_threads_run(device_list, sequential=options.sequential_prog)
 
     # Program step finished

applications/nrf5340_audio/tools/buildprog/program.py

@@ -41,31 +41,35 @@ def __populate_uicr(dev):
 def _program_cores(dev: DeviceConf) -> int:
     if dev.core_net_programmed == SelectFlags.TBD:
         if not path.isfile(dev.hex_path_net):
-            print("NET core hex not found. Built as APP core image.")
-            return 1
-
-        print(f"Programming net core on: {dev}")
-        cmd = (f"nrfjprog --program {dev.hex_path_net}  -f NRF53  -q "
-               f"--snr {dev.nrf5340_audio_dk_snr} --sectorerase --coprocessor CP_NETWORK")
-        ret_val = system(cmd)
-        if ret_val != 0:
-            if not dev.recover_on_fail:
-                dev.core_net_programmed = SelectFlags.FAIL
-            return ret_val
+            print(f"NET core hex not found. Built as APP core image. {dev.hex_path_net}")
         else:
-            dev.core_net_programmed = SelectFlags.DONE
+            print(f"Programming net core on: {dev}")
+            cmd = (f"nrfjprog --program {dev.hex_path_net}  -f NRF53  -q "
+                   f"--snr {dev.nrf5340_audio_dk_snr} --sectorerase --coprocessor CP_NETWORK")
+            ret_val = system(cmd)
+            if ret_val != 0:
+                if not dev.recover_on_fail:
+                    dev.core_net_programmed = SelectFlags.FAIL
+                return ret_val
+            else:
+                dev.core_net_programmed = SelectFlags.DONE
 
     if dev.core_app_programmed == SelectFlags.TBD:
-        print(f"Programming app core on: {dev}")
-        cmd = (f"nrfjprog --program {dev.hex_path_app} -f NRF53  -q "
-               f"--snr {dev.nrf5340_audio_dk_snr} --chiperase --coprocessor CP_APPLICATION")
-        ret_val = system(cmd)
-        if ret_val != 0:
-            if not dev.recover_on_fail:
-                dev.core_app_programmed = SelectFlags.FAIL
-            return ret_val
+        if not path.isfile(dev.hex_path_app):
+            print(f"APP core hex not found. Built as NET core image. {dev.hex_path_app}")
+            return 1
         else:
-            dev.core_app_programmed = SelectFlags.DONE
+            print(f"Programming app core on: {dev}")
+            cmd = (f"nrfjprog --program {dev.hex_path_app} -f NRF53  -q "
+                   f"--snr {dev.nrf5340_audio_dk_snr} --chiperase --coprocessor CP_APPLICATION")
+            ret_val = system(cmd)
+            if ret_val != 0:
+                if not dev.recover_on_fail:
+                    dev.core_app_programmed = SelectFlags.FAIL
+                return ret_val
+            else:
+                dev.core_app_programmed = SelectFlags.DONE
+
         # Populate UICR data matching the JSON file
         if not __populate_uicr(dev):
             dev.core_app_programmed = SelectFlags.FAIL