[v7,2/2] dt-bindings: spi: Document Renesas R-Car Gen3 RPC-IF controller bindings
diff mbox series

Message ID 1548227352-14910-3-git-send-email-masonccyang@mxic.com.tw
State Superseded
Delegated to: Geert Uytterhoeven
Headers show
Series
  • spi: Add Renesas R-Car Gen3 RPC-IF SPI driver
Related show

Commit Message

Mason Yang Jan. 23, 2019, 7:09 a.m. UTC
Document the bindings used by the Renesas R-Car Gen3 RPC-IF controller.

Signed-off-by: Mason Yang <masonccyang@mxic.com.tw>
---
 .../devicetree/bindings/spi/spi-renesas-rpc.txt    | 46 ++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt

Comments

Sergei Shtylyov Jan. 23, 2019, 6:06 p.m. UTC | #1
On 01/23/2019 10:09 AM, Mason Yang wrote:

> Document the bindings used by the Renesas R-Car Gen3 RPC-IF controller.
> 
> Signed-off-by: Mason Yang <masonccyang@mxic.com.tw>
> ---
>  .../devicetree/bindings/spi/spi-renesas-rpc.txt    | 46 ++++++++++++++++++++++
>  1 file changed, 46 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt
> 
> diff --git a/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt b/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt
> new file mode 100644
> index 0000000..305bd10
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt
> @@ -0,0 +1,46 @@
> +Renesas R-Car Gen3 RPC-IF controller Device Tree Bindings
> +--------------------------------------------------------------------
> +
> +Required properties:
> +- compatible: should be an SoC-specific compatible value, followed by
> +		"renesas,rcar-gen3-rpc" as a fallback, i.e.,
> +		"renesas,r8a77995-rpc", "renesas,rcar-gen3-rpc".
> +		"renesas,r8a7795-rpc"	(R-Car H3)
> +		"renesas,r8a7796-rpc"	(R-Car M3-W)
> +		"renesas,r8a77965-rpc"	(R-Car M3-N)
> +		"renesas,r8a77970-rpc"	(R-Car V3M)
> +		"renesas,r8a77980-rpc"	(R-Car V3H)
> +		"renesas,r8a77990-rpc"	(R-Car E3)
> +		"renesas,r8a77995-rpc"	(R-Car D3)
> +- reg: should contain three register areas:

   The driver now handles "dirmap" and "wbuf" resources as optional --
you need to document that.

[...]

MBR, Sergei
Marek Vasut Jan. 24, 2019, 1:53 a.m. UTC | #2
On 1/23/19 8:09 AM, Mason Yang wrote:
> Document the bindings used by the Renesas R-Car Gen3 RPC-IF controller.
> 
> Signed-off-by: Mason Yang <masonccyang@mxic.com.tw>
> ---
>  .../devicetree/bindings/spi/spi-renesas-rpc.txt    | 46 ++++++++++++++++++++++
>  1 file changed, 46 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt
> 
> diff --git a/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt b/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt
> new file mode 100644
> index 0000000..305bd10
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt
> @@ -0,0 +1,46 @@
> +Renesas R-Car Gen3 RPC-IF controller Device Tree Bindings
> +--------------------------------------------------------------------
> +
> +Required properties:
> +- compatible: should be an SoC-specific compatible value, followed by
> +		"renesas,rcar-gen3-rpc" as a fallback, i.e.,
> +		"renesas,r8a77995-rpc", "renesas,rcar-gen3-rpc".
> +		"renesas,r8a7795-rpc"	(R-Car H3)
> +		"renesas,r8a7796-rpc"	(R-Car M3-W)
> +		"renesas,r8a77965-rpc"	(R-Car M3-N)
> +		"renesas,r8a77970-rpc"	(R-Car V3M)
> +		"renesas,r8a77980-rpc"	(R-Car V3H)
> +		"renesas,r8a77990-rpc"	(R-Car E3)
> +		"renesas,r8a77995-rpc"	(R-Car D3)

Was it tested on all of those SoCs and do we already handle all the
quirks of those ?

> +- reg: should contain three register areas:
> +	first for the base address of rpc-if registers,
> +	second for the direct mapping read mode and
> +	third for the write buffer area.
> +- reg-names: should contain "regs", "dirmap" and "wbuf"
> +- clocks: should contain 1 entries for the module's clock
> +- clock-names: should contain "rpc"
> +- #address-cells: should be 1
> +- #size-cells: should be 0
> +
> +Example:
> +
> +	rpc: rpc@ee200000 {
> +		compatible = "renesas,r8a77995-rpc", "renesas,rcar-gen3-rpc";
> +		reg = <0 0xee200000 0 0x200>, <0 0x08000000 0 0x4000000>,
> +		      <0 0xee208000 0 0x100>;
> +		reg-names = "regs", "dirmap", "wbuf";
> +		clocks = <&cpg CPG_MOD 917>;
> +		clock-names = "rpc";
> +		power-domains = <&sysc R8A77995_PD_ALWAYS_ON>;
> +		resets = <&cpg 917>;
> +		#address-cells = <1>;
> +		#size-cells = <0>;
> +
> +		flash@0 {
> +			compatible = "jedec,spi-nor";
> +			reg = <0>;
> +			spi-max-frequency = <40000000>;
> +			spi-tx-bus-width = <1>;
> +			spi-rx-bus-width = <1>;

Is the bus width really 1 or is it 4 on the D3 ?

> +		};
> +	};
>
Sergei Shtylyov Jan. 24, 2019, 8:16 a.m. UTC | #3
On 24.01.2019 4:40, masonccyang@mxic.com.tw wrote:

>  > > @@ -0,0 +1,46 @@
>  > > +Renesas R-Car Gen3 RPC-IF controller Device Tree Bindings
>  > > +--------------------------------------------------------------------
>  > > +
>  > > +Required properties:
>  > > +- compatible: should be an SoC-specific compatible value, followed by
>  > > +      "renesas,rcar-gen3-rpc" as a fallback, i.e.,
>  > > +      "renesas,r8a77995-rpc", "renesas,rcar-gen3-rpc".
>  > > +      "renesas,r8a7795-rpc" (R-Car H3)
>  > > +      "renesas,r8a7796-rpc" (R-Car M3-W)
>  > > +      "renesas,r8a77965-rpc" (R-Car M3-N)
>  > > +      "renesas,r8a77970-rpc" (R-Car V3M)
>  > > +      "renesas,r8a77980-rpc" (R-Car V3H)
>  > > +      "renesas,r8a77990-rpc" (R-Car E3)
>  > > +      "renesas,r8a77995-rpc" (R-Car D3)
>  > > +- reg: should contain three register areas:
>  >
>  >    The driver now handles "dirmap" and "wbuf" resources as optional --
>  > you need to document that.
>  >
> 
> Why ?

    Because the driver treats "dirmap" and "wbuf" as optional resources.

[...]

> best regards,
> Mason

MBR, Sergei
Geert Uytterhoeven Jan. 24, 2019, 9:06 a.m. UTC | #4
Hi Mason,

On Thu, Jan 24, 2019 at 3:39 AM <masonccyang@mxic.com.tw> wrote:
> > "Marek Vasut" <marek.vasut@gmail.com>
> > 2019/01/24 上午 09:54
> > >
> > > diff --git a/Documentation/devicetree/bindings/spi/spi-renesas-
> > rpc.txt b/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt
> > > new file mode 100644
> > > index 0000000..305bd10
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt
> > > @@ -0,0 +1,46 @@
> > > +Renesas R-Car Gen3 RPC-IF controller Device Tree Bindings
> > > +--------------------------------------------------------------------
> > > +
> > > +Required properties:
> > > +- compatible: should be an SoC-specific compatible value, followed by
> > > +      "renesas,rcar-gen3-rpc" as a fallback, i.e.,
> > > +      "renesas,r8a77995-rpc", "renesas,rcar-gen3-rpc".
> > > +      "renesas,r8a7795-rpc"   (R-Car H3)
> > > +      "renesas,r8a7796-rpc"   (R-Car M3-W)
> > > +      "renesas,r8a77965-rpc"   (R-Car M3-N)
> > > +      "renesas,r8a77970-rpc"   (R-Car V3M)
> > > +      "renesas,r8a77980-rpc"   (R-Car V3H)
> > > +      "renesas,r8a77990-rpc"   (R-Car E3)
> > > +      "renesas,r8a77995-rpc"   (R-Car D3)
> >
> > Was it tested on all of those SoCs and do we already handle all the
> > quirks of those ?
>
> These are R-Car Gen3 series and I list these by Geert's comments,
> or I misunderstand Geert's comments ?

I think you misunderstood. Typically we only list the SoC-specific
compatible values for SoCs that have been tested with the driver.
So for now I'd go with:

    - compatible: should be an SoC-specific compatible value, followed by
                  "renesas,rcar-gen3-rpc" as a fallback.
                  Supported SoC-specific values are:
                    - "renesas,r8a77995-rpc"   (R-Car D3)

The list can be extended when the driver has been tested/enhanced to
support more SoC types.

Does that sound OK?
Thanks!

Gr{oetje,eeting}s,

                        Geert

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt b/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt
new file mode 100644
index 0000000..305bd10
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/spi-renesas-rpc.txt
@@ -0,0 +1,46 @@ 
+Renesas R-Car Gen3 RPC-IF controller Device Tree Bindings
+--------------------------------------------------------------------
+
+Required properties:
+- compatible: should be an SoC-specific compatible value, followed by
+		"renesas,rcar-gen3-rpc" as a fallback, i.e.,
+		"renesas,r8a77995-rpc", "renesas,rcar-gen3-rpc".
+		"renesas,r8a7795-rpc"	(R-Car H3)
+		"renesas,r8a7796-rpc"	(R-Car M3-W)
+		"renesas,r8a77965-rpc"	(R-Car M3-N)
+		"renesas,r8a77970-rpc"	(R-Car V3M)
+		"renesas,r8a77980-rpc"	(R-Car V3H)
+		"renesas,r8a77990-rpc"	(R-Car E3)
+		"renesas,r8a77995-rpc"	(R-Car D3)
+- reg: should contain three register areas:
+	first for the base address of rpc-if registers,
+	second for the direct mapping read mode and
+	third for the write buffer area.
+- reg-names: should contain "regs", "dirmap" and "wbuf"
+- clocks: should contain 1 entries for the module's clock
+- clock-names: should contain "rpc"
+- #address-cells: should be 1
+- #size-cells: should be 0
+
+Example:
+
+	rpc: rpc@ee200000 {
+		compatible = "renesas,r8a77995-rpc", "renesas,rcar-gen3-rpc";
+		reg = <0 0xee200000 0 0x200>, <0 0x08000000 0 0x4000000>,
+		      <0 0xee208000 0 0x100>;
+		reg-names = "regs", "dirmap", "wbuf";
+		clocks = <&cpg CPG_MOD 917>;
+		clock-names = "rpc";
+		power-domains = <&sysc R8A77995_PD_ALWAYS_ON>;
+		resets = <&cpg 917>;
+		#address-cells = <1>;
+		#size-cells = <0>;
+
+		flash@0 {
+			compatible = "jedec,spi-nor";
+			reg = <0>;
+			spi-max-frequency = <40000000>;
+			spi-tx-bus-width = <1>;
+			spi-rx-bus-width = <1>;
+		};
+	};