Merge branches 'for-4.8/alps', 'for-4.8/apple', 'for-4.8/i2c-hid', 'for-4.8/uhid...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / serial / serial.txt
1 Generic Serial DT Bindings
2
3 This document lists a set of generic properties for describing UARTs in a
4 device tree.  Whether these properties apply to a particular device depends on
5 the DT bindings for the actual device.
6
7 Optional properties:
8   - cts-gpios: Must contain a GPIO specifier, referring to the GPIO pin to be
9     used as the UART's CTS line.
10   - dcd-gpios: Must contain a GPIO specifier, referring to the GPIO pin to be
11     used as the UART's DCD line.
12   - dsr-gpios: Must contain a GPIO specifier, referring to the GPIO pin to be
13     used as the UART's DSR line.
14   - dtr-gpios: Must contain a GPIO specifier, referring to the GPIO pin to be
15     used as the UART's DTR line.
16   - rng-gpios: Must contain a GPIO specifier, referring to the GPIO pin to be
17     used as the UART's RNG line.
18   - rts-gpios: Must contain a GPIO specifier, referring to the GPIO pin to be
19     used as the UART's RTS line.
20
21   - uart-has-rtscts: The presence of this property indicates that the
22     UART has dedicated lines for RTS/CTS hardware flow control, and that
23     they are available for use (wired and enabled by pinmux configuration).
24     This depends on both the UART hardware and the board wiring.
25     Note that this property is mutually-exclusive with "cts-gpios" and
26     "rts-gpios" above.
27
28
29 Examples:
30
31         uart1: serial@48022000 {
32                 compatible = "ti,am3352-uart", "ti,omap3-uart";
33                 ti,hwmods = "uart2";
34                 clock-frequency = <48000000>;
35                 reg = <0x48022000 0x2000>;
36                 interrupts = <73>;
37                 dmas = <&edma 28 0>, <&edma 29 0>;
38                 dma-names = "tx", "rx";
39                 dtr-gpios = <&gpio2 22 GPIO_ACTIVE_LOW>;
40                 dsr-gpios = <&gpio2 23 GPIO_ACTIVE_LOW>;
41                 dcd-gpios = <&gpio2 24 GPIO_ACTIVE_LOW>;
42                 rng-gpios = <&gpio2 25 GPIO_ACTIVE_LOW>;
43                 cts-gpios = <&gpio0 12 GPIO_ACTIVE_LOW>;
44                 rts-gpios = <&gpio0 13 GPIO_ACTIVE_LOW>;
45                 status = "okay";
46         };
47
48         scifa4: serial@e6c80000 {
49                 compatible = "renesas,scifa-sh73a0", "renesas,scifa";
50                 reg = <0xe6c80000 0x100>;
51                 interrupts = <GIC_SPI 78 IRQ_TYPE_LEVEL_HIGH>;
52                 clocks = <&mstp2_clks SH73A0_CLK_SCIFA4>;
53                 clock-names = "fck";
54                 power-domains = <&pd_a3sp>;
55                 uart-has-rtscts;
56                 status = "okay";
57         };