Skip to content

Commit f36a64d

Browse files
greg-fercarlescufi
authored andcommitted
doc: update nRF Util install calls
Edited nRF Util installation calls. nRF Util is now part of the toolchain bundle. NRFU-1571 and PR #22969. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent e61f950 commit f36a64d

File tree

9 files changed

+31
-34
lines changed

9 files changed

+31
-34
lines changed

doc/nrf/app_dev/device_guides/nrf54l/kmu_provision.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,8 @@ The |NCS| provides a west command, ``ncs-provision``, allowing to upload keys to
1313
Prerequisites
1414
*************
1515

16-
First, ensure that the `nRF Util`_ tool is installed.
17-
It should install automatically during the setup of the |NCS| working environment.
18-
Once completed, install the required additional commands for nRF Util:
19-
20-
.. parsed-literal::
21-
:class: highlight
22-
23-
nrfutil install device
16+
You need the `nRF Util`_ tool, which you get as part of the :ref:`nRF Connect SDK toolchain bundle <requirements_toolchain>` when you :ref:`gs_installing_toolchain`.
17+
The bundle also provides the ``nrfutil device`` command, which you can use to program the keys to the device.
2418

2519
Additionally, before provisioning, make sure you familiarized yourself with the :ref:`ug_nrf54l_developing_basics_kmu_provisioning_keys` section.
2620

doc/nrf/app_dev/device_guides/nrf70/nrf70_fw_patch_update.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The following platforms are supported:
4848
.. note::
4949

5050
For nRF7002 DK, this feature does not work with tools from the `nRF Command Line Tools`_ product page and nrfjprog programming tool.
51-
To program the nRF7002 DK device, you need to use the nRF Util downloaded from `nRF Util development tool`_ product page.
51+
To program the nRF7002 DK device, you need to use the `nRF Util`_ tool that is part of the :ref:`nRF Connect SDK toolchain bundle <requirements_toolchain>` when you :ref:`gs_installing_toolchain`.
5252

5353
Preparing the application
5454
=========================

doc/nrf/app_dev/device_guides/thingy91x/thingy91x_updating_fw_programmer.rst

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ When developing with your Thingy:91 X, it is recommended to use an external debu
2020
The external debug probe must support Arm Cortex-M33, such as the nRF9151 DK.
2121
You need a 10-pin 2x5 socket-socket 1.27 mm IDC (:term:`Serial Wire Debug (SWD)`) JTAG cable to connect to the external debug probe.
2222

23-
See `Installing nRF Util`_ and `Installing and upgrading nRF Util commands`_ for instructions on how to install the nrfutil device utility.
23+
Both nRF Util and the ``device`` command are part of the :ref:`nRF Connect SDK toolchain bundle <requirements_toolchain>` and you get them when you :ref:`gs_installing_toolchain`.
2424

2525
.. _updating_firmware_nRF5340:
2626

@@ -35,8 +35,7 @@ This section describes how you can update the firmware of the nRF5340 SoC on the
3535

3636
To update the nRF5340 SoC firmware over USB, complete the following steps:
3737

38-
1. Install the ``nrfutil device`` command package by completing the steps in the `Installing and upgrading nRF Util commands`_ documentation.
39-
#. Connect the Thingy:91 X to your computer with a USB-C cable.
38+
1. Connect the Thingy:91 X to your computer with a USB-C cable.
4039
#. Power on the device by switching **SW1** to the **ON** position.
4140
#. Open a terminal window.
4241
#. Enter the following command to list the connected devices and their traits::
@@ -61,8 +60,7 @@ This section describes how you can update the firmware of the nRF5340 SoC on the
6160

6261
To update the nRF5340 firmware using an external debug probe, complete the following steps:
6362

64-
2. Install the ``nrfutil device`` command package by completing the steps in the `Installing and upgrading nRF Util commands`_ documentation.
65-
#. Connect the Thingy:91 X to your computer with a USB-C cable.
63+
2. Connect the Thingy:91 X to your computer with a USB-C cable.
6664
#. Connect the 10-pin :term:`Serial Wire Debug (SWD)` programming cable from the external debug probe to the programming connector (**P8**) on the Thingy:91 X.
6765
#. Connect the external debug probe to your computer.
6866
#. Power on the device by switching **SW1** to the **ON** position.
@@ -101,8 +99,7 @@ When updating the firmware through USB and MCUboot method, you must not connect
10199

102100
To update the nRF9151 SiP application firmware over USB, complete the following steps:
103101

104-
1. Install the ``nrfutil device`` command package by completing the steps in the `Installing and upgrading nRF Util commands`_ documentation.
105-
#. Connect the Thingy:91 X to your computer with a USB-C cable.
102+
1. Connect the Thingy:91 X to your computer with a USB-C cable.
106103
#. Power on the device by switching **SW1** to the **ON** position.
107104
#. Open a terminal window.
108105
#. Enter the following command to list the connected devices and their traits::
@@ -126,8 +123,7 @@ When updating the firmware through USB and MCUboot method, you must not connect
126123

127124
To update the nRF9151 SiP application firmware using an external debug probe, complete the following steps:
128125

129-
1. Install the ``nrfutil device`` command package by completing the steps in the `Installing and upgrading nRF Util commands`_ documentation.
130-
#. Connect the Thingy:91 X to your computer with a USB-C cable.
126+
1. Connect the Thingy:91 X to your computer with a USB-C cable.
131127
#. Connect the 10-pin :term:`Serial Wire Debug (SWD)` programming cable from the external debug probe to the programming connector (**P8**) on the Thingy:91 X.
132128
#. Connect the external debug probe to your computer.
133129
#. Power on the device by switching **SW1** to the **ON** position.
@@ -155,8 +151,7 @@ Updating the modem firmware on the nRF9151 SiP
155151

156152
To update the nRF9151 modem firmware using an external debug probe, complete the following steps:
157153

158-
1. Install the ``nrfutil device`` command package by completing the steps in the `Installing and upgrading nRF Util commands`_ documentation.
159-
#. Connect the Thingy:91 X to your computer with a USB-C cable.
154+
1. Connect the Thingy:91 X to your computer with a USB-C cable.
160155
#. Connect the 10-pin :term:`Serial Wire Debug (SWD)` programming cable from the external debug probe to the programming connector (**P8**) on the Thingy:91 X.
161156
#. Connect the external debug probe to your computer.
162157
#. Power on the device by switching **SW1** to the **ON** position.

doc/nrf/app_dev/programming.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ If you want to change the runner used by ``west flash``, you can use one of the
5959
west flash -r nrfjprog
6060
6161
In either case, make sure you have the required tools installed on your system.
62-
`nRF Util`_ is a :ref:`prerequisite <installing_vsc>` for the |NCS|.
62+
`nRF Util`_ is part of the :ref:`nRF Connect SDK toolchain bundle <requirements_toolchain>`.
6363
For ``-r nrfjprog``, you need the archived `nRF Command Line Tools`_.
6464

6565
To see which runners are available for your board, run the following command:
@@ -94,6 +94,7 @@ Programming the nRF52840 Dongle
9494
Programming the nRF54H20 DK
9595
To program the nRF54H20 DK, follow the programming instructions in the :ref:`nRF54H20 device guide <ug_nrf54h20_gs_sample>`.
9696
Programming the nRF54H20 DK with the |NCS| version earlier than v3.0.0 requires installing the `nrfutil device command <Installing and upgrading nRF Util commands_>`_ for the ``west flash`` command to work with this device.
97+
Starting with the |NCS| v3.1.0, the ``nrfutil device`` command is part of the :ref:`nRF Connect SDK toolchain bundle <requirements_toolchain>` and you get it when you :ref:`gs_installing_toolchain`.
9798

9899
.. _programming_params:
99100

doc/nrf/installation/install_ncs.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ Depending on your preferred development environment, complete the following step
115115
.. group-tab:: Command line
116116

117117
1. Open a terminal window.
118+
#. Remove the lock on the nRF Util installation to be able to install other nRF Util commands.
119+
See `Locking nRF Util home directory`_ in the tool documentation for more information.
118120
#. Run the following command to install the nRF Util's ``sdk-manager`` command:
119121

120122
.. code-block:: console

doc/nrf/links.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,7 @@
923923
.. _`Upgrading nRF Util core module`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing.html#upgrading-nrf-util
924924
.. _`Installing and upgrading nRF Util commands`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing_commands.html
925925
.. _`Installing specific versions of nRF Util commands`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing_commands.html#installing-specific-versions-of-commands
926-
.. _`Installing nRF Util for nRF5 SDK`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/installing.html
926+
.. _`nrf5sdk-tools command overview`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-nrf5sdk-tools/guides/intro.html
927927
.. _`Generating DFU packages`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/dfu_generating_packages.html
928928
.. _`DFU over a serial USB connection`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/dfu_performing.html#dfu-over-a-serial-usb-connection
929929
.. _`Toolchain Manager command`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-toolchain-manager/nrfutil-toolchain-manager_0.14.1.html

doc/nrf/protocols/thread/tools.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,22 @@ To program the nRF device with the RCP application, complete the following steps
102102

103103
.. tab:: nRF52840 Dongle (USB transport)
104104

105-
a. Install nRF Util as described in `Installing nRF Util for nRF5 SDK`_.
105+
This procedure uses the `nRF Util`_ tool, which is part of the :ref:`nRF Connect SDK toolchain bundle <requirements_toolchain>` and you get it when you :ref:`gs_installing_toolchain`.
106+
107+
1. Remove the lock on the nRF Util installation to be able to install other nRF Util commands.
108+
See `Locking nRF Util home directory`_ in the tool documentation for more information.
109+
#. Install nRF Util's ``nrf5sdk-tools`` command:
110+
111+
.. code-block:: console
112+
113+
nrfutil install nrf5sdk-tools
114+
115+
See `nrf5sdk-tools command overview`_ for more information.
106116
#. Generate the RCP firmware package:
107117

108118
.. code-block:: console
109119
110-
nrfutil pkg generate --hw-version 52 --sd-req=0x00 \
120+
nrfutil nrf5sdk-tools pkg generate --hw-version 52 --sd-req=0x00 \
111121
--application build/zephyr/zephyr.hex --application-version 1 build/zephyr/zephyr.zip
112122
113123
#. Connect the nRF52840 Dongle to the USB port.
@@ -117,7 +127,7 @@ To program the nRF device with the RCP application, complete the following steps
117127

118128
.. code-block:: console
119129
120-
nrfutil dfu usb-serial -pkg build/zephyr/zephyr.zip -p /dev/ttyACM0
130+
nrfutil nrf5sdk-tools dfu usb-serial -pkg build/zephyr/zephyr.zip -p /dev/ttyACM0
121131
122132
.. tab:: nRF52840 Development Kit (UART transport)
123133

doc/nrf/protocols/wifi/regulatory_certification/test_setup.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,7 @@ This describes the flashing, running, and use of the appropriate console ports w
139139
Programming firmware in the nRF7002 setup
140140
=========================================
141141

142-
Before you begin, make sure you have the nRF Util tool installed on your computer.
143-
See `Installing nRF Util`_ and `Installing and upgrading nRF Util commands`_ for instructions on how to install the nRF Util device utility.
142+
This procedure uses the `nRF Util`_ tool, which is part of the :ref:`nRF Connect SDK toolchain bundle <requirements_toolchain>` and you get it when you :ref:`gs_installing_toolchain`.
144143

145144
To program firmware in the nRF7002 DK or EK setup, complete the following steps.
146145

@@ -177,7 +176,7 @@ To program firmware in the nRF7002 DK or EK setup, complete the following steps.
177176
$ nrfutil device program --firmware merged_CPUNET.hex --core Network --options chip_erase_mode=ERASE_ALL,reset=RESET_SYSTEM
178177
179178
#. To run the firmware on the nRF7002 DK or EK, reset the device.
180-
You can press the **RESET** button, use the ``reset`` command in nRF Util, or power cycle the development kit.
179+
You can press the **RESET** button, use the ``nrfutil device reset`` command in nRF Util, or power cycle the development kit.
181180

182181
.. note::
183182
Set the baud rate to 115,200 bps.

scripts/docker/README.rst

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,8 @@
1010
The image is based on Linux - Ubuntu 22.04 Docker image with the following additional tools:
1111

1212
* Git
13-
* `nRF Util`_ with following commands:
14-
15-
* ``toolchain-manager``
16-
* ``device``
17-
18-
* |NCS| toolchain bundle
13+
* |NCS| toolchain bundle, which includes `nRF Util`_ and the ``device`` command
14+
* ``toolchain-manager`` command in nRF Util
1915
* SEGGER J-Link |jlink_ver| (installation requires accepting SEGGER License)
2016

2117
Building image

0 commit comments

Comments
 (0)