Skip to content

Commit 7498cd2

Browse files
henrikbrixandersenMaureenHelm
authored andcommitted
docs: release: migration-guide: 3.6.0: reorder entries a bit
Reorder a few entries in the v3.6.0 migration guide in order to list the ones likely to affect most people more prominently. Group related entries together and get rid of a couple of empty headlines. Signed-off-by: Henrik Brix Andersen <[email protected]>
1 parent c33743e commit 7498cd2

File tree

1 file changed

+66
-73
lines changed

1 file changed

+66
-73
lines changed

doc/releases/migration-guide-3.6.rst

Lines changed: 66 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,6 @@ the :ref:`release notes<zephyr_3.6>`.
1414
Required changes
1515
****************
1616

17-
Boards
18-
======
19-
20-
* The deprecated Nordic SoC Kconfig option ``NRF_STORE_REBOOT_TYPE_GPREGRET`` has been removed,
21-
applications that use this should switch to using the :ref:`boot_mode_api` instead.
22-
* NXP: Enabled :ref:`linkserver<linkserver-debug-host-tools>` to be the default runner on the
23-
following NXP boards: ``mimxrt685_evk_cm33``, ``frdm_k64f``, ``mimxrt1050_evk``, ``frdm_kl25z``,
24-
``mimxrt1020_evk``, ``mimxrt1015_evk``
25-
2617
Build System
2718
============
2819

@@ -54,8 +45,14 @@ Kernel
5445
:kconfig:option:`CONFIG_HEAP_MEM_POOL_IGNORE_MIN` option has been introduced (which defaults
5546
being disabled).
5647

57-
C Library
58-
=========
48+
Boards
49+
======
50+
51+
* The deprecated Nordic SoC Kconfig option ``NRF_STORE_REBOOT_TYPE_GPREGRET`` has been removed,
52+
applications that use this should switch to using the :ref:`boot_mode_api` instead.
53+
* NXP: Enabled :ref:`linkserver<linkserver-debug-host-tools>` to be the default runner on the
54+
following NXP boards: ``mimxrt685_evk_cm33``, ``frdm_k64f``, ``mimxrt1050_evk``, ``frdm_kl25z``,
55+
``mimxrt1020_evk``, ``mimxrt1015_evk``
5956

6057
Optional Modules
6158
================
@@ -72,6 +69,52 @@ enable all optional modules, and then run ``west update`` again.
7269
Device Drivers and Device Tree
7370
==============================
7471

72+
* Various deprecated macros related to the deprecated devicetree label property
73+
were removed. These are listed in the following table. The table also
74+
provides replacements.
75+
76+
However, if you are still using code like
77+
``device_get_binding(DT_LABEL(node_id))``, consider replacing it with
78+
something like ``DEVICE_DT_GET(node_id)`` instead. The ``DEVICE_DT_GET()``
79+
macro avoids run-time string comparisons, and is also safer because it will
80+
fail the build if the device does not exist.
81+
82+
.. list-table::
83+
:header-rows: 1
84+
85+
* - Removed macro
86+
- Replacement
87+
88+
* - ``DT_GPIO_LABEL(node_id, gpio_pha)``
89+
- ``DT_PROP(DT_GPIO_CTLR(node_id, gpio_pha), label)``
90+
91+
* - ``DT_GPIO_LABEL_BY_IDX(node_id, gpio_pha, idx)``
92+
- ``DT_PROP(DT_GPIO_CTLR_BY_IDX(node_id, gpio_pha, idx), label)``
93+
94+
* - ``DT_INST_GPIO_LABEL(inst, gpio_pha)``
95+
- ``DT_PROP(DT_GPIO_CTLR(DT_DRV_INST(inst), gpio_pha), label)``
96+
97+
* - ``DT_INST_GPIO_LABEL_BY_IDX(inst, gpio_pha, idx)``
98+
- ``DT_PROP(DT_GPIO_CTLR_BY_IDX(DT_DRV_INST(inst), gpio_pha, idx), label)``
99+
100+
* - ``DT_SPI_DEV_CS_GPIOS_LABEL(spi_dev)``
101+
- ``DT_PROP(DT_SPI_DEV_CS_GPIOS_CTLR(spi_dev), label)``
102+
103+
* - ``DT_INST_SPI_DEV_CS_GPIOS_LABEL(inst)``
104+
- ``DT_PROP(DT_SPI_DEV_CS_GPIOS_CTLR(DT_DRV_INST(inst)), label)``
105+
106+
* - ``DT_LABEL(node_id)``
107+
- ``DT_PROP(node_id, label)``
108+
109+
* - ``DT_BUS_LABEL(node_id)``
110+
- ``DT_PROP(DT_BUS(node_id), label)``
111+
112+
* - ``DT_INST_LABEL(inst)``
113+
- ``DT_INST_PROP(inst, label)``
114+
115+
* - ``DT_INST_BUS_LABEL(inst)``
116+
- ``DT_PROP(DT_BUS(DT_DRV_INST(inst)), label)``
117+
75118
* The :dtcompatible:`nxp,pcf8574` driver has been renamed to
76119
:dtcompatible:`nxp,pcf857x`. (:github:`67054`) to support pcf8574 and pcf8575.
77120
The Kconfig option has been renamed from :kconfig:option:`CONFIG_GPIO_PCF8574` to
@@ -127,52 +170,6 @@ Device Drivers and Device Tree
127170

128171
(:github:`62994`)
129172

130-
* Various deprecated macros related to the deprecated devicetree label property
131-
were removed. These are listed in the following table. The table also
132-
provides replacements.
133-
134-
However, if you are still using code like
135-
``device_get_binding(DT_LABEL(node_id))``, consider replacing it with
136-
something like ``DEVICE_DT_GET(node_id)`` instead. The ``DEVICE_DT_GET()``
137-
macro avoids run-time string comparisons, and is also safer because it will
138-
fail the build if the device does not exist.
139-
140-
.. list-table::
141-
:header-rows: 1
142-
143-
* - Removed macro
144-
- Replacement
145-
146-
* - ``DT_GPIO_LABEL(node_id, gpio_pha)``
147-
- ``DT_PROP(DT_GPIO_CTLR(node_id, gpio_pha), label)``
148-
149-
* - ``DT_GPIO_LABEL_BY_IDX(node_id, gpio_pha, idx)``
150-
- ``DT_PROP(DT_GPIO_CTLR_BY_IDX(node_id, gpio_pha, idx), label)``
151-
152-
* - ``DT_INST_GPIO_LABEL(inst, gpio_pha)``
153-
- ``DT_PROP(DT_GPIO_CTLR(DT_DRV_INST(inst), gpio_pha), label)``
154-
155-
* - ``DT_INST_GPIO_LABEL_BY_IDX(inst, gpio_pha, idx)``
156-
- ``DT_PROP(DT_GPIO_CTLR_BY_IDX(DT_DRV_INST(inst), gpio_pha, idx), label)``
157-
158-
* - ``DT_SPI_DEV_CS_GPIOS_LABEL(spi_dev)``
159-
- ``DT_PROP(DT_SPI_DEV_CS_GPIOS_CTLR(spi_dev), label)``
160-
161-
* - ``DT_INST_SPI_DEV_CS_GPIOS_LABEL(inst)``
162-
- ``DT_PROP(DT_SPI_DEV_CS_GPIOS_CTLR(DT_DRV_INST(inst)), label)``
163-
164-
* - ``DT_LABEL(node_id)``
165-
- ``DT_PROP(node_id, label)``
166-
167-
* - ``DT_BUS_LABEL(node_id)``
168-
- ``DT_PROP(DT_BUS(node_id), label)``
169-
170-
* - ``DT_INST_LABEL(inst)``
171-
- ``DT_INST_PROP(inst, label)``
172-
173-
* - ``DT_INST_BUS_LABEL(inst)``
174-
- ``DT_PROP(DT_BUS(DT_DRV_INST(inst)), label)``
175-
176173
* The :dtcompatible:`st,stm32-lptim` lptim which is selected for counting ticks during
177174
low power modes is identified by **stm32_lp_tick_source** in the device tree as follows.
178175
The stm32_lptim_timer driver has been changed to support this.
@@ -183,7 +180,6 @@ Device Drivers and Device Tree
183180
status = "okay";
184181
};
185182
186-
187183
* The :dtcompatible:`st,stm32-ospi-nor` and :dtcompatible:`st,stm32-qspi-nor` give the nor flash
188184
base address and size (in Bytes) with the **reg** property as follows.
189185
The <size> property is not used anymore.
@@ -230,6 +226,18 @@ Device Drivers and Device Tree
230226
is enabled, applications can still filter between Data and RTR frames in their receive callback
231227
functions as needed.
232228

229+
* The :dtcompatible:`st,stm32h7-fdcan` CAN controller driver now supports configuring the
230+
domain/kernel clock via devicetree. Previously, the driver only supported using the PLL1_Q clock
231+
for kernel clock, but now it defaults to the HSE clock, which is the chip default. Boards that
232+
use the PLL1_Q clock for FDCAN will need to override the ``clocks`` property as follows:
233+
234+
.. code-block:: devicetree
235+
236+
&fdcan1 {
237+
clocks = <&rcc STM32_CLOCK_BUS_APB1_2 0x00000100>,
238+
<&rcc STM32_SRC_PLL1_Q FDCAN_SEL(1)>;
239+
};
240+
233241
* The io-channel cells of the following devicetree bindings were reduced from 2 (``positive`` and
234242
``negative``) to the common ``input``, making it possible to use the various ADC DT macros with TI
235243
LMP90xxx ADC devices:
@@ -289,18 +297,6 @@ Device Drivers and Device Tree
289297
};
290298
};
291299
292-
* The :dtcompatible:`st,stm32h7-fdcan` CAN controller driver now supports configuring the
293-
domain/kernel clock via devicetree. Previously, the driver only supported using the PLL1_Q clock
294-
for kernel clock, but now it defaults to the HSE clock, which is the chip default. Boards that
295-
use the PLL1_Q clock for FDCAN will need to override the ``clocks`` property as follows:
296-
297-
.. code-block:: devicetree
298-
299-
&fdcan1 {
300-
clocks = <&rcc STM32_CLOCK_BUS_APB1_2 0x00000100>,
301-
<&rcc STM32_SRC_PLL1_Q FDCAN_SEL(1)>;
302-
};
303-
304300
* Runtime configuration is now disabled by default for Nordic UART drivers. The motivation for the
305301
change is that this feature is rarely used and disabling it significantly reduces the memory
306302
footprint.
@@ -364,9 +360,6 @@ Device Drivers and Device Tree
364360
* The :dtcompatible:`st,hci-spi-v1` should be used instead of :dtcompatible:`zephyr,bt-hci-spi`
365361
for the boards which are based on ST BlueNRG-MS.
366362

367-
Power Management
368-
================
369-
370363
Shell
371364
=====
372365

0 commit comments

Comments
 (0)