Skip to content

Commit 30cb036

Browse files
committed
doc: nrf: migration notes: add nrfx 4.0 entry
Provide migration notes for nrfx 4.0 in NCS context. Signed-off-by: Marcin Szymczyk <marcin.szymczyk@nordicsemi.no>
1 parent 7e270a4 commit 30cb036

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

doc/nrf/links.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@
124124
.. _`Changelog for nrfx 2.3.0`: https://github.com/NordicSemiconductor/nrfx/blob/master/CHANGELOG.md#user-content-230---2020-08-19
125125
.. _`Changelog for nrfx 2.4.0`: https://github.com/NordicSemiconductor/nrfx/blob/master/CHANGELOG.md#user-content-240---2020-11-13
126126
.. _`Changelog for nrfx 2.5.0`: https://github.com/NordicSemiconductor/nrfx/blob/master/CHANGELOG.md#250---2021-05-05
127-
127+
.. _`nrfx 4.0 migration note`: https://github.com/NordicSemiconductor/nrfx/wiki/nrfx-3.14.0-to-4.0.0
128128

129129
.. _`HIDAPI library`: https://github.com/libusb/hidapi
130130
.. _`HIDAPI releases`: https://github.com/libusb/hidapi/releases

doc/nrf/releases_and_maturity/migration/migration_guide_3.2.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,3 +352,40 @@ Memfault integration
352352
* :kconfig:option:`CONFIG_MEMFAULT_NCS_DEVICE_ID_RUNTIME` - Use a runtime-applied device ID, commonly used when the serial number of the device is written into settings at manufacturing time, for example.
353353
* :kconfig:option:`CONFIG_MEMFAULT_NCS_DEVICE_ID_IMEI` (deprecated) - Use the LTE modem IMEI as the device ID.
354354
* :kconfig:option:`CONFIG_MEMFAULT_NCS_DEVICE_ID_NET_MAC` (deprecated) - Use the network interface MAC address as the device ID.
355+
356+
Drivers
357+
=======
358+
359+
This section provides detailed lists of changes by drivers.
360+
361+
nrfx
362+
----
363+
364+
.. toggle::
365+
366+
* nrfx version has been updated to 4.0.
367+
For nrfx changes see :ref:`nrfx 4.0 migration note`_.
368+
369+
Additionally, to migrate a Zephyr build system application that uses nrfx API directly, complete the following steps:
370+
371+
#. Kconfig options:
372+
373+
* Replace:
374+
375+
* ``CONFIG_NRFX_DPPI``, ``CONFIG_NRFX_DPPI0``, ``CONFIG_NRFX_DPPI00``, ``CONFIG_NRFX_DPPI10``, ``CONFIG_NRFX_DPPI20``, ``CONFIG_NRFX_DPPI30``, ``CONFIG_NRFX_DPPI020``, ``CONFIG_NRFX_DPPI120``, ``CONFIG_NRFX_DPPI130``, ``CONFIG_NRFX_DPPI131``, ``CONFIG_NRFX_DPPI132``, ``CONFIG_NRFX_DPPI133``, ``CONFIG_NRFX_DPPI134``, ``CONFIG_NRFX_DPPI135``, ``CONFIG_NRFX_DPPI136`` with :kconfig:option:`CONFIG_NRFX_GPPI`.
376+
* ``CONFIG_NRFX_I2S0``, ``CONFIG_NRFX_I2S20`` with :kconfig:option:`CONFIG_NRFX_I2S`.
377+
* ``CONFIG_NRFX_PDM0``, ``CONFIG_NRFX_PDM20``, ``CONFIG_NRFX_PDM21`` with :kconfig:option:`CONFIG_NRFX_PDM`.
378+
* ``CONFIG_NRFX_PPI`` with :kconfig:option:`CONFIG_NRFX_GPPI`.
379+
* ``CONFIG_NRFX_PWM0``, ``CONFIG_NRFX_PWM1``, ``CONFIG_NRFX_PWM2``, ``CONFIG_NRFX_PWM3``, ``CONFIG_NRFX_PWM20``, ``CONFIG_NRFX_PWM21``, ``CONFIG_NRFX_PWM22``, ``CONFIG_NRFX_PWM120``, ``CONFIG_NRFX_PWM130``, ``CONFIG_NRFX_PWM131``, ``CONFIG_NRFX_PWM132``, ``CONFIG_NRFX_PWM133`` with :kconfig:option:`CONFIG_NRFX_PWM`.
380+
* ``CONFIG_NRFX_QDEC0``, ``CONFIG_NRFX_QDEC1``, ``CONFIG_NRFX_QDEC20``, ``CONFIG_NRFX_QDEC21``, ``CONFIG_NRFX_QDEC130``, ``CONFIG_NRFX_QDEC131`` with :kconfig:option:`CONFIG_NRFX_QDEC`.
381+
* ``CONFIG_NRFX_SPIM0``, ``CONFIG_NRFX_SPIM1``, ``CONFIG_NRFX_SPIM2``, ``CONFIG_NRFX_SPIM3``, ``CONFIG_NRFX_SPIM4``, ``CONFIG_NRFX_SPIM00``, ``CONFIG_NRFX_SPIM01``, ``CONFIG_NRFX_SPIM20``, ``CONFIG_NRFX_SPIM21``, ``CONFIG_NRFX_SPIM22``, ``CONFIG_NRFX_SPIM23``, ``CONFIG_NRFX_SPIM24``, ``CONFIG_NRFX_SPIM30``, ``CONFIG_NRFX_SPIM120``, ``CONFIG_NRFX_SPIM121``, ``CONFIG_NRFX_SPIM130``, ``CONFIG_NRFX_SPIM131``, ``CONFIG_NRFX_SPIM132``, ``CONFIG_NRFX_SPIM133``, ``CONFIG_NRFX_SPIM134``, ``CONFIG_NRFX_SPIM135``, ``CONFIG_NRFX_SPIM136``, ``CONFIG_NRFX_SPIM137`` with :kconfig:option:`CONFIG_NRFX_SPIM`.
382+
* ``CONFIG_NRFX_SPIS0``, ``CONFIG_NRFX_SPIS1``, ``CONFIG_NRFX_SPIS2``, ``CONFIG_NRFX_SPIS3``, ``CONFIG_NRFX_SPIS00``, ``CONFIG_NRFX_SPIS01``, ``CONFIG_NRFX_SPIS20``, ``CONFIG_NRFX_SPIS21``, ``CONFIG_NRFX_SPIS22``, ``CONFIG_NRFX_SPIS23``, ``CONFIG_NRFX_SPIS24``, ``CONFIG_NRFX_SPIS30``, ``CONFIG_NRFX_SPIS120``, ``CONFIG_NRFX_SPIS130``, ``CONFIG_NRFX_SPIS131``, ``CONFIG_NRFX_SPIS132``, ``CONFIG_NRFX_SPIS133``, ``CONFIG_NRFX_SPIS134``, ``CONFIG_NRFX_SPIS135``, ``CONFIG_NRFX_SPIS136``, ``CONFIG_NRFX_SPIS137`` with :kconfig:option:`CONFIG_NRFX_SPIS`.
383+
* ``CONFIG_NRFX_TIMER0``, ``CONFIG_NRFX_TIMER1``, ``CONFIG_NRFX_TIMER2``, ``CONFIG_NRFX_TIMER3``, ``CONFIG_NRFX_TIMER4``, ``CONFIG_NRFX_TIMER00``, ``CONFIG_NRFX_TIMER10``, ``CONFIG_NRFX_TIMER20``, ``CONFIG_NRFX_TIMER21``, ``CONFIG_NRFX_TIMER22``, ``CONFIG_NRFX_TIMER23``, ``CONFIG_NRFX_TIMER24``, ``CONFIG_NRFX_TIMER020``, ``CONFIG_NRFX_TIMER021``, ``CONFIG_NRFX_TIMER022``, ``CONFIG_NRFX_TIMER120``, ``CONFIG_NRFX_TIMER121``, ``CONFIG_NRFX_TIMER130``, ``CONFIG_NRFX_TIMER131``, ``CONFIG_NRFX_TIMER132``, ``CONFIG_NRFX_TIMER133``, ``CONFIG_NRFX_TIMER134``, ``CONFIG_NRFX_TIMER135``, ``CONFIG_NRFX_TIMER136``, ``CONFIG_NRFX_TIMER137`` with :kconfig:option:`CONFIG_NRFX_TIMER`.
384+
* ``CONFIG_NRFX_TWIM0``, ``CONFIG_NRFX_TWIM1``, ``CONFIG_NRFX_TWIM2``, ``CONFIG_NRFX_TWIM3``, ``CONFIG_NRFX_TWIM20``, ``CONFIG_NRFX_TWIM21``, ``CONFIG_NRFX_TWIM22``, ``CONFIG_NRFX_TWIM23``, ``CONFIG_NRFX_TWIM24``, ``CONFIG_NRFX_TWIM30``, ``CONFIG_NRFX_TWIM120``, ``CONFIG_NRFX_TWIM130``, ``CONFIG_NRFX_TWIM131``, ``CONFIG_NRFX_TWIM132``, ``CONFIG_NRFX_TWIM133``, ``CONFIG_NRFX_TWIM134``, ``CONFIG_NRFX_TWIM135``, ``CONFIG_NRFX_TWIM136``, ``CONFIG_NRFX_TWIM137`` with :kconfig:option:`CONFIG_NRFX_TWIM`.
385+
* ``CONFIG_NRFX_TWIS0``, ``CONFIG_NRFX_TWIS1``, ``CONFIG_NRFX_TWIS2``, ``CONFIG_NRFX_TWIS3``, ``CONFIG_NRFX_TWIS20``, ``CONFIG_NRFX_TWIS21``, ``CONFIG_NRFX_TWIS22``, ``CONFIG_NRFX_TWIS23``, ``CONFIG_NRFX_TWIS24``, ``CONFIG_NRFX_TWIS30``, ``CONFIG_NRFX_TWIS120``, ``CONFIG_NRFX_TWIS130``, ``CONFIG_NRFX_TWIS131``, ``CONFIG_NRFX_TWIS132``, ``CONFIG_NRFX_TWIS133``, ``CONFIG_NRFX_TWIS134``, ``CONFIG_NRFX_TWIS135``, ``CONFIG_NRFX_TWIS136``, ``CONFIG_NRFX_TWIS137`` with :kconfig:option:`CONFIG_NRFX_TWIS`.
386+
* ``CONFIG_NRFX_UARTE0``, ``CONFIG_NRFX_UARTE1``, ``CONFIG_NRFX_UARTE2``, ``CONFIG_NRFX_UARTE3``, ``CONFIG_NRFX_UARTE20``, ``CONFIG_NRFX_UARTE21``, ``CONFIG_NRFX_UARTE22``, ``CONFIG_NRFX_UARTE23``, ``CONFIG_NRFX_UARTE24``, ``CONFIG_NRFX_UARTE30``, ``CONFIG_NRFX_UARTE120``, ``CONFIG_NRFX_UARTE130``, ``CONFIG_NRFX_UARTE131``, ``CONFIG_NRFX_UARTE132``, ``CONFIG_NRFX_UARTE133``, ``CONFIG_NRFX_UARTE134``, ``CONFIG_NRFX_UARTE135``, ``CONFIG_NRFX_UARTE136``, ``CONFIG_NRFX_UARTE137`` with :kconfig:option:`CONFIG_NRFX_UARTE`.
387+
* ``CONFIG_NRFX_WDT0``, ``CONFIG_NRFX_WDT1``, ``CONFIG_NRFX_WDT30``, ``CONFIG_NRFX_WDT31``, ``CONFIG_NRFX_WDT010``, ``CONFIG_NRFX_WDT011``, ``CONFIG_NRFX_WDT130``, ``CONFIG_NRFX_WDT131``, ``CONFIG_NRFX_WDT132`` with :kconfig:option:`CONFIG_NRFX_WDT`.
388+
389+
* Remove:
390+
391+
* ``CONFIG_NRFX_PPIB``, ``CONFIG_NRFX_PPIB00``, ``CONFIG_NRFX_PPIB01``, ``CONFIG_NRFX_PPIB10``, ``CONFIG_NRFX_PPIB11``, ``CONFIG_NRFX_PPIB20``, ``CONFIG_NRFX_PPIB21``, ``CONFIG_NRFX_PPIB22``, ``CONFIG_NRFX_PPIB30``.

0 commit comments

Comments
 (0)