]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - Bindings/serial/8250.txt
DTS: Update the device-tree files to Linux 5.5
[FreeBSD/FreeBSD.git] / Bindings / serial / 8250.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         - For Tegra20, must contain "nvidia,tegra20-uart"
12         - For other Tegra, must contain '"nvidia,<chip>-uart",
13           "nvidia,tegra20-uart"' where <chip> is tegra30, tegra114, tegra124,
14           tegra132, or tegra210.
15         - "nxp,lpc3220-uart"
16         - "ralink,rt2880-uart"
17         - For MediaTek BTIF, must contain '"mediatek,<chip>-btif",
18           "mediatek,mtk-btif"' where <chip> is mt7622, mt7623.
19         - "altr,16550-FIFO32"
20         - "altr,16550-FIFO64"
21         - "altr,16550-FIFO128"
22         - "fsl,16550-FIFO64"
23         - "fsl,ns16550"
24         - "intel,xscale-uart"
25         - "ti,da830-uart"
26         - "aspeed,ast2400-vuart"
27         - "aspeed,ast2500-vuart"
28         - "nuvoton,npcm750-uart"
29         - "serial" if the port type is unknown.
30 - reg : offset and length of the register set for the device.
31 - interrupts : should contain uart interrupt.
32 - clock-frequency : the input clock frequency for the UART
33          or
34   clocks phandle to refer to the clk used as per Documentation/devicetree
35   /bindings/clock/clock-bindings.txt
36
37 Optional properties:
38 - current-speed : the current active speed of the UART.
39 - reg-offset : offset to apply to the mapbase from the start of the registers.
40 - reg-shift : quantity to shift the register offsets by.
41 - reg-io-width : the size (in bytes) of the IO accesses that should be
42   performed on the device.  There are some systems that require 32-bit
43   accesses to the UART (e.g. TI davinci).
44 - used-by-rtas : set to indicate that the port is in use by the OpenFirmware
45   RTAS and should not be registered.
46 - no-loopback-test: set to indicate that the port does not implements loopback
47   test mode
48 - fifo-size: the fifo size of the UART.
49 - auto-flow-control: one way to enable automatic flow control support. The
50   driver is allowed to detect support for the capability even without this
51   property.
52 - tx-threshold: Specify the TX FIFO low water indication for parts with
53   programmable TX FIFO thresholds.
54 - resets : phandle + reset specifier pairs
55 - overrun-throttle-ms : how long to pause uart rx when input overrun is encountered.
56 - {rts,cts,dtr,dsr,rng,dcd}-gpios: specify a GPIO for RTS/CTS/DTR/DSR/RI/DCD
57   line respectively. It will use specified GPIO instead of the peripheral
58   function pin for the UART feature. If unsure, don't specify this property.
59 - aspeed,sirq-polarity-sense: Only applicable to aspeed,ast2500-vuart.
60   phandle to aspeed,ast2500-scu compatible syscon alongside register offset
61   and bit number to identify how the SIRQ polarity should be configured.
62   One possible data source is the LPC/eSPI mode bit.
63   Example: aspeed,sirq-polarity-sense = <&syscon 0x70 25>
64
65 Note:
66 * fsl,ns16550:
67   ------------
68   Freescale DUART is very similar to the PC16552D (and to a
69   pair of NS16550A), albeit with some nonstandard behavior such as
70   erratum A-004737 (relating to incorrect BRK handling).
71
72   Represents a single port that is compatible with the DUART found
73   on many Freescale chips (examples include mpc8349, mpc8548,
74   mpc8641d, p4080 and ls2085a).
75
76 Example:
77
78         uart@80230000 {
79                 compatible = "ns8250";
80                 reg = <0x80230000 0x100>;
81                 clock-frequency = <3686400>;
82                 interrupts = <10>;
83                 reg-shift = <2>;
84         };
85
86 Example for OMAP UART using GPIO-based modem control signals:
87
88         uart4: serial@49042000 {
89                 compatible = "ti,omap3-uart";
90                 reg = <0x49042000 0x400>;
91                 interrupts = <80>;
92                 ti,hwmods = "uart4";
93                 clock-frequency = <48000000>;
94                 cts-gpios = <&gpio3 5 GPIO_ACTIVE_LOW>;
95                 rts-gpios = <&gpio3 6 GPIO_ACTIVE_LOW>;
96                 dtr-gpios = <&gpio1 12 GPIO_ACTIVE_LOW>;
97                 dsr-gpios = <&gpio1 13 GPIO_ACTIVE_LOW>;
98                 dcd-gpios = <&gpio1 14 GPIO_ACTIVE_LOW>;
99                 rng-gpios = <&gpio1 15 GPIO_ACTIVE_LOW>;
100         };