Skip to content

Commit 3fc4fcf

Browse files
masz-nordicrlubos
authored andcommitted
doc: nrf: migration notes: add nrfx 4.0 entry
Provide migration notes for nrfx 4.0 in NCS context. Signed-off-by: Marcin Szymczyk <[email protected]>
1 parent 7a0899d commit 3fc4fcf

File tree

2 files changed

+243
-1
lines changed

2 files changed

+243
-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: 242 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -469,3 +469,245 @@ Memfault integration
469469
* :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.
470470
* :kconfig:option:`CONFIG_MEMFAULT_NCS_DEVICE_ID_IMEI` (deprecated) - Use the LTE modem IMEI as the device ID.
471471
* :kconfig:option:`CONFIG_MEMFAULT_NCS_DEVICE_ID_NET_MAC` (deprecated) - Use the network interface MAC address as the device ID.
472+
473+
Drivers
474+
=======
475+
476+
This section provides detailed lists of changes by drivers.
477+
478+
nrfx
479+
----
480+
481+
.. toggle::
482+
483+
* nrfx version has been updated to 4.0.
484+
For nrfx changes see `nrfx 4.0 migration note`_.
485+
486+
Additionally, to migrate a Zephyr build system application that uses nrfx API directly, complete the following steps:
487+
488+
#. Kconfig options:
489+
490+
* Replace:
491+
492+
* Use :kconfig:option:`CONFIG_NRFX_GPPI` instead of the following:
493+
494+
* ``CONFIG_NRFX_DPPI``
495+
* ``CONFIG_NRFX_DPPI0``
496+
* ``CONFIG_NRFX_DPPI00``
497+
* ``CONFIG_NRFX_DPPI10``
498+
* ``CONFIG_NRFX_DPPI20``
499+
* ``CONFIG_NRFX_DPPI30``
500+
* ``CONFIG_NRFX_DPPI020``
501+
* ``CONFIG_NRFX_DPPI120``
502+
* ``CONFIG_NRFX_DPPI130``
503+
* ``CONFIG_NRFX_DPPI131``
504+
* ``CONFIG_NRFX_DPPI132``
505+
* ``CONFIG_NRFX_DPPI133``
506+
* ``CONFIG_NRFX_DPPI134``
507+
* ``CONFIG_NRFX_DPPI135``
508+
* ``CONFIG_NRFX_DPPI136``
509+
* ``CONFIG_NRFX_PPI``
510+
511+
* Use :kconfig:option:`CONFIG_NRFX_I2S` instead of the following:
512+
513+
* ``CONFIG_NRFX_I2S0``
514+
* ``CONFIG_NRFX_I2S20``
515+
516+
* Use :kconfig:option:`CONFIG_NRFX_PDM` instead of the following:
517+
518+
* ``CONFIG_NRFX_PDM0``
519+
* ``CONFIG_NRFX_PDM20``
520+
* ``CONFIG_NRFX_PDM21``
521+
522+
* Use :kconfig:option:`CONFIG_NRFX_PWM` instead of the following:
523+
524+
* ``CONFIG_NRFX_PWM0``
525+
* ``CONFIG_NRFX_PWM1``
526+
* ``CONFIG_NRFX_PWM2``
527+
* ``CONFIG_NRFX_PWM3``
528+
* ``CONFIG_NRFX_PWM20``
529+
* ``CONFIG_NRFX_PWM21``
530+
* ``CONFIG_NRFX_PWM22``
531+
* ``CONFIG_NRFX_PWM120``
532+
* ``CONFIG_NRFX_PWM130``
533+
* ``CONFIG_NRFX_PWM131``
534+
* ``CONFIG_NRFX_PWM132``
535+
* ``CONFIG_NRFX_PWM133``
536+
537+
* Use :kconfig:option:`CONFIG_NRFX_QDEC` instead of the following:
538+
539+
* ``CONFIG_NRFX_QDEC0``
540+
* ``CONFIG_NRFX_QDEC1``
541+
* ``CONFIG_NRFX_QDEC20``
542+
* ``CONFIG_NRFX_QDEC21``
543+
* ``CONFIG_NRFX_QDEC130``
544+
* ``CONFIG_NRFX_QDEC131``
545+
546+
* Use :kconfig:option:`CONFIG_NRFX_SPIM` instead of the following:
547+
548+
* ``CONFIG_NRFX_SPIM0``
549+
* ``CONFIG_NRFX_SPIM1``
550+
* ``CONFIG_NRFX_SPIM2``
551+
* ``CONFIG_NRFX_SPIM3``
552+
* ``CONFIG_NRFX_SPIM4``
553+
* ``CONFIG_NRFX_SPIM00``
554+
* ``CONFIG_NRFX_SPIM01``
555+
* ``CONFIG_NRFX_SPIM20``
556+
* ``CONFIG_NRFX_SPIM21``
557+
* ``CONFIG_NRFX_SPIM22``
558+
* ``CONFIG_NRFX_SPIM23``
559+
* ``CONFIG_NRFX_SPIM24``
560+
* ``CONFIG_NRFX_SPIM30``
561+
* ``CONFIG_NRFX_SPIM120``
562+
* ``CONFIG_NRFX_SPIM121``
563+
* ``CONFIG_NRFX_SPIM130``
564+
* ``CONFIG_NRFX_SPIM131``
565+
* ``CONFIG_NRFX_SPIM132``
566+
* ``CONFIG_NRFX_SPIM133``
567+
* ``CONFIG_NRFX_SPIM134``
568+
* ``CONFIG_NRFX_SPIM135``
569+
* ``CONFIG_NRFX_SPIM136``
570+
* ``CONFIG_NRFX_SPIM137``
571+
572+
* Use :kconfig:option:`CONFIG_NRFX_SPIS` instead of the following:
573+
574+
* ``CONFIG_NRFX_SPIS0``
575+
* ``CONFIG_NRFX_SPIS1``
576+
* ``CONFIG_NRFX_SPIS2``
577+
* ``CONFIG_NRFX_SPIS3``
578+
* ``CONFIG_NRFX_SPIS00``
579+
* ``CONFIG_NRFX_SPIS01``
580+
* ``CONFIG_NRFX_SPIS20``
581+
* ``CONFIG_NRFX_SPIS21``
582+
* ``CONFIG_NRFX_SPIS22``
583+
* ``CONFIG_NRFX_SPIS23``
584+
* ``CONFIG_NRFX_SPIS24``
585+
* ``CONFIG_NRFX_SPIS30``
586+
* ``CONFIG_NRFX_SPIS120``
587+
* ``CONFIG_NRFX_SPIS130``
588+
* ``CONFIG_NRFX_SPIS131``
589+
* ``CONFIG_NRFX_SPIS132``
590+
* ``CONFIG_NRFX_SPIS133``
591+
* ``CONFIG_NRFX_SPIS134``
592+
* ``CONFIG_NRFX_SPIS135``
593+
* ``CONFIG_NRFX_SPIS136``
594+
* ``CONFIG_NRFX_SPIS137``
595+
596+
* Use :kconfig:option:`CONFIG_NRFX_TIMER` instead of the following:
597+
598+
* ``CONFIG_NRFX_TIMER0``
599+
* ``CONFIG_NRFX_TIMER1``
600+
* ``CONFIG_NRFX_TIMER2``
601+
* ``CONFIG_NRFX_TIMER3``
602+
* ``CONFIG_NRFX_TIMER4``
603+
* ``CONFIG_NRFX_TIMER00``
604+
* ``CONFIG_NRFX_TIMER10``
605+
* ``CONFIG_NRFX_TIMER20``
606+
* ``CONFIG_NRFX_TIMER21``
607+
* ``CONFIG_NRFX_TIMER22``
608+
* ``CONFIG_NRFX_TIMER23``
609+
* ``CONFIG_NRFX_TIMER24``
610+
* ``CONFIG_NRFX_TIMER020``
611+
* ``CONFIG_NRFX_TIMER021``
612+
* ``CONFIG_NRFX_TIMER022``
613+
* ``CONFIG_NRFX_TIMER120``
614+
* ``CONFIG_NRFX_TIMER121``
615+
* ``CONFIG_NRFX_TIMER130``
616+
* ``CONFIG_NRFX_TIMER131``
617+
* ``CONFIG_NRFX_TIMER132``
618+
* ``CONFIG_NRFX_TIMER133``
619+
* ``CONFIG_NRFX_TIMER134``
620+
* ``CONFIG_NRFX_TIMER135``
621+
* ``CONFIG_NRFX_TIMER136``
622+
* ``CONFIG_NRFX_TIMER137``
623+
624+
* Use :kconfig:option:`CONFIG_NRFX_TWIM` instead of the following:
625+
626+
* ``CONFIG_NRFX_TWIM0``
627+
* ``CONFIG_NRFX_TWIM1``
628+
* ``CONFIG_NRFX_TWIM2``
629+
* ``CONFIG_NRFX_TWIM3``
630+
* ``CONFIG_NRFX_TWIM20``
631+
* ``CONFIG_NRFX_TWIM21``
632+
* ``CONFIG_NRFX_TWIM22``
633+
* ``CONFIG_NRFX_TWIM23``
634+
* ``CONFIG_NRFX_TWIM24``
635+
* ``CONFIG_NRFX_TWIM30``
636+
* ``CONFIG_NRFX_TWIM120``
637+
* ``CONFIG_NRFX_TWIM130``
638+
* ``CONFIG_NRFX_TWIM131``
639+
* ``CONFIG_NRFX_TWIM132``
640+
* ``CONFIG_NRFX_TWIM133``
641+
* ``CONFIG_NRFX_TWIM134``
642+
* ``CONFIG_NRFX_TWIM135``
643+
* ``CONFIG_NRFX_TWIM136``
644+
* ``CONFIG_NRFX_TWIM137``
645+
646+
* Use :kconfig:option:`CONFIG_NRFX_TWIS` instead of the following:
647+
648+
* ``CONFIG_NRFX_TWIS0``
649+
* ``CONFIG_NRFX_TWIS1``
650+
* ``CONFIG_NRFX_TWIS2``
651+
* ``CONFIG_NRFX_TWIS3``
652+
* ``CONFIG_NRFX_TWIS20``
653+
* ``CONFIG_NRFX_TWIS21``
654+
* ``CONFIG_NRFX_TWIS22``
655+
* ``CONFIG_NRFX_TWIS23``
656+
* ``CONFIG_NRFX_TWIS24``
657+
* ``CONFIG_NRFX_TWIS30``
658+
* ``CONFIG_NRFX_TWIS120``
659+
* ``CONFIG_NRFX_TWIS130``
660+
* ``CONFIG_NRFX_TWIS131``
661+
* ``CONFIG_NRFX_TWIS132``
662+
* ``CONFIG_NRFX_TWIS133``
663+
* ``CONFIG_NRFX_TWIS134``
664+
* ``CONFIG_NRFX_TWIS135``
665+
* ``CONFIG_NRFX_TWIS136``
666+
* ``CONFIG_NRFX_TWIS137``
667+
668+
* Use :kconfig:option:`CONFIG_NRFX_UARTE` instead of the following:
669+
670+
* ``CONFIG_NRFX_UARTE0``
671+
* ``CONFIG_NRFX_UARTE1``
672+
* ``CONFIG_NRFX_UARTE2``
673+
* ``CONFIG_NRFX_UARTE3``
674+
* ``CONFIG_NRFX_UARTE00``
675+
* ``CONFIG_NRFX_UARTE20``
676+
* ``CONFIG_NRFX_UARTE21``
677+
* ``CONFIG_NRFX_UARTE22``
678+
* ``CONFIG_NRFX_UARTE23``
679+
* ``CONFIG_NRFX_UARTE24``
680+
* ``CONFIG_NRFX_UARTE30``
681+
* ``CONFIG_NRFX_UARTE120``
682+
* ``CONFIG_NRFX_UARTE130``
683+
* ``CONFIG_NRFX_UARTE131``
684+
* ``CONFIG_NRFX_UARTE132``
685+
* ``CONFIG_NRFX_UARTE133``
686+
* ``CONFIG_NRFX_UARTE134``
687+
* ``CONFIG_NRFX_UARTE135``
688+
* ``CONFIG_NRFX_UARTE136``
689+
* ``CONFIG_NRFX_UARTE137``
690+
691+
* Use :kconfig:option:`CONFIG_NRFX_WDT` instead of the following:
692+
693+
* ``CONFIG_NRFX_WDT0``
694+
* ``CONFIG_NRFX_WDT1``
695+
* ``CONFIG_NRFX_WDT30``
696+
* ``CONFIG_NRFX_WDT31``
697+
* ``CONFIG_NRFX_WDT010``
698+
* ``CONFIG_NRFX_WDT011``
699+
* ``CONFIG_NRFX_WDT130``
700+
* ``CONFIG_NRFX_WDT131``
701+
* ``CONFIG_NRFX_WDT132``
702+
703+
* Remove:
704+
705+
* ``CONFIG_NRFX_PPIB``
706+
* ``CONFIG_NRFX_PPIB00``
707+
* ``CONFIG_NRFX_PPIB01``
708+
* ``CONFIG_NRFX_PPIB10``
709+
* ``CONFIG_NRFX_PPIB11``
710+
* ``CONFIG_NRFX_PPIB20``
711+
* ``CONFIG_NRFX_PPIB21``
712+
* ``CONFIG_NRFX_PPIB22``
713+
* ``CONFIG_NRFX_PPIB30``

0 commit comments

Comments
 (0)