[PATCH v2 28/29] serial: sh-sci: Add device tree bindings documentation

Laurent Pinchart
2013-11-10T03:33:35Z

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

Cc: devicetree@vger.kernel.org
Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Acked-by: Simon Horman <horms+renesas@verge.net.au>
---
.../bindings/serial/renesas,sci-serial.txt | 42 ++++++++++++++++++++++
1 file changed, 42 insertions(+)
create mode 100644 Documentation/devicetree/bindings/serial/renesas,sci-serial.txt

diff --git a/Documentation/devicetree/bindings/serial/renesas,sci-serial.txt b/Documentation/devicetree/bindings/serial/renesas,sci-serial.txt
new file mode 100644
index 0000000..66d3bca
--- /dev/null
+++ b/Documentation/devicetree/bindings/serial/renesas,sci-serial.txt
@@ -0,0 +1,42 @@
+* Renesas SH-Mobile Serial Communication Interface
+
+Required properties:
+
+ - compatible: one of the following types (scif, scifa, scifb, hscif).
+
+ - "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-generic" for generic SCIF compatible UART.
+ - "renesas,scifa-generic" for generic SCIFA compatible UART.
+ - "renesas,scifb-generic" for generic SCIFB compatible UART.
+ - "renesas,hscif-generic" for generic HSCIF compatible UART.
+
+ When compatible with the generic version, nodes must also list the
+ SoC-specific version corresponding to the platform.
+
+ - reg: Base address and length of the memory resource used by the UART.
+
+ - interrupt-parent: Reference to the parent interrupt controller.
+ - interrupts: Interrupt number.
+
+ - clocks: Reference to the SCIx UART interface clock.
+ - clock-names: Should be "sci_ick".
+
+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 4>;
+ clocks = <&mstp2_clks 4>;
+ clock-names = "sci_ick";
+ };
--
1.8.1.5