From: robh+dt@kernel.org (Rob Herring) To: linux-riscv@lists.infradead.org Subject: [PATCH v2 1/2] dt-bindings: serial: add documentation for the SiFive UART driver Date: Fri, 19 Oct 2018 15:45:57 -0500 [thread overview] Message-ID: <CAL_JsqJBSqaxnETdJg1Mdp+H2ay+WKT0JaxLe6D4Fwo_99qUkw@mail.gmail.com> (raw) In-Reply-To: <20181019184827.12351-2-paul.walmsley@sifive.com> On Fri, Oct 19, 2018 at 1:48 PM Paul Walmsley <paul.walmsley@sifive.com> wrote: > > Add DT binding documentation for the Linux driver for the SiFive > asynchronous serial IP block. Nothing too exotic. > > Cc: linux-serial at vger.kernel.org > Cc: devicetree at vger.kernel.org > Cc: linux-riscv at lists.infradead.org > Cc: linux-kernel at vger.kernel.org > Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> > Cc: Rob Herring <robh+dt@kernel.org> > Cc: Mark Rutland <mark.rutland@arm.com> > Cc: Palmer Dabbelt <palmer@sifive.com> > Reviewed-by: Palmer Dabbelt <palmer@sifive.com> > Signed-off-by: Paul Walmsley <paul.walmsley@sifive.com> > Signed-off-by: Paul Walmsley <paul@pwsan.com> > --- > .../bindings/serial/sifive-serial.txt | 21 +++++++++++++++++++ > 1 file changed, 21 insertions(+) > create mode 100644 Documentation/devicetree/bindings/serial/sifive-serial.txt > > diff --git a/Documentation/devicetree/bindings/serial/sifive-serial.txt b/Documentation/devicetree/bindings/serial/sifive-serial.txt > new file mode 100644 > index 000000000000..8982338512f5 > --- /dev/null > +++ b/Documentation/devicetree/bindings/serial/sifive-serial.txt > @@ -0,0 +1,21 @@ > +SiFive asynchronous serial interface (UART) > + > +Required properties: > + > +- compatible: should be "sifive,fu540-c000-uart0" or "sifive,uart0" I assume once again, the last '0' is a version? As I mentioned for the intc and now the pwm block bindings, if you are going to do version numbers please document the versioning scheme. Palmer mentioned the compatible string is part of the IP block repository? Where does the number come from? What's the next version? Major vs. minor versions? ECO fixes? Is the version s/w readable? How do you ensure it gets updated? All that should be addressed. Otherwise, don't do version numbers because we have no visibility to what they mean. > +- reg: address and length of the register space > +- interrupt-parent: should contain a phandle pointing to the SoC interrupt > + controller device node that the UART interrupts are connected to Don't need to document interrupt-parent here. > +- interrupts: Should contain the UART interrupt identifier > +- clocks: Should contain a clock identifier for the UART's parent clock > + > + > +Example: > + > +uart0: serial at 10010000 { > + compatible = "sifive,uart0"; > + interrupt-parent = <&plic0>; > + interrupts = <80>; > + reg = <0x0 0x10010000 0x0 0x1000>; > + clocks = <&prci PRCI_CLK_TLCLK>; > +}; > -- > 2.19.1 >
WARNING: multiple messages have this Message-ID (diff)
From: Rob Herring <robh+dt@kernel.org> To: Paul Walmsley <paul.walmsley@sifive.com> Cc: Mark Rutland <mark.rutland@arm.com>, devicetree@vger.kernel.org, Paul Walmsley <paul@pwsan.com>, Greg Kroah-Hartman <gregkh@linuxfoundation.org>, Palmer Dabbelt <palmer@sifive.com>, "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>, "open list:SERIAL DRIVERS" <linux-serial@vger.kernel.org>, linux-riscv@lists.infradead.org Subject: Re: [PATCH v2 1/2] dt-bindings: serial: add documentation for the SiFive UART driver Date: Fri, 19 Oct 2018 15:45:57 -0500 [thread overview] Message-ID: <CAL_JsqJBSqaxnETdJg1Mdp+H2ay+WKT0JaxLe6D4Fwo_99qUkw@mail.gmail.com> (raw) Message-ID: <20181019204557.L6kwXLlQxRpyqVIN3S2B3ygd4fCTo7NdsotOP97Bjyc@z> (raw) In-Reply-To: <20181019184827.12351-2-paul.walmsley@sifive.com> On Fri, Oct 19, 2018 at 1:48 PM Paul Walmsley <paul.walmsley@sifive.com> wrote: > > Add DT binding documentation for the Linux driver for the SiFive > asynchronous serial IP block. Nothing too exotic. > > Cc: linux-serial@vger.kernel.org > Cc: devicetree@vger.kernel.org > Cc: linux-riscv@lists.infradead.org > Cc: linux-kernel@vger.kernel.org > Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> > Cc: Rob Herring <robh+dt@kernel.org> > Cc: Mark Rutland <mark.rutland@arm.com> > Cc: Palmer Dabbelt <palmer@sifive.com> > Reviewed-by: Palmer Dabbelt <palmer@sifive.com> > Signed-off-by: Paul Walmsley <paul.walmsley@sifive.com> > Signed-off-by: Paul Walmsley <paul@pwsan.com> > --- > .../bindings/serial/sifive-serial.txt | 21 +++++++++++++++++++ > 1 file changed, 21 insertions(+) > create mode 100644 Documentation/devicetree/bindings/serial/sifive-serial.txt > > diff --git a/Documentation/devicetree/bindings/serial/sifive-serial.txt b/Documentation/devicetree/bindings/serial/sifive-serial.txt > new file mode 100644 > index 000000000000..8982338512f5 > --- /dev/null > +++ b/Documentation/devicetree/bindings/serial/sifive-serial.txt > @@ -0,0 +1,21 @@ > +SiFive asynchronous serial interface (UART) > + > +Required properties: > + > +- compatible: should be "sifive,fu540-c000-uart0" or "sifive,uart0" I assume once again, the last '0' is a version? As I mentioned for the intc and now the pwm block bindings, if you are going to do version numbers please document the versioning scheme. Palmer mentioned the compatible string is part of the IP block repository? Where does the number come from? What's the next version? Major vs. minor versions? ECO fixes? Is the version s/w readable? How do you ensure it gets updated? All that should be addressed. Otherwise, don't do version numbers because we have no visibility to what they mean. > +- reg: address and length of the register space > +- interrupt-parent: should contain a phandle pointing to the SoC interrupt > + controller device node that the UART interrupts are connected to Don't need to document interrupt-parent here. > +- interrupts: Should contain the UART interrupt identifier > +- clocks: Should contain a clock identifier for the UART's parent clock > + > + > +Example: > + > +uart0: serial@10010000 { > + compatible = "sifive,uart0"; > + interrupt-parent = <&plic0>; > + interrupts = <80>; > + reg = <0x0 0x10010000 0x0 0x1000>; > + clocks = <&prci PRCI_CLK_TLCLK>; > +}; > -- > 2.19.1 > _______________________________________________ linux-riscv mailing list linux-riscv@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-riscv
next prev parent reply other threads:[~2018-10-19 20:45 UTC|newest] Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top 2018-10-19 18:48 [PATCH v2 0/2] tty: serial: add DT bindings and serial driver for the SiFive FU540 UART Paul Walmsley 2018-10-19 18:48 ` Paul Walmsley 2018-10-19 18:48 ` [PATCH v2 1/2] dt-bindings: serial: add documentation for the SiFive UART driver Paul Walmsley 2018-10-19 18:48 ` Paul Walmsley 2018-10-19 20:45 ` Rob Herring [this message] 2018-10-19 20:45 ` Rob Herring 2018-10-19 22:05 ` Paul Walmsley 2018-10-19 22:05 ` Paul Walmsley 2018-10-20 14:21 ` Rob Herring 2018-10-20 14:21 ` Rob Herring 2018-10-23 17:05 ` Paul Walmsley 2018-10-23 17:05 ` Paul Walmsley 2018-10-24 17:32 ` Rob Herring 2018-10-24 17:32 ` Rob Herring 2018-11-16 23:10 ` Paul Walmsley 2018-11-16 23:10 ` Paul Walmsley 2018-10-22 16:41 ` Palmer Dabbelt 2018-10-22 16:41 ` Palmer Dabbelt 2018-10-24 16:53 ` Rob Herring 2018-10-24 16:53 ` Rob Herring 2018-10-19 18:48 ` [PATCH v2 2/2] tty: serial: add driver for the SiFive UART Paul Walmsley 2018-10-19 18:48 ` Paul Walmsley 2018-10-20 2:47 ` kbuild test robot 2018-10-20 2:47 ` kbuild test robot
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=CAL_JsqJBSqaxnETdJg1Mdp+H2ay+WKT0JaxLe6D4Fwo_99qUkw@mail.gmail.com \ --to=robh+dt@kernel.org \ --cc=linux-riscv@lists.infradead.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).