Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 61ab1a90 authored by Jamie Iles's avatar Jamie Iles Committed by Grant Likely
Browse files

dt: document the of_serial bindings 



The of_serial bindings can be used to register a number of serial
devices.  Document this binding with all of the others.

v3: remove device-type and clarify used-by-rtas

Signed-off-by: default avatarJamie Iles <jamie@jamieiles.com>
Acked-by: default avatarArnd Bergmann <arnd@arndb.de>
Signed-off-by: default avatarGrant Likely <grant.likely@secretlab.ca>
parent 15c3597d

Documentation/devicetree/bindings/tty/serial/of-serial.txt

0 → 100644
+33 −0
Original line number Diff line number Diff line 
* UART (Universal Asynchronous Receiver/Transmitter)



Required properties:

- compatible : one of:

	- "ns8250"

	- "ns16450"

	- "ns16550a"

	- "ns16550"

	- "ns16750"

	- "ns16850"

	- "nvidia,tegra250-uart"

	- "ibm,qpace-nwp-serial"

	- "serial" if the port type is unknown.

- reg : offset and length of the register set for the device.

- interrupts : should contain uart interrupt.

- clock-frequency : the input clock frequency for the UART.



Optional properties:

- current-speed : the current active speed of the UART.

- reg-offset : offset to apply to the mapbase from the start of the registers.

- reg-shift : quantity to shift the register offsets by.

- used-by-rtas : set to indicate that the port is in use by the OpenFirmware

  RTAS and should not be registered.



Example:



	uart@80230000 {

		compatible = "ns8250";

		reg = <0x80230000 0x100>;

		clock-frequency = <3686400>;

		interrupts = <10>;

		reg-shift = <2>;

	};