Merge branch 'next' of git://git.kernel.org/pub/scm/linux/kernel/git/rzhang/linux
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / spi / spi-rspi.txt
1 Device tree configuration for Renesas RSPI/QSPI driver
2
3 Required properties:
4 - compatible       : For Renesas Serial Peripheral Interface on legacy SH:
5                      "renesas,rspi-<soctype>", "renesas,rspi" as fallback.
6                      For Renesas Serial Peripheral Interface on RZ/A:
7                      "renesas,rspi-<soctype>", "renesas,rspi-rz" as fallback.
8                      For Quad Serial Peripheral Interface on R-Car Gen2 and
9                      RZ/G1 devices:
10                      "renesas,qspi-<soctype>", "renesas,qspi" as fallback.
11                      Examples with soctypes are:
12                         - "renesas,rspi-sh7757" (SH)
13                         - "renesas,rspi-r7s72100" (RZ/A1H)
14                         - "renesas,rspi-r7s9210" (RZ/A2)
15                         - "renesas,qspi-r8a7743" (RZ/G1M)
16                         - "renesas,qspi-r8a7744" (RZ/G1N)
17                         - "renesas,qspi-r8a7745" (RZ/G1E)
18                         - "renesas,qspi-r8a77470" (RZ/G1C)
19                         - "renesas,qspi-r8a7790" (R-Car H2)
20                         - "renesas,qspi-r8a7791" (R-Car M2-W)
21                         - "renesas,qspi-r8a7792" (R-Car V2H)
22                         - "renesas,qspi-r8a7793" (R-Car M2-N)
23                         - "renesas,qspi-r8a7794" (R-Car E2)
24 - reg              : Address start and address range size of the device
25 - interrupts       : A list of interrupt-specifiers, one for each entry in
26                      interrupt-names.
27                      If interrupt-names is not present, an interrupt specifier
28                      for a single muxed interrupt.
29 - interrupt-names  : A list of interrupt names. Should contain (if present):
30                        - "error" for SPEI,
31                        - "rx" for SPRI,
32                        - "tx" to SPTI,
33                        - "mux" for a single muxed interrupt.
34 - num-cs           : Number of chip selects. Some RSPI cores have more than 1.
35 - #address-cells   : Must be <1>
36 - #size-cells      : Must be <0>
37
38 Optional properties:
39 - clocks           : Must contain a reference to the functional clock.
40 - dmas             : Must contain a list of two references to DMA specifiers,
41                      one for transmission, and one for reception.
42 - dma-names        : Must contain a list of two DMA names, "tx" and "rx".
43
44 Pinctrl properties might be needed, too.  See
45 Documentation/devicetree/bindings/pinctrl/renesas,*.
46
47 Examples:
48
49         spi0: spi@e800c800 {
50                 compatible = "renesas,rspi-r7s72100", "renesas,rspi-rz";
51                 reg = <0xe800c800 0x24>;
52                 interrupts = <0 238 IRQ_TYPE_LEVEL_HIGH>,
53                              <0 239 IRQ_TYPE_LEVEL_HIGH>,
54                              <0 240 IRQ_TYPE_LEVEL_HIGH>;
55                 interrupt-names = "error", "rx", "tx";
56                 interrupt-parent = <&gic>;
57                 num-cs = <1>;
58                 #address-cells = <1>;
59                 #size-cells = <0>;
60         };
61
62         spi: spi@e6b10000 {
63                 compatible = "renesas,qspi-r8a7791", "renesas,qspi";
64                 reg = <0 0xe6b10000 0 0x2c>;
65                 interrupt-parent = <&gic>;
66                 interrupts = <0 184 IRQ_TYPE_LEVEL_HIGH>;
67                 clocks = <&mstp9_clks R8A7791_CLK_QSPI_MOD>;
68                 num-cs = <1>;
69                 #address-cells = <1>;
70                 #size-cells = <0>;
71                 dmas = <&dmac0 0x17>, <&dmac0 0x18>;
72                 dma-names = "tx", "rx";
73         };