Merge tag 'rtc-4.14' of git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / spi / fsl-imx-cspi.txt
1 * Freescale (Enhanced) Configurable Serial Peripheral Interface
2   (CSPI/eCSPI) for i.MX
3
4 Required properties:
5 - compatible :
6   - "fsl,imx1-cspi" for SPI compatible with the one integrated on i.MX1
7   - "fsl,imx21-cspi" for SPI compatible with the one integrated on i.MX21
8   - "fsl,imx27-cspi" for SPI compatible with the one integrated on i.MX27
9   - "fsl,imx31-cspi" for SPI compatible with the one integrated on i.MX31
10   - "fsl,imx35-cspi" for SPI compatible with the one integrated on i.MX35
11   - "fsl,imx51-ecspi" for SPI compatible with the one integrated on i.MX51
12   - "fsl,imx53-ecspi" for SPI compatible with the one integrated on i.MX53 and later Soc
13 - reg : Offset and length of the register set for the device
14 - interrupts : Should contain CSPI/eCSPI interrupt
15 - cs-gpios : Specifies the gpio pins to be used for chipselects.
16 - clocks : Clock specifiers for both ipg and per clocks.
17 - clock-names : Clock names should include both "ipg" and "per"
18 See the clock consumer binding,
19         Documentation/devicetree/bindings/clock/clock-bindings.txt
20 - dmas: DMA specifiers for tx and rx dma. See the DMA client binding,
21                 Documentation/devicetree/bindings/dma/dma.txt
22 - dma-names: DMA request names should include "tx" and "rx" if present.
23
24 Obsolete properties:
25 - fsl,spi-num-chipselects : Contains the number of the chipselect
26
27 Optional properties:
28 - fsl,spi-rdy-drctl: Integer, representing the value of DRCTL, the register
29 controlling the SPI_READY handling. Note that to enable the DRCTL consideration,
30 the SPI_READY mode-flag needs to be set too.
31 Valid values are: 0 (disabled), 1 (edge-triggered burst) and 2 (level-triggered burst).
32
33 Example:
34
35 ecspi@70010000 {
36         #address-cells = <1>;
37         #size-cells = <0>;
38         compatible = "fsl,imx51-ecspi";
39         reg = <0x70010000 0x4000>;
40         interrupts = <36>;
41         cs-gpios = <&gpio3 24 0>, /* GPIO3_24 */
42                    <&gpio3 25 0>; /* GPIO3_25 */
43         dmas = <&sdma 3 7 1>, <&sdma 4 7 2>;
44         dma-names = "rx", "tx";
45         fsl,spi-rdy-drctl = <1>;
46 };