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

Commit 334bc118 authored by Laurent Pinchart's avatar Laurent Pinchart Committed by Simon Horman
Browse files

serial: sh-sci: Add device tree bindings documentation 



Document the device tree bindings for the sci serial port devices.

Signed-off-by: default avatarLaurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Acked-by: default avatarSimon Horman <horms+renesas@verge.net.au>
Acked-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: default avatarSimon Horman <horms+renesas@verge.net.au>
parent 89b5c1ab

Documentation/devicetree/bindings/serial/renesas,sci-serial.txt

0 → 100644
+46 −0
Original line number Diff line number Diff line 
* Renesas SH-Mobile Serial Communication Interface



Required properties:



  - compatible: Must contain one of the following:



    - "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) SCIF compatible UART.

    - "renesas,scifa-r8a7791" for R8A7791 (R-Car M2) SCIFA compatible UART.

    - "renesas,scifb-r8a7791" for R8A7791 (R-Car M2) SCIFB compatible UART.

    - "renesas,hscif-r8a7791" for R8A7791 (R-Car M2) 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.



    When compatible with the generic version, nodes must list the

    SoC-specific version corresponding to the platform first followed by the

    generic version.



  - 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 "sci_ick" for the SCIx UART interface clock.



Note: Each enabled SCIx UART should have an alias correctly numbered in the

"aliases" node.



Example:

	aliases {

		serial0 = &scifa0;

	};



	scifa0: serial@e6c40000 {

		compatible = "renesas,scifa-r8a7790", "renesas,scifa-generic";

		reg = <0 0xe6c40000 0 64>;

		interrupt-parent = <&gic>;

		interrupts = <0 144 IRQ_TYPE_LEVEL_HIGH>;

		clocks = <&mstp2_clks R8A7790_CLK_SCIFA0>;

		clock-names = "sci_ick";

	};