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