From 7783dec68487595b5a90daec5220b3135eded402 Mon Sep 17 00:00:00 2001 From: Grzegorz Ferenc Date: Fri, 6 Sep 2024 08:54:58 +0200 Subject: [PATCH] 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 --- .../device_guides/nrf53/building_nrf53.rst | 2 +- .../nrf54h/ug_nrf54h20_gs.rst | 2 +- doc/nrf/installation/install_ncs.rst | 25 ++- doc/nrf/installation/recommended_versions.rst | 200 ++++++++++-------- doc/nrf/links.txt | 9 +- ...on_guide_2.6.99-cs2_to_2_7_environment.rst | 2 +- ...on_guide_2.4.99-cs3_to_2.7_environment.rst | 2 +- .../releases/release-notes-changelog.rst | 13 +- doc/nrf/shortcuts.txt | 6 +- 9 files changed, 151 insertions(+), 110 deletions(-) diff --git a/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst b/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst index eedba3b33bc6..988b31bbb141 100644 --- a/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst +++ b/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst @@ -51,7 +51,7 @@ Using the command line ====================== To build nRF5340 samples from the command line, use :ref:`west `. -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 `. +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 `. .. note:: Programming the nRF5340 DK from the command line with west requires the `nRF Command Line Tools`_ v10.12.0 or later. diff --git a/doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst b/doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst index 2fa3d8becc47..d29da9935141 100644 --- a/doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst +++ b/doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst @@ -34,7 +34,7 @@ On your computer, one of the following operating systems: :start-after: os_table_start :end-before: os_table_end -See :ref:`supported_OS` for more information about the tier definitions. +See :ref:`supported_OS` for more information. |supported OS| diff --git a/doc/nrf/installation/install_ncs.rst b/doc/nrf/installation/install_ncs.rst index ae0938b640c0..c5238fb4f1c6 100644 --- a/doc/nrf/installation/install_ncs.rst +++ b/doc/nrf/installation/install_ncs.rst @@ -9,7 +9,7 @@ Installing the |NCS| :local: :depth: 2 -There are different ways to install the |NCS|, depending on your preferred development environment and the :ref:`toolchain management tool `: +There are different ways to install the |NCS|, depending on your preferred development environment: * Using |VSC| and the |nRFVSC| (recommended) * Using command line and nRF Util @@ -25,14 +25,12 @@ This includes everything that is required by Zephyr's :ref:`zephyr:getting_start Update operating system *********************** -Before you start setting up the toolchain, install available updates for your operating system. +Before you start setting up the toolchain, install available updates for your :ref:`operating system ` to make sure it supports the |NCS| firmware. .. include:: ./recommended_versions.rst :start-after: os_table_start :end-before: os_table_end -See :ref:`supported_OS` for more information about the tier definitions. - .. _installing_vsc: .. rst-class:: numbered-step @@ -40,7 +38,8 @@ See :ref:`supported_OS` for more information about the tier definitions. Install prerequisites ********************* -Depending on your preferred development environment, install the following required tools: +Depending on your preferred development environment, install the following required tools. + .. tabs:: @@ -49,7 +48,7 @@ Depending on your preferred development environment, install the following requi * All operating systems: * The latest version of the :ref:`requirements_clt` package. - Download it from the `nRF Command Line Tools`_ page. + Check :ref:`operating system versions that support this tool ` and download the installer from the `nRF Command Line Tools`_ page. * The |jlink_ver_vsc| of :ref:`SEGGER J-Link `. Download it from the `J-Link Software and Documentation Pack`_ page. * 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 * All operating systems: - * The latest version of `nRF Util development tool`_, a unified command-line utility for Nordic Semiconductor products. + * The latest version of nRF Util, a unified command-line utility for Nordic Semiconductor products. + Check :ref:`operating system versions that support this tool ` and download the installer from the `nRF Util development tool`_ page. .. note:: After downloading the nRF Util executable, move it to a directory that is in the system :envvar:`PATH`. - On macOS and Linux, you need to give execute rights to the downloaded file. - Type `chmod +x nrfutil` or check the checkbox in the file properties. + 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. * The latest version of the :ref:`requirements_clt` package. - Download it from the `nRF Command Line Tools`_ page. + Check :ref:`operating system versions that support this tool ` and download the installer from the `nRF Command Line Tools`_ page. .. note:: After downloading and installing the tools, add nrfjprog to the system :envvar:`PATH` in the environment variables. @@ -624,8 +623,7 @@ It is available from `nRF Connect for Desktop`_, a cross-platform tool that prov Both Toolchain Manager and nRF Connect for Desktop are available for Windows, Linux, and macOS. .. note:: - The Toolchain Manager installation is recommended only when using the nRF54H20 DK with the |NCS| v2.7.0. - 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|. + |toolchain_management_ncs_versions| .. toggle:: @@ -633,7 +631,8 @@ Both Toolchain Manager and nRF Connect for Desktop are available for Windows, Li 1. Install Toolchain Manager: - a. `Download nRF Connect for Desktop`_ for your operating system. + a. Check :ref:`operating system versions that support this tool `. + #. `Download nRF Connect for Desktop`_ for your operating system. #. Install and run the tool on your machine. #. In the **APPS** section, click :guilabel:`Install` next to Toolchain Manager. diff --git a/doc/nrf/installation/recommended_versions.rst b/doc/nrf/installation/recommended_versions.rst index 1a94b9f27de8..f8e192e492c0 100644 --- a/doc/nrf/installation/recommended_versions.rst +++ b/doc/nrf/installation/recommended_versions.rst @@ -14,83 +14,35 @@ All of these requirements are installed when you :ref:`install the nRF Connect S .. _gs_supported_OS: .. _supported_OS: -Supported operating systems -*************************** +Supported operating systems (firmware) +************************************** The |NCS| supports Microsoft Windows, Linux, and macOS for development. -The following table shows the operating system versions that support the |NCS| tools: + +The following table lists the support levels for the |NCS| firmware. +For OS support for additional software tools from Nordic Semiconductor, see :ref:`the table at the bottom of the page `. .. os_table_start .. list-table:: - :header-rows: 1 - - * - Operating System - - x86 - - x64 - - ARM64 - * - `Windows 11`_ - - Tier 3 - - Tier 3 - - Not supported - * - `Windows 10`_ - - Tier 3 - - Tier 1 - - Not supported - * - `Linux - Ubuntu 22.04 LTS`_ - - Not supported - - Tier 1 - - Not supported - * - `Linux - Ubuntu 20.04 LTS`_ - - Not supported - - Tier 2 - - Not supported - * - `macOS 14`_ - - Not applicable - - Tier 3 - - Tier 3 - * - `macOS 13`_ - - Not applicable - - Tier 1 - - Tier 1 - * - `macOS 12`_ - - Not applicable - - Tier 3 - - Tier 3 - * - `macOS 11`_ - - Not applicable - - Tier 2 - - Tier 2 - * - `macOS 10.15`_ - - Not applicable - - Tier 3 - - Not supported + :header-rows: 1 + + * - Operating System + - x64 + - ARM64 + * - `Windows 10`_ + - Built and tested with :ref:`Twister `. + - Not supported. + * - `Linux - Ubuntu 22.04 LTS`_ + - Built and tested with :ref:`Twister `. Comprehensive testing with Nordic Semiconductor hardware. + - Not supported. + * - `macOS 14`_ + - Built and tested with :ref:`Twister `. + - Only toolchain provided. .. os_table_end -Tier definitions - The table uses several tier definitions to categorize the level of operating system support: - - .. toggle:: Support levels - - Tier 1 - The |NCS| tools will always work. - The automated build and automated testing ensure that the |NCS| tools build and successfully complete tests after each change. - - Tier 2 - The |NCS| tools will always build. - The automated build ensures that the |NCS| tools build successfully after each change. - There is no guarantee that a build will work because the automation tests do not always run. - - Tier 3 - The |NCS| tools are supported by design, but are not built or tested after each change. - Therefore, the application may or may not work. - - Not supported - The |NCS| tools do not work, but it may be supported in the future. - - Not applicable - The specified architecture is not supported for the respective operating system. +For building, Twister uses definitions in :file:`sample.yml` for the default configuration for the given sample or application. Zephyr features only available on Linux 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``. * - west - :ncs-tool-version:`WEST_VERSION` -.. _requirements_clt: - -nRF Command Line Tools -********************** - -`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. -Among others, this package includes the nrfjprog executable and library, which the west command uses by default to program the development kits. -For more information on nrfjprog, see `Programming SoCs with nrfjprog`_. - -It is recommended to use the latest version of the package when you :ref:`installing_vsc`. - .. _requirements_jlink: 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 It is recommended to use the |jlink_ver| of the package when you :ref:`installing_vsc`. .. _toolchain_management_tools: +.. _additional_nordic_sw_tools: -|NCS| toolchain management tools -******************************** +Additional software tools +************************* -Nordic Semiconductor provides proprietary |NCS| toolchain management tools that streamline the process of installing the |NCS| and its toolchain. +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. Depending on your development environment, you need to install only some of them when you :ref:`installing_vsc`. +.. _additional_nordic_sw_tools_os_support: + +Supported operating systems (proprietary tools) +=============================================== + +The following table shows the operating system versions that support the additional software tools from Nordic Semiconductor. +For firmware OS support, see :ref:`the table at the top of the page `. + +.. list-table:: + :header-rows: 1 + + * - Operating System + - x86 + - x64 + - ARM64 + * - `Windows 11`_ + - Tier 3 + - Tier 3 + - Not supported + * - `Windows 10`_ + - Tier 3 + - Tier 1 + - Not supported + * - `Linux - Ubuntu 24.04 LTS`_ + - Not supported + - Tier 2 + - Not supported + * - `Linux - Ubuntu 22.04 LTS`_ + - Not supported + - Tier 1 + - Not supported + * - `Linux - Ubuntu 20.04 LTS`_ + - Not supported + - Tier 2 + - Not supported + * - `macOS 15`_ + - n/a + - Tier 3 + - Tier 3 + * - `macOS 14`_ + - n/a + - Tier 3 + - Tier 3 + * - `macOS 13`_ + - n/a + - Tier 1 + - Tier 1 + +Tier definitions + .. toggle:: Support levels + + Tier 1 + The toolchain management tools will always work. + The automated build and automated testing ensure that the |NCS| tools build and successfully complete tests after each change. + + Tier 2 + The toolchain management tools will always build. + The automated build ensures that the |NCS| tools build successfully after each change. + There is no guarantee that a build will work because the automation tests do not always run. + + Tier 3 + The toolchain management tools are supported by design, but are not built or tested after each change. + Therefore, the application may or may not work. + + Not supported + The toolchain management tools do not work, but it may be supported in the future. + + Not applicable + The specified architecture is not supported for the respective operating system. + +.. _requirements_clt: + +nRF Command Line Tools +====================== + +`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. +Among others, this package includes the nrfjprog executable and library, which the west command uses by default to program the development kits. +For more information on nrfjprog, see `Programming SoCs with nrfjprog`_. + +It is recommended to use the latest version of the package when you :ref:`installing_vsc`. + |nRFVSC| ======== @@ -379,8 +402,19 @@ nRF Util The `nRF Util development tool`_ is a unified command line utility for Nordic products. Its functionality is provided through installable and upgradeable commands that are served on a central package registry on the Internet. -The utility follows its own release cycle. +The utility follows its own release cycle and has its own `operating system requirements `_. Use the latest available release for development. nRF Util provides |NCS| toolchain packages for each |NCS| release through the ``toolchain-manager`` command. See the :ref:`install_ncs` page for information about how to use this command. + +.. _requirements_ncd: + +nRF Connect for Desktop's Toolchain Manager +=========================================== + +`nRF Connect for Desktop`_ is a cross-platform tool that provides different applications that simplify working the |NCS| and Nordic Semiconductor products. +One of those tools is the :ref:`Toolchain Manager `, which allows you to install the toolchain and the SDK. + +.. note:: + |toolchain_management_ncs_versions| diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt index 68057873d9ad..5b9eaa9e68f2 100644 --- a/doc/nrf/links.txt +++ b/doc/nrf/links.txt @@ -598,7 +598,6 @@ .. _`nRF Connect Serial Terminal`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/index.html .. _`Connecting using Serial Terminal`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/connecting.html .. _`Serial Terminal configuration`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/configuration.html -.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html .. _`nRF Connect Bluetooth Low Energy`: https://docs.nordicsemi.com/bundle/nrf-connect-ble/page/index.html .. _`Cellular Monitor`: https://docs.nordicsemi.com/bundle/nrf-connect-cellularmonitor/page/index.html .. _`nPM PowerUP`: https://docs.nordicsemi.com/bundle/nrf-connect-npm/page/index.html @@ -613,8 +612,6 @@ .. _`Programming the nRF52840 Dongle`: .. _`Programming a Development Kit`: https://docs.nordicsemi.com/bundle/nrf-connect-programmer/page/programming_dk.html -.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html - .. _`nRF Thread Topology Monitor`: https://docs.nordicsemi.com/bundle/ug_nrf_ttm/page/UG/nrf_ttm/ttm_introduction.html .. _`nRF Sniffer for 802.15.4`: https://docs.nordicsemi.com/bundle/ug_sniffer_802154/page/UG/sniffer_802154/intro_802154.html .. _`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 @@ .. _`Toolchain Manager command`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-toolchain-manager/nrfutil-toolchain-manager_0.14.1.html#available-subcommands .. _`Recovering the device`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-device/guides/programming_recovery.html .. _`nrfutil-trace`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-trace/CHANGELOG.html +.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html .. _`anomaly 19`: https://docs.nordicsemi.com/bundle/errata_nRF5340_EngA/page/ERR/nRF5340/EngineeringA/latest/anomaly_340_19.html @@ -1397,16 +1395,15 @@ .. ### Source: ubuntu.com +.. _`Linux - Ubuntu 24.04 LTS`: https://releases.ubuntu.com/24.04/ .. _`Linux - Ubuntu 22.04 LTS`: https://releases.ubuntu.com/22.04/ .. _`Linux - Ubuntu 20.04 LTS`: https://releases.ubuntu.com/20.04/ .. ### Source: apple.com +.. _`macOS 15`: https://www.apple.com/macos/macos-sequoia/ .. _`macOS 14`: https://www.apple.com/macos/sonoma/ .. _`macOS 13`: https://www.apple.com/macos/ventura/ -.. _`macOS 12`: https://www.apple.com/macos/monterey/ -.. _`macOS 11`: https://support.apple.com/en-us/HT211896 -.. _`macOS 10.15`: https://support.apple.com/en-us/HT210642 .. _`Apple Notification Center Service Specification`: https://developer.apple.com/library/archive/documentation/CoreBluetooth/Reference/AppleNotificationCenterServiceSpecification/Introduction/Introduction.html .. _`Apple Media Service Reference`: https://developer.apple.com/library/ios/documentation/CoreBluetooth/Reference/AppleMediaService_Reference/Introduction/Introduction.html diff --git a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst index 6bf1c40caa03..babb48d150ab 100644 --- a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst +++ b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst @@ -45,7 +45,7 @@ On your computer, one of the following operating systems: :start-after: os_table_start :end-before: os_table_end -See :ref:`supported_OS` for more information about the tier definitions. +See :ref:`supported_OS` for more information. |supported OS| diff --git a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst index 62e7060f632b..341c8d45f6be 100644 --- a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst +++ b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst @@ -45,7 +45,7 @@ On your computer, one of the following operating systems: :start-after: os_table_start :end-before: os_table_end -See :ref:`supported_OS` for more information about the tier definitions. +See :ref:`supported_OS` for more information. |supported OS| diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst index 75416dfd0839..f71b0f93486a 100644 --- a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst +++ b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst @@ -30,11 +30,18 @@ Changelog The following sections provide detailed lists of changes by component. -IDE, and tool support -===================== +IDE, OS, and tool support +========================= * Added explicit mention of the :ref:`requirements_jlink` being required in the :ref:`installing_vsc` section of the installation page. -* Updated the required `SEGGER J-Link`_ version to v7.94i. +* Updated: + + * The required `SEGGER J-Link`_ version to v7.94i. + * The :ref:`supported_OS` table on the :ref:`gs_recommended_versions` page: + + * Linux 24.04 and macOS 15 have been added to the list. + * macOS 10.15, macOS 11, macOS 12 have been removed from the list. + * Tier descriptions have been updated. Board support ============= diff --git a/doc/nrf/shortcuts.txt b/doc/nrf/shortcuts.txt index 4fe8c9569eb7..ffbf3d599994 100644 --- a/doc/nrf/shortcuts.txt +++ b/doc/nrf/shortcuts.txt @@ -208,7 +208,8 @@ The NFCT driver is part of the nrfx driver package. For more information about this driver, see the NFCT driver page in the `nrfx`_ repository. -.. |Supported OS| replace:: The operating system versions that support the |NCS| tools are listed in the :ref:`supported_OS` section. +.. |Supported OS| replace:: The operating system versions that support the |NCS| firmware are listed in the :ref:`supported_OS` section. + Some additional tools for working with Nordic Semiconductor devices might have :ref:`different OS requirements `. .. |no_changes_yet_note| replace:: No changes since the latest |NCS| release. @@ -243,3 +244,6 @@ .. |ATv2_maintenance_note| replace:: The Asset Tracker v2 application is in maintenance mode. For new projects, it is recommended to use the :ref:`nrf_cloud_multi_service` sample instead. + +.. |toolchain_management_ncs_versions| replace:: The Toolchain Manager installation is recommended only when using the nRF54H20 DK with the |NCS| v2.7.0. + When using any other DK, the Toolchain Manager installation is recommended for the |NCS| v1.9.x and earlier versions.