Skip to content

Commit 7783dec

Browse files
greg-ferrlubos
greg-fer
authored and
rlubos
committed
doc: OS support: update table
Updated table with input received from stakeholders. Updated definitions based on receved feedback. NCSDK-29043. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent e4a47d5 commit 7783dec

File tree

9 files changed

+151
-110
lines changed

9 files changed

+151
-110
lines changed

‎doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Using the command line
5151
======================
5252

5353
To build nRF5340 samples from the command line, use :ref:`west <zephyr:west>`.
54-
To program the nRF5340 DK from the command line, use either west (which uses nrfjprog that is part of the `nRF Command Line Tools`_) or :ref:`nRF Util <toolchain_management_tools>`.
54+
To program the nRF5340 DK from the command line, use either west (which uses nrfjprog that is part of the `nRF Command Line Tools`_) or :ref:`nRF Util <requirements_nrf_util>`.
5555

5656
.. note::
5757
Programming the nRF5340 DK from the command line with west requires the `nRF Command Line Tools`_ v10.12.0 or later.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ On your computer, one of the following operating systems:
3434
:start-after: os_table_start
3535
:end-before: os_table_end
3636

37-
See :ref:`supported_OS` for more information about the tier definitions.
37+
See :ref:`supported_OS` for more information.
3838

3939
|supported OS|
4040

‎doc/nrf/installation/install_ncs.rst‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Installing the |NCS|
99
:local:
1010
:depth: 2
1111

12-
There are different ways to install the |NCS|, depending on your preferred development environment and the :ref:`toolchain management tool <toolchain_management_tools>`:
12+
There are different ways to install the |NCS|, depending on your preferred development environment:
1313

1414
* Using |VSC| and the |nRFVSC| (recommended)
1515
* Using command line and nRF Util
@@ -25,22 +25,21 @@ This includes everything that is required by Zephyr's :ref:`zephyr:getting_start
2525
Update operating system
2626
***********************
2727

28-
Before you start setting up the toolchain, install available updates for your operating system.
28+
Before you start setting up the toolchain, install available updates for your :ref:`operating system <supported_OS>` to make sure it supports the |NCS| firmware.
2929

3030
.. include:: ./recommended_versions.rst
3131
:start-after: os_table_start
3232
:end-before: os_table_end
3333

34-
See :ref:`supported_OS` for more information about the tier definitions.
35-
3634
.. _installing_vsc:
3735

3836
.. rst-class:: numbered-step
3937

4038
Install prerequisites
4139
*********************
4240

43-
Depending on your preferred development environment, install the following required tools:
41+
Depending on your preferred development environment, install the following required tools.
42+
4443

4544
.. tabs::
4645

@@ -49,7 +48,7 @@ Depending on your preferred development environment, install the following requi
4948
* All operating systems:
5049

5150
* The latest version of the :ref:`requirements_clt` package.
52-
Download it from the `nRF Command Line Tools`_ page.
51+
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and download the installer from the `nRF Command Line Tools`_ page.
5352
* The |jlink_ver_vsc| of :ref:`SEGGER J-Link <requirements_jlink>`.
5453
Download it from the `J-Link Software and Documentation Pack`_ page.
5554
* The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_.
@@ -61,15 +60,15 @@ Depending on your preferred development environment, install the following requi
6160

6261
* All operating systems:
6362

64-
* The latest version of `nRF Util development tool`_, a unified command-line utility for Nordic Semiconductor products.
63+
* The latest version of nRF Util, a unified command-line utility for Nordic Semiconductor products.
64+
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and download the installer from the `nRF Util development tool`_ page.
6565

6666
.. note::
6767
After downloading the nRF Util executable, move it to a directory that is in the system :envvar:`PATH`.
68-
On macOS and Linux, you need to give execute rights to the downloaded file.
69-
Type `chmod +x nrfutil` or check the checkbox in the file properties.
68+
On macOS and Linux, the downloaded file also needs to be given execute permission by typing `chmod +x nrfutil` or by checking the checkbox in the file properties.
7069

7170
* The latest version of the :ref:`requirements_clt` package.
72-
Download it from the `nRF Command Line Tools`_ page.
71+
Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>` and download the installer from the `nRF Command Line Tools`_ page.
7372

7473
.. note::
7574
After downloading and installing the tools, add nrfjprog to the system :envvar:`PATH` in the environment variables.
@@ -624,16 +623,16 @@ It is available from `nRF Connect for Desktop`_, a cross-platform tool that prov
624623
Both Toolchain Manager and nRF Connect for Desktop are available for Windows, Linux, and macOS.
625624

626625
.. note::
627-
The Toolchain Manager installation is recommended only when using the nRF54H20 DK with the |NCS| v2.7.0.
628-
Since the release of the |NCS| v2.0.0, the |nRFVSC| is the recommended IDE for managing the |NCS| Toolchain and working with the |NCS|.
626+
|toolchain_management_ncs_versions|
629627

630628
.. toggle::
631629

632630
To install the toolchain and the SDK using the Toolchain Manager app, complete the following steps:
633631

634632
1. Install Toolchain Manager:
635633

636-
a. `Download nRF Connect for Desktop`_ for your operating system.
634+
a. Check :ref:`operating system versions that support this tool <additional_nordic_sw_tools>`.
635+
#. `Download nRF Connect for Desktop`_ for your operating system.
637636
#. Install and run the tool on your machine.
638637
#. In the **APPS** section, click :guilabel:`Install` next to Toolchain Manager.
639638

‎doc/nrf/installation/recommended_versions.rst‎

Lines changed: 117 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -14,83 +14,35 @@ All of these requirements are installed when you :ref:`install the nRF Connect S
1414
.. _gs_supported_OS:
1515
.. _supported_OS:
1616

17-
Supported operating systems
18-
***************************
17+
Supported operating systems (firmware)
18+
**************************************
1919

2020
The |NCS| supports Microsoft Windows, Linux, and macOS for development.
21-
The following table shows the operating system versions that support the |NCS| tools:
21+
22+
The following table lists the support levels for the |NCS| firmware.
23+
For OS support for additional software tools from Nordic Semiconductor, see :ref:`the table at the bottom of the page <additional_nordic_sw_tools>`.
2224

2325
.. os_table_start
2426
2527
.. list-table::
26-
:header-rows: 1
27-
28-
* - Operating System
29-
- x86
30-
- x64
31-
- ARM64
32-
* - `Windows 11`_
33-
- Tier 3
34-
- Tier 3
35-
- Not supported
36-
* - `Windows 10`_
37-
- Tier 3
38-
- Tier 1
39-
- Not supported
40-
* - `Linux - Ubuntu 22.04 LTS`_
41-
- Not supported
42-
- Tier 1
43-
- Not supported
44-
* - `Linux - Ubuntu 20.04 LTS`_
45-
- Not supported
46-
- Tier 2
47-
- Not supported
48-
* - `macOS 14`_
49-
- Not applicable
50-
- Tier 3
51-
- Tier 3
52-
* - `macOS 13`_
53-
- Not applicable
54-
- Tier 1
55-
- Tier 1
56-
* - `macOS 12`_
57-
- Not applicable
58-
- Tier 3
59-
- Tier 3
60-
* - `macOS 11`_
61-
- Not applicable
62-
- Tier 2
63-
- Tier 2
64-
* - `macOS 10.15`_
65-
- Not applicable
66-
- Tier 3
67-
- Not supported
28+
:header-rows: 1
29+
30+
* - Operating System
31+
- x64
32+
- ARM64
33+
* - `Windows 10`_
34+
- Built and tested with :ref:`Twister <running_unit_tests>`.
35+
- Not supported.
36+
* - `Linux - Ubuntu 22.04 LTS`_
37+
- Built and tested with :ref:`Twister <running_unit_tests>`. Comprehensive testing with Nordic Semiconductor hardware.
38+
- Not supported.
39+
* - `macOS 14`_
40+
- Built and tested with :ref:`Twister <running_unit_tests>`.
41+
- Only toolchain provided.
6842

6943
.. os_table_end
7044
71-
Tier definitions
72-
The table uses several tier definitions to categorize the level of operating system support:
73-
74-
.. toggle:: Support levels
75-
76-
Tier 1
77-
The |NCS| tools will always work.
78-
The automated build and automated testing ensure that the |NCS| tools build and successfully complete tests after each change.
79-
80-
Tier 2
81-
The |NCS| tools will always build.
82-
The automated build ensures that the |NCS| tools build successfully after each change.
83-
There is no guarantee that a build will work because the automation tests do not always run.
84-
85-
Tier 3
86-
The |NCS| tools are supported by design, but are not built or tested after each change.
87-
Therefore, the application may or may not work.
88-
89-
Not supported
90-
The |NCS| tools do not work, but it may be supported in the future.
91-
92-
Not applicable
93-
The specified architecture is not supported for the respective operating system.
45+
For building, Twister uses definitions in :file:`sample.yml` for the default configuration for the given sample or application.
9446

9547
Zephyr features only available on Linux
9648
There are some Zephyr features that are currently only available on Linux, including:
@@ -325,17 +277,6 @@ They can all be installed using the ``doc/requirements.txt`` file using ``pip``.
325277
* - west
326278
- :ncs-tool-version:`WEST_VERSION`
327279

328-
.. _requirements_clt:
329-
330-
nRF Command Line Tools
331-
**********************
332-
333-
`nRF Command Line Tools`_ is a package of tools used for development, programming, and debugging of Nordic Semiconductor's nRF51, nRF52, nRF53, nRF54H, and nRF91 Series devices.
334-
Among others, this package includes the nrfjprog executable and library, which the west command uses by default to program the development kits.
335-
For more information on nrfjprog, see `Programming SoCs with nrfjprog`_.
336-
337-
It is recommended to use the latest version of the package when you :ref:`installing_vsc`.
338-
339280
.. _requirements_jlink:
340281

341282
J-Link Software and Documentation Pack
@@ -347,13 +288,95 @@ Among others, this package includes the J-Link RTT Viewer, which can be used for
347288
It is recommended to use the |jlink_ver| of the package when you :ref:`installing_vsc`.
348289

349290
.. _toolchain_management_tools:
291+
.. _additional_nordic_sw_tools:
350292

351-
|NCS| toolchain management tools
352-
********************************
293+
Additional software tools
294+
*************************
353295

354-
Nordic Semiconductor provides proprietary |NCS| toolchain management tools that streamline the process of installing the |NCS| and its toolchain.
296+
Nordic Semiconductor provides proprietary tools for working with Nordic Semiconductor devices, as well as different |NCS| toolchain management tools that streamline the process of installing the |NCS| and its toolchain.
355297
Depending on your development environment, you need to install only some of them when you :ref:`installing_vsc`.
356298

299+
.. _additional_nordic_sw_tools_os_support:
300+
301+
Supported operating systems (proprietary tools)
302+
===============================================
303+
304+
The following table shows the operating system versions that support the additional software tools from Nordic Semiconductor.
305+
For firmware OS support, see :ref:`the table at the top of the page <supported_OS>`.
306+
307+
.. list-table::
308+
:header-rows: 1
309+
310+
* - Operating System
311+
- x86
312+
- x64
313+
- ARM64
314+
* - `Windows 11`_
315+
- Tier 3
316+
- Tier 3
317+
- Not supported
318+
* - `Windows 10`_
319+
- Tier 3
320+
- Tier 1
321+
- Not supported
322+
* - `Linux - Ubuntu 24.04 LTS`_
323+
- Not supported
324+
- Tier 2
325+
- Not supported
326+
* - `Linux - Ubuntu 22.04 LTS`_
327+
- Not supported
328+
- Tier 1
329+
- Not supported
330+
* - `Linux - Ubuntu 20.04 LTS`_
331+
- Not supported
332+
- Tier 2
333+
- Not supported
334+
* - `macOS 15`_
335+
- n/a
336+
- Tier 3
337+
- Tier 3
338+
* - `macOS 14`_
339+
- n/a
340+
- Tier 3
341+
- Tier 3
342+
* - `macOS 13`_
343+
- n/a
344+
- Tier 1
345+
- Tier 1
346+
347+
Tier definitions
348+
.. toggle:: Support levels
349+
350+
Tier 1
351+
The toolchain management tools will always work.
352+
The automated build and automated testing ensure that the |NCS| tools build and successfully complete tests after each change.
353+
354+
Tier 2
355+
The toolchain management tools will always build.
356+
The automated build ensures that the |NCS| tools build successfully after each change.
357+
There is no guarantee that a build will work because the automation tests do not always run.
358+
359+
Tier 3
360+
The toolchain management tools are supported by design, but are not built or tested after each change.
361+
Therefore, the application may or may not work.
362+
363+
Not supported
364+
The toolchain management tools do not work, but it may be supported in the future.
365+
366+
Not applicable
367+
The specified architecture is not supported for the respective operating system.
368+
369+
.. _requirements_clt:
370+
371+
nRF Command Line Tools
372+
======================
373+
374+
`nRF Command Line Tools`_ is a package of tools used for development, programming, and debugging of Nordic Semiconductor's nRF51, nRF52, nRF53, nRF54H, and nRF91 Series devices.
375+
Among others, this package includes the nrfjprog executable and library, which the west command uses by default to program the development kits.
376+
For more information on nrfjprog, see `Programming SoCs with nrfjprog`_.
377+
378+
It is recommended to use the latest version of the package when you :ref:`installing_vsc`.
379+
357380
|nRFVSC|
358381
========
359382

@@ -379,8 +402,19 @@ nRF Util
379402
The `nRF Util development tool`_ is a unified command line utility for Nordic products.
380403
Its functionality is provided through installable and upgradeable commands that are served on a central package registry on the Internet.
381404

382-
The utility follows its own release cycle.
405+
The utility follows its own release cycle and has its own `operating system requirements <nRF Util_>`_.
383406
Use the latest available release for development.
384407

385408
nRF Util provides |NCS| toolchain packages for each |NCS| release through the ``toolchain-manager`` command.
386409
See the :ref:`install_ncs` page for information about how to use this command.
410+
411+
.. _requirements_ncd:
412+
413+
nRF Connect for Desktop's Toolchain Manager
414+
===========================================
415+
416+
`nRF Connect for Desktop`_ is a cross-platform tool that provides different applications that simplify working the |NCS| and Nordic Semiconductor products.
417+
One of those tools is the :ref:`Toolchain Manager <auto_installation_tcm_setup>`, which allows you to install the toolchain and the SDK.
418+
419+
.. note::
420+
|toolchain_management_ncs_versions|

‎doc/nrf/links.txt‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,6 @@
598598
.. _`nRF Connect Serial Terminal`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/index.html
599599
.. _`Connecting using Serial Terminal`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/connecting.html
600600
.. _`Serial Terminal configuration`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/configuration.html
601-
.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html
602601
.. _`nRF Connect Bluetooth Low Energy`: https://docs.nordicsemi.com/bundle/nrf-connect-ble/page/index.html
603602
.. _`Cellular Monitor`: https://docs.nordicsemi.com/bundle/nrf-connect-cellularmonitor/page/index.html
604603
.. _`nPM PowerUP`: https://docs.nordicsemi.com/bundle/nrf-connect-npm/page/index.html
@@ -613,8 +612,6 @@
613612
.. _`Programming the nRF52840 Dongle`:
614613
.. _`Programming a Development Kit`: https://docs.nordicsemi.com/bundle/nrf-connect-programmer/page/programming_dk.html
615614

616-
.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html
617-
618615
.. _`nRF Thread Topology Monitor`: https://docs.nordicsemi.com/bundle/ug_nrf_ttm/page/UG/nrf_ttm/ttm_introduction.html
619616
.. _`nRF Sniffer for 802.15.4`: https://docs.nordicsemi.com/bundle/ug_sniffer_802154/page/UG/sniffer_802154/intro_802154.html
620617
.. _`Configuring Wireshark for Zigbee`: https://docs.nordicsemi.com/bundle/ug_sniffer_802154/page/UG/sniffer_802154/configuring_sniffer_802154_zigbee.html
@@ -810,6 +807,7 @@
810807
.. _`Toolchain Manager command`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-toolchain-manager/nrfutil-toolchain-manager_0.14.1.html#available-subcommands
811808
.. _`Recovering the device`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-device/guides/programming_recovery.html
812809
.. _`nrfutil-trace`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-trace/CHANGELOG.html
810+
.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html
813811

814812
.. _`anomaly 19`: https://docs.nordicsemi.com/bundle/errata_nRF5340_EngA/page/ERR/nRF5340/EngineeringA/latest/anomaly_340_19.html
815813

@@ -1397,16 +1395,15 @@
13971395

13981396
.. ### Source: ubuntu.com
13991397

1398+
.. _`Linux - Ubuntu 24.04 LTS`: https://releases.ubuntu.com/24.04/
14001399
.. _`Linux - Ubuntu 22.04 LTS`: https://releases.ubuntu.com/22.04/
14011400
.. _`Linux - Ubuntu 20.04 LTS`: https://releases.ubuntu.com/20.04/
14021401

14031402
.. ### Source: apple.com
14041403

1404+
.. _`macOS 15`: https://www.apple.com/macos/macos-sequoia/
14051405
.. _`macOS 14`: https://www.apple.com/macos/sonoma/
14061406
.. _`macOS 13`: https://www.apple.com/macos/ventura/
1407-
.. _`macOS 12`: https://www.apple.com/macos/monterey/
1408-
.. _`macOS 11`: https://support.apple.com/en-us/HT211896
1409-
.. _`macOS 10.15`: https://support.apple.com/en-us/HT210642
14101407
.. _`Apple Notification Center Service Specification`: https://developer.apple.com/library/archive/documentation/CoreBluetooth/Reference/AppleNotificationCenterServiceSpecification/Introduction/Introduction.html
14111408
.. _`Apple Media Service Reference`: https://developer.apple.com/library/ios/documentation/CoreBluetooth/Reference/AppleMediaService_Reference/Introduction/Introduction.html
14121409

‎doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ On your computer, one of the following operating systems:
4545
:start-after: os_table_start
4646
:end-before: os_table_end
4747

48-
See :ref:`supported_OS` for more information about the tier definitions.
48+
See :ref:`supported_OS` for more information.
4949

5050
|supported OS|
5151

0 commit comments

Comments
 (0)