Skip to content

Commit

Permalink
doc: nrf util: usb driver prerequisite for win
Browse files Browse the repository at this point in the history 
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 <[email protected]>
  • Loading branch information
@greg-fer
greg-fer committed Jan 10, 2025
1 parent 09d5944 commit bcc0d22
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 25 deletions.
23 changes: 2 additions & 21 deletions doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_gs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,27 +46,8 @@ You also need the following:

* `Git`_ or `Git for Windows`_ (on Linux and Mac, or Windows, respectively)
* `curl`_
* SEGGER J-Link |jlink_ver| and, on Windows, also the SEGGER USB Driver for J-Link from `SEGGER J-Link`_ |jlink_ver|

.. note::
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:

1. Navigate to the download location of the J-Link executable and run one of the following commands:

* From the Command Prompt::

JLink_Windows_V794i_x86_64.exe -InstUSBDriver=1

* From PowerShell::

.\JLink_Windows_V794i_x86_64.exe -InstUSBDriver=1

#. Follow the on-screen instructions.
#. After installing, ensure the J-Link executable can be run from anywhere on your system:

* For Linux and MacOS, add it to the system path.
* For Windows, add it to the environment variables.

* SEGGER J-Link |jlink_ver| and, on Windows, also the SEGGER USB Driver for J-Link from `SEGGER J-Link`_ |jlink_ver|.
For information on how to install the USB Driver, see the `nRF Util prerequisites`_ documentation.
* The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_
* In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_
* On Linux, the `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware
Expand Down
10 changes: 8 additions & 2 deletions doc/nrf/installation/install_ncs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,13 @@ Depending on your preferred development environment, install the following requi
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and download the installer from the `nRF Command Line Tools`_ page.
* The |jlink_ver_vsc| of :ref:`SEGGER J-Link <requirements_jlink>`.
Download it from the `J-Link Software and Documentation Pack`_ page.
On Windows, `install it manually together with SEGGER USB Driver for J-Link <nRF Util prerequisites_>`_.
* The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_.
* In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_.

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

.. group-tab:: Command line

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

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

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

.. _gs_installing_toolchain:
.. _gs_installing_tools:
Expand Down
3 changes: 3 additions & 0 deletions doc/nrf/installation/recommended_versions.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,9 @@ Among others, this package includes the J-Link RTT Viewer, which can be used for

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

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`.
For information on how to install the USB Driver, see the `nRF Util prerequisites`_ documentation.

.. _toolchain_management_tools:
.. _additional_nordic_sw_tools:

Expand Down
1 change: 1 addition & 0 deletions doc/nrf/links.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -836,6 +836,7 @@

.. _`nRF Util`: https://docs.nordicsemi.com/bundle/nrfutil/page/README.html
.. _`Installing nRF Util`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing.html
.. _`nRF Util prerequisites`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing.html#prerequisites
.. _`Installing and upgrading nRF Util commands`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing_commands.html
.. _`Installing nRF Util for nRF5 SDK`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/installing.html
.. _`DFU over Zigbee`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/dfu_performing.html#dfu-over-zigbee
Expand Down
5 changes: 3 additions & 2 deletions doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The following sections provide detailed lists of changes by component.
IDE, OS, and tool support
=========================

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

Board support
=============
Expand Down Expand Up @@ -63,7 +63,8 @@ Developing with nRF70 Series
Working with nRF54H Series
==========================

|no_changes_yet_note|
* 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.
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.

Developing with nRF54L Series
=============================
Expand Down

0 comments on commit bcc0d22

Please sign in to comment.