GNU Linux-libre 4.19.264-gnu1
[releases.git] / Documentation / devicetree / bindings / mmc / renesas,mmcif.txt
1 * Renesas Multi Media Card Interface (MMCIF) Controller
2
3 This file documents differences between the core properties in mmc.txt
4 and the properties used by the MMCIF device.
5
6
7 Required properties:
8
9 - compatible: should be "renesas,mmcif-<soctype>", "renesas,sh-mmcif" as a
10   fallback. Examples with <soctype> are:
11         - "renesas,mmcif-r7s72100" for the MMCIF found in r7s72100 SoCs
12         - "renesas,mmcif-r8a73a4" for the MMCIF found in r8a73a4 SoCs
13         - "renesas,mmcif-r8a7740" for the MMCIF found in r8a7740 SoCs
14         - "renesas,mmcif-r8a7743" for the MMCIF found in r8a7743 SoCs
15         - "renesas,mmcif-r8a7745" for the MMCIF found in r8a7745 SoCs
16         - "renesas,mmcif-r8a7778" for the MMCIF found in r8a7778 SoCs
17         - "renesas,mmcif-r8a7790" for the MMCIF found in r8a7790 SoCs
18         - "renesas,mmcif-r8a7791" for the MMCIF found in r8a7791 SoCs
19         - "renesas,mmcif-r8a7793" for the MMCIF found in r8a7793 SoCs
20         - "renesas,mmcif-r8a7794" for the MMCIF found in r8a7794 SoCs
21         - "renesas,mmcif-sh73a0" for the MMCIF found in sh73a0 SoCs
22
23 - interrupts: Some SoCs have only 1 shared interrupt, while others have either
24   2 or 3 individual interrupts (error, int, card detect). Below is the number
25   of interrupts for each SoC:
26     1: r8a73a4, r8a7743, r8a7745, r8a7778, r8a7790, r8a7791, r8a7793, r8a7794
27     2: r8a7740, sh73a0
28     3: r7s72100
29
30 - clocks: reference to the functional clock
31
32 - dmas: reference to the DMA channels, one per channel name listed in the
33   dma-names property.
34 - dma-names: must contain "tx" for the transmit DMA channel and "rx" for the
35   receive DMA channel.
36 - max-frequency: Maximum operating clock frequency, driver uses default clock
37   frequency if it is not set.
38
39
40 Example: R8A7790 (R-Car H2) MMCIF0
41
42         mmcif0: mmc@ee200000 {
43                 compatible = "renesas,mmcif-r8a7790", "renesas,sh-mmcif";
44                 reg = <0 0xee200000 0 0x80>;
45                 interrupts = <0 169 IRQ_TYPE_LEVEL_HIGH>;
46                 clocks = <&mstp3_clks R8A7790_CLK_MMCIF0>;
47                 dmas = <&dmac0 0xd1>, <&dmac0 0xd2>;
48                 dma-names = "tx", "rx";
49                 max-frequency = <97500000>;
50         };