[PATCH v2 1/2] dt-bindings: serial: add documentation for the SiFive UART driver
robh+dt at kernel.org
Sat Oct 20 07:21:42 PDT 2018
On Fri, Oct 19, 2018 at 5:06 PM Paul Walmsley <paul.walmsley at sifive.com> wrote:
> On 10/19/18 1:45 PM, Rob Herring wrote:
> > On Fri, Oct 19, 2018 at 1:48 PM Paul Walmsley <paul.walmsley at 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 at linuxfoundation.org>
> >> Cc: Rob Herring <robh+dt at kernel.org>
> >> Cc: Mark Rutland <mark.rutland at arm.com>
> >> Cc: Palmer Dabbelt <palmer at sifive.com>
> >> Reviewed-by: Palmer Dabbelt <palmer at sifive.com>
> >> Signed-off-by: Paul Walmsley <paul.walmsley at sifive.com>
> >> Signed-off-by: Paul Walmsley <paul at 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?
> > Palmer mentioned the
> > compatible string is part of the IP block repository?
> It is, but there's no guarantee that the compatible string from the RTL
> will make it into a ROM for any given chip. For example, a customer may
> want the UART, but not want to take the DT ROM to keep area down.
Optional? Well, that's pointless to have then.
> This is one of the reasons why we'll likely switch to the usual
> software-maintained DTS files for Linux, just like the rest of arch/arm,
> arch/powerpc, etc.
Then you should probably just follow normal conventions.
I don't think DT in the h/w is the best strategy anyways. Ideally,
what the h/w should have are version and capabilities (assuming there
are configuration options) registers which aren't optional and can't
be forgotten to be updated. The version should probably have a vendor
> > 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.
> Will add that to the binding document.
I don't seem to be making my point clear. I don't want any of this
added to a binding doc for particular IP blocks. Write a common doc
that explains the scheme and addresses the questions I asked. Then
just reference that doc here.
Maybe this is documented somewhere already? Otherwise, if one is
creating a new IP block, how do they know what the versioning scheme
is or what goes in the DT ROM?
> > Where does the
> > number come from?
> It comes from the RTL, which is public:
I'm not going to go read your RTL, sorry.
More information about the linux-riscv