diff mbox

[2/5] Documentation: Detail permitted DT properties for the imx6ul_tsc

Message ID 1437996407-27266-3-git-send-email-haibo.chen@freescale.com (mailing list archive)
State New, archived
Headers show

Commit Message

Haibo Chen July 27, 2015, 11:26 a.m. UTC
Here we apply required documentation for the imx6ul touch screen
controller driver which describe available properties and how to
use them.

Signed-off-by: Haibo Chen <haibo.chen@freescale.com>
---
 .../devicetree/bindings/input/touchscreen/imx6ul_tsc.txt   | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt

Comments

Mark Rutland July 27, 2015, 11:25 a.m. UTC | #1
On Mon, Jul 27, 2015 at 12:26:44PM +0100, Haibo Chen wrote:
> Here we apply required documentation for the imx6ul touch screen
> controller driver which describe available properties and how to
> use them.
> 
> Signed-off-by: Haibo Chen <haibo.chen@freescale.com>
> ---
>  .../devicetree/bindings/input/touchscreen/imx6ul_tsc.txt   | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt
> 
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt b/Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt
> new file mode 100644
> index 0000000..e34d752
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt
> @@ -0,0 +1,14 @@
> +* Freescale i.MX6UL Touch Controller
> +
> +Required properties:
> +- compatible: must be "fsl,imx6ul-tsc"
> +

What about all the other properties in the example?

> +Example:
> +	&tsc {
> +		pinctrl-names = "default";
> +		pinctrl-0 = <&pinctrl_tsc>;
> +		status = "okay";
> +		xnur-gpio = <&gpio1 3 GPIO_ACTIVE_HIGH>;
> +		measure_delay_time = <0xfff>;
> +		pre_charge_time = <0xffff>;

Thiose underscores should be dashes, and all the properties should be
documented.

Mark.
Haibo Chen July 28, 2015, 8:48 a.m. UTC | #2
Hi Mark,



> -----Original Message-----
> From: Mark Rutland [mailto:mark.rutland@arm.com]
> Sent: Monday, July 27, 2015 7:26 PM
> To: Chen Haibo-B51421
> Cc: robh+dt@kernel.org; Pawel Moll; ijc+devicetree@hellion.org.uk;
> galak@codeaurora.org; shawnguo@kernel.org; kernel@pengutronix.de;
> linux@arm.linux.org.uk; dmitry.torokhov@gmail.com; hans.verkuil@cisco.com;
> hadess@hadess.net; mchehab@osg.samsung.com; mamlinav@gmail.com;
> arnd@arndb.de; jonathar@broadcom.com; hdegoede@redhat.com;
> christian.gmeiner@gmail.com; scott.liu@emc.com.tw; geert@linux-m68k.org;
> benjamin.tissoires@redhat.com; sebastien.szymanski@armadeus.com;
> sbranden@broadcom.com; devicetree@vger.kernel.org; linux-
> kernel@vger.kernel.org; linux-arm-kernel@lists.infradead.org; linux-
> input@vger.kernel.org
> Subject: Re: [PATCH 2/5] Documentation: Detail permitted DT properties
> for the imx6ul_tsc
> 
> On Mon, Jul 27, 2015 at 12:26:44PM +0100, Haibo Chen wrote:
> > Here we apply required documentation for the imx6ul touch screen
> > controller driver which describe available properties and how to use
> > them.
> >
> > Signed-off-by: Haibo Chen <haibo.chen@freescale.com>
> > ---
> >  .../devicetree/bindings/input/touchscreen/imx6ul_tsc.txt   | 14
> ++++++++++++++
> >  1 file changed, 14 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt
> >
> > diff --git
> > a/Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt
> > b/Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt
> > new file mode 100644
> > index 0000000..e34d752
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.t
> > +++ xt
> > @@ -0,0 +1,14 @@
> > +* Freescale i.MX6UL Touch Controller
> > +
> > +Required properties:
> > +- compatible: must be "fsl,imx6ul-tsc"
> > +
> 
> What about all the other properties in the example?

[haibo] I will add other properties in the documentation. 

> 
> > +Example:
> > +	&tsc {
> > +		pinctrl-names = "default";
> > +		pinctrl-0 = <&pinctrl_tsc>;
> > +		status = "okay";
> > +		xnur-gpio = <&gpio1 3 GPIO_ACTIVE_HIGH>;
> > +		measure_delay_time = <0xfff>;
> > +		pre_charge_time = <0xffff>;
> 
> Thiose underscores should be dashes, and all the properties should be
> documented.

[haibo] I will change to "measure-delay-time" and "pre-charge-time"

Thanks for your review!

Haibo.

> 
> Mark.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt b/Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt
new file mode 100644
index 0000000..e34d752
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/touchscreen/imx6ul_tsc.txt
@@ -0,0 +1,14 @@ 
+* Freescale i.MX6UL Touch Controller
+
+Required properties:
+- compatible: must be "fsl,imx6ul-tsc"
+
+Example:
+	&tsc {
+		pinctrl-names = "default";
+		pinctrl-0 = <&pinctrl_tsc>;
+		status = "okay";
+		xnur-gpio = <&gpio1 3 GPIO_ACTIVE_HIGH>;
+		measure_delay_time = <0xfff>;
+		pre_charge_time = <0xffff>;
+	};