[1/2] dt: serial: Add Renesas RZ/N1 binding documentation

Message ID 1531312174-17489-2-git-send-email-phil.edworthy@renesas.com
State Superseded
Headers show
Series
  • [1/2] dt: serial: Add Renesas RZ/N1 binding documentation
Related show

Commit Message

Phil Edworthy July 11, 2018, 12:29 p.m.
The RZ/N1 UART is a modified Synopsys DesignWare UART.
The modifications only relate to DMA so you could actually use the
controller with the Synopsys compatible string if you are not using
DMA, but you should not do so.

Signed-off-by: Phil Edworthy <phil.edworthy@renesas.com>
---
 Documentation/devicetree/bindings/serial/renesas,rzn1-uart.txt | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/serial/renesas,rzn1-uart.txt

Comments

Geert Uytterhoeven July 11, 2018, 12:39 p.m. | #1
Hi Phil,

On Wed, Jul 11, 2018 at 2:30 PM Phil Edworthy <phil.edworthy@renesas.com> wrote:
> The RZ/N1 UART is a modified Synopsys DesignWare UART.
> The modifications only relate to DMA so you could actually use the
> controller with the Synopsys compatible string if you are not using
> DMA, but you should not do so.
>
> Signed-off-by: Phil Edworthy <phil.edworthy@renesas.com>

Thanks for your patch!

> --- /dev/null
> +++ b/Documentation/devicetree/bindings/serial/renesas,rzn1-uart.txt
> @@ -0,0 +1,10 @@
> +Renesas RZ/N1 UART
> +
> +This controller is based on the Synopsys DesignWare ABP UART and inherits all
> +properties defined in snps-dw-apb-uart.txt except for the compatible property.
> +
> +Required properties:
> +- compatible : The device specific string followed by the generic RZ/N1 string.
> +   Therefore it must be one of:
> +   "renesas,uart-r9a06g032", "renesas,uart-rzn1"

"renesas,r9a06g032-uart", "renesas,rzn1-uart"

> +   "renesas,uart-r9a06g033", "renesas,uart-rzn1"

"renesas,r9a06g033-uart", "renesas,rzn1-uart"

I assume you plan to describe the DMA-related properties later?

Gr{oetje,eeting}s,

                        Geert
Phil Edworthy July 12, 2018, 12:05 p.m. | #2
Hi Geert,

On 11 July 2018 13:39, Geert Uytterhoeven wrote:
> On Wed, Jul 11, 2018 at 2:30 PM Phil Edworthy wrote:
> > The RZ/N1 UART is a modified Synopsys DesignWare UART.
> > The modifications only relate to DMA so you could actually use the
> > controller with the Synopsys compatible string if you are not using
> > DMA, but you should not do so.
> >
> > Signed-off-by: Phil Edworthy <phil.edworthy@renesas.com>
> 
> Thanks for your patch!
> 
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/serial/renesas,rzn1-uart.txt
> > @@ -0,0 +1,10 @@
> > +Renesas RZ/N1 UART
> > +
> > +This controller is based on the Synopsys DesignWare ABP UART and
> > +inherits all properties defined in snps-dw-apb-uart.txt except for the
> compatible property.
> > +
> > +Required properties:
> > +- compatible : The device specific string followed by the generic RZ/N1
> string.
> > +   Therefore it must be one of:
> > +   "renesas,uart-r9a06g032", "renesas,uart-rzn1"
> 
> "renesas,r9a06g032-uart", "renesas,rzn1-uart"
> 
> > +   "renesas,uart-r9a06g033", "renesas,uart-rzn1"
> 
> "renesas,r9a06g033-uart", "renesas,rzn1-uart"
I followed the renesas convention of renesas,peripheral-device that is used for
most R-Car drivers, but happy to change.

> I assume you plan to describe the DMA-related properties later?
Yes, it will take a while to sort out.

Thanks
Phil
Simon Horman July 13, 2018, 7:47 a.m. | #3
On Thu, Jul 12, 2018 at 12:05:21PM +0000, Phil Edworthy wrote:
> Hi Geert,
> 
> On 11 July 2018 13:39, Geert Uytterhoeven wrote:
> > On Wed, Jul 11, 2018 at 2:30 PM Phil Edworthy wrote:
> > > The RZ/N1 UART is a modified Synopsys DesignWare UART.
> > > The modifications only relate to DMA so you could actually use the
> > > controller with the Synopsys compatible string if you are not using
> > > DMA, but you should not do so.
> > >
> > > Signed-off-by: Phil Edworthy <phil.edworthy@renesas.com>
> > 
> > Thanks for your patch!
> > 
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/serial/renesas,rzn1-uart.txt
> > > @@ -0,0 +1,10 @@
> > > +Renesas RZ/N1 UART
> > > +
> > > +This controller is based on the Synopsys DesignWare ABP UART and
> > > +inherits all properties defined in snps-dw-apb-uart.txt except for the
> > compatible property.
> > > +
> > > +Required properties:
> > > +- compatible : The device specific string followed by the generic RZ/N1
> > string.
> > > +   Therefore it must be one of:
> > > +   "renesas,uart-r9a06g032", "renesas,uart-rzn1"
> > 
> > "renesas,r9a06g032-uart", "renesas,rzn1-uart"
> > 
> > > +   "renesas,uart-r9a06g033", "renesas,uart-rzn1"
> > 
> > "renesas,r9a06g033-uart", "renesas,rzn1-uart"
> I followed the renesas convention of renesas,peripheral-device that is used for
> most R-Car drivers, but happy to change.

Please do. The "Renesas convention" is a hold over from early work on
DT bindings. The format Geert describes is now preferred.

> > I assume you plan to describe the DMA-related properties later?
> Yes, it will take a while to sort out.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/Documentation/devicetree/bindings/serial/renesas,rzn1-uart.txt b/Documentation/devicetree/bindings/serial/renesas,rzn1-uart.txt
new file mode 100644
index 0000000..4d40587
--- /dev/null
+++ b/Documentation/devicetree/bindings/serial/renesas,rzn1-uart.txt
@@ -0,0 +1,10 @@ 
+Renesas RZ/N1 UART
+
+This controller is based on the Synopsys DesignWare ABP UART and inherits all
+properties defined in snps-dw-apb-uart.txt except for the compatible property.
+
+Required properties:
+- compatible : The device specific string followed by the generic RZ/N1 string.
+   Therefore it must be one of:
+   "renesas,uart-r9a06g032", "renesas,uart-rzn1"
+   "renesas,uart-r9a06g033", "renesas,uart-rzn1"