dt: document the of_serial bindings
[platform/kernel/linux-starfive.git] / Documentation / devicetree / bindings / tty / serial / of-serial.txt
1 * UART (Universal Asynchronous Receiver/Transmitter)
2
3 Required properties:
4 - compatible : one of:
5         - "ns8250"
6         - "ns16450"
7         - "ns16550a"
8         - "ns16550"
9         - "ns16750"
10         - "ns16850"
11         - "nvidia,tegra250-uart"
12         - "ibm,qpace-nwp-serial"
13         - "serial" if the port type is unknown.
14 - reg : offset and length of the register set for the device.
15 - interrupts : should contain uart interrupt.
16 - clock-frequency : the input clock frequency for the UART.
17
18 Optional properties:
19 - current-speed : the current active speed of the UART.
20 - reg-offset : offset to apply to the mapbase from the start of the registers.
21 - reg-shift : quantity to shift the register offsets by.
22 - used-by-rtas : set to indicate that the port is in use by the OpenFirmware
23   RTAS and should not be registered.
24
25 Example:
26
27         uart@80230000 {
28                 compatible = "ns8250";
29                 reg = <0x80230000 0x100>;
30                 clock-frequency = <3686400>;
31                 interrupts = <10>;
32                 reg-shift = <2>;
33         };