Unverified Commit 85d27be8 authored by Simon Horman's avatar Simon Horman Committed by Mark Brown
Browse files

dt-bindings: hspi: Convert bindings to json-schema



Convert Renesas HSPI bindings documentation to json-schema.
Also name bindings documentation file according to the compat string
being documented.

As a side effect of this change all currently supported/used compat
strings are listed while no while card compat string is documented.
This, in my opinion, is desirable as only supported hardware should
be documented.

Signed-off-by: default avatarSimon Horman <horms+renesas@verge.net.au>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20190916075352.32108-1-horms+renesas@verge.net.au


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 54ecb8f7
Loading
Loading
Loading
Loading
+57 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: GPL-2.0
%YAML 1.2
---
$id: http://devicetree.org/schemas/spi/renesas,hspi.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Renesas HSPI

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

allOf:
  - $ref: spi-controller.yaml#

properties:
  compatible:
    items:
      - enum:
        - renesas,hspi-r8a7778 # R-Car M1A
        - renesas,hspi-r8a7779 # R-Car H1
      - const: renesas,hspi

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    maxItems: 1

  power-domains:
    maxItems: 1

required:
  - compatible
  - reg
  - interrupts
  - clocks
  - '#address-cells'
  - '#size-cells'

examples:
  - |
    #include <dt-bindings/clock/r8a7778-clock.h>
    #include <dt-bindings/interrupt-controller/irq.h>

    hspi0: spi@fffc7000 {
        compatible = "renesas,hspi-r8a7778", "renesas,hspi";
        reg = <0xfffc7000 0x18>;
        interrupts = <0 63 IRQ_TYPE_LEVEL_HIGH>;
        clocks = <&mstp0_clks R8A7778_CLK_HSPI>;
        power-domains = <&cpg_clocks>;
        #address-cells = <1>;
        #size-cells = <0>;
    };
+0 −26
Original line number Diff line number Diff line
Renesas HSPI.

Required properties:
- compatible       : "renesas,hspi-<soctype>", "renesas,hspi" as fallback.
		     Examples with soctypes are:
		       - "renesas,hspi-r8a7778" (R-Car M1)
		       - "renesas,hspi-r8a7779" (R-Car H1)
- reg              : Offset and length of the register set for the device
- interrupts       : Interrupt specifier
- #address-cells   : Must be <1>
- #size-cells      : Must be <0>

Pinctrl properties might be needed, too.  See
Documentation/devicetree/bindings/pinctrl/renesas,*.

Example:

	hspi0: spi@fffc7000 {
		compatible = "renesas,hspi-r8a7778", "renesas,hspi";
		reg = <0xfffc7000 0x18>;
		interrupt-parent = <&gic>;
		interrupts = <0 63 IRQ_TYPE_LEVEL_HIGH>;
		#address-cells = <1>;
		#size-cells = <0>;
	};