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

Laurent Pinchart
2013-11-11T02:39:04Z

Hi Sergei,

On Sunday 10 November 2013 22:07:16 Sergei Shtylyov wrote:
> On 10-11-2013 7:33, Laurent Pinchart wrote:
> > Document the device tree bindings for the sci serial port devices.
> >
> > Cc: devicetree@vger.kernel.org
>
> Hm, why are you not CCing a bunch of people responsible for the DT bindings
> maintenance that scripts/get_maintainer.pl should yield?

Because they're subscribed to the devicetree list, and they're already
overwhelmed with e-mails.

> > 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.
>
> Which are not all specified here?

The r8a7790-specific versions are. Other SoCs will be added later when ported
to SCIF DT.

> > +
> > + - reg: Base address and length of the memory resource used by the UART.
> > +
> > + - interrupt-parent: Reference to the parent interrupt controller.
>
> This is not a required property. It can be specified in the parent node.

But in practice it isn't for the SCIF devices.

Given that we'll soon get a new way to specify interrupts, I think I'll just
reference the corresponding DT bindings document when it will be updated
instead of documenting all possibilities here.

> > + - interrupts: Interrupt number.
>
> s/number/specifier/

I'll fix that.

>
> > +
> > + - 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";
> > + };

--
Regards,

Laurent Pinchart