Commit 8acbbddc authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Rob Herring
Browse files

dt-bindings: ata: rcar-sata: Convert to json-schema



Convert the Renesas R-Car Serial-ATA Device Tree binding documentation
to json-schema.

While at it:
  - Remove the deprecated "renesas,rcar-sata" compatible value,
  - Add "iommus", "power-domains", and "resets" properties,
  - Update the example.

Signed-off-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
Reviewed-by: default avatarNiklas Söderlund <niklas.soderlund+renesas@ragnatech.se>
Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent 238415f7
Loading
Loading
Loading
Loading
+71 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: "http://devicetree.org/schemas/ata/renesas,rcar-sata.yaml#"
$schema: "http://devicetree.org/meta-schemas/core.yaml#"

title: Renesas R-Car Serial-ATA Interface

maintainers:
  - Geert Uytterhoeven <geert+renesas@glider.be>

properties:
  compatible:
    oneOf:
      - items:
          - enum:
              - renesas,sata-r8a7779      # R-Car H1
      - items:
          - enum:
              - renesas,sata-r8a7790-es1  # R-Car H2 ES1
              - renesas,sata-r8a7790      # R-Car H2 other than ES1
              - renesas,sata-r8a7791      # R-Car M2-W
              - renesas,sata-r8a7793      # R-Car M2-N
          - const: renesas,rcar-gen2-sata # generic R-Car Gen2
      - items:
          - enum:
              - renesas,sata-r8a774b1     # RZ/G2N
              - renesas,sata-r8a7795      # R-Car H3
              - renesas,sata-r8a77965     # R-Car M3-N
          - const: renesas,rcar-gen3-sata # generic R-Car Gen3 or RZ/G2

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    maxItems: 1

  iommus:
    maxItems: 1

  power-domains:
    maxItems: 1

  resets:
    maxItems: 1

required:
  - compatible
  - reg
  - interrupts
  - clocks

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/r8a7791-cpg-mssr.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    #include <dt-bindings/power/r8a7791-sysc.h>

    sata@ee300000 {
            compatible = "renesas,sata-r8a7791", "renesas,rcar-gen2-sata";
            reg = <0xee300000 0x200000>;
            interrupts = <GIC_SPI 105 IRQ_TYPE_LEVEL_HIGH>;
            clocks = <&cpg CPG_MOD 815>;
            power-domains = <&sysc R8A7791_PD_ALWAYS_ON>;
            resets = <&cpg 815>;
    };
+0 −36
Original line number Diff line number Diff line
* Renesas R-Car SATA

Required properties:
- compatible		: should contain one or more of the following:
			  - "renesas,sata-r8a774b1" for RZ/G2N
			  - "renesas,sata-r8a7779" for R-Car H1
			  - "renesas,sata-r8a7790-es1" for R-Car H2 ES1
			  - "renesas,sata-r8a7790" for R-Car H2 other than ES1
			  - "renesas,sata-r8a7791" for R-Car M2-W
			  - "renesas,sata-r8a7793" for R-Car M2-N
			  - "renesas,sata-r8a7795" for R-Car H3
			  - "renesas,sata-r8a77965" for R-Car M3-N
			  - "renesas,rcar-gen2-sata" for a generic R-Car Gen2
			     compatible device
			  - "renesas,rcar-gen3-sata" for a generic R-Car Gen3 or
			     RZ/G2 compatible device
			  - "renesas,rcar-sata" is deprecated

			  When compatible with the generic version nodes
			  must list the SoC-specific version corresponding
			  to the platform first followed by the generic
			  version.

- reg			: address and length of the SATA registers;
- interrupts		: must consist of one interrupt specifier.
- clocks		: must contain a reference to the functional clock.

Example:

sata0: sata@ee300000 {
	compatible = "renesas,sata-r8a7791", "renesas,rcar-gen2-sata";
	reg = <0 0xee300000 0 0x2000>;
	interrupt-parent = <&gic>;
	interrupts = <0 105 IRQ_TYPE_LEVEL_HIGH>;
	clocks = <&mstp8_clks R8A7791_CLK_SATA0>;
};