Commit 73f76a41 authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Rob Herring
Browse files

dt-bindings: example: Extend based on practice 



Extend the example schema with common rules which seems to be not that
obvious:
1. Expecting arrays of phandles to be always ordered, regardless if
   "xxx-names" is provided (e.g. clocks),
2. Add example of altering a property based on presence of other
   property,
3. Document usage of unevaluatedProperties.

Signed-off-by: default avatarKrzysztof Kozlowski <krzk@kernel.org>
Link: https://lore.kernel.org/r/20200910184706.9677-1-krzk@kernel.org


Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent 5f40bb39

Documentation/devicetree/bindings/example-schema.yaml

+25 −8
Original line number Diff line number Diff line
@@ -81,6 +81,8 @@ properties: 
    maxItems: 1

    description: bus clock. A description is only needed for a single item if

      there's something unique to add.

      The items should be have a fixed order, so pattern matching names are

      discouraged.



  clock-names:

    items:
@@ -97,6 +99,8 @@ properties: 
      A variable number of interrupts warrants a description of what conditions

      affect the number of interrupts. Otherwise, descriptions on standard

      properties are not necessary.

      The items should be have a fixed order, so pattern matching names are

      discouraged.



  interrupt-names:

    # minItems must be specified here because the default would be 2
@@ -196,7 +200,8 @@ required: 
#

# If the conditionals become too unweldy, then it may be better to just split

# the binding into separate schema documents.

if:

allOf:

  - if:

      properties:

        compatible:

          contains:
@@ -204,6 +209,15 @@ if: 
    then:

      required:

        - foo-supply

  # Altering schema depending on presence of properties is usually done by

  # dependencies (see above), however some adjustments might require if:

  - if:

      required:

        - vendor,bool-property

    then:

      properties:

        vendor,int-property:

          enum: [2, 4, 6]



# Ideally, the schema should have this line otherwise any other properties

# present are allowed. There's a few common properties such as 'status' and
@@ -211,6 +225,9 @@ then: 
#

# This can't be used in cases where another schema is referenced

# (i.e. allOf: [{$ref: ...}]).

# If and only if another schema is referenced and arbitrary children nodes can

# appear, "unevaluatedProperties: false" could be used.  Typical example is I2C

# controller where no name pattern matching for children can be added.

additionalProperties: false



examples: