[mirror_ubuntu-focal-kernel.git] / Documentation / devicetree / bindings / serial / renesas,sci-serial.txt

* Renesas SH-Mobile Serial Communication Interface

Required properties:

  - compatible: Must contain one or more of the following:

    - "renesas,scif-r7s72100" for R7S72100 (RZ/A1H) SCIF compatible UART.
    - "renesas,scifa-r8a73a4" for R8A73A4 (R-Mobile APE6) SCIFA compatible UART.
    - "renesas,scifb-r8a73a4" for R8A73A4 (R-Mobile APE6) SCIFB compatible UART.
    - "renesas,scifa-r8a7740" for R8A7740 (R-Mobile A1) SCIFA compatible UART.
    - "renesas,scifb-r8a7740" for R8A7740 (R-Mobile A1) SCIFB compatible UART.
    - "renesas,scif-r8a7743" for R8A7743 (RZ/G1M) SCIF compatible UART.
    - "renesas,scifa-r8a7743" for R8A7743 (RZ/G1M) SCIFA compatible UART.
    - "renesas,scifb-r8a7743" for R8A7743 (RZ/G1M) SCIFB compatible UART.
    - "renesas,hscif-r8a7743" for R8A7743 (RZ/G1M) HSCIF compatible UART.
    - "renesas,scif-r8a7745" for R8A7745 (RZ/G1E) SCIF compatible UART.
    - "renesas,scifa-r8a7745" for R8A7745 (RZ/G1E) SCIFA compatible UART.
    - "renesas,scifb-r8a7745" for R8A7745 (RZ/G1E) SCIFB compatible UART.
    - "renesas,hscif-r8a7745" for R8A7745 (RZ/G1E) HSCIF compatible UART.
    - "renesas,scif-r8a7778" for R8A7778 (R-Car M1) SCIF compatible UART.
    - "renesas,scif-r8a7779" for R8A7779 (R-Car H1) SCIF compatible UART.
    - "renesas,scif-r8a7790" for R8A7790 (R-Car H2) SCIF compatible UART.
    - "renesas,scifa-r8a7790" for R8A7790 (R-Car H2) SCIFA compatible UART.
    - "renesas,scifb-r8a7790" for R8A7790 (R-Car H2) SCIFB compatible UART.
    - "renesas,hscif-r8a7790" for R8A7790 (R-Car H2) HSCIF compatible UART.
    - "renesas,scif-r8a7791" for R8A7791 (R-Car M2-W) SCIF compatible UART.
    - "renesas,scifa-r8a7791" for R8A7791 (R-Car M2-W) SCIFA compatible UART.
    - "renesas,scifb-r8a7791" for R8A7791 (R-Car M2-W) SCIFB compatible UART.
    - "renesas,hscif-r8a7791" for R8A7791 (R-Car M2-W) HSCIF compatible UART.
    - "renesas,scif-r8a7792" for R8A7792 (R-Car V2H) SCIF compatible UART.
    - "renesas,hscif-r8a7792" for R8A7792 (R-Car V2H) HSCIF compatible UART.
    - "renesas,scif-r8a7793" for R8A7793 (R-Car M2-N) SCIF compatible UART.
    - "renesas,scifa-r8a7793" for R8A7793 (R-Car M2-N) SCIFA compatible UART.
    - "renesas,scifb-r8a7793" for R8A7793 (R-Car M2-N) SCIFB compatible UART.
    - "renesas,hscif-r8a7793" for R8A7793 (R-Car M2-N) HSCIF compatible UART.
    - "renesas,scif-r8a7794" for R8A7794 (R-Car E2) SCIF compatible UART.
    - "renesas,scifa-r8a7794" for R8A7794 (R-Car E2) SCIFA compatible UART.
    - "renesas,scifb-r8a7794" for R8A7794 (R-Car E2) SCIFB compatible UART.
    - "renesas,hscif-r8a7794" for R8A7794 (R-Car E2) HSCIF compatible UART.
    - "renesas,scif-r8a7795" for R8A7795 (R-Car H3) SCIF compatible UART.
    - "renesas,hscif-r8a7795" for R8A7795 (R-Car H3) HSCIF compatible UART.
    - "renesas,scif-r8a7796" for R8A7796 (R-Car M3-W) SCIF compatible UART.
    - "renesas,hscif-r8a7796" for R8A7796 (R-Car M3-W) HSCIF compatible UART.
    - "renesas,scif-r8a77995" for R8A77995 (R-Car D3) SCIF compatible UART.
    - "renesas,hscif-r8a77995" for R8A77995 (R-Car D3) HSCIF compatible UART.
    - "renesas,scifa-sh73a0" for SH73A0 (SH-Mobile AG5) SCIFA compatible UART.
    - "renesas,scifb-sh73a0" for SH73A0 (SH-Mobile AG5) SCIFB compatible UART.
    - "renesas,rcar-gen1-scif" for R-Car Gen1 SCIF compatible UART,
    - "renesas,rcar-gen2-scif" for R-Car Gen2 SCIF compatible UART,
    - "renesas,rcar-gen3-scif" for R-Car Gen3 SCIF compatible UART,
    - "renesas,rcar-gen2-scifa" for R-Car Gen2 SCIFA compatible UART,
    - "renesas,rcar-gen2-scifb" for R-Car Gen2 SCIFB compatible UART,
    - "renesas,rcar-gen1-hscif" for R-Car Gen1 HSCIF compatible UART,
    - "renesas,rcar-gen2-hscif" for R-Car Gen2 HSCIF compatible UART,
    - "renesas,rcar-gen3-hscif" for R-Car Gen3 HSCIF compatible UART,
    - "renesas,scif" for generic SCIF compatible UART.
    - "renesas,scifa" for generic SCIFA compatible UART.
    - "renesas,scifb" for generic SCIFB compatible UART.
    - "renesas,hscif" for generic HSCIF compatible UART.
    - "renesas,sci" for generic SCI compatible UART.

    When compatible with the generic version, nodes must list the
    SoC-specific version corresponding to the platform first, followed by the
    family-specific and/or generic versions.

  - reg: Base address and length of the I/O registers used by the UART.
  - interrupts: Must contain an interrupt-specifier for the SCIx interrupt.

  - clocks: Must contain a phandle and clock-specifier pair for each entry
    in clock-names.
  - clock-names: Must contain "fck" for the SCIx UART functional clock.
    Apart from the divided functional clock, there may be other possible
    sources for the sampling clock, depending on SCIx variant.
    On (H)SCI(F) and some SCIFA, an additional clock may be specified:
      - "hsck" for the optional external clock input (on HSCIF),
      - "sck" for the optional external clock input (on other variants).
    On UARTs equipped with a Baud Rate Generator for External Clock (BRG)
    (some SCIF and HSCIF), additional clocks may be specified:
      - "brg_int" for the optional internal clock source for the frequency
	divider (typically the (AXI or SHwy) bus clock),
      - "scif_clk" for the optional external clock source for the frequency
	divider (SCIF_CLK).

Note: Each enabled SCIx UART should have an alias correctly numbered in the
"aliases" node.

Optional properties:
  - dmas: Must contain a list of two references to DMA specifiers, one for
	  transmission, and one for reception.
  - dma-names: Must contain a list of two DMA names, "tx" and "rx".
  - {cts,dsr,dcd,rng,rts,dtr}-gpios: Specify GPIOs for modem lines, cfr. the
    generic serial DT bindings in serial.txt.
  - uart-has-rtscts: Indicates dedicated lines for RTS/CTS hardware flow
    control, cfr. the generic serial DT bindings in serial.txt.

Example:
	aliases {
		serial0 = &scifa0;
	};

	scifa0: serial@e6c40000 {
		compatible = "renesas,scifa-r8a7790",
			     "renesas,rcar-gen2-scifa", "renesas,scifa";
		reg = <0 0xe6c40000 0 64>;
		interrupt-parent = <&gic>;
		interrupts = <0 144 IRQ_TYPE_LEVEL_HIGH>;
		clocks = <&mstp2_clks R8A7790_CLK_SCIFA0>;
		clock-names = "fck";
		dmas = <&dmac0 0x21>, <&dmac0 0x22>;
		dma-names = "tx", "rx";
	};
Commit	Line	Data
334bc118 LP	1	* Renesas SH-Mobile Serial Communication Interface
	2
	3	Required properties:
	4
598604ff	5	- compatible: Must contain one or more of the following:
334bc118	6
681b05f5	7	- "renesas,scif-r7s72100" for R7S72100 (RZ/A1H) SCIF compatible UART.
34c4eda8 SH	8	- "renesas,scifa-r8a73a4" for R8A73A4 (R-Mobile APE6) SCIFA compatible UART.
	9	- "renesas,scifb-r8a73a4" for R8A73A4 (R-Mobile APE6) SCIFB compatible UART.
	10	- "renesas,scifa-r8a7740" for R8A7740 (R-Mobile A1) SCIFA compatible UART.
	11	- "renesas,scifb-r8a7740" for R8A7740 (R-Mobile A1) SCIFB compatible UART.
c03e1b87 SS	12	- "renesas,scif-r8a7743" for R8A7743 (RZ/G1M) SCIF compatible UART.
	13	- "renesas,scifa-r8a7743" for R8A7743 (RZ/G1M) SCIFA compatible UART.
	14	- "renesas,scifb-r8a7743" for R8A7743 (RZ/G1M) SCIFB compatible UART.
	15	- "renesas,hscif-r8a7743" for R8A7743 (RZ/G1M) HSCIF compatible UART.
	16	- "renesas,scif-r8a7745" for R8A7745 (RZ/G1E) SCIF compatible UART.
	17	- "renesas,scifa-r8a7745" for R8A7745 (RZ/G1E) SCIFA compatible UART.
	18	- "renesas,scifb-r8a7745" for R8A7745 (RZ/G1E) SCIFB compatible UART.
	19	- "renesas,hscif-r8a7745" for R8A7745 (RZ/G1E) HSCIF compatible UART.
34c4eda8	20	- "renesas,scif-r8a7778" for R8A7778 (R-Car M1) SCIF compatible UART.
81bd1eb7	21	- "renesas,scif-r8a7779" for R8A7779 (R-Car H1) SCIF compatible UART.
334bc118 LP	22	- "renesas,scif-r8a7790" for R8A7790 (R-Car H2) SCIF compatible UART.
	23	- "renesas,scifa-r8a7790" for R8A7790 (R-Car H2) SCIFA compatible UART.
	24	- "renesas,scifb-r8a7790" for R8A7790 (R-Car H2) SCIFB compatible UART.
	25	- "renesas,hscif-r8a7790" for R8A7790 (R-Car H2) HSCIF compatible UART.
456ad4a1 UH	26	- "renesas,scif-r8a7791" for R8A7791 (R-Car M2-W) SCIF compatible UART.
	27	- "renesas,scifa-r8a7791" for R8A7791 (R-Car M2-W) SCIFA compatible UART.
	28	- "renesas,scifb-r8a7791" for R8A7791 (R-Car M2-W) SCIFB compatible UART.
	29	- "renesas,hscif-r8a7791" for R8A7791 (R-Car M2-W) HSCIF compatible UART.
02064176 SH	30	- "renesas,scif-r8a7792" for R8A7792 (R-Car V2H) SCIF compatible UART.
02064176 SH	31	- "renesas,hscif-r8a7792" for R8A7792 (R-Car V2H) HSCIF compatible UART.
456ad4a1 UH	32	- "renesas,scif-r8a7793" for R8A7793 (R-Car M2-N) SCIF compatible UART.
	33	- "renesas,scifa-r8a7793" for R8A7793 (R-Car M2-N) SCIFA compatible UART.
	34	- "renesas,scifb-r8a7793" for R8A7793 (R-Car M2-N) SCIFB compatible UART.
	35	- "renesas,hscif-r8a7793" for R8A7793 (R-Car M2-N) HSCIF compatible UART.
c556522e UH	36	- "renesas,scif-r8a7794" for R8A7794 (R-Car E2) SCIF compatible UART.
	37	- "renesas,scifa-r8a7794" for R8A7794 (R-Car E2) SCIFA compatible UART.
	38	- "renesas,scifb-r8a7794" for R8A7794 (R-Car E2) SCIFB compatible UART.
	39	- "renesas,hscif-r8a7794" for R8A7794 (R-Car E2) HSCIF compatible UART.
3575b858 KM	40	- "renesas,scif-r8a7795" for R8A7795 (R-Car H3) SCIF compatible UART.
3575b858 KM	41	- "renesas,hscif-r8a7795" for R8A7795 (R-Car H3) HSCIF compatible UART.
ac8305cd HY	42	- "renesas,scif-r8a7796" for R8A7796 (R-Car M3-W) SCIF compatible UART.
ac8305cd HY	43	- "renesas,hscif-r8a7796" for R8A7796 (R-Car M3-W) HSCIF compatible UART.
dde68266 GU	44	- "renesas,scif-r8a77995" for R8A77995 (R-Car D3) SCIF compatible UART.
dde68266 GU	45	- "renesas,hscif-r8a77995" for R8A77995 (R-Car D3) HSCIF compatible UART.
681b05f5 GU	46	- "renesas,scifa-sh73a0" for SH73A0 (SH-Mobile AG5) SCIFA compatible UART.
681b05f5 GU	47	- "renesas,scifb-sh73a0" for SH73A0 (SH-Mobile AG5) SCIFB compatible UART.
598604ff GU	48	- "renesas,rcar-gen1-scif" for R-Car Gen1 SCIF compatible UART,
	49	- "renesas,rcar-gen2-scif" for R-Car Gen2 SCIF compatible UART,
	50	- "renesas,rcar-gen3-scif" for R-Car Gen3 SCIF compatible UART,
	51	- "renesas,rcar-gen2-scifa" for R-Car Gen2 SCIFA compatible UART,
	52	- "renesas,rcar-gen2-scifb" for R-Car Gen2 SCIFB compatible UART,
	53	- "renesas,rcar-gen1-hscif" for R-Car Gen1 HSCIF compatible UART,
	54	- "renesas,rcar-gen2-hscif" for R-Car Gen2 HSCIF compatible UART,
	55	- "renesas,rcar-gen3-hscif" for R-Car Gen3 HSCIF compatible UART,
334bc118 LP	56	- "renesas,scif" for generic SCIF compatible UART.
	57	- "renesas,scifa" for generic SCIFA compatible UART.
	58	- "renesas,scifb" for generic SCIFB compatible UART.
	59	- "renesas,hscif" for generic HSCIF compatible UART.
e1d0be61	60	- "renesas,sci" for generic SCI compatible UART.
334bc118 LP	61
334bc118 LP	62	When compatible with the generic version, nodes must list the
598604ff GU	63	SoC-specific version corresponding to the platform first, followed by the
598604ff GU	64	family-specific and/or generic versions.
334bc118 LP	65
	66	- reg: Base address and length of the I/O registers used by the UART.
	67	- interrupts: Must contain an interrupt-specifier for the SCIx interrupt.
	68
	69	- clocks: Must contain a phandle and clock-specifier pair for each entry
	70	in clock-names.
a9ec81f4	71	- clock-names: Must contain "fck" for the SCIx UART functional clock.
9a040c9f GU	72	Apart from the divided functional clock, there may be other possible
	73	sources for the sampling clock, depending on SCIx variant.
	74	On (H)SCI(F) and some SCIFA, an additional clock may be specified:
	75	- "hsck" for the optional external clock input (on HSCIF),
	76	- "sck" for the optional external clock input (on other variants).
176ae5f6 GU	77	On UARTs equipped with a Baud Rate Generator for External Clock (BRG)
	78	(some SCIF and HSCIF), additional clocks may be specified:
	79	- "brg_int" for the optional internal clock source for the frequency
	80	divider (typically the (AXI or SHwy) bus clock),
	81	- "scif_clk" for the optional external clock source for the frequency
	82	divider (SCIF_CLK).
334bc118 LP	83
	84	Note: Each enabled SCIx UART should have an alias correctly numbered in the
	85	"aliases" node.
	86
3c99121c GU	87	Optional properties:
	88	- dmas: Must contain a list of two references to DMA specifiers, one for
	89	transmission, and one for reception.
	90	- dma-names: Must contain a list of two DMA names, "tx" and "rx".
0c529b3f GU	91	- {cts,dsr,dcd,rng,rts,dtr}-gpios: Specify GPIOs for modem lines, cfr. the
0c529b3f GU	92	generic serial DT bindings in serial.txt.
b0405dc9 GU	93	- uart-has-rtscts: Indicates dedicated lines for RTS/CTS hardware flow
b0405dc9 GU	94	control, cfr. the generic serial DT bindings in serial.txt.
3c99121c	95
334bc118 LP	96	Example:
	97	aliases {
	98	serial0 = &scifa0;
	99	};
	100
	101	scifa0: serial@e6c40000 {
598604ff GU	102	compatible = "renesas,scifa-r8a7790",
598604ff GU	103	"renesas,rcar-gen2-scifa", "renesas,scifa";
334bc118 LP	104	reg = <0 0xe6c40000 0 64>;
	105	interrupt-parent = <&gic>;
	106	interrupts = <0 144 IRQ_TYPE_LEVEL_HIGH>;
	107	clocks = <&mstp2_clks R8A7790_CLK_SCIFA0>;
a9ec81f4	108	clock-names = "fck";
3c99121c GU	109	dmas = <&dmac0 0x21>, <&dmac0 0x22>;
3c99121c GU	110	dma-names = "tx", "rx";
334bc118	111	};