]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
docs: dt: writing-bindings: Document node name ABI and simple-mfd
authorKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Mon, 18 Aug 2025 13:25:35 +0000 (15:25 +0200)
committerRob Herring (Arm) <robh@kernel.org>
Wed, 3 Sep 2025 14:01:25 +0000 (09:01 -0500)
commit81bb4d07edd72a56180e2c8414ead0e63c379502
treef1446cc00ad01c20ff604b7b46d7f2d2f07826ef
parent835bdddd028ff57afaee28eb5e4b260f714fd555
docs: dt: writing-bindings: Document node name ABI and simple-mfd

Document established Devicetree bindings maintainers review practice:

1. Device node names should not be treated as an ABI, unless for
   children of a device when documented.
   There were many patches posted using of_find_node_by_name() or
   of_node_name_eq() for accessing siblings or completely different
   nodes.  These cases were introducing undocumented ABI, so they are
   discouraged.

2. 'simple-mfd' means children do not depend on parent device resources.
   'simple-bus' is so simple, that even 'reg' properties are not
   applicable.

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20250818132534.120217-2-krzysztof.kozlowski@linaro.org
Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
Documentation/devicetree/bindings/writing-bindings.rst