Commit 6a57cf21 authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Rob Herring (Arm)
Browse files

docs: dt: writing-bindings: Document discouraged instance IDs 



Document established Devicetree bindings maintainers review practice:
instance indexes, either as properties or as custom new OF alias, are
not accepted.  Recommended way is to use, depending on the
situation/hardware: different compatible, cell arguments or syscon
phandle arguments.

Signed-off-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Reviewed-by: default avatarConor Dooley <conor.dooley@microchip.com>
Link: https://lore.kernel.org/r/20250713-dt-bindings-docs-v2-3-672c898054ae@linaro.org


Signed-off-by: default avatarRob Herring (Arm) <robh@kernel.org>
parent a1d87a35

Documentation/devicetree/bindings/writing-bindings.rst

+5 −0
Original line number Diff line number Diff line
@@ -105,6 +105,11 @@ Typical cases and caveats 
- "syscon" is not a generic property. Use vendor and type, e.g.

  "vendor,power-manager-syscon".



- Do not add instance index (IDs) properties or custom OF aliases.  If the

  devices have different programming model, they might need different

  compatibles.  If such devices use some other device in a different way, e.g.

  they program the phy differently, use cell/phandle arguments.



- Bindings files should be named like compatible: vendor,device.yaml. In case

  of multiple compatibles in the binding, use one of the fallbacks or a more

  generic name, yet still matching compatible style.