diff options
| author | Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> | 2025-09-04 16:24:01 +0200 |
|---|---|---|
| committer | Rob Herring (Arm) <robh@kernel.org> | 2025-09-09 20:38:31 -0500 |
| commit | 3ef9c995fa51a90b08b0cc8d2951acb53c38936c (patch) | |
| tree | 904f6ac82a7875f0902976250126de73bea2074d | |
| parent | bc3f7d0340f7cf32b53e40aeed25ac0c6a0e77e7 (diff) | |
docs: dt: writing-schema: Describe defining properties in top-level
Document established Devicetree bindings maintainers review practice:
Properties having differences per each device in the binding, e.g.
different constraints for lists or different allowed values, should
still be defined in top-level 'properties' section and only customized
in 'if:then:'.
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20250904142400.179955-2-krzysztof.kozlowski@linaro.org
Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
| -rw-r--r-- | Documentation/devicetree/bindings/writing-schema.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst index fcd4726f8df4..05c34248e544 100644 --- a/Documentation/devicetree/bindings/writing-schema.rst +++ b/Documentation/devicetree/bindings/writing-schema.rst @@ -165,6 +165,14 @@ The YAML Devicetree format also makes all string values an array and scalar values a matrix (in order to define groupings) even when only a single value is present. Single entries in schemas are fixed up to match this encoding. +When bindings cover multiple similar devices that differ in some properties, +those properties should be constrained for each device. This usually means: + + * In top level 'properties' define the property with the broadest constraints. + * In 'if:then:' blocks, further narrow the constraints for those properties. + * Do not define the properties within an 'if:then:' block (note that + 'additionalItems' also won't allow that). + Coding style ------------ |