[linux-block.git] / Documentation / devicetree / bindings / mmc / renesas,sdhi.yaml

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: "http://devicetree.org/schemas/mmc/renesas,sdhi.yaml#"
$schema: "http://devicetree.org/meta-schemas/core.yaml#"

title: Renesas SDHI SD/MMC controller

maintainers:
  - Wolfram Sang <wsa+renesas@sang-engineering.com>

properties:
  compatible:
    oneOf:
      - items:
          - const: renesas,sdhi-sh73a0  # R-Mobile APE6
      - items:
          - const: renesas,sdhi-r7s72100 # RZ/A1H
      - items:
          - const: renesas,sdhi-r7s9210 # SH-Mobile AG5
      - items:
          - const: renesas,sdhi-r8a73a4 # R-Mobile APE6
      - items:
          - const: renesas,sdhi-r8a7740 # R-Mobile A1
      - items:
          - enum:
              - renesas,sdhi-r8a7778 # R-Car M1
              - renesas,sdhi-r8a7779 # R-Car H1
          - const: renesas,rcar-gen1-sdhi # R-Car Gen1
      - items:
          - enum:
              - renesas,sdhi-r8a7742  # RZ/G1H
              - renesas,sdhi-r8a7743  # RZ/G1M
              - renesas,sdhi-r8a7744  # RZ/G1N
              - renesas,sdhi-r8a7745  # RZ/G1E
              - renesas,sdhi-r8a77470 # RZ/G1C
              - renesas,sdhi-r8a7790  # R-Car H2
              - renesas,sdhi-r8a7791  # R-Car M2-W
              - renesas,sdhi-r8a7792  # R-Car V2H
              - renesas,sdhi-r8a7793  # R-Car M2-N
              - renesas,sdhi-r8a7794  # R-Car E2
          - const: renesas,rcar-gen2-sdhi # R-Car Gen2 and RZ/G1
      - items:
          - const: renesas,sdhi-mmc-r8a77470 # RZ/G1C (SDHI/MMC IP)
      - items:
          - enum:
              - renesas,sdhi-r8a774a1  # RZ/G2M
              - renesas,sdhi-r8a774b1  # RZ/G2N
              - renesas,sdhi-r8a774c0  # RZ/G2E
              - renesas,sdhi-r8a774e1  # RZ/G2H
              - renesas,sdhi-r8a7795   # R-Car H3
              - renesas,sdhi-r8a7796   # R-Car M3-W
              - renesas,sdhi-r8a77961  # R-Car M3-W+
              - renesas,sdhi-r8a77965  # R-Car M3-N
              - renesas,sdhi-r8a77970  # R-Car V3M
              - renesas,sdhi-r8a77980  # R-Car V3H
              - renesas,sdhi-r8a77990  # R-Car E3
              - renesas,sdhi-r8a77995  # R-Car D3
              - renesas,sdhi-r8a779a0  # R-Car V3U
              - renesas,sdhi-r9a07g043 # RZ/G2UL
              - renesas,sdhi-r9a07g044 # RZ/G2{L,LC}
              - renesas,sdhi-r9a07g054 # RZ/V2L
          - const: renesas,rcar-gen3-sdhi # R-Car Gen3 or RZ/G2

  reg:
    maxItems: 1

  interrupts:
    minItems: 1
    maxItems: 3

  clocks: true

  clock-names: true

  dmas:
    minItems: 4
    maxItems: 4

  dma-names:
    minItems: 4
    maxItems: 4
    items:
      enum:
        - tx
        - rx

  power-domains:
    maxItems: 1

  resets:
    maxItems: 1

  pinctrl-0:
    minItems: 1
    maxItems: 2

  pinctrl-1:
    maxItems: 1

  pinctrl-names: true

  max-frequency: true

allOf:
  - $ref: "mmc-controller.yaml"

  - if:
      properties:
        compatible:
          contains:
            enum:
              - renesas,sdhi-r9a07g043
              - renesas,sdhi-r9a07g044
              - renesas,sdhi-r9a07g054
    then:
      properties:
        clocks:
          items:
            - description: IMCLK, SDHI channel main clock1.
            - description: CLK_HS, SDHI channel High speed clock which operates
                           4 times that of SDHI channel main clock1.
            - description: IMCLK2, SDHI channel main clock2. When this clock is
                           turned off, external SD card detection cannot be
                           detected.
            - description: ACLK, SDHI channel bus clock.
        clock-names:
          items:
            - const: core
            - const: clkh
            - const: cd
            - const: aclk
      required:
        - clock-names
        - resets
    else:
      if:
        properties:
          compatible:
            contains:
              enum:
                - renesas,rcar-gen2-sdhi
                - renesas,rcar-gen3-sdhi
      then:
        properties:
          clocks:
            minItems: 1
            maxItems: 3
          clock-names:
            minItems: 1
            uniqueItems: true
            items:
              - const: core
              - enum: [ clkh, cd ]
              - const: cd
      else:
        properties:
          clocks:
            minItems: 1
            maxItems: 2
          clock-names:
            minItems: 1
            items:
              - const: core
              - const: cd

  - if:
      properties:
        compatible:
          contains:
            const: renesas,sdhi-mmc-r8a77470
    then:
      properties:
        pinctrl-names:
          items:
            - const: state_uhs
    else:
      properties:
        pinctrl-names:
          minItems: 1
          items:
            - const: default
            - const: state_uhs

  - if:
      properties:
        compatible:
          contains:
            enum:
              - renesas,sdhi-r7s72100
              - renesas,sdhi-r7s9210
    then:
      required:
        - clock-names
      description:
        The internal card detection logic that exists in these controllers is
        sectioned off to be run by a separate second clock source to allow
        the main core clock to be turned off to save power.

required:
  - compatible
  - reg
  - interrupts
  - clocks
  - power-domains

unevaluatedProperties: false

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

    sdhi0: mmc@ee100000 {
            compatible = "renesas,sdhi-r8a7790", "renesas,rcar-gen2-sdhi";
            reg = <0xee100000 0x328>;
            interrupts = <GIC_SPI 165 IRQ_TYPE_LEVEL_HIGH>;
            clocks = <&cpg CPG_MOD 314>;
            dmas = <&dmac0 0xcd>, <&dmac0 0xce>, <&dmac1 0xcd>, <&dmac1 0xce>;
            dma-names = "tx", "rx", "tx", "rx";
            max-frequency = <195000000>;
            power-domains = <&sysc R8A7790_PD_ALWAYS_ON>;
            resets = <&cpg 314>;
    };

    sdhi1: mmc@ee120000 {
             compatible = "renesas,sdhi-r8a7790", "renesas,rcar-gen2-sdhi";
             reg = <0xee120000 0x328>;
             interrupts = <GIC_SPI 166 IRQ_TYPE_LEVEL_HIGH>;
             clocks = <&cpg CPG_MOD 313>;
             dmas = <&dmac0 0xc9>, <&dmac0 0xca>, <&dmac1 0xc9>, <&dmac1 0xca>;
             dma-names = "tx", "rx", "tx", "rx";
             max-frequency = <195000000>;
             power-domains = <&sysc R8A7790_PD_ALWAYS_ON>;
             resets = <&cpg 313>;
    };

    sdhi2: mmc@ee140000 {
             compatible = "renesas,sdhi-r8a7790", "renesas,rcar-gen2-sdhi";
             reg = <0xee140000 0x100>;
             interrupts = <GIC_SPI 167 IRQ_TYPE_LEVEL_HIGH>;
             clocks = <&cpg CPG_MOD 312>;
             dmas = <&dmac0 0xc1>, <&dmac0 0xc2>, <&dmac1 0xc1>, <&dmac1 0xc2>;
             dma-names = "tx", "rx", "tx", "rx";
             max-frequency = <97500000>;
             power-domains = <&sysc R8A7790_PD_ALWAYS_ON>;
             resets = <&cpg 312>;
     };

     sdhi3: mmc@ee160000 {
              compatible = "renesas,sdhi-r8a7790", "renesas,rcar-gen2-sdhi";
              reg = <0xee160000 0x100>;
              interrupts = <GIC_SPI 168 IRQ_TYPE_LEVEL_HIGH>;
              clocks = <&cpg CPG_MOD 311>;
              dmas = <&dmac0 0xd3>, <&dmac0 0xd4>, <&dmac1 0xd3>, <&dmac1 0xd4>;
              dma-names = "tx", "rx", "tx", "rx";
              max-frequency = <97500000>;
              power-domains = <&sysc R8A7790_PD_ALWAYS_ON>;
              resets = <&cpg 311>;
    };
Commit	Line	Data
a1c76734 YS	1	# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
	2	%YAML 1.2
	3	---
	4	$id: "http://devicetree.org/schemas/mmc/renesas,sdhi.yaml#"
	5	$schema: "http://devicetree.org/meta-schemas/core.yaml#"
	6
	7	title: Renesas SDHI SD/MMC controller
	8
	9	maintainers:
	10	- Wolfram Sang <wsa+renesas@sang-engineering.com>
	11
a1c76734 YS	12	properties:
	13	compatible:
	14	oneOf:
	15	- items:
	16	- const: renesas,sdhi-sh73a0 # R-Mobile APE6
	17	- items:
	18	- const: renesas,sdhi-r7s72100 # RZ/A1H
	19	- items:
	20	- const: renesas,sdhi-r7s9210 # SH-Mobile AG5
	21	- items:
	22	- const: renesas,sdhi-r8a73a4 # R-Mobile APE6
	23	- items:
	24	- const: renesas,sdhi-r8a7740 # R-Mobile A1
	25	- items:
	26	- enum:
	27	- renesas,sdhi-r8a7778 # R-Car M1
	28	- renesas,sdhi-r8a7779 # R-Car H1
	29	- const: renesas,rcar-gen1-sdhi # R-Car Gen1
	30	- items:
	31	- enum:
	32	- renesas,sdhi-r8a7742 # RZ/G1H
	33	- renesas,sdhi-r8a7743 # RZ/G1M
	34	- renesas,sdhi-r8a7744 # RZ/G1N
	35	- renesas,sdhi-r8a7745 # RZ/G1E
	36	- renesas,sdhi-r8a77470 # RZ/G1C
	37	- renesas,sdhi-r8a7790 # R-Car H2
	38	- renesas,sdhi-r8a7791 # R-Car M2-W
	39	- renesas,sdhi-r8a7792 # R-Car V2H
	40	- renesas,sdhi-r8a7793 # R-Car M2-N
	41	- renesas,sdhi-r8a7794 # R-Car E2
	42	- const: renesas,rcar-gen2-sdhi # R-Car Gen2 and RZ/G1
	43	- items:
	44	- const: renesas,sdhi-mmc-r8a77470 # RZ/G1C (SDHI/MMC IP)
	45	- items:
	46	- enum:
bfadee45 BD	47	- renesas,sdhi-r8a774a1 # RZ/G2M
	48	- renesas,sdhi-r8a774b1 # RZ/G2N
	49	- renesas,sdhi-r8a774c0 # RZ/G2E
	50	- renesas,sdhi-r8a774e1 # RZ/G2H
	51	- renesas,sdhi-r8a7795 # R-Car H3
	52	- renesas,sdhi-r8a7796 # R-Car M3-W
	53	- renesas,sdhi-r8a77961 # R-Car M3-W+
	54	- renesas,sdhi-r8a77965 # R-Car M3-N
	55	- renesas,sdhi-r8a77970 # R-Car V3M
	56	- renesas,sdhi-r8a77980 # R-Car V3H
	57	- renesas,sdhi-r8a77990 # R-Car E3
	58	- renesas,sdhi-r8a77995 # R-Car D3
	59	- renesas,sdhi-r8a779a0 # R-Car V3U
dc3d879c	60	- renesas,sdhi-r9a07g043 # RZ/G2UL
bfadee45	61	- renesas,sdhi-r9a07g044 # RZ/G2{L,LC}
a4ee7906	62	- renesas,sdhi-r9a07g054 # RZ/V2L
a1c76734 YS	63	- const: renesas,rcar-gen3-sdhi # R-Car Gen3 or RZ/G2
	64
	65	reg:
	66	maxItems: 1
	67
	68	interrupts:
	69	minItems: 1
	70	maxItems: 3
	71
bfadee45	72	clocks: true
a1c76734	73
bfadee45	74	clock-names: true
a1c76734 YS	75
	76	dmas:
	77	minItems: 4
	78	maxItems: 4
	79
	80	dma-names:
	81	minItems: 4
	82	maxItems: 4
	83	items:
	84	enum:
	85	- tx
	86	- rx
	87
	88	power-domains:
	89	maxItems: 1
	90
	91	resets:
	92	maxItems: 1
	93
	94	pinctrl-0:
	95	minItems: 1
	96	maxItems: 2
	97
	98	pinctrl-1:
	99	maxItems: 1
	100
4aba5dc7	101	pinctrl-names: true
a1c76734 YS	102
	103	max-frequency: true
	104
4aba5dc7 BD	105	allOf:
	106	- $ref: "mmc-controller.yaml"
	107
bfadee45 BD	108	- if:
	109	properties:
	110	compatible:
	111	contains:
a4ee7906	112	enum:
dc3d879c	113	- renesas,sdhi-r9a07g043
a4ee7906 LP	114	- renesas,sdhi-r9a07g044
a4ee7906 LP	115	- renesas,sdhi-r9a07g054
bfadee45 BD	116	then:
	117	properties:
	118	clocks:
	119	items:
	120	- description: IMCLK, SDHI channel main clock1.
217c7d18 BD	121	- description: CLK_HS, SDHI channel High speed clock which operates
217c7d18 BD	122	4 times that of SDHI channel main clock1.
bfadee45 BD	123	- description: IMCLK2, SDHI channel main clock2. When this clock is
	124	turned off, external SD card detection cannot be
	125	detected.
bfadee45 BD	126	- description: ACLK, SDHI channel bus clock.
	127	clock-names:
	128	items:
217c7d18 BD	129	- const: core
	130	- const: clkh
	131	- const: cd
bfadee45 BD	132	- const: aclk
	133	required:
	134	- clock-names
	135	- resets
	136	else:
e051025e WS	137	if:
	138	properties:
	139	compatible:
	140	contains:
	141	enum:
	142	- renesas,rcar-gen2-sdhi
	143	- renesas,rcar-gen3-sdhi
	144	then:
	145	properties:
	146	clocks:
	147	minItems: 1
	148	maxItems: 3
	149	clock-names:
	150	minItems: 1
	151	uniqueItems: true
	152	items:
	153	- const: core
	154	- enum: [ clkh, cd ]
	155	- const: cd
	156	else:
	157	properties:
	158	clocks:
	159	minItems: 1
	160	maxItems: 2
	161	clock-names:
	162	minItems: 1
	163	items:
	164	- const: core
	165	- const: cd
bfadee45	166
4aba5dc7 BD	167	- if:
	168	properties:
	169	compatible:
	170	contains:
	171	const: renesas,sdhi-mmc-r8a77470
	172	then:
	173	properties:
	174	pinctrl-names:
	175	items:
	176	- const: state_uhs
	177	else:
	178	properties:
	179	pinctrl-names:
	180	minItems: 1
	181	items:
	182	- const: default
	183	- const: state_uhs
	184
	185	- if:
	186	properties:
	187	compatible:
	188	contains:
	189	enum:
	190	- renesas,sdhi-r7s72100
	191	- renesas,sdhi-r7s9210
	192	then:
	193	required:
	194	- clock-names
	195	description:
	196	The internal card detection logic that exists in these controllers is
	197	sectioned off to be run by a separate second clock source to allow
	198	the main core clock to be turned off to save power.
	199
a1c76734 YS	200	required:
	201	- compatible
	202	- reg
	203	- interrupts
	204	- clocks
	205	- power-domains
	206
a1c76734 YS	207	unevaluatedProperties: false
	208
	209	examples:
	210	- \|
	211	#include <dt-bindings/clock/r8a7790-cpg-mssr.h>
	212	#include <dt-bindings/interrupt-controller/arm-gic.h>
	213	#include <dt-bindings/power/r8a7790-sysc.h>
	214
	215	sdhi0: mmc@ee100000 {
	216	compatible = "renesas,sdhi-r8a7790", "renesas,rcar-gen2-sdhi";
	217	reg = <0xee100000 0x328>;
	218	interrupts = <GIC_SPI 165 IRQ_TYPE_LEVEL_HIGH>;
	219	clocks = <&cpg CPG_MOD 314>;
	220	dmas = <&dmac0 0xcd>, <&dmac0 0xce>, <&dmac1 0xcd>, <&dmac1 0xce>;
	221	dma-names = "tx", "rx", "tx", "rx";
	222	max-frequency = <195000000>;
	223	power-domains = <&sysc R8A7790_PD_ALWAYS_ON>;
	224	resets = <&cpg 314>;
	225	};
	226
	227	sdhi1: mmc@ee120000 {
	228	compatible = "renesas,sdhi-r8a7790", "renesas,rcar-gen2-sdhi";
	229	reg = <0xee120000 0x328>;
	230	interrupts = <GIC_SPI 166 IRQ_TYPE_LEVEL_HIGH>;
	231	clocks = <&cpg CPG_MOD 313>;
	232	dmas = <&dmac0 0xc9>, <&dmac0 0xca>, <&dmac1 0xc9>, <&dmac1 0xca>;
	233	dma-names = "tx", "rx", "tx", "rx";
	234	max-frequency = <195000000>;
	235	power-domains = <&sysc R8A7790_PD_ALWAYS_ON>;
	236	resets = <&cpg 313>;
	237	};
	238
	239	sdhi2: mmc@ee140000 {
	240	compatible = "renesas,sdhi-r8a7790", "renesas,rcar-gen2-sdhi";
	241	reg = <0xee140000 0x100>;
	242	interrupts = <GIC_SPI 167 IRQ_TYPE_LEVEL_HIGH>;
	243	clocks = <&cpg CPG_MOD 312>;
	244	dmas = <&dmac0 0xc1>, <&dmac0 0xc2>, <&dmac1 0xc1>, <&dmac1 0xc2>;
	245	dma-names = "tx", "rx", "tx", "rx";
	246	max-frequency = <97500000>;
	247	power-domains = <&sysc R8A7790_PD_ALWAYS_ON>;
	248	resets = <&cpg 312>;
	249	};
	250
	251	sdhi3: mmc@ee160000 {
	252	compatible = "renesas,sdhi-r8a7790", "renesas,rcar-gen2-sdhi";
	253	reg = <0xee160000 0x100>;
	254	interrupts = <GIC_SPI 168 IRQ_TYPE_LEVEL_HIGH>;
	255	clocks = <&cpg CPG_MOD 311>;
	256	dmas = <&dmac0 0xd3>, <&dmac0 0xd4>, <&dmac1 0xd3>, <&dmac1 0xd4>;
	257	dma-names = "tx", "rx", "tx", "rx";
	258	max-frequency = <97500000>;
	259	power-domains = <&sysc R8A7790_PD_ALWAYS_ON>;
	260	resets = <&cpg 311>;
	261	};