[2/3] dt-bindings: serial: document LiteUART bindings
diff mbox series

Message ID 20190930130430.GA9080@localhost.localdomain
State Changes Requested
Headers show
Series
  • LiteUART serial driver
Related show

Checks

Context Check Description
robh/checkpatch success

Commit Message

Mateusz Holenko Sept. 30, 2019, 1:04 p.m. UTC
From: Filip Kokosinski <fkokosinski@internships.antmicro.com>

Add documentation for LiteUART devicetree bindings.

Signed-off-by: Filip Kokosinski <fkokosinski@internships.antmicro.com>
Signed-off-by: Mateusz Holenko <mholenko@antmicro.com>
---
 .../devicetree/bindings/serial/litex,liteuart.txt    | 12 ++++++++++++
 MAINTAINERS                                          |  6 ++++++
 2 files changed, 18 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/serial/litex,liteuart.txt

Comments

Rob Herring Sept. 30, 2019, 9:32 p.m. UTC | #1
On Mon, Sep 30, 2019 at 8:04 AM Mateusz Holenko <mholenko@antmicro.com> wrote:
>
> From: Filip Kokosinski <fkokosinski@internships.antmicro.com>
>
> Add documentation for LiteUART devicetree bindings.
>
> Signed-off-by: Filip Kokosinski <fkokosinski@internships.antmicro.com>
> Signed-off-by: Mateusz Holenko <mholenko@antmicro.com>
> ---
>  .../devicetree/bindings/serial/litex,liteuart.txt    | 12 ++++++++++++
>  MAINTAINERS                                          |  6 ++++++
>  2 files changed, 18 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/serial/litex,liteuart.txt

Please make this a schema. See
Documentation/devicetree/writing-schema.rst (or .md before 5.4).

>
> diff --git a/Documentation/devicetree/bindings/serial/litex,liteuart.txt b/Documentation/devicetree/bindings/serial/litex,liteuart.txt
> new file mode 100644
> index 000000000..13c71a0c9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/serial/litex,liteuart.txt
> @@ -0,0 +1,12 @@
> +LiteUART serial controller
> +
> +Required properties:
> +- compatible: should be "litex,liteuart"

Only 1 version?

> +- reg: base address and length of the register set for this device

Is there really no interrupt line? That should be added if there's h/w
support even if the driver doesn't yet support it.

> +
> +Example:
> +
> +uart0: serial@f0001000 {

Wrong unit address. Should be "@e0001800".


> +       compatible = "litex,liteuart";
> +       reg = <0xe0001800 0x100>;
> +};
> diff --git a/MAINTAINERS b/MAINTAINERS
> index b2326dece..65a6cf296 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -9462,6 +9462,12 @@ F:       Documentation/misc-devices/lis3lv02d.rst
>  F:     drivers/misc/lis3lv02d/
>  F:     drivers/platform/x86/hp_accel.c
>
> +LITEX PLATFORM
> +M:     Karol Gugala <kgugala@antmicro.com>
> +M:     Mateusz Holenko <mholenko@antmicro.com>
> +S:     Maintained
> +F:     Documentation/devicetree/bindings/serial/litex,liteuart.txt
> +
>  LIVE PATCHING
>  M:     Josh Poimboeuf <jpoimboe@redhat.com>
>  M:     Jiri Kosina <jikos@kernel.org>
> --
> 2.23.0
>
Mateusz Holenko Oct. 3, 2019, 9:23 a.m. UTC | #2
pon., 30 wrz 2019 o 23:32 Rob Herring <robh+dt@kernel.org> napisał(a):
>
> On Mon, Sep 30, 2019 at 8:04 AM Mateusz Holenko <mholenko@antmicro.com> wrote:
> >
> > From: Filip Kokosinski <fkokosinski@internships.antmicro.com>
> >
> > Add documentation for LiteUART devicetree bindings.
> >
> > Signed-off-by: Filip Kokosinski <fkokosinski@internships.antmicro.com>
> > Signed-off-by: Mateusz Holenko <mholenko@antmicro.com>
> > ---
> >  .../devicetree/bindings/serial/litex,liteuart.txt    | 12 ++++++++++++
> >  MAINTAINERS                                          |  6 ++++++
> >  2 files changed, 18 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/serial/litex,liteuart.txt
>
> Please make this a schema. See
> Documentation/devicetree/writing-schema.rst (or .md before 5.4).

Ok. We will rewrite it.

> >
> > diff --git a/Documentation/devicetree/bindings/serial/litex,liteuart.txt b/Documentation/devicetree/bindings/serial/litex,liteuart.txt
> > new file mode 100644
> > index 000000000..13c71a0c9
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/serial/litex,liteuart.txt
> > @@ -0,0 +1,12 @@
> > +LiteUART serial controller
> > +
> > +Required properties:
> > +- compatible: should be "litex,liteuart"
>
> Only 1 version?

For the time being there is only one flavor.

> > +- reg: base address and length of the register set for this device
>
> Is there really no interrupt line? That should be added if there's h/w
> support even if the driver doesn't yet support it.
>
> > +
> > +Example:
> > +
> > +uart0: serial@f0001000 {
>
> Wrong unit address. Should be "@e0001800".

Right, address should be consistent with the one in 'reg'.

>
> > +       compatible = "litex,liteuart";
> > +       reg = <0xe0001800 0x100>;
> > +};
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index b2326dece..65a6cf296 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -9462,6 +9462,12 @@ F:       Documentation/misc-devices/lis3lv02d.rst
> >  F:     drivers/misc/lis3lv02d/
> >  F:     drivers/platform/x86/hp_accel.c
> >
> > +LITEX PLATFORM
> > +M:     Karol Gugala <kgugala@antmicro.com>
> > +M:     Mateusz Holenko <mholenko@antmicro.com>
> > +S:     Maintained
> > +F:     Documentation/devicetree/bindings/serial/litex,liteuart.txt
> > +
> >  LIVE PATCHING
> >  M:     Josh Poimboeuf <jpoimboe@redhat.com>
> >  M:     Jiri Kosina <jikos@kernel.org>
> > --
> > 2.23.0
> >

Thanks for your comments.
I'll address the remarks in V2 of the patchset after receiving a
response on the rest of the patches.

--
Mateusz Holenko
mobile: +48 606 791 789
Antmicro Ltd | www.antmicro.com
Zwierzyniecka 3, 60-813 Poznan, Poland

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/serial/litex,liteuart.txt b/Documentation/devicetree/bindings/serial/litex,liteuart.txt
new file mode 100644
index 000000000..13c71a0c9
--- /dev/null
+++ b/Documentation/devicetree/bindings/serial/litex,liteuart.txt
@@ -0,0 +1,12 @@ 
+LiteUART serial controller
+
+Required properties:
+- compatible: should be "litex,liteuart"
+- reg: base address and length of the register set for this device
+
+Example:
+
+uart0: serial@f0001000 {
+	compatible = "litex,liteuart";
+	reg = <0xe0001800 0x100>;
+};
diff --git a/MAINTAINERS b/MAINTAINERS
index b2326dece..65a6cf296 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9462,6 +9462,12 @@  F:	Documentation/misc-devices/lis3lv02d.rst
 F:	drivers/misc/lis3lv02d/
 F:	drivers/platform/x86/hp_accel.c
 
+LITEX PLATFORM
+M:	Karol Gugala <kgugala@antmicro.com>
+M:	Mateusz Holenko <mholenko@antmicro.com>
+S:	Maintained
+F:	Documentation/devicetree/bindings/serial/litex,liteuart.txt
+
 LIVE PATCHING
 M:	Josh Poimboeuf <jpoimboe@redhat.com>
 M:	Jiri Kosina <jikos@kernel.org>