applications: nrf5340_audio: Buildprog, pristine and flashing issue

Buildprog issues with building and programming single cores.

Signed-off-by: Graham Wacey <[email protected]>

Author: gWacey

applications/nrf5340_audio/doc/building.rst

@@ -48,6 +48,9 @@ This eases the process of building and programming images for multiple developme
 
 The script is located in the :file:`applications/nrf5340_audio/tools/buildprog` directory.
 
+  .. note::
+     The :file:`buildprog.py` script is an app-specific script for building and programming multiple kits and cores with various audio application configurations. The script will be deprecated in a future release. The audio applications will gradually shift only to using standard tools for building and programming development kits.
+
 Preparing the JSON file
 =======================
 
@@ -115,9 +118,9 @@ For example, the following command builds headset and gateway applications using
 
 The command can be run from any location, as long as the correct path to :file:`buildprog.py` is given.
 
-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.
+The build files are saved in separate subdirectories in the :file:`applications/nrf5340_audio/tools/build` directory.
+The script creates a directory for each transport, device type, core, and version combination.
+For example, when running the command above, the script creates the :file:`unicast/gateway/app/debug`, :file:`unicast/gateway/net/debug`, :file:`unicast/headset/app/debug`, :file:`unicast/headset/net/debug` files and directories.
 
 Script parameters for programming
 ---------------------------------

applications/nrf5340_audio/tools/buildprog/buildprog.py

@@ -42,9 +42,8 @@
         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
+TARGET_AUDIO_BUILD_FOLDER = TARGET_AUDIO_FOLDER / "tools/build"
 
 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,35 +89,24 @@ 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:
-        dest_folder = TARGET_DEV_HEADSET_FOLDER
-    elif device == AudioDevice.gateway:
-        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!")
 
@@ -152,7 +140,9 @@ def __build_cmd_get(cores: Core, device: AudioDevice, build: BuildType,
     if os.name == 'nt':
         release_flag = release_flag.replace('\\', '/')
     if pristine:
-        build_cmd += " -p"
+        build_cmd += " --pristine"
+
+    dest_folder = TARGET_AUDIO_BUILD_FOLDER / options.transport / device / core / build
 
     return build_cmd, dest_folder, device_flag, release_flag, overlay_flag
 
@@ -199,12 +189,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):
@@ -248,7 +237,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",
@@ -315,7 +307,7 @@ def __main():
     parser.add_argument(
         "-t",
         "--transport",
-        required = True,
+        required=True,
         choices=[i.name for i in Transport],
         default=Transport.unicast.name,
         help="Select the transport type",
@@ -384,23 +376,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)
@@ -412,6 +406,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/nrf5340_audio_dk_devices.py

@@ -24,7 +24,7 @@ class SelectFlags(str, Enum):
 class Core(str, Enum):
     """SoC core"""
     app = "app"
-    net = "network"
+    net = "net"
     both = "both"
 
 

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 only for APP core. {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 only for NET core. {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

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

@@ -285,7 +285,11 @@ Matter Bridge
 nRF5340 Audio
 -------------
 
-|no_changes_yet_note|
+* Updated:
+
+  * The documentation for :ref:`nrf53_audio_app_building` with cross-links and additional information.
+  * The :file:`buildprog.py` is an app-specific script for building and programming multiple kits and cores with various audio application configurations. The script will be deprecated in a future release. The audio applications will gradually shift only to using standard tools for building and programming development kits.
+  * The :ref:`nrf53_audio_app` :ref:`nrf53_audio_app_building_script` now builds into a directory for each transport, device type, core, and version combination.
 
 nRF Desktop
 -----------