Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / spi / sh-msiof.txt
1 Renesas MSIOF spi controller
2
3 Required properties:
4 - compatible           : "renesas,msiof-r8a7790" (R-Car H2)
5                          "renesas,msiof-r8a7791" (R-Car M2-W)
6                          "renesas,msiof-r8a7792" (R-Car V2H)
7                          "renesas,msiof-r8a7793" (R-Car M2-N)
8                          "renesas,msiof-r8a7794" (R-Car E2)
9                          "renesas,msiof-r8a7796" (R-Car M3-W)
10                          "renesas,msiof-sh73a0" (SH-Mobile AG5)
11                          "renesas,sh-mobile-msiof" (generic SH-Mobile compatibile device)
12                          "renesas,rcar-gen2-msiof" (generic R-Car Gen2 compatible device)
13                          "renesas,rcar-gen3-msiof" (generic R-Car Gen3 compatible device)
14                          "renesas,sh-msiof"      (deprecated)
15
16                          When compatible with the generic version, nodes
17                          must list the SoC-specific version corresponding
18                          to the platform first followed by the generic
19                          version.
20
21 - reg                  : A list of offsets and lengths of the register sets for
22                          the device.
23                          If only one register set is present, it is to be used
24                          by both the CPU and the DMA engine.
25                          If two register sets are present, the first is to be
26                          used by the CPU, and the second is to be used by the
27                          DMA engine.
28 - interrupt-parent     : The phandle for the interrupt controller that
29                          services interrupts for this device
30 - interrupts           : Interrupt specifier
31 - #address-cells       : Must be <1>
32 - #size-cells          : Must be <0>
33
34 Optional properties:
35 - clocks               : Must contain a reference to the functional clock.
36 - num-cs               : Total number of chip-selects (default is 1)
37 - dmas                 : Must contain a list of two references to DMA
38                          specifiers, one for transmission, and one for
39                          reception.
40 - dma-names            : Must contain a list of two DMA names, "tx" and "rx".
41 - spi-slave            : Empty property indicating the SPI controller is used
42                          in slave mode.
43 - renesas,dtdl         : delay sync signal (setup) in transmit mode.
44                          Must contain one of the following values:
45                          0   (no bit delay)
46                          50  (0.5-clock-cycle delay)
47                          100 (1-clock-cycle delay)
48                          150 (1.5-clock-cycle delay)
49                          200 (2-clock-cycle delay)
50
51 - renesas,syncdl       : delay sync signal (hold) in transmit mode.
52                          Must contain one of the following values:
53                          0   (no bit delay)
54                          50  (0.5-clock-cycle delay)
55                          100 (1-clock-cycle delay)
56                          150 (1.5-clock-cycle delay)
57                          200 (2-clock-cycle delay)
58                          300 (3-clock-cycle delay)
59
60 Optional properties, deprecated for soctype-specific bindings:
61 - renesas,tx-fifo-size : Overrides the default tx fifo size given in words
62                          (default is 64)
63 - renesas,rx-fifo-size : Overrides the default rx fifo size given in words
64                          (default is 64)
65
66 Pinctrl properties might be needed, too.  See
67 Documentation/devicetree/bindings/pinctrl/renesas,*.
68
69 Example:
70
71         msiof0: spi@e6e20000 {
72                 compatible = "renesas,msiof-r8a7791",
73                              "renesas,rcar-gen2-msiof";
74                 reg = <0 0xe6e20000 0 0x0064>;
75                 interrupts = <0 156 IRQ_TYPE_LEVEL_HIGH>;
76                 clocks = <&mstp0_clks R8A7791_CLK_MSIOF0>;
77                 dmas = <&dmac0 0x51>, <&dmac0 0x52>;
78                 dma-names = "tx", "rx";
79                 #address-cells = <1>;
80                 #size-cells = <0>;
81                 status = "disabled";
82         };