Skip to content

Commit 2752814

Browse files
xingrzkartben
authored andcommitted
doc: migration: 4.2: Clarify machine timer DTS changes
Clarify the changes introduced in machine timer bindings: * Several legacy compatibles (e.g. andestech,machine-timer, neorv32-machine-timer, etc.) have been unified under riscv,machine-timer. * MTIME and MTIMECMP addresses must now be specified explicitly using the reg and reg-names properties. * The reg-names property is now required and must match the reg entries one-to-one. Signed-off-by: Chen Xingyu <hi@xingrz.me>
1 parent e40315e commit 2752814

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

doc/releases/migration-guide-4.2.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,28 @@ Timer
277277
:kconfig:option:`CONFIG_NATIVE_POSIX_TIMER` has been deprecated in favor of
278278
:kconfig:option:`CONFIG_NATIVE_SIM_TIMER`, (:github:`86612`).
279279

280+
* :dtcompatible:`andestech,machine-timer`, :dtcompatible:`neorv32-machine-timer`,
281+
:dtcompatible:`telink,machine-timer`, :dtcompatible:`lowrisc,machine-timer`,
282+
:dtcompatible:`niosv-machine-timer`, and :dtcompatible:`scr,machine-timer` have
283+
been unified under :dtcompatible:`riscv,machine-timer`.
284+
285+
The addresses of both ``MTIME`` and ``MTIMECMP`` registers must now be explicitly
286+
specified using the ``reg`` and ``reg-names`` properties. The ``reg-names`` property
287+
is now **required**, and must list names corresponding one-to-one with each entry
288+
in ``reg``. (:github:`84175` and :github:`89847`)
289+
290+
Example:
291+
292+
.. code-block:: devicetree
293+
294+
mtimer: timer@d1000000 {
295+
compatible = "riscv,machine-timer";
296+
interrupts-extended = <&cpu0_intc 7>;
297+
reg = <0xd1000000 0x8
298+
0xd1000008 0x8>;
299+
reg-names = "mtime", "mtimecmp";
300+
};
301+
280302
Modem
281303
=====
282304

0 commit comments

Comments
 (0)