Skip to content

Commit 93861e0

Browse files
mstasiaknordicmstasiaknordic
committed
doc: add migration guide for removed CMake defines
Added a short entry to NCS 3.5 migration guide that continues the change described in 3.4 migration guide. Signed-off-by: Michał Stasiak <michal.stasiak@nordicsemi.no>
1 parent 1f6978a commit 93861e0

2 files changed

Lines changed: 183 additions & 0 deletions

File tree

‎doc/nrf/releases_and_maturity/migration/migration_guide_3.4.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ Removal of legacy PSA Crypto API
7474
Build and configuration system
7575
==============================
7676

77+
.. _migration_3.4_hal_global_defines:
78+
7779
HAL global define deprecation
7880
-----------------------------
7981

‎doc/nrf/releases_and_maturity/migration/migration_guide_3.5.rst‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,187 @@ This section describes the changes related to the build and configuration system
4242
If you set the :kconfig:option:`SB_CONFIG_MCUBOOT_UPDATEABLE_IMAGES` Kconfig option or a static partition layout explicitly for a firmware-patch build, reduce the number of updatable images by one and remove the now-unused update-slot partitions.
4343
Storing the nRF70 Series firmware patch in external flash using the :kconfig:option:`SB_CONFIG_WIFI_PATCHES_EXT_FLASH_XIP` or :kconfig:option:`SB_CONFIG_WIFI_PATCHES_EXT_FLASH_STORE` Kconfig option is not affected.
4444

45+
.. _migration_3.5_hal_global_defines:
46+
47+
* The HAL preprocessor symbols listed in :ref:`migration_3.4_hal_global_defines` are no longer defined globally.
48+
In application code, replace references to the deprecated symbols with the corresponding Kconfig symbols or devicetree properties shown below.
49+
50+
.. list-table:: HAL preprocessor symbols replacements
51+
:widths: 35 45 20
52+
:header-rows: 1
53+
54+
* - Deprecated symbol
55+
- Replacement symbol
56+
- Notes
57+
* - ``NRF51``
58+
- :kconfig:option:`CONFIG_SOC_SERIES_NRF51`
59+
- Board-selected
60+
* - ``NRF51422_XXAA``
61+
- :kconfig:option:`CONFIG_SOC_NRF51822_QFAA`
62+
- Board-selected
63+
* - ``NRF51422_XXAB``
64+
- :kconfig:option:`CONFIG_SOC_NRF51822_QFAB`
65+
- Board-selected
66+
* - ``NRF51422_XXAC``
67+
- :kconfig:option:`CONFIG_SOC_NRF51822_QFAC`
68+
- Board-selected
69+
* - ``NRF52805_XXAA``
70+
- :kconfig:option:`CONFIG_SOC_NRF52805`
71+
- Board-selected
72+
* - ``NRF52810_XXAA``
73+
- :kconfig:option:`CONFIG_SOC_NRF52810`
74+
- Board-selected
75+
* - ``NRF52811_XXAA``
76+
- :kconfig:option:`CONFIG_SOC_NRF52811`
77+
- Board-selected
78+
* - ``NRF52820_XXAA``
79+
- :kconfig:option:`CONFIG_SOC_NRF52820`
80+
- Board-selected
81+
* - ``NRF52832_XXAA``
82+
- :kconfig:option:`CONFIG_SOC_NRF52832`
83+
- Board-selected
84+
* - ``NRF52833_XXAA``
85+
- :kconfig:option:`CONFIG_SOC_COMPATIBLE_NRF52833`
86+
- Board-selected
87+
* - ``NRF52840_XXAA``
88+
- :kconfig:option:`CONFIG_SOC_NRF52840`
89+
- Board-selected
90+
* - ``NRF5340_XXAA_APPLICATION``
91+
- :kconfig:option:`CONFIG_SOC_COMPATIBLE_NRF5340_CPUAPP`
92+
- Board-selected
93+
* - ``NRF5340_XXAA_NETWORK``
94+
- :kconfig:option:`CONFIG_SOC_COMPATIBLE_NRF5340_CPUNET`
95+
- Board-selected
96+
* - ``NRF54H20_XXAA``
97+
- :kconfig:option:`CONFIG_SOC_NRF54H20_CPUAPP`, :kconfig:option:`CONFIG_SOC_NRF54H20_CPURAD`, :kconfig:option:`CONFIG_SOC_NRF54H20_CPUPPR`, or :kconfig:option:`CONFIG_SOC_NRF54H20_CPUFLPR`
98+
- Board-selected
99+
* - ``NRF54L05_XXAA``
100+
- :kconfig:option:`CONFIG_SOC_NRF54L05_CPUAPP` or :kconfig:option:`CONFIG_SOC_NRF54L05_CPUFLPR`
101+
- Board-selected
102+
* - ``DEVELOP_IN_NRF54L15``
103+
- :kconfig:option:`CONFIG_SOC_NRF54L05_DEVELOP_IN_NRF54L15` or :kconfig:option:`CONFIG_SOC_NRF54L10_DEVELOP_IN_NRF54L15`
104+
- Board-selected
105+
* - ``NRF54L10_XXAA``
106+
- :kconfig:option:`CONFIG_SOC_NRF54L10_CPUAPP` or :kconfig:option:`CONFIG_SOC_NRF54L10_CPUFLPR`
107+
- Board-selected
108+
* - ``NRF54L15_XXAA``
109+
- :kconfig:option:`CONFIG_SOC_NRF54L15_CPUAPP`, :kconfig:option:`CONFIG_SOC_NRF54L15_CPUFLPR`, or :kconfig:option:`CONFIG_SOC_COMPATIBLE_NRF54L15`
110+
- Board-selected
111+
* - ``NRF54LC10A_XXAA``
112+
- :kconfig:option:`CONFIG_SOC_NRF54LC10A_CPUAPP` or :kconfig:option:`CONFIG_SOC_NRF54LC10A_CPUFLPR`
113+
- Board-selected; |NCS| extension
114+
* - ``DEVELOP_IN_NRF54LM20B``
115+
- :kconfig:option:`CONFIG_SOC_NRF54LM20A_DEVELOP_IN_NRF54LM20B`
116+
- Board-selected
117+
* - ``NRF54LM20A_XXAA``
118+
- :kconfig:option:`CONFIG_SOC_NRF54LM20A_CPUAPP`, :kconfig:option:`CONFIG_SOC_NRF54LM20A_CPUFLPR`, or :kconfig:option:`CONFIG_SOC_COMPATIBLE_NRF54LM20A`
119+
- Board-selected
120+
* - ``NRF7120_ENGA_XXAA``
121+
- :kconfig:option:`CONFIG_SOC_NRF7120_ENGA_CPUAPP`, :kconfig:option:`CONFIG_SOC_NRF7120_ENGA_CPUFLPR`, or :kconfig:option:`CONFIG_SOC_COMPATIBLE_NRF7120_ENGA`
122+
- Board-selected
123+
* - ``NRF54LM20B_XXAA``
124+
- :kconfig:option:`CONFIG_SOC_NRF54LM20B_CPUAPP` or :kconfig:option:`CONFIG_SOC_NRF54LM20B_CPUFLPR`
125+
- Board-selected
126+
* - ``NRF54LS05A_XXAA``
127+
- :kconfig:option:`CONFIG_SOC_NRF54LS05A_CPUAPP`
128+
- Board-selected; |NCS| extension
129+
* - ``DEVELOP_IN_NRF54LS05B``
130+
- :kconfig:option:`CONFIG_SOC_NRF54LS05A_DEVELOP_IN_NRF54LS05B`
131+
- Board-selected; |NCS| extension
132+
* - ``NRF54LS05B_XXAA``
133+
- :kconfig:option:`CONFIG_SOC_NRF54LS05B_CPUAPP`
134+
- Board-selected; |NCS| extension
135+
* - ``NRF54LV10A_XXAA``
136+
- :kconfig:option:`CONFIG_SOC_NRF54LV10A_CPUAPP` or :kconfig:option:`CONFIG_SOC_NRF54LV10A_CPUFLPR`
137+
- Board-selected; |NCS| extension
138+
* - ``NRF9120_XXAA``
139+
- :kconfig:option:`CONFIG_SOC_NRF9120`
140+
- Board-selected
141+
* - ``NRF9160_XXAA``
142+
- :kconfig:option:`CONFIG_SOC_NRF9160`
143+
- Board-selected
144+
* - ``NRF9220_XXAA``
145+
- :kconfig:option:`CONFIG_SOC_NRF9251_CPUAPP`, :kconfig:option:`CONFIG_SOC_NRF9251_CPUPPR`, or :kconfig:option:`CONFIG_SOC_NRF9251_CPUFLPR`
146+
- Board-selected; |NCS| extension
147+
* - ``NRF9230_ENGB_XXAA``
148+
- :kconfig:option:`CONFIG_SOC_NRF9230_ENGB_CPUAPP`, :kconfig:option:`CONFIG_SOC_NRF9230_ENGB_CPURAD`, or :kconfig:option:`CONFIG_SOC_NRF9230_ENGB_CPUPPR`
149+
- Board-selected
150+
* - ``NRF_APPLICATION``
151+
- Matching ``CONFIG_SOC_*_CPUAPP`` symbol for your board target (for example, :kconfig:option:`CONFIG_SOC_NRF54LC10A_CPUAPP` or :kconfig:option:`CONFIG_SOC_NRF9251_CPUAPP`)
152+
- Board-selected
153+
* - ``NRF_FLPR``
154+
- Matching ``CONFIG_SOC_*_CPUFLPR`` symbol for your board target (for example, :kconfig:option:`CONFIG_SOC_NRF54LC10A_CPUFLPR` or :kconfig:option:`CONFIG_SOC_NRF9251_CPUFLPR`)
155+
- Board-selected
156+
* - ``NRF_RADIOCORE``
157+
- :kconfig:option:`CONFIG_SOC_NRF54H20_CPURAD` or :kconfig:option:`CONFIG_SOC_NRF9230_ENGB_CPURAD`
158+
- Board-selected
159+
* - ``NRF_PPR``
160+
- :kconfig:option:`CONFIG_SOC_NRF54H20_CPUPPR`, :kconfig:option:`CONFIG_SOC_NRF9230_ENGB_CPUPPR`, or :kconfig:option:`CONFIG_SOC_NRF9251_CPUPPR`
161+
- Board-selected
162+
* - ``NRF_TRUSTZONE_NONSECURE``
163+
- :kconfig:option:`CONFIG_ARM_NONSECURE_FIRMWARE`
164+
- Board-selected for non-secure firmware images
165+
* - ``ENABLE_APPROTECT``
166+
- :kconfig:option:`CONFIG_NRF_APPROTECT_LOCK`
167+
- Kconfig
168+
* - ``ENABLE_APPROTECT_USER_HANDLING``
169+
- :kconfig:option:`CONFIG_NRF_APPROTECT_USER_HANDLING`
170+
- Kconfig
171+
* - ``ENABLE_AUTHENTICATED_APPROTECT``
172+
- :kconfig:option:`CONFIG_NRF_APPROTECT_USER_HANDLING`
173+
- Set together with ``ENABLE_APPROTECT_USER_HANDLING``
174+
* - ``ENABLE_SECURE_APPROTECT``
175+
- :kconfig:option:`CONFIG_NRF_SECURE_APPROTECT_LOCK`
176+
- Kconfig
177+
* - ``ENABLE_SECUREAPPROTECT``
178+
- :kconfig:option:`CONFIG_NRF_SECURE_APPROTECT_LOCK`
179+
- Alias of ``ENABLE_SECURE_APPROTECT``
180+
* - ``ENABLE_SECURE_APPROTECT_USER_HANDLING``
181+
- :kconfig:option:`CONFIG_NRF_SECURE_APPROTECT_USER_HANDLING`
182+
- Kconfig
183+
* - ``ENABLE_AUTHENTICATED_SECUREAPPROTECT``
184+
- :kconfig:option:`CONFIG_NRF_SECURE_APPROTECT_USER_HANDLING`
185+
- Set together with ``ENABLE_SECURE_APPROTECT_USER_HANDLING``
186+
* - ``ENABLE_TRACE``
187+
- :kconfig:option:`CONFIG_NRF_TRACE_PORT`
188+
- Kconfig
189+
* - ``ENABLE_SWO``
190+
- :kconfig:option:`CONFIG_LOG_BACKEND_SWO`
191+
- Kconfig
192+
* - ``NRF_SKIP_FICR_NS_COPY_TO_RAM``
193+
- :kconfig:option:`CONFIG_SOC_NRF5340_CPUAPP` or :kconfig:option:`CONFIG_SOC_SERIES_NRF91`
194+
- Implicit for these targets; use Kconfig checks instead of the define
195+
* - ``NRF_SKIP_CLOCK_CONFIGURATION``
196+
- :kconfig:option:`CONFIG_NRF_SKIP_CLOCK_CONFIG`
197+
- Kconfig
198+
* - ``NRF_DISABLE_FICR_TRIMCNF``
199+
- :kconfig:option:`CONFIG_SOC_NRF54LX_DISABLE_FICR_TRIMCNF`
200+
- Kconfig
201+
* - ``NRF_SKIP_TAMPC_SETUP``
202+
- :kconfig:option:`CONFIG_SOC_NRF54LX_SKIP_TAMPC_SETUP`
203+
- Kconfig
204+
* - ``NRF_SKIP_GLITCHDETECTOR_DISABLE``
205+
- :kconfig:option:`CONFIG_SOC_NRF54LX_SKIP_GLITCHDETECTOR_DISABLE`
206+
- Kconfig
207+
* - ``NRF54L_CONFIGURATION_56_ENABLE``
208+
- :kconfig:option:`CONFIG_SOC_NRF54L_ANOMALY_56_WORKAROUND`
209+
- Kconfig; enabled by default on nRF54L Series SoCs
210+
* - ``NRF91_ERRATA_36_ENABLE_WORKAROUND``
211+
- ``CONFIG_NRF91_ANOMALY_36_WORKAROUND``
212+
- TF-M build configuration
213+
* - ``NRF_CONFIG_NFCT_PINS_AS_GPIOS``
214+
- ``nfct-pins-as-gpios`` property on the ``uicr`` or ``nfct`` devicetree node
215+
- Devicetree
216+
* - ``NRF_CONFIG_GPIO_AS_PINRESET``
217+
- ``gpio-as-nreset`` property on the ``uicr`` devicetree node
218+
- Devicetree
219+
* - ``NRF_CONFIG_SWD_PINS_AS_GPIOS``
220+
- ``swd-pins-as-gpios`` property on the ``tampc`` devicetree node
221+
- Devicetree
222+
* - ``NRF_CONFIG_CPU_FREQ_MHZ``
223+
- Devicetree ``clock-frequency`` on the ``hfpll`` or ``cpuapp`` node, or :kconfig:option:`CONFIG_TFM_CPU_FREQ_MHZ` in TF-M builds
224+
- Derived from devicetree or TF-M Kconfig
225+
45226
Samples and applications
46227
========================
47228

0 commit comments

Comments
 (0)