Skip to content

Commit bcc0d22

Browse files
committed
doc: nrf util: usb driver prerequisite for win
Added information about the required installation of USB Driver for J-Link on Windows. Moved installation instructions to nRF Util docs and removed them from the nRF54H20 Getting Started Guide. NCD-909. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
1 parent 09d5944 commit bcc0d22

File tree

5 files changed

+17
-25
lines changed

5 files changed

+17
-25
lines changed

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_gs.rst

+2-21
Original file line numberDiff line numberDiff line change
@@ -46,27 +46,8 @@ You also need the following:
4646

4747
* `Git`_ or `Git for Windows`_ (on Linux and Mac, or Windows, respectively)
4848
* `curl`_
49-
* SEGGER J-Link |jlink_ver| and, on Windows, also the SEGGER USB Driver for J-Link from `SEGGER J-Link`_ |jlink_ver|
50-
51-
.. note::
52-
To install the SEGGER USB Driver for J-Link on Windows, manually install J-Link |jlink_ver| from the command line using the ``-InstUSBDriver=1`` parameter:
53-
54-
1. Navigate to the download location of the J-Link executable and run one of the following commands:
55-
56-
* From the Command Prompt::
57-
58-
JLink_Windows_V794i_x86_64.exe -InstUSBDriver=1
59-
60-
* From PowerShell::
61-
62-
.\JLink_Windows_V794i_x86_64.exe -InstUSBDriver=1
63-
64-
#. Follow the on-screen instructions.
65-
#. After installing, ensure the J-Link executable can be run from anywhere on your system:
66-
67-
* For Linux and MacOS, add it to the system path.
68-
* For Windows, add it to the environment variables.
69-
49+
* SEGGER J-Link |jlink_ver| and, on Windows, also the SEGGER USB Driver for J-Link from `SEGGER J-Link`_ |jlink_ver|.
50+
For information on how to install the USB Driver, see the `nRF Util prerequisites`_ documentation.
7051
* The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_
7152
* In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_
7253
* On Linux, the `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware

doc/nrf/installation/install_ncs.rst

+8-2
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,13 @@ Depending on your preferred development environment, install the following requi
5151
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and download the installer from the `nRF Command Line Tools`_ page.
5252
* The |jlink_ver_vsc| of :ref:`SEGGER J-Link <requirements_jlink>`.
5353
Download it from the `J-Link Software and Documentation Pack`_ page.
54+
On Windows, `install it manually together with SEGGER USB Driver for J-Link <nRF Util prerequisites_>`_.
5455
* The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_.
5556
* In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_.
5657

57-
* Additionally for Linux users: the `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware.
58+
* Additionally, for Windows users: SEGGER USB Driver for J-Link, required for support of older Nordic Semiconductor devices in nRF Util.
59+
For information on how to install the USB Driver, see the `nRF Util prerequisites`_ documentation.
60+
* Additionally, for Linux users: the `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware.
5861

5962
.. group-tab:: Command line
6063

@@ -75,8 +78,11 @@ Depending on your preferred development environment, install the following requi
7578

7679
* The |jlink_ver| of :ref:`SEGGER J-Link <requirements_jlink>`.
7780
Download it from the `J-Link Software and Documentation Pack`_ page.
81+
On Windows, `install it manually together with SEGGER USB Driver for J-Link <nRF Util prerequisites_>`_.
7882

79-
* Additionally for Linux users: the `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware.
83+
* Additionally, for Windows users: SEGGER USB Driver for J-Link, required for support of older Nordic Semiconductor devices in nRF Util.
84+
For information on how to install the USB Driver, see the `nRF Util prerequisites`_ documentation.
85+
* Additionally, for Linux users: the `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware.
8086

8187
.. _gs_installing_toolchain:
8288
.. _gs_installing_tools:

doc/nrf/installation/recommended_versions.rst

+3
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,9 @@ Among others, this package includes the J-Link RTT Viewer, which can be used for
287287

288288
It is recommended to use the |jlink_ver| of the package when you :ref:`installing_vsc`.
289289

290+
On Windows, you also need to install SEGGER USB Driver for J-Link, which is required for support of older Nordic Semiconductor devices in :ref:`requirements_nrf_util`.
291+
For information on how to install the USB Driver, see the `nRF Util prerequisites`_ documentation.
292+
290293
.. _toolchain_management_tools:
291294
.. _additional_nordic_sw_tools:
292295

doc/nrf/links.txt

+1
Original file line numberDiff line numberDiff line change
@@ -836,6 +836,7 @@
836836

837837
.. _`nRF Util`: https://docs.nordicsemi.com/bundle/nrfutil/page/README.html
838838
.. _`Installing nRF Util`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing.html
839+
.. _`nRF Util prerequisites`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing.html#prerequisites
839840
.. _`Installing and upgrading nRF Util commands`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing_commands.html
840841
.. _`Installing nRF Util for nRF5 SDK`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/installing.html
841842
.. _`DFU over Zigbee`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/dfu_performing.html#dfu-over-zigbee

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The following sections provide detailed lists of changes by component.
3333
IDE, OS, and tool support
3434
=========================
3535

36-
|no_changes_yet_note|
36+
* Updated the :ref:`installing_vsc` section on the :ref:`installation` page with the Windows-only requirement to install SEGGER USB Driver for J-Link.
3737

3838
Board support
3939
=============
@@ -63,7 +63,8 @@ Developing with nRF70 Series
6363
Working with nRF54H Series
6464
==========================
6565

66-
|no_changes_yet_note|
66+
* Removed the note on installing SEGGER USB Driver for J-Link on Windows from the :ref:`ug_nrf54h20_gs` page and moved its contents to the `nRF Util prerequisites`_ documentation.
67+
The Windows-only requirement to install the SEGGER USB Driver for J-Link is now mentioned in the :ref:`installing_vsc` section on the :ref:`installation` page.
6768

6869
Developing with nRF54L Series
6970
=============================

0 commit comments

Comments
 (0)