55Migration guide to Zephyr v3.6.0 (Working Draft)
66################################################
77
8- This document describes the changes required or recommended when migrating your
9- application from Zephyr v3.5.0 to Zephyr v3.6.0.
8+ This document describes the changes required when migrating your application from Zephyr v3.5.0 to
9+ Zephyr v3.6.0.
1010
1111Any other changes (not directly related to migrating applications) can be found in
1212the :ref: `release notes<zephyr_3.6> `.
1313
14- Required changes
15- ****************
16-
1714Build System
18- ============
15+ ************
1916
2017* The deprecated ``prj_<board>.conf `` Kconfig file support has been removed, projects that use
2118 this should switch to using board Kconfig fragments instead (``boards/<board>.conf ``).
@@ -34,7 +31,7 @@ Build System
3431 instead use the new ``-DFILE_SUFFIX `` feature :ref: `application-file-suffixes `.
3532
3633Kernel
37- ======
34+ ******
3835
3936* The system heap size and its availability is now determined by a ``K_HEAP_MEM_POOL_SIZE ``
4037 define instead of the :kconfig:option: `CONFIG_HEAP_MEM_POOL_SIZE ` Kconfig option. Subsystems
4643 being disabled).
4744
4845Boards
49- ======
46+ ******
5047
5148* The deprecated Nordic SoC Kconfig option ``NRF_STORE_REBOOT_TYPE_GPREGRET `` has been removed,
5249 applications that use this should switch to using the :ref: `boot_mode_api ` instead.
5552 ``mimxrt1020_evk ``, ``mimxrt1015_evk ``
5653
5754Optional Modules
58- ================
55+ ****************
5956
6057The following modules have been made optional and are not downloaded with `west update ` by default
6158anymore:
@@ -67,7 +64,7 @@ name>`` command, or ``west config manifest.group-filter -- +optional`` to
6764enable all optional modules, and then run ``west update `` again.
6865
6966Device Drivers and Device Tree
70- ==============================
67+ ******************************
7168
7269* Various deprecated macros related to the deprecated devicetree label property
7370 were removed. These are listed in the following table. The table also
@@ -361,7 +358,7 @@ Device Drivers and Device Tree
361358 for the boards which are based on ST BlueNRG-MS.
362359
363360Shell
364- =====
361+ *****
365362
366363* The following subsystem and driver shell modules are now disabled by default. Each required shell
367364 module must now be explicitly enabled via Kconfig (:github: `65307 `):
@@ -405,14 +402,14 @@ Shell
405402 also has to be enabled in order to use the asynchronous serial shell (:github: `68475 `).
406403
407404Bootloader
408- ==========
405+ **********
409406
410407* MCUboot's deprecated ``CONFIG_ZEPHYR_TRY_MASS_ERASE `` Kconfig option has been removed. If an
411408 erase is needed when flashing MCUboot, this should now be provided directly to the ``west ``
412409 command e.g. ``west flash --erase ``. (:github: `64703 `)
413410
414411Bluetooth
415- =========
412+ *********
416413
417414* ATT now has its own TX buffer pool.
418415 If extra ATT buffers were configured using :kconfig:option: `CONFIG_BT_L2CAP_TX_BUF_COUNT `,
@@ -495,7 +492,7 @@ Bluetooth
495492
496493
497494LoRaWAN
498- =======
495+ *******
499496
500497* The API to register a callback to provide battery level information to the LoRaWAN stack has been
501498 renamed from ``lorawan_set_battery_level_callback `` to
@@ -504,7 +501,7 @@ LoRaWAN
504501 (:github: `65103 `)
505502
506503Networking
507- ==========
504+ **********
508505
509506* The CoAP public API has some minor changes to take into account. The
510507 :c:func: `coap_remove_observer ` now returns a result if the observer was removed. This
@@ -552,7 +549,7 @@ Networking
552549 removed.
553550
554551zcbor
555- =====
552+ *****
556553
557554* If you have zcbor-generated code that relies on the zcbor libraries through Zephyr, you must
558555 regenerate the files using zcbor 0.8.1. Note that the names of generated types and members has
@@ -579,7 +576,7 @@ zcbor
579576 :c:func: `zcbor_trace_file ` and :c:func: `zcbor_trace `, both of which take a ``state `` parameter.
580577
581578Other Subsystems
582- ================
579+ ****************
583580
584581* MCUmgr applications that make use of serial transports (shell or UART) must now select
585582 :kconfig:option: `CONFIG_CRC `, this was previously erroneously selected if MCUmgr was enabled,
@@ -596,7 +593,7 @@ Other Subsystems
596593 and :kconfig:option: `ZBUS_MSG_SUBSCRIBER_BUF_ALLOC_STATIC ` options should be used.
597594
598595Userspace
599- =========
596+ *********
600597
601598* A number of userspace related functions have been moved out of the ``z_ `` namespace
602599 and into the kernel namespace.
@@ -633,7 +630,7 @@ Userspace
633630 * ``z_dynamic_object_aligned_create `` to :c:func: `k_object_create_dynamic_aligned `
634631
635632Xtensa
636- ======
633+ ******
637634
638635* :kconfig:option: `CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC ` no longer has a default in
639636 the architecture layer. Instead, SoCs or boards will need to define it.
@@ -656,14 +653,3 @@ Xtensa
656653 * ``z_xtensa_irq_disable `` to :c:func: `xtensa_irq_disable `
657654
658655 * ``z_xtensa_irq_is_enabled `` to :c:func: `xtensa_irq_is_enabled `
659-
660- Recommended Changes
661- *******************
662-
663- * New macros available for ST sensor DT properties setting. These macros have a self-explanatory
664- name that helps in recognizing what the property setting means (e.g. LSM6DSV16X_DT_ODR_AT_60Hz).
665- (:github: `65410 `)
666-
667- * Users of :ref: `native_posix<native_posix> ` are recommended to migrate to
668- :ref: `native_sim<native_sim> `. :ref: `native_sim<native_sim> ` supports all its use cases,
669- and should be a drop-in replacement for most.
0 commit comments