Skip to content

Commit

Permalink
doc: Add Release Notes and Known Issues for CS2
Browse files Browse the repository at this point in the history
Added release notes for 2.6.99-cs2
Added known issues for 2.6.99-cs2
Added software maturity for 2.6.99-cs2
Added limitations for 2.6.99-cs2
Added highlights for 2.6.99-cs2

Signed-off-by: Francesco Domenico Servidio <[email protected]>
  • Loading branch information
FrancescoSer authored and rlubos committed May 23, 2024
1 parent 81ccadc commit 8645631
Show file tree
Hide file tree
Showing 17 changed files with 187 additions and 18 deletions.
2 changes: 1 addition & 1 deletion doc/nrf/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
project = "nRF Connect SDK"
copyright = "2019-2024, Nordic Semiconductor"
author = "Nordic Semiconductor"
version = release = "2.6.99"
version = release = "2.6.99-cs2"

sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions"))
sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions"))
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/dev_model_and_contributions/adding_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ For example:
projects:
- name: nrf
remote: ncs
revision: 2.6.1
revision: 2.6.99-cs2
import: true
# Example for how to override a repository in the nRF Connect SDK with your own:
- name: mcuboot
Expand Down
1 change: 1 addition & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,7 @@
.. _`LwM2M carrier library changelog for v1.9.1`: https://docs.nordicsemi.com/bundle/ncs-1.9.1/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html
.. _`LwM2M carrier library changelog for v1.9.0`: https://docs.nordicsemi.com/bundle/ncs-1.9.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html

.. _`Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.html
.. _`Migration guide for nRF Connect SDK v2.6.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.6.html
.. _`Migration guide for nRF Connect SDK v2.5.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.5.html
.. _`Migration guide for nRF Connect SDK v2.0.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.html
Expand Down
1 change: 0 additions & 1 deletion doc/nrf/releases_and_maturity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,3 @@ If an issue is found in a release after it has taken place, those issues are lis
releases_and_maturity/migration_guides
releases_and_maturity/repository_revisions
releases_and_maturity/software_maturity
releases_and_maturity/known_issues
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/known_issues.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _known_issues:

Known issues
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _ncs_2.0.0_migration:

Migration notes for |NCS| v2.0.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.5:

Migration guide for |NCS| v2.5.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.6:

Migration guide for |NCS| v2.6.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.7:

Migration guide for |NCS| v2.7.0 (Working draft)
Expand Down
12 changes: 6 additions & 6 deletions doc/nrf/releases_and_maturity/migration_guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ Migration guides

The |NCS| provides migration guides for all major and minor releases, in order to assist user's transition from the previous release.

.. toctree::
:maxdepth: 1
:glob:
:reversed:
:caption: Subpages:
* `Migration guide for nRF Connect SDK v2.6.0`_
* `Migration guide for nRF Connect SDK v2.5.0`_
* `Migration guide for nRF Connect SDK v2.0.0`_

migration/*
Only for nRF54H20 customer sampling participants:

* `Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`_
3 changes: 1 addition & 2 deletions doc/nrf/releases_and_maturity/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,14 @@ This page is included only in the latest documentation, because it might contain
A "99" at the end of the version number of this documentation indicates continuous updates on the main branch since the previous major.minor release.
When looking at this latest documentation, be aware of the following aspects:

* Changes between releases are tracked on the :ref:`ncs_release_notes_changelog` page, but the main branch might contain additional changes that are not listed on that page.
* The release note pages that are available in the latest documentation might differ slightly from the release notes that were included in the respective |NCS| release at its release date.
Therefore, to see the official version of the release notes for a specific |NCS| release, switch to the documentation for the corresponding |NCS| version using the selector in the upper right-hand corner.

.. toctree::
:maxdepth: 1
:caption: Subpages:

releases/release-notes-changelog
releases/release-notes-2.6.99-cs2
releases/release-notes-2.6.99-cs1
releases/release-notes-2.6.1
releases/release-notes-2.6.0
Expand Down
157 changes: 157 additions & 0 deletions doc/nrf/releases_and_maturity/releases/release-notes-2.6.99-cs2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
.. _ncs_release_notes_2699_cs2:

|NCS| v2.6.99-cs2 Release Notes
###############################

.. contents::
:local:
:depth: 3

|NCS| v2.6.99-cs2 is a **customer sampling** release, tailored exclusively for participants in the nRF54H20 SoC customer sampling program.
Do not use this release of |NCS| if you are not participating in the program.

The release is not part of the regular release cycle and is specifically designed to support early adopters working with the nRF54H20 SoC.
It is intended to provide early access to the latest developments for nRF54H20 SoC, enabling participants to experiment with new features and provide feedback.

The scope of this release is intentionally narrow, concentrating solely on the nRF54H20 DK.
You can use the latest stable release of |NCS| to work with other boards.

All functionality related to nRF54H20 SoC is considered experimental.

Migration notes
***************

See the `Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`_ for the changes required or recommended when migrating your application from v2.4.99-cs3 to v2.6.99-cs2.

Changelog
*********

The following sections provide detailed lists of changes by component.

Peripherals support
===================

* Added experimental support for the following peripherals on the nRF54H20 DK:

* ADC
* CLOCK
* GPIO
* GRTC
* I2C
* MRAM
* NFCT
* PWM
* RADIO (Bluetooth Low Energy and 802.15.4)
* SPI
* UART
* WDT

Working with nRF54H Series
==========================

* Added the :ref:`ug_nrf54h` section.

Protocols
=========

This section provides detailed lists of changes by :ref:`protocol <protocols>`.
See `Samples`_ for lists of changes for the protocol-related samples.

Enhanced ShockBurst (ESB)
-------------------------

* Added:

* Support for the :ref:`nRF54H20 DK <ug_nrf54h20_gs>` board.
* Fast switching between radio states for the nRF54H20 SoC.
* Fast radio channel switching for the nRF54H20 SoC.

Samples
=======

This section provides detailed lists of changes by :ref:`sample <samples>`.

Bluetooth samples
-----------------

* :ref:`direct_test_mode` sample:

* Added:

* Support for the :ref:`nRF54H20 DK <ug_nrf54h20_gs>` with build target ``nrf54h20dk_nrf54h20_cpurad``.
* Experimental support for the HCI interface.

* Updated the internal sample API.

Enhanced ShockBurst samples
---------------------------

* Added support for the :ref:`nRF54H20 DK <ug_nrf54h20_gs>` with build target ``nrf54h20dk_nrf54h20_cpurad`` in the following ESB samples:

* :ref:`esb_prx` sample
* :ref:`esb_ptx` sample

Multicore samples
-----------------

* :ref:`multicore_hello_world` sample:

* Added support for the :ref:`nRF54H20 DK <ug_nrf54h20_gs>` with build target ``nrf54h20dk_nrf54h20_cpuapp``.

Peripheral samples
------------------

* :ref:`radio_test` sample:

* Added support for the :ref:`nRF54H20 DK <ug_nrf54h20_gs>` with build target ``nrf54h20dk_nrf54h20_cpurad``.
* Updated the CLI command ``fem tx_power_control <tx_power_control>`` which replaces ``fem tx_gain <tx_gain>`` .
This change applies to the sample built with the Kconfig option :ref:`CONFIG_RADIO_TEST_POWER_CONTROL_AUTOMATIC <CONFIG_RADIO_TEST_POWER_CONTROL_AUTOMATIC>` set to ``n``.

Zephyr
======

.. NOTE TO MAINTAINERS: All the Zephyr commits in the below git commands must be handled specially after each upmerge and each nRF Connect SDK release.
The Zephyr fork in |NCS| (``sdk-zephyr``) contains all commits from the upstream Zephyr repository up to and including ``0051731a41fa2c9057f360dc9b819e47b2484be5``, with some |NCS| specific additions.

For the list of upstream Zephyr commits (not including cherry-picked commits) incorporated into the |NCS| since the most recent release, run the following command from the :file:`ncs/zephyr` repository (after running ``west update``):

.. code-block:: none
git log --oneline 0051731a41 ^23cf38934c
For the list of |NCS| specific commits, including commits cherry-picked from upstream, run:

.. code-block:: none
git log --oneline manifest-rev ^0051731a41
The current |NCS| main branch is based on revision ``0051731a41`` of Zephyr.

.. note::
For possible breaking changes and changes between the latest Zephyr release and the current Zephyr version, refer to the :ref:`Zephyr release notes <zephyr_release_notes>`.

Zephyr samples
--------------

* Added support for the :ref:`nRF54H20 DK <ug_nrf54h20_gs>` in the following Zephyr samples:

* :zephyr:code-sample:`pwm-blinky`
* :ref:`zephyr:hello_world`
* :zephyr:code-sample:`fade-led`

Documentation
=============

* Added:

* The :ref:`ug_nrf54h` section.
* The `Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`_ section.

* Updated the table listing the :ref:`boards included in sdk-zephyr <app_boards_names_zephyr>` with the nRF54H20 DK board.

Current nRF54H20 DK Limitations
*******************************

* On the nRF54H20 DK Revision PCA10175 v0.7.x, the **ON** and **OFF** markings for the power switch on the PCB are switched.
* On all the revisions of the nRF54H20 DK, buttons and LEDs on the PCB are numbered from 0 to 3 instead of from 1 to 4.
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _ncs_release_notes_changelog:

Changelog for |NCS| v2.6.99
Expand Down
5 changes: 4 additions & 1 deletion doc/nrf/releases_and_maturity/software_maturity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Protocol support
The following table indicates the software maturity levels of the support for each :ref:`protocol <protocols>`:

.. sml-table:: top_level
:insert-values: [("Bluetooth","nRF54L15","Experimental"), ("Bluetooth Mesh","nRF54L15","-"), ("Matter","nRF54L15","Experimental"), ("Sidewalk","nRF54L15","Experimental"), ("Thread","nRF54L15","Experimental")]
:insert-values: [("Bluetooth","nRF54L15","Experimental"), ("Bluetooth Mesh","nRF54L15","-"), ("Matter","nRF54L15","Experimental"), ("Sidewalk","nRF54L15","Experimental"), ("Thread","nRF54L15","Experimental"), ("Bluetooth","nRF54H20","Experimental"), ("Wi-Fi","nRF54H20","-")]

Amazon Sidewalk features support
********************************
Expand All @@ -190,6 +190,7 @@ The following table indicates the software maturity levels of the support for ea
.. toggle::

.. sml-table:: bluetooth
:insert-values: [("Bluetooth LE Peripheral/Central","nRF54H20","Experimental"), ("Connectionless/Connected CTE Transmitter","nRF54H20","Experimental"), ("LE Coded PHY","nRF54H20","Experimental"), ("LLPM","nRF54H20","Experimental")]

Thread features support
***********************
Expand Down Expand Up @@ -228,6 +229,7 @@ The following table indicates the software maturity levels of the support for ea
.. toggle::

.. sml-table:: wifi
:insert-values: [("STA Mode","nRF54H20","-")]

Security Feature Support
************************
Expand All @@ -253,6 +255,7 @@ PSA Crypto support
.. toggle::

.. sml-table:: psa_crypto
:insert-values: [("PSA Crypto APIs","nRF54H20","-")]

|NSIB|
======
Expand Down
6 changes: 3 additions & 3 deletions doc/nrf/shortcuts.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. |NCS| replace:: nRF Connect SDK

.. |release| replace:: v2.6.1
.. |release_tt| replace:: ``v2.6.1``
.. |release_number_tt| replace:: ``2.6.1``
.. |release| replace:: v2.6.99-cs2
.. |release_tt| replace:: ``v2.6.99-cs2``
.. |release_number_tt| replace:: ``2.6.99-cs2``

.. ### Config shortcuts

Expand Down
2 changes: 1 addition & 1 deletion doc/versions.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[
"2.6.99",
"2.6.99-cs2",
"2.6.99-cs1",
"2.6.1",
"2.6.0",
Expand Down
2 changes: 0 additions & 2 deletions samples/multicore/hello_world/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,6 @@ nRF54H20 DK
.. include:: /includes/nRF54H20_erase_UICR.txt

.. include:: /includes/nRF54H20_erase_UICR.txt

Testing
=======

Expand Down

0 comments on commit 8645631

Please sign in to comment.