2006-12-15 15:16:57

by Nicolas Ferre

[permalink] [raw]
Subject: [PATCH] input/spi: add ads7843 support to ads7846 touchscreen driver

Add support for the ads7843 touchscreen controller to the ads7846
driver code.
The "pen down" information is managed quite differently as we
do not have a touch-pressure measurement on the ads7843.

Signed-off-by: Nicolas Ferre <[email protected]>
---

I add a ads7843_rx function to manage the end of a measurement cycle.
As for ads7846_rx, it does the real work and communicates with the
input subsystem.
The timer function is responsible of taking the pen up/pen down state
through the board specific get_pendown_state() callback.

As the SPI underlying code behaves quite differently from a controller
driver to another while not having a tx_buf filled, I have add a
zeroed buffer to give to the SPI layer while receiving data.

===================================================================
--- a/input/touchscreen/ads7846.c (.../linux-2.6.19-at91/drivers) (revision 634)
+++ b/input/touchscreen/ads7846.c (.../linux-2.6.19-atmel-devel/drivers) (revision 634)
@@ -4,6 +4,7 @@
* Copyright (c) 2005 David Brownell
* Copyright (c) 2006 Nokia Corporation
* Various changes: Imre Deak <[email protected]>
+ * Ads7843 support: Atmel, Nicolas Ferre <[email protected]>
*
* Using code from:
* - corgi_ts.c
@@ -38,7 +39,8 @@
/*
* This code has been heavily tested on a Nokia 770, and lightly
* tested on other ads7846 devices (OSK/Mistral, Lubbock).
- * Support for ads7843 and ads7845 has only been stubbed in.
+ * Support for ads7843 tested on Atmel at91sam926x-EK.
+ * Support for ads7845 has only been stubbed in.
*
* IRQ handling needs a workaround because of a shortcoming in handling
* edge triggered IRQs on some platforms like the OMAP1/2. These
@@ -82,6 +84,7 @@ struct ads7846 {
u16 pressure_max;

u8 read_x, read_y, read_z1, read_z2, pwrdown;
+ u16 zerro; /* to send zerros while receiving */
u16 dummy; /* for the pwrdown read */
struct ts_event tc;

@@ -151,6 +154,10 @@ struct ads7846 {
#define READ_X (READ_12BIT_DFR(x) | ADS_PD10_ADC_ON)
#define PWRDOWN (READ_12BIT_DFR(y) | ADS_PD10_PDOWN) /* LAST */

+/* alternate ads7843 commands */
+#define ALT_READ_Y (READ_12BIT_DFR(y) | ADS_PD10_ALL_ON)
+#define ALT_READ_X (READ_12BIT_DFR(x) | ADS_PD10_ALL_ON)
+
/* single-ended samples need to first power up reference voltage;
* we leave both ADC and VREF powered
*/
@@ -171,6 +178,7 @@ struct ser_req {
u8 command;
u8 ref_off;
u16 scratch;
+ u16 zerro;
__be16 sample;
struct spi_message msg;
struct spi_transfer xfer[6];
@@ -203,6 +211,7 @@ static int ads7846_read12_ser(struct dev
req->ref_on = REF_ON;
req->xfer[0].tx_buf = &req->ref_on;
req->xfer[0].len = 1;
+ req->xfer[1].tx_buf = &req->zerro;
req->xfer[1].rx_buf = &req->scratch;
req->xfer[1].len = 2;

@@ -217,6 +226,7 @@ static int ads7846_read12_ser(struct dev
req->command = (u8) command;
req->xfer[2].tx_buf = &req->command;
req->xfer[2].len = 1;
+ req->xfer[3].tx_buf = &req->zerro;
req->xfer[3].rx_buf = &req->sample;
req->xfer[3].len = 2;

@@ -226,6 +236,7 @@ static int ads7846_read12_ser(struct dev
req->ref_off = REF_OFF;
req->xfer[4].tx_buf = &req->ref_off;
req->xfer[4].len = 1;
+ req->xfer[3].tx_buf = &req->zerro;
req->xfer[5].rx_buf = &req->scratch;
req->xfer[5].len = 2;

@@ -410,6 +421,50 @@ static void ads7846_rx(void *ads)
spin_unlock_irqrestore(&ts->lock, flags);
}

+static void ads7843_rx(void *ads)
+{
+ struct ads7846 *ts = ads;
+ struct input_dev *input_dev = ts->input;
+ u16 x, y;
+ unsigned long flags;
+
+
+ /* adjust: on-wire is a must-ignore bit, a BE12 value, then padding;
+ * built from two 8 bit values written msb-first.
+ */
+ x = (be16_to_cpu(ts->tc.x) >> 3) & 0x0fff;
+ y = (be16_to_cpu(ts->tc.y) >> 3) & 0x0fff;
+
+ /* range filtering */
+ if (x == MAX_12BIT)
+ x = 0;
+
+ if (ts->pendown) {
+ input_report_key(input_dev, BTN_TOUCH, 1);
+ input_report_abs(input_dev, ABS_PRESSURE, ts->pressure_max / 2);
+ input_report_abs(input_dev, ABS_X, x);
+ input_report_abs(input_dev, ABS_Y, y);
+ } else {
+ input_report_key(input_dev, BTN_TOUCH, 0);
+ input_report_abs(input_dev, ABS_PRESSURE, 0);
+ }
+
+ input_sync(input_dev);
+
+#ifdef VERBOSE
+ pr_debug("%s: %d/%d%s\n", ts->spi->dev.bus_id,
+ x, y, ts->pendown ? "" : " UP");
+#endif
+
+ if (ts->pendown) {
+ spin_lock_irqsave(&ts->lock, flags);
+
+ mod_timer(&ts->timer, jiffies + TS_POLL_PERIOD);
+
+ spin_unlock_irqrestore(&ts->lock, flags);
+ }
+}
+
static void ads7846_debounce(void *ads)
{
struct ads7846 *ts = ads;
@@ -465,11 +520,25 @@ static void ads7846_timer(unsigned long
{
struct ads7846 *ts = (void *)handle;
int status = 0;
+ int alt_end_cycle = 0; /* ads7843 alternative cycle end */
+
+ if (ts->model == 7843) {
+ /* get sample */
+ ts->pendown = ts->get_pendown_state();
+ alt_end_cycle = ts->pending;
+ }

spin_lock_irq(&ts->lock);

- if (unlikely(ts->msg_idx && !ts->pendown)) {
+ if (unlikely(!ts->pendown && (ts->msg_idx || alt_end_cycle))) {
/* measurement cycle ended */
+ if (ts->model == 7843) {
+ status = spi_async(ts->spi, ts->last_msg);
+ if (status)
+ dev_err(&ts->spi->dev,
+ "spi_async --> %d\n", status);
+ }
+
if (!device_suspended(&ts->spi->dev)) {
ts->irq_disabled = 0;
enable_irq(ts->spi->irq);
@@ -684,12 +753,17 @@ static int __devinit ads7846_probe(struc
spi_message_init(m);

/* y- still on; turn on only y+ (and ADC) */
- ts->read_y = READ_Y;
+ if (ts->model == 7843) {
+ ts->read_y = ALT_READ_Y;
+ } else {
+ ts->read_y = READ_Y;
+ }
x->tx_buf = &ts->read_y;
x->len = 1;
spi_message_add_tail(x, m);

x++;
+ x->tx_buf = &ts->zerro;
x->rx_buf = &ts->tc.y;
x->len = 2;
spi_message_add_tail(x, m);
@@ -702,12 +776,17 @@ static int __devinit ads7846_probe(struc

/* turn y- off, x+ on, then leave in lowpower */
x++;
- ts->read_x = READ_X;
+ if (ts->model == 7843) {
+ ts->read_x = ALT_READ_X;
+ } else {
+ ts->read_x = READ_X;
+ }
x->tx_buf = &ts->read_x;
x->len = 1;
spi_message_add_tail(x, m);

x++;
+ x->tx_buf = &ts->zerro;
x->rx_buf = &ts->tc.x;
x->len = 2;
spi_message_add_tail(x, m);
@@ -763,12 +842,17 @@ static int __devinit ads7846_probe(struc
spi_message_add_tail(x, m);

x++;
+ x->tx_buf = &ts->zerro;
x->rx_buf = &ts->dummy;
x->len = 2;
CS_CHANGE(*x);
spi_message_add_tail(x, m);

- m->complete = ads7846_rx;
+ if (ts->model == 7843) {
+ m->complete = ads7843_rx;
+ } else {
+ m->complete = ads7846_rx;
+ }
m->context = ts;

ts->last_msg = m;
@@ -782,11 +866,16 @@ static int __devinit ads7846_probe(struc

dev_info(&spi->dev, "touchscreen, irq %d\n", spi->irq);

- /* take a first sample, leaving nPENIRQ active; avoid
- * the touchscreen, in case it's not connected.
- */
- (void) ads7846_read12_ser(&spi->dev,
- READ_12BIT_SER(vaux) | ADS_PD10_ALL_ON);
+ if (ts->model != 7843) {
+ /* take a first sample, leaving nPENIRQ active; avoid
+ * the touchscreen, in case it's not connected.
+ */
+ (void) ads7846_read12_ser(&spi->dev,
+ READ_12BIT_SER(vaux) | ADS_PD10_ALL_ON);
+ } else {
+ (void) ads7846_read12_ser(&spi->dev,
+ READ_12BIT_DFR(y) | ADS_PD10_ALL_ON);
+ }

/* ads7843/7845 don't have temperature sensors, and
* use the other sensors a bit differently too
@@ -795,12 +884,14 @@ static int __devinit ads7846_probe(struc
device_create_file(&spi->dev, &dev_attr_temp0);
device_create_file(&spi->dev, &dev_attr_temp1);
}
- if (ts->model != 7845)
+ if (ts->model != 7845 && ts->model != 7843)
device_create_file(&spi->dev, &dev_attr_vbatt);
- device_create_file(&spi->dev, &dev_attr_vaux);

- device_create_file(&spi->dev, &dev_attr_pen_down);
+ if (ts->model != 7843) {
+ device_create_file(&spi->dev, &dev_attr_vaux);
+ }

+ device_create_file(&spi->dev, &dev_attr_pen_down);
device_create_file(&spi->dev, &dev_attr_disable);

err = input_register_device(input_dev);
@@ -816,9 +907,12 @@ static int __devinit ads7846_probe(struc
device_remove_file(&spi->dev, &dev_attr_temp1);
device_remove_file(&spi->dev, &dev_attr_temp0);
}
- if (ts->model != 7845)
+ if (ts->model != 7845 && ts->model != 7843)
device_remove_file(&spi->dev, &dev_attr_vbatt);
- device_remove_file(&spi->dev, &dev_attr_vaux);
+
+ if (ts->model != 7843) {
+ device_remove_file(&spi->dev, &dev_attr_vaux);
+ }

free_irq(spi->irq, ts);
err_free_mem:
@@ -841,9 +935,12 @@ static int __devexit ads7846_remove(stru
device_remove_file(&spi->dev, &dev_attr_temp1);
device_remove_file(&spi->dev, &dev_attr_temp0);
}
- if (ts->model != 7845)
+ if (ts->model != 7845 && ts->model != 7843)
device_remove_file(&spi->dev, &dev_attr_vbatt);
- device_remove_file(&spi->dev, &dev_attr_vaux);
+
+ if (ts->model != 7843) {
+ device_remove_file(&spi->dev, &dev_attr_vaux);
+ }

free_irq(ts->spi->irq, ts);
/* suspend left the IRQ disabled */



2006-12-20 22:03:13

by Andrew Morton

[permalink] [raw]
Subject: Re: [PATCH] input/spi: add ads7843 support to ads7846 touchscreen driver

On Fri, 15 Dec 2006 15:45:08 +0100
Nicolas FERRE <[email protected]> wrote:

> Add support for the ads7843 touchscreen controller to the ads7846
> driver code.

Generates a lot of errors when applied to the current mainline kernel.
Please prepare and test patches against Linus's current git tree.

> --- a/input/touchscreen/ads7846.c (.../linux-2.6.19-at91/drivers) (revision 634)
> +++ b/input/touchscreen/ads7846.c (.../linux-2.6.19-atmel-devel/drivers) (revision 634)


That should be

--- a/drivers/input/ads7846.c
+++ b/drivers/input/ads7846.c

ie: `patch -p1' form, thanks.

2006-12-20 23:13:13

by David Brownell

[permalink] [raw]
Subject: Re: [PATCH] input/spi: add ads7843 support to ads7846 touchscreen driver

On Friday 15 December 2006 7:20 am, Nicolas FERRE wrote:
> Add support for the ads7843 touchscreen controller to the ads7846 driver code.

Glad to see this! Is this for AT91sam9261-EK board support, maybe?


> The "pen down" information is managed quite differently as we do not have a
> touch-presure mesurement on the ads7843.
>
> Signed-off-by: Nicolas Ferre <[email protected]>
> ---
>
> I add a ads7843_rx function to manage the end of a measurement cycle. As for
> ads7846_rx, it does the real work and comnunicates with the input subsystem.
> The timer function is responsible of taking the pen up/pen down state through
> the board specific get_pendown_state() callback.

Hmm, unfortunately there are a lot of updates to this driver sitting in
the linux-omap tree ... the N770 guys really put a lot of solid work into
it (ISTR seeing a statistical plot showing how touchscreen debounce helps
get stable readings!), but those patches didn't get upstream yet.

One of the more critical of those patches addressed much the same pendown
state issue; it turns out that measuring pressure (after the pendown irq)
isn't the best way to notice when pen status becomes "up".

Let me try to sort out the mess with those updates, and ask you to refresh
this ads7843 support against that more-current ads7846 code. (Or if you
want a preview, have a look at the linux-omap tree. There's a clone of
that in the GIT area on kernel.org if you want.)


> As the SPI underlying code behaves quite differently from a controller driver
> to another whan not having a tx_buf filled, I have add a zerroed buffer to give
> to the spi layer while receiving data.

You must be working with a buggy controller driver then. That part of
this patch should never be needed. It's expected that rx-only transfers
will omit a tx buf; all controller drivers must handle that case.

- Dave


> Already posted to lkml :
> http://lkml.org/lkml/2006/12/15/71
>

2006-12-21 09:59:11

by Nicolas Ferre

[permalink] [raw]
Subject: Re: [PATCH] input/spi: add ads7843 support to ads7846 touchscreen driver

Andrew Morton a ?crit :
> On Fri, 15 Dec 2006 15:45:08 +0100
> Nicolas FERRE <[email protected]> wrote:
>
>> Add support for the ads7843 touchscreen controller to the ads7846
>> driver code.
>
> Generates a lot of errors when applied to the current mainline kernel.
> Please prepare and test patches against Linus's current git tree.

Hi,

David Brownell told me to take into account code written by
the omap/N770 guys.
I will then refresh my patch against those bits and produce
an up-to-date patch.

Follow-up for this thread @
http://lkml.org/lkml/2006/12/20/293

Regards,
--
Nicolas Ferre


2006-12-21 13:10:25

by Nicolas Ferre

[permalink] [raw]
Subject: Re: [PATCH] input/spi: add ads7843 support to ads7846 touchscreen driver

David Brownell a ?crit :
> On Friday 15 December 2006 7:20 am, Nicolas FERRE wrote:
>> Add support for the ads7843 touchscreen controller to the ads7846 driver code.
>
> Glad to see this! Is this for AT91sam9261-EK board support, maybe?

Indeed ! An also for the AT91sam9263-EK which has the same touchscreen chip.

> Let me try to sort out the mess with those updates, and ask you to refresh
> this ads7843 support against that more-current ads7846 code.

Ok, let me know when you have a newer code. I will try to adapt my
ads7843 support then.

>> As the SPI underlying code behaves quite differently from a controller driver
>> to another whan not having a tx_buf filled, I have add a zerroed buffer to give
>> to the spi layer while receiving data.
>
> You must be working with a buggy controller driver then. That part of
> this patch should never be needed. It's expected that rx-only transfers
> will omit a tx buf; all controller drivers must handle that case.

I said that because it is true that most of spi controller drivers
manage rx only transactions filling the tx buffer with zerros but the
spi_s3c24xx.c driver seems to fill with ones (line 177 hw_txbyte())

Anyway, I will check in our controller driver to sort this out.

Regards,
--
Nicolas Ferre



2006-12-21 14:41:55

by Nicolas Ferre

[permalink] [raw]
Subject: Re: [PATCH] input/spi: add ads7843 support to ads7846 touchscreen driver

Nicolas Ferre a ?crit :
>>> As the SPI underlying code behaves quite differently from a
>>> controller driver
>>> to another whan not having a tx_buf filled, I have add a zerroed
>>> buffer to give
>>> to the spi layer while receiving data.
>>
>> You must be working with a buggy controller driver then. That part of
>> this patch should never be needed. It's expected that rx-only transfers
>> will omit a tx buf; all controller drivers must handle that case.
>
> I said that because it is true that most of spi controller drivers
> manage rx only transactions filling the tx buffer with zerros but the
> spi_s3c24xx.c driver seems to fill with ones (line 177 hw_txbyte())
>
> Anyway, I will check in our controller driver to sort this out.

I dug a bit into this.
Well, in the atmel_spi driver code, we use previous rx buffer if we do
not provide a tx_buf (as it is said that in struct spi_transfer
comments, "If the transmit buffer is null, undefined data will be
shifted out while filling rx_buf").
So, the touchscreen controller sees sometimes a "start" condition (bit 7
of a control byte). It then takes the control byte and sets trash bits
as a configuration. I ran into those troubles and add a zerroed buffer
as tx.

Do you think that shifting zerros out when a tx_buf is not specified is
the desired behavior ?

Regards,
--
Nicolas Ferre


2006-12-22 19:31:29

by David Brownell

[permalink] [raw]
Subject: Re: [PATCH] input/spi: add ads7843 support to ads7846 touchscreen driver

On Thursday 21 December 2006 5:08 am, Nicolas Ferre wrote:

> > Let me try to sort out the mess with those updates, and ask you to refresh
> > this ads7843 support against that more-current ads7846 code.
>
> Ok, let me know when you have a newer code. I will try to adapt my
> ads7843 support then.

I just sent these updates to LKML ... though the address I had for Dmitry
sees to have gone bad, I do see all six patches in the list archives.

Now it's your turn. :)

- Dave

2006-12-22 20:06:00

by David Brownell

[permalink] [raw]
Subject: Re: [PATCH] input/spi: add ads7843 support to ads7846 touchscreen driver

On Thursday 21 December 2006 6:40 am, Nicolas Ferre wrote:
> Nicolas Ferre a ?crit :
> >>> As the SPI underlying code behaves quite differently from a
> >>> controller driver to another whan not having a tx_buf filled,
> >>> I have add a zerroed buffer to give to the spi layer while
> >>> receiving data.
> >>
> >> You must be working with a buggy controller driver then. That part of
> >> this patch should never be needed. It's expected that rx-only transfers
> >> will omit a tx buf; all controller drivers must handle that case.
> >
> > I said that because it is true that most of spi controller drivers
> > manage rx only transactions filling the tx buffer with zerros but the
> > spi_s3c24xx.c driver seems to fill with ones (line 177 hw_txbyte())
> >
> > Anyway, I will check in our controller driver to sort this out.
>
> I dug a bit into this.

I always like to see followup on such issues. :)


> Well, in the atmel_spi driver code, we use previous rx buffer if we do
> not provide a tx_buf (as it is said that in struct spi_transfer
> comments, "If the transmit buffer is null, undefined data will be
> shifted out while filling rx_buf").

That seems like a reasonable approach. If it's undefined, the only
reasons I can think of to not use the rx buffer are that:

(a) the cachelines might not be managed correctly during DMA ...
i.e. to defend against a bug in the controller driver; and
(b) that writing such _defined_ data would be a "covert channel"
in the security sense.

Now, (a) is just a bug to fix, and in most cases (b) won't be an
issue since even if the system with that driver is being evaluated
at a level where such channels matter, the hardware hooked up via
SPI will probably already be trusted. (Unless the system allows
thing like MMC or SD cards...) However, see below.


> So, the touchscreen controller sees sometimes a "start" condition (bit 7
> of a control byte). It then takes the control byte and sets trash bits
> as a configuration.

Actually, now that I look at it I see that the docs for both the
ads7846 and the ads7843 show that DIN/MOSI should be zero/low
after the command is given, while reading DOUT/MISO.

Which means that the real issue here is that the driver was wrong
in the first place to not explicitly write zeroes while it's reading
back that data.

The testing I've done with it involved two controller drivers which
do happen to interpret "undefined" as "write zeros": omap_uwire,
which I'm guessing does so in hardware (MicroWire is half duplex),
and pxa2xx_spi, which explicitly writes zeros (null_writer).


> I ran into those troubles and add a zerroed buffer as tx.
>
> Do you think that shifting zerros out when a tx_buf is not specified is
> the desired behavior ?

I'm leaning towards a "yes" there -- changing the spec for spi_transfer.

The alternative would seem to mean teaching the SPI interface about
two different kinds of "rx only" transfers, one with "must tx zero"
semantics and the other with "tx data doesn't matter" (and security
audits would define it anyway, to avoid covert channels). And I can't
easily justify that.

For now, I'd suggest you update the atmel_spi driver so that it shifts
zeroes in that case; can't hurt (too much). And I'll forward the issue
to the SPI list. If nobody there objects, I'll send patches to update
the spec for spi_transfer, and the s3c driver.

- Dave

2006-12-22 20:14:55

by Dmitry Torokhov

[permalink] [raw]
Subject: Re: [PATCH] input/spi: add ads7843 support to ads7846 touchscreen driver

On 12/22/06, David Brownell <[email protected]> wrote:
> On Thursday 21 December 2006 5:08 am, Nicolas Ferre wrote:
>
> > > Let me try to sort out the mess with those updates, and ask you to refresh
> > > this ads7843 support against that more-current ads7846 code.
> >
> > Ok, let me know when you have a newer code. I will try to adapt my
> > ads7843 support then.
>
> I just sent these updates to LKML ... though the address I had for Dmitry
> sees to have gone bad, I do see all six patches in the list archives.
>

I changed my ISP. Please use either:

[email protected]
[email protected]
[email protected]

The last one may go bad if I ever change ISP again but I intend to
keep the first 2 indefinitely.

I'll fish the patches from LKML.

--
Dmitry