dt-bindings: mfd: Explain lack of child dependency in simple-mfd

Common mistake of usage of 'simple-mfd' compatible is a dependency of
children on resources acquired and managed by the parent, e.g. clocks.
Extend the simple-mfd documentation to cover this case.

Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Arnd Bergmann <arnd@arndb.de>
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
Link: https://lore.kernel.org/r/20240623134600.115098-1-krzysztof.kozlowski@linaro.org
Signed-off-by: Lee Jones <lee@kernel.org>
This commit is contained in:
Krzysztof Kozlowski 2024-06-23 15:46:00 +02:00 committed by Lee Jones
parent 1d845319dc
commit b0a5cde57c

View File

@ -17,13 +17,14 @@ A typical MFD can be:
Optional properties: Optional properties:
- compatible : "simple-mfd" - this signifies that the operating system should - compatible : "simple-mfd" - this signifies that the operating system
consider all subnodes of the MFD device as separate devices akin to how should consider all subnodes of the MFD device as separate and independent
"simple-bus" indicates when to see subnodes as children for a simple devices, so not needing any resources to be provided by the parent device.
memory-mapped bus. For more complex devices, when the nexus driver has to Similarly to how "simple-bus" indicates when to see subnodes as children for
probe registers to figure out what child devices exist etc, this should not a simple memory-mapped bus.
be used. In the latter case the child devices will be determined by the For more complex devices, when the nexus driver has to probe registers to
operating system. figure out what child devices exist etc, this should not be used. In the
latter case the child devices will be determined by the operating system.
- ranges: Describes the address mapping relationship to the parent. Should set - ranges: Describes the address mapping relationship to the parent. Should set
the child's base address to 0, the physical address within parent's address the child's base address to 0, the physical address within parent's address