diff options
author | Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> | 2025-07-13 14:46:38 +0200 |
---|---|---|
committer | Rob Herring (Arm) <robh@kernel.org> | 2025-07-14 16:23:52 -0500 |
commit | 6a57cf210711c068a650bd86acae4a88303dfd5d (patch) | |
tree | 854f719bc090b342a7db83da1030428db8f39836 | |
parent | a1d87a3586152f52856b449c4787f21cb35d430f (diff) |
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: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
Link: https://lore.kernel.org/r/20250713-dt-bindings-docs-v2-3-672c898054ae@linaro.org
Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
-rw-r--r-- | Documentation/devicetree/bindings/writing-bindings.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/writing-bindings.rst b/Documentation/devicetree/bindings/writing-bindings.rst index e63de88385b5..f8e0293a7c06 100644 --- a/Documentation/devicetree/bindings/writing-bindings.rst +++ b/Documentation/devicetree/bindings/writing-bindings.rst @@ -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. |