Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

applications: nrf5340_audio: Buildprog, pristine and flashing issue #20963

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gWacey
Copy link
Contributor

@gWacey gWacey commented Mar 17, 2025

OCT-3320

Buildprog issues with building and programming single cores.

@gWacey gWacey requested review from a team as code owners March 17, 2025 08:38
@gWacey gWacey requested review from koffes, rick1082 and alexsven March 17, 2025 08:39
@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Mar 17, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Mar 17, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 17

Inputs:

Sources:

sdk-nrf: PR head: 78c0fa353e5a425f4ff2233ac845312b39b6f9e3

more details

sdk-nrf:

PR head: 78c0fa353e5a425f4ff2233ac845312b39b6f9e3
merge base: 8798f86aa24582bd18256cbaca76cb25e25096cb
target head (main): c35c15e1fdcef48c5c15efa3a388d40d8f694b9b
Diff

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (3)
applications
│  ├── nrf5340_audio
│  │  ├── doc
│  │  │  │ building.rst
│  │  ├── tools
│  │  │  ├── buildprog
│  │  │  │  ├── buildprog.py
│  │  │  │  │ program.py

Outputs:

Toolchain

Version: 4ffa2202d5
Build docker image: docker-dtr.nordicsemi.no/sw-production/ncs-build:4ffa2202d5_8bf7ca4353

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain - Skipped: existing toolchain is used
  • ✅ Build twister
    • sdk-nrf test count: 34
  • ✅ Integration tests
    • ✅ test-sdk-audio
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_cloud
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_mosh
    • test-fw-nrfconnect-nrf-iot_positioning
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_thingy91
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-proprietary_esb
    • test-fw-nrfconnect-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-low-level
    • test-sdk-dfu
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-wifi
    • test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

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>`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nrf53_audio_app_overview_broadcast_unicast does not exist. I don't know where you want to link here... nrf53_audio_feature_support? https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/applications/nrf5340_audio/doc/feature_support.html

Or maybe you want to link to building?

Suggested change
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>`:
Given the nRF5340 Audio :ref:`application architecture <nrf53_audio_app_overview>`, you can :ref:`build the nRF5340 Audio applications <nrf53_audio_app_building>` for either the broadcast or the unicast role.

@gWacey gWacey force-pushed the OCT-3320-Buildprog-pristine-and-flashing-issue branch 3 times, most recently from b054c12 to 5f64c65 Compare March 17, 2025 20:49
@gWacey gWacey requested a review from greg-fer March 17, 2025 20:50
Copy link

github-actions bot commented Mar 17, 2025

You can find the documentation preview for this PR here.

Preview links for modified nRF Connect SDK documents:

https://ncsdoc.z6.web.core.windows.net/PR-20963/nrf/applications/nrf5340_audio/doc/building.html

Copy link
Contributor

@greg-fer greg-fer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with nit about #20817.

@@ -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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrased this line a bit in #20817 , so you might want to update accordingly.

@gWacey gWacey force-pushed the OCT-3320-Buildprog-pristine-and-flashing-issue branch 2 times, most recently from 0a8eabb to 66f8222 Compare March 19, 2025 10:40
@gWacey gWacey requested a review from greg-fer March 19, 2025 10:43
@gWacey gWacey force-pushed the OCT-3320-Buildprog-pristine-and-flashing-issue branch 3 times, most recently from 346a733 to 8fadf93 Compare March 20, 2025 15:16
@github-actions github-actions bot removed the doc-required PR must not be merged without tech writer approval. label Mar 20, 2025
@gWacey gWacey force-pushed the OCT-3320-Buildprog-pristine-and-flashing-issue branch from 8fadf93 to 36aada3 Compare March 20, 2025 15:31
Copy link

@gWacey gWacey force-pushed the OCT-3320-Buildprog-pristine-and-flashing-issue branch from 36aada3 to f91bd8b Compare March 24, 2025 08:48
@@ -152,7 +139,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=auto"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we manually select pristine, i believe this script should just do:

Suggested change
build_cmd += " --pristine=auto"
build_cmd += " --pristine"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Put back to --pristine

build_cmd += " -p"
build_cmd += " --pristine=auto"

dest_folder = TARGET_AUDIO_FOLDER / "build" / options.transport / device / core / build
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is "build" required as part of the path? I thought ./build/ would be the top folder? (Within the audio application folder).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussion, we can put the buildprog builds in the buildprog folder.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General: We need to add a note to the changelog about this buildprog change.
Suggest that we also add a deprecation note there. Something along the lines of:
"The buildprog.py is a convenience script for building and flashing multiple kits and cores with various audio application configurations. With time, we will progress towards using only standard tools for building and flashing kits. Buildprog will be deprecated in a future release."

@gWacey gWacey force-pushed the OCT-3320-Buildprog-pristine-and-flashing-issue branch 2 times, most recently from fcc6bb7 to d3c4bcb Compare March 25, 2025 14:36
@gWacey gWacey force-pushed the OCT-3320-Buildprog-pristine-and-flashing-issue branch 2 times, most recently from 81c6c1b to 7161bad Compare March 25, 2025 15:00
@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Mar 25, 2025
@gWacey gWacey force-pushed the OCT-3320-Buildprog-pristine-and-flashing-issue branch from 7161bad to 8f34837 Compare March 25, 2025 15:19
Buildprog issues with building and programming single cores.

Signed-off-by: Graham Wacey <graham.wacey@nordicsemi.no>
@gWacey gWacey force-pushed the OCT-3320-Buildprog-pristine-and-flashing-issue branch from 8f34837 to 78c0fa3 Compare March 25, 2025 16:08
@gWacey gWacey requested review from koffes and greg-fer March 25, 2025 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants