[PATCH] input: ti_am33x_tsc: make the documentation for the ti,wire-config parameter clear

[PATCH] input: ti_am33x_tsc: make the documentation for the ti,wire-config parameter clear

[Sebastian Andrzej Siewior]

The document says "first four bits" and means the upper nibble. Most
people would probably agree that the first four bits are bits 0…3 and
that is the lower nibble.
This patch updates the documentation so it is clear what is meant.

Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
---
 Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt b/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
index 491c97b..0fcd430 100644
--- a/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
+++ b/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
@@ -17,8 +17,8 @@
 				remaining 4 can be used by the ADC.
 	ti,wire-config: Different boards could have a different order for
 			connecting wires on touchscreen. We need to provide an
-			8 bit number where in the 1st four bits represent the
-			analog lines and the next 4 bits represent positive/
+			8 bit number where the upper nibble represent the
+			analog lines and the lower nibble represent positive/
 			negative terminal on that input line. Notations to
 			represent the input lines and terminals resoectively
 			is as follows:
-- 
1.8.4.2

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

Re: [PATCH] input: ti_am33x_tsc: make the documentation for the ti,wire-config parameter clear

[Kumar Gala]

On Nov 12, 2013, at 10:22 AM, Sebastian Andrzej Siewior <bigeasy@linutronix.de> wrote:

> The document says "first four bits" and means the upper nibble. Most
> people would probably agree that the first four bits are bits 0…3 and
> that is the lower nibble.
> This patch updates the documentation so it is clear what is meant.
> 
> Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
> ---
> Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt b/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
> index 491c97b..0fcd430 100644
> --- a/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
> +++ b/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
> @@ -17,8 +17,8 @@
> 				remaining 4 can be used by the ADC.
> 	ti,wire-config: Different boards could have a different order for
> 			connecting wires on touchscreen. We need to provide an
> -			8 bit number where in the 1st four bits represent the
> -			analog lines and the next 4 bits represent positive/
> +			8 bit number where the upper nibble represent the
> +			analog lines and the lower nibble represent positive/
> 			negative terminal on that input line. Notations to
> 			represent the input lines and terminals resoectively
> 			is as follows:

Is it possible to give an example because that might help with the confusion.

- k

> -- 
> 1.8.4.2
> 
> --
> 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

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

Re: [PATCH] input: ti_am33x_tsc: make the documentation for the ti,wire-config parameter clear

[Andrey Moiseev]

Maybe "most/least significant" is more clear. Everyone got used to
little-endian, anyway.

On Tue, Nov 12, 2013 at 8:22 PM, Sebastian Andrzej Siewior
<bigeasy-hfZtesqFncYOwBW4kG4KsQ@public.gmane.org> wrote:
> The document says "first four bits" and means the upper nibble. Most
> people would probably agree that the first four bits are bits 0…3 and
> that is the lower nibble.
> This patch updates the documentation so it is clear what is meant.
>
> Signed-off-by: Sebastian Andrzej Siewior <bigeasy-hfZtesqFncYOwBW4kG4KsQ@public.gmane.org>
> ---
>  Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt b/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
> index 491c97b..0fcd430 100644
> --- a/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
> +++ b/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
> @@ -17,8 +17,8 @@
>                                 remaining 4 can be used by the ADC.
>         ti,wire-config: Different boards could have a different order for
>                         connecting wires on touchscreen. We need to provide an
> -                       8 bit number where in the 1st four bits represent the
> -                       analog lines and the next 4 bits represent positive/
> +                       8 bit number where the upper nibble represent the
> +                       analog lines and the lower nibble represent positive/
>                         negative terminal on that input line. Notations to
>                         represent the input lines and terminals resoectively
>                         is as follows:
> --
> 1.8.4.2
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-input" 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

[PATCH v2] input: ti_am33x_tsc: make the documentation for the ti,wire-config parameter clear

[Sebastian Andrzej Siewior]

The document says "first four bits" and means the upper nibble. Most
people would probably agree that the first four bits are bits 0…3 and
that is the lower nibble.
This patch updates the documentation so it is clear what is meant.

Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
---
v1…v2:
	- use most/least significant instead of upper/ lower nibble
	- add an example.

 .../devicetree/bindings/input/touchscreen/ti-tsc-adc.txt    | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt b/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
index 491c97b..b25a2fe 100644
--- a/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
+++ b/Documentation/devicetree/bindings/input/touchscreen/ti-tsc-adc.txt
@@ -17,13 +17,16 @@
 				remaining 4 can be used by the ADC.
 	ti,wire-config: Different boards could have a different order for
 			connecting wires on touchscreen. We need to provide an
-			8 bit number where in the 1st four bits represent the
-			analog lines and the next 4 bits represent positive/
-			negative terminal on that input line. Notations to
-			represent the input lines and terminals resoectively
-			is as follows:
+			8 bit number where the most significant nibble represent
+			the analog lines and the least significant nibble
+			represent positive/ negative terminal on that input
+			line. Notations to represent the input lines and
+			terminals resoectively is as follows:
 			AIN0 = 0, AIN1 = 1 and so on till AIN7 = 7.
 			XP  = 0, XN = 1, YP = 2, YN = 3.
+
+			Example: ti,wire-config = <0x71>;
+			=> line AIN7, configuration XN
 - child "adc"
 	ti,adc-channels: List of analog inputs available for ADC.
 			 AIN0 = 0, AIN1 = 1 and so on till AIN7 = 7.
-- 
1.8.4.2

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

Re: [PATCH v2] input: ti_am33x_tsc: make the documentation for the ti,wire-config parameter clear

[Kumar Gala]

On Nov 12, 2013, at 11:40 AM, Sebastian Andrzej Siewior <bigeasy@linutronix.de> wrote:

> The document says "first four bits" and means the upper nibble. Most
> people would probably agree that the first four bits are bits 0…3 and
> that is the lower nibble.
> This patch updates the documentation so it is clear what is meant.
> 
> Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
> ---
> v1…v2:
> 	- use most/least significant instead of upper/ lower nibble
> 	- add an example.
> 
> .../devicetree/bindings/input/touchscreen/ti-tsc-adc.txt    | 13 ++++++++-----
> 1 file changed, 8 insertions(+), 5 deletions(-)

Thanks

Acked-by: Kumar Gala <galak@codeaurora.org>

- k

-- 
Employee of Qualcomm Innovation Center, Inc.
Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum, hosted by The Linux Foundation

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

Re: [PATCH v2] input: ti_am33x_tsc: make the documentation for the ti,wire-config parameter clear

[Grant Likely]

On Tue, 12 Nov 2013 12:26:14 -0600, Kumar Gala <galak@codeaurora.org> wrote:
> 
> On Nov 12, 2013, at 11:40 AM, Sebastian Andrzej Siewior <bigeasy@linutronix.de> wrote:
> 
> > The document says "first four bits" and means the upper nibble. Most
> > people would probably agree that the first four bits are bits 0…3 and
> > that is the lower nibble.
> > This patch updates the documentation so it is clear what is meant.
> > 
> > Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
> > ---
> > v1…v2:
> > 	- use most/least significant instead of upper/ lower nibble
> > 	- add an example.
> > 
> > .../devicetree/bindings/input/touchscreen/ti-tsc-adc.txt    | 13 ++++++++-----
> > 1 file changed, 8 insertions(+), 5 deletions(-)
> 
> Thanks
> 
> Acked-by: Kumar Gala <galak@codeaurora.org>

Kumar, for patches like this, do you want to put them into a git tree
instead of acking? It will help spread the load.

g.

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