UPSTREAM: spi: rockchip: add bindings for rk3399 spi
[firefly-linux-kernel-4.4.55.git] / Documentation / devicetree / bindings / spi / spi-rockchip.txt
1 * Rockchip SPI Controller
2
3 The Rockchip SPI controller is used to interface with various devices such as flash
4 and display controllers using the SPI communication interface.
5
6 Required Properties:
7
8 - compatible: should be one of the following.
9     "rockchip,rk3066-spi" for rk3066.
10     "rockchip,rk3188-spi", "rockchip,rk3066-spi" for rk3188.
11     "rockchip,rk3288-spi", "rockchip,rk3066-spi" for rk3288.
12     "rockchip,rk3399-spi", "rockchip,rk3066-spi" for rk3399.
13 - reg: physical base address of the controller and length of memory mapped
14        region.
15 - interrupts: The interrupt number to the cpu. The interrupt specifier format
16               depends on the interrupt controller.
17 - clocks: Must contain an entry for each entry in clock-names.
18 - clock-names: Shall be "spiclk" for the transfer-clock, and "apb_pclk" for
19                            the peripheral clock.
20 - #address-cells: should be 1.
21 - #size-cells: should be 0.
22
23 Optional Properties:
24
25 - dmas: DMA specifiers for tx and rx dma. See the DMA client binding,
26                 Documentation/devicetree/bindings/dma/dma.txt
27 - dma-names: DMA request names should include "tx" and "rx" if present.
28 - rx-sample-delay-ns: nanoseconds to delay after the SCLK edge before sampling
29                 Rx data (may need to be fine tuned for high capacitance lines).
30                 No delay (0) by default.
31
32
33 Example:
34
35         spi0: spi@ff110000 {
36                 compatible = "rockchip,rk3066-spi";
37                 reg = <0xff110000 0x1000>;
38                 dmas = <&pdma1 11>, <&pdma1 12>;
39                 dma-names = "tx", "rx";
40                 rx-sample-delay-ns = <10>;
41                 #address-cells = <1>;
42                 #size-cells = <0>;
43                 interrupts = <GIC_SPI 44 IRQ_TYPE_LEVEL_HIGH>;
44                 clocks = <&cru SCLK_SPI0>, <&cru PCLK_SPI0>;
45                 clock-names = "spiclk", "apb_pclk";
46         };