[deliverable/linux.git] / Documentation / devicetree / bindings / serial / samsung_uart.txt

* Samsung's UART Controller

The Samsung's UART controller is used for interfacing SoC with serial
communicaion devices.

Required properties:
- compatible: should be one of following:
  - "samsung,exynos4210-uart" -  Exynos4210 SoC,
  - "samsung,s3c2410-uart" - compatible with ports present on S3C2410 SoC,
  - "samsung,s3c2412-uart" - compatible with ports present on S3C2412 SoC,
  - "samsung,s3c2440-uart" - compatible with ports present on S3C2440 SoC,
  - "samsung,s3c6400-uart" - compatible with ports present on S3C6400 SoC,
  - "samsung,s5pv210-uart" - compatible with ports present on S5PV210 SoC.

- reg: base physical address of the controller and length of memory mapped
  region.

- interrupts: a single interrupt signal to SoC interrupt controller,
  according to interrupt bindings documentation [1].

- clock-names: input names of clocks used by the controller:
  - "uart" - controller bus clock,
  - "clk_uart_baudN" - Nth baud base clock input (N = 0, 1, ...),
    according to SoC User's Manual (only N = 0 is allowedfor SoCs without
    internal baud clock mux).
- clocks: phandles and specifiers for all clocks specified in "clock-names"
  property, in the same order, according to clock bindings documentation [2].

[1] Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
[2] Documentation/devicetree/bindings/clock/clock-bindings.txt

Optional properties:
- samsung,uart-fifosize: The fifo size supported by the UART channel

Note: Each Samsung UART should have an alias correctly numbered in the
"aliases" node, according to serialN format, where N is the port number
(non-negative decimal integer) as specified by User's Manual of respective
SoC.

Example:
	aliases {
		serial0 = &uart0;
		serial1 = &uart1;
		serial2 = &uart2;
	};

Example:
	uart1: serial@7f005400 {
		compatible = "samsung,s3c6400-uart";
		reg = <0x7f005400 0x100>;
		interrupt-parent = <&vic1>;
		interrupts = <6>;
		clock-names = "uart", "clk_uart_baud2",
				"clk_uart_baud3";
		clocks = <&clocks PCLK_UART1>, <&clocks PCLK_UART1>,
				<&clocks SCLK_UART>;
		samsung,uart-fifosize = <16>;
	};
Commit	Line	Data
26c919e1 TA	1	* Samsung's UART Controller
26c919e1 TA	2
9b58bec7 TF	3	The Samsung's UART controller is used for interfacing SoC with serial
9b58bec7 TF	4	communicaion devices.
26c919e1 TA	5
26c919e1 TA	6	Required properties:
9b58bec7 TF	7	- compatible: should be one of following:
	8	- "samsung,exynos4210-uart" - Exynos4210 SoC,
	9	- "samsung,s3c2410-uart" - compatible with ports present on S3C2410 SoC,
	10	- "samsung,s3c2412-uart" - compatible with ports present on S3C2412 SoC,
	11	- "samsung,s3c2440-uart" - compatible with ports present on S3C2440 SoC,
	12	- "samsung,s3c6400-uart" - compatible with ports present on S3C6400 SoC,
	13	- "samsung,s5pv210-uart" - compatible with ports present on S5PV210 SoC.
26c919e1 TA	14
	15	- reg: base physical address of the controller and length of memory mapped
	16	region.
	17
9b58bec7 TF	18	- interrupts: a single interrupt signal to SoC interrupt controller,
	19	according to interrupt bindings documentation [1].
	20
	21	- clock-names: input names of clocks used by the controller:
	22	- "uart" - controller bus clock,
	23	- "clk_uart_baudN" - Nth baud base clock input (N = 0, 1, ...),
	24	according to SoC User's Manual (only N = 0 is allowedfor SoCs without
	25	internal baud clock mux).
	26	- clocks: phandles and specifiers for all clocks specified in "clock-names"
	27	property, in the same order, according to clock bindings documentation [2].
	28
	29	[1] Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
	30	[2] Documentation/devicetree/bindings/clock/clock-bindings.txt
	31
135f07c3 NKC	32	Optional properties:
	33	- samsung,uart-fifosize: The fifo size supported by the UART channel
	34
9b58bec7 TF	35	Note: Each Samsung UART should have an alias correctly numbered in the
	36	"aliases" node, according to serialN format, where N is the port number
	37	(non-negative decimal integer) as specified by User's Manual of respective
	38	SoC.
	39
	40	Example:
	41	aliases {
	42	serial0 = &uart0;
	43	serial1 = &uart1;
	44	serial2 = &uart2;
	45	};
	46
	47	Example:
	48	uart1: serial@7f005400 {
	49	compatible = "samsung,s3c6400-uart";
	50	reg = <0x7f005400 0x100>;
	51	interrupt-parent = <&vic1>;
	52	interrupts = <6>;
	53	clock-names = "uart", "clk_uart_baud2",
	54	"clk_uart_baud3";
	55	clocks = <&clocks PCLK_UART1>, <&clocks PCLK_UART1>,
	56	<&clocks SCLK_UART>;
135f07c3	57	samsung,uart-fifosize = <16>;
9b58bec7	58	};