good-example.yaml

# SPDX-License-Identifier: BSD-2-Clause
# Copyright 2018 Linaro Ltd.
# Copyright 2018 Arm Ltd.
%YAML 1.2
---
$id: "http://devicetree.org/schemas/good-example.yaml#"
$schema: "http://devicetree.org/meta-schemas/core.yaml#"

title: A one line title for a good binding

description: A more detailed description for a good binding example.

maintainers:
  - Rob Herring <robh@kernel.org>

properties:
  compatible:
    oneOf:
      - items:
          - enum:
              - vendor,soc4-ip
              - vendor,soc3-ip
              - vendor,soc2-ip
          - enum:
              - vendor,soc1-ip
      - items:
          - enum:
              - vendor,soc1-ip

  reg:
    maxItems: 2

  reg-names:
    items:
      - const: "coreAAA"
      - const: "aux"

  interrupts:
    minItems: 1
    maxItems: 2
    items:
      - description: 1st irq
      - description: 2nd irq

  interrupt-names:
    minItems: 1
    items:
      - const: "tx irq"
      - const: "rx irq"

  '#interrupt-cells':
    const: 2

  interrupt-controller: {}

  clock-frequency:
    minimum: 100
    maximum: 400000

  clocks:
    minItems: 1
    maxItems: 2
    items:
      - description: 1st clock
      - description: 2nd clock

  clock-names:
    items:
      - const: "clk1"
      - const: "clk2"

  '#clock-cells':
    const: 1

  clock-output-names:
    minItems: 1
    maxItems: 2

  some-gpios:
    maxItems: 2

  a-single-gpios:
    description: A GPIO that does something
    maxItems: 1

  vendor,bool-prop:
    $ref: "/schemas/types.yaml#/definitions/flag"
    description: A vendor specific boolean property

  vendor,int-prop:
    allOf:
      - $ref: "/schemas/types.yaml#/definitions/uint32"
      - enum: [ 1, 2, 3 ]
    description: Vendor specific single cell integer property

  vendor,int-array-prop:
    allOf:
      - $ref: "/schemas/types.yaml#/definitions/uint32-array"
      - items:
          minimum: 5
          maximum: 10
    description: Vendor specific integer array property

  vendor,int-array-prop-2:
    allOf:
      - $ref: "/schemas/types.yaml#/definitions/uint32-array"
      - items:
          - const: 5
          - const: 10
    description: Vendor specific integer array property

  vendor,int-array-size-only-prop:
    allOf:
      - $ref: "/schemas/types.yaml#/definitions/uint32-array"
    minItems: 2
    maxItems: 5
    description: Vendor specific integer array property with only a size
      range. This can use either form of brackets.

  vendor,string-prop:
    allOf:
      - $ref: "/schemas/types.yaml#/definitions/string"
      - enum:
          - foo
          - bar
    description: Vendor specific single string property

  vendor,string-list-prop:
    allOf:
     - $ref: "/schemas/types.yaml#/definitions/string-array"
     - minItems: 2
       items:
         - const: foobar
         - const: foobaz
    description: Vendor specific string list property

  vendor,int8-prop:
    $ref: /schemas/types.yaml#definitions/uint8
    description: Vendor specific 8-bit integer property

  vendor,int8-array-prop:
    allOf:
      - $ref: /schemas/types.yaml#definitions/uint8-array
      - items:
          - minItems: 2
            maxItems: 3
    description: A vendor specific uint8 array property with 2 or 3 entries

  vendor,int16-prop:
    allOf:
      - $ref: /schemas/types.yaml#definitions/uint16
      - enum: [ 1, 2, 3 ]
    description: Vendor specific 16-bit integer property

  vendor,int16-array-prop:
    allOf:
      - $ref: /schemas/types.yaml#definitions/uint16-array
      - items:
          - const: 1
          - const: 2
    description: Vendor specific 16-bit integer array property

  vendor,int64-prop:
    allOf:
      - $ref: /schemas/types.yaml#definitions/uint64
      - items:
        - items:
            - minimum: 0x1234

    description: Vendor specific 16-bit integer property

  vendor,int64-array-prop:
    allOf:
      - $ref: /schemas/types.yaml#definitions/uint64-array
    description: Vendor specific 64-bit integer array property

  vendor,phandle-prop:
    $ref: "/schemas/types.yaml#/definitions/phandle"
    description: Vendor specific single cell phandle property

  vendor,phandle-array-prop:
    allOf:
      - $ref: "/schemas/types.yaml#/definitions/phandle-array"
      - minItems: 2
    description: Vendor specific array of phandles property

  vendor,phandle-with-fixed-cells:
    allOf:
      - $ref: "/schemas/types.yaml#/definitions/phandle-array"
      - items:
          - items:
            - description: the phandle to something
            - description: the 1st cell data
            - description: the 2nd cell data
    description: Vendor specific array of phandles property


required:
  - compatible

examples:
  - |
      /dts-v1/;
      /{
              model = "ARM Juno development board (r0)";
              compatible = "arm,juno", "arm,vexpress";
              interrupt-parent = <&gic>;
              #address-cells = <2>;
              #size-cells = <2>;

                      cpus {
                      #address-cells = <2>;
                      #size-cells = <0>;
                      A57_0: cpu@0 {
                              compatible = "arm,cortex-a57","arm,armv8";
                              reg = <0x0 0x0>;
                              device_type = "cpu";
                              enable-method = "psci";
                      };

                      .....

                      A53_0: cpu@100 {
                              compatible = "arm,cortex-a53","arm,armv8";
                              reg = <0x0 0x100>;
                              device_type = "cpu";
                              enable-method = "psci";
                      };

                      .....
              };

      };