[PATCH] [linux][master][v1] devicetree: misc: Add binding for logicoreIP xlnx,vcu

[PATCH] [linux][master][v1] devicetree: misc: Add binding for logicoreIP xlnx,vcu

[Dhaval Shah]

From: Dhaval Shah <dhaval.shah-gjFFaj9aHVfQT0dZR+AlfA@public.gmane.org>

Added the txt file which contain the xlnx,vcu DT node
properties information. This also provides the information
of it's child node as well.

Signed-off-by: Dhaval Shah <dshah-gjFFaj9aHVfQT0dZR+AlfA@public.gmane.org>
---
 .../devicetree/bindings/misc/xlnx,vcu.txt          | 59 ++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/misc/xlnx,vcu.txt

diff --git a/Documentation/devicetree/bindings/misc/xlnx,vcu.txt b/Documentation/devicetree/bindings/misc/xlnx,vcu.txt
new file mode 100644
index 0000000..e722ff3
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/xlnx,vcu.txt
@@ -0,0 +1,59 @@
+Xilinx VCU init Driver
+-----------------------------
+
+General concept
+---------------
+
+Xilinx VCU init driver is developed to handle the LogiCore related
+new implementation. In this directory, The DT node of the Xilinx
+VCU init driver represents as a top level node.
+
+Required properties:
+- compatible: Must be "xlnx,vcu".
+- reg, reg-names: There are two sets of registers need to provide.
+	1. vcu slcr
+	2. Logicore
+	reg-names should contain name for the each register sequence.
+- clocks: phandle for aclk and pll_ref clocksource
+- clock-names: The identification string, "aclk", is always required for
+   the axi clock. "pll_ref" is required for pll.
+- ranges
+- VCU Init driver node define the following child nodes:
+	* Allegro encoder driver node
+		- compatible: Must be "al,al5e"
+		- reg: There is a one set of register.
+		- interrupts: interrupt number to the cpu.
+		- interrupt-parent: the phandle for the interrupt controller
+		  that services interrupts for this device.
+	* Allegro decoder driver node
+		- compatible: Must be "al,al5d"
+		- reg: There is a one set of register.
+		- interrupts: interrupt number to the cpu.
+		- interrupt-parent: the phandle for the interrupt controller
+		  that services interrupts for this device.
+Example:
+
+	xlnx_vcu: vcu@a0040000 {
+		compatible = "xlnx,vcu";
+		#address-cells = <2>;
+		#size-cells = <2>;
+		reg = <0x0 0xa0040000 0x0 0x1000>,
+			 <0x0 0xa0041000 0x0 0x1000>;
+		reg-names = "vcu_slcr", "logicore";
+		clocks = <&si570_1>, <&clkc 71>;
+		clock-names = "pll_ref", "aclk";
+		ranges;
+		encoder: al5e@a0000000 {
+			compatible = "al,al5e";
+			reg = <0x0 0xa0000000 0x0 0x10000>;
+			interrupts = <0 89 4>;
+			interrupt-parent = <&gic>;
+		};
+
+		decoder: al5d@a0020000 {
+			compatible = "al,al5d";
+			reg = <0x0 0xa0020000 0x0 0x10000>;
+			interrupts = <0 89 4>;
+			interrupt-parent = <&gic>;
+		};
+	};
-- 
2.7.4

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] [linux][master][v1] devicetree: misc: Add binding for logicoreIP xlnx,vcu

[Rob Herring]

On Tue, Dec 05, 2017 at 03:07:03AM -0800, Dhaval Shah wrote:
> From: Dhaval Shah <dhaval.shah@xilinx.com>
> 
> Added the txt file which contain the xlnx,vcu DT node
> properties information. This also provides the information
> of it's child node as well.
> 
> Signed-off-by: Dhaval Shah <dshah@xilinx.com>
> ---
>  .../devicetree/bindings/misc/xlnx,vcu.txt          | 59 ++++++++++++++++++++++
>  1 file changed, 59 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/misc/xlnx,vcu.txt
> 
> diff --git a/Documentation/devicetree/bindings/misc/xlnx,vcu.txt b/Documentation/devicetree/bindings/misc/xlnx,vcu.txt
> new file mode 100644
> index 0000000..e722ff3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/misc/xlnx,vcu.txt
> @@ -0,0 +1,59 @@
> +Xilinx VCU init Driver

Bindings don't describe drivers. Describe the h/w.

> +-----------------------------
> +
> +General concept
> +---------------
> +
> +Xilinx VCU init driver is developed to handle the LogiCore related
> +new implementation. In this directory, The DT node of the Xilinx
> +VCU init driver represents as a top level node.
> +
> +Required properties:
> +- compatible: Must be "xlnx,vcu".

Needs to be more specific.

> +- reg, reg-names: There are two sets of registers need to provide.
> +	1. vcu slcr
> +	2. Logicore
> +	reg-names should contain name for the each register sequence.
> +- clocks: phandle for aclk and pll_ref clocksource
> +- clock-names: The identification string, "aclk", is always required for
> +   the axi clock. "pll_ref" is required for pll.
> +- ranges
> +- VCU Init driver node define the following child nodes:
> +	* Allegro encoder driver node

encoder of what?

> +		- compatible: Must be "al,al5e"
> +		- reg: There is a one set of register.


> +		- interrupts: interrupt number to the cpu.
> +		- interrupt-parent: the phandle for the interrupt controller
> +		  that services interrupts for this device.
> +	* Allegro decoder driver node
> +		- compatible: Must be "al,al5d"
> +		- reg: There is a one set of register.
> +		- interrupts: interrupt number to the cpu.
> +		- interrupt-parent: the phandle for the interrupt controller
> +		  that services interrupts for this device.
> +Example:
> +
> +	xlnx_vcu: vcu@a0040000 {
> +		compatible = "xlnx,vcu";
> +		#address-cells = <2>;
> +		#size-cells = <2>;

There's no reason the child nodes need 64 bits of address or size. Use 
ranges.

> +		reg = <0x0 0xa0040000 0x0 0x1000>,
> +			 <0x0 0xa0041000 0x0 0x1000>;
> +		reg-names = "vcu_slcr", "logicore";
> +		clocks = <&si570_1>, <&clkc 71>;
> +		clock-names = "pll_ref", "aclk";
> +		ranges;
> +		encoder: al5e@a0000000 {
> +			compatible = "al,al5e";
> +			reg = <0x0 0xa0000000 0x0 0x10000>;
> +			interrupts = <0 89 4>;
> +			interrupt-parent = <&gic>;
> +		};
> +
> +		decoder: al5d@a0020000 {
> +			compatible = "al,al5d";
> +			reg = <0x0 0xa0020000 0x0 0x10000>;
> +			interrupts = <0 89 4>;

A shared interrupt? Are these really separate blocks? Seems like this 
could all be a single node.

> +			interrupt-parent = <&gic>;
> +		};
> +	};
> -- 
> 2.7.4
> 
> --
> 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

RE: [PATCH] [linux][master][v1] devicetree: misc: Add binding for logicoreIP xlnx,vcu

[Dhaval Rajeshbhai Shah]

> -----Original Message-----
> From: Rob Herring [mailto:robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org]
> Sent: Wednesday, December 06, 2017 1:49 PM
> To: Dhaval Rajeshbhai Shah <DSHAH-gjFFaj9aHVfQT0dZR+AlfA@public.gmane.org>
> Cc: mark.rutland-5wv7dgnIgG8@public.gmane.org; devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org; linux-
> kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org; michal.simek-gjFFaj9aHVfQT0dZR+AlfA@public.gmane.org; Hyun Kwon
> <hyunk-gjFFaj9aHVfQT0dZR+AlfA@public.gmane.org>; Dhaval Rajeshbhai Shah <DSHAH-gjFFaj9aHVfQT0dZR+AlfA@public.gmane.org>
> Subject: Re: [PATCH] [linux][master][v1] devicetree: misc: Add binding for
> logicoreIP xlnx,vcu
> 
> On Tue, Dec 05, 2017 at 03:07:03AM -0800, Dhaval Shah wrote:
> > From: Dhaval Shah <dhaval.shah-gjFFaj9aHVfQT0dZR+AlfA@public.gmane.org>
> >
> > Added the txt file which contain the xlnx,vcu DT node properties
> > information. This also provides the information of it's child node as
> > well.
> >
> > Signed-off-by: Dhaval Shah <dshah-gjFFaj9aHVfQT0dZR+AlfA@public.gmane.org>
> > ---
> >  .../devicetree/bindings/misc/xlnx,vcu.txt          | 59
> ++++++++++++++++++++++
> >  1 file changed, 59 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/misc/xlnx,vcu.txt
> >
> > diff --git a/Documentation/devicetree/bindings/misc/xlnx,vcu.txt
> > b/Documentation/devicetree/bindings/misc/xlnx,vcu.txt
> > new file mode 100644
> > index 0000000..e722ff3
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/misc/xlnx,vcu.txt
> > @@ -0,0 +1,59 @@
> > +Xilinx VCU init Driver
> 
> Bindings don't describe drivers. Describe the h/w.
I will take care of this.
> 
> > +-----------------------------
> > +
> > +General concept
> > +---------------
> > +
> > +Xilinx VCU init driver is developed to handle the LogiCore related
> > +new implementation. In this directory, The DT node of the Xilinx VCU
> > +init driver represents as a top level node.
> > +
> > +Required properties:
> > +- compatible: Must be "xlnx,vcu".
> 
> Needs to be more specific.
I will resolve this.
> 
> > +- reg, reg-names: There are two sets of registers need to provide.
> > +	1. vcu slcr
> > +	2. Logicore
> > +	reg-names should contain name for the each register sequence.
> > +- clocks: phandle for aclk and pll_ref clocksource
> > +- clock-names: The identification string, "aclk", is always required for
> > +   the axi clock. "pll_ref" is required for pll.
> > +- ranges
> > +- VCU Init driver node define the following child nodes:
> > +	* Allegro encoder driver node
> 
> encoder of what?
I have to remove this encoder and decoder nodes. Other team is working on that. They will extend this once they are done with encoder and decoder. 
> 
> > +		- compatible: Must be "al,al5e"
> > +		- reg: There is a one set of register.
> 
> 
> > +		- interrupts: interrupt number to the cpu.
> > +		- interrupt-parent: the phandle for the interrupt controller
> > +		  that services interrupts for this device.
> > +	* Allegro decoder driver node
> > +		- compatible: Must be "al,al5d"
> > +		- reg: There is a one set of register.
> > +		- interrupts: interrupt number to the cpu.
> > +		- interrupt-parent: the phandle for the interrupt controller
> > +		  that services interrupts for this device.
> > +Example:
> > +
> > +	xlnx_vcu: vcu@a0040000 {
> > +		compatible = "xlnx,vcu";
> > +		#address-cells = <2>;
> > +		#size-cells = <2>;
> 
> There's no reason the child nodes need 64 bits of address or size. Use ranges.
I will take care of this.
> 
> > +		reg = <0x0 0xa0040000 0x0 0x1000>,
> > +			 <0x0 0xa0041000 0x0 0x1000>;
> > +		reg-names = "vcu_slcr", "logicore";
> > +		clocks = <&si570_1>, <&clkc 71>;
> > +		clock-names = "pll_ref", "aclk";
> > +		ranges;
> > +		encoder: al5e@a0000000 {
> > +			compatible = "al,al5e";
> > +			reg = <0x0 0xa0000000 0x0 0x10000>;
> > +			interrupts = <0 89 4>;
> > +			interrupt-parent = <&gic>;
> > +		};
> > +
> > +		decoder: al5d@a0020000 {
> > +			compatible = "al,al5d";
> > +			reg = <0x0 0xa0020000 0x0 0x10000>;
> > +			interrupts = <0 89 4>;
> 
> A shared interrupt? Are these really separate blocks? Seems like this could all
> be a single node.
Based on the discussion in the misc/drivers forum, I will remove this encoder and decoder node which is of some other team working on. They will extend this once they are done with there work.
> 
> > +			interrupt-parent = <&gic>;
> > +		};
> > +	};
> > --
> > 2.7.4
> >
> > --
> > To unsubscribe from this list: send the line "unsubscribe devicetree"
> > in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More
> majordomo
> > info at  http://vger.kernel.org/majordomo-info.html
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html