Loading...
1/*
2 * wm97xx-core.c -- Touch screen driver core for Wolfson WM9705, WM9712
3 * and WM9713 AC97 Codecs.
4 *
5 * Copyright 2003, 2004, 2005, 2006, 2007, 2008 Wolfson Microelectronics PLC.
6 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
7 * Parts Copyright : Ian Molton <spyro@f2s.com>
8 * Andrew Zabolotny <zap@homelink.ru>
9 * Russell King <rmk@arm.linux.org.uk>
10 *
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
15 *
16 * Notes:
17 *
18 * Features:
19 * - supports WM9705, WM9712, WM9713
20 * - polling mode
21 * - continuous mode (arch-dependent)
22 * - adjustable rpu/dpp settings
23 * - adjustable pressure current
24 * - adjustable sample settle delay
25 * - 4 and 5 wire touchscreens (5 wire is WM9712 only)
26 * - pen down detection
27 * - battery monitor
28 * - sample AUX adcs
29 * - power management
30 * - codec GPIO
31 * - codec event notification
32 * Todo
33 * - Support for async sampling control for noisy LCDs.
34 *
35 */
36
37#include <linux/module.h>
38#include <linux/moduleparam.h>
39#include <linux/kernel.h>
40#include <linux/init.h>
41#include <linux/delay.h>
42#include <linux/string.h>
43#include <linux/proc_fs.h>
44#include <linux/pm.h>
45#include <linux/interrupt.h>
46#include <linux/bitops.h>
47#include <linux/workqueue.h>
48#include <linux/wm97xx.h>
49#include <linux/uaccess.h>
50#include <linux/io.h>
51#include <linux/slab.h>
52
53#define TS_NAME "wm97xx"
54#define WM_CORE_VERSION "1.00"
55#define DEFAULT_PRESSURE 0xb0c0
56
57
58/*
59 * Touchscreen absolute values
60 *
61 * These parameters are used to help the input layer discard out of
62 * range readings and reduce jitter etc.
63 *
64 * o min, max:- indicate the min and max values your touch screen returns
65 * o fuzz:- use a higher number to reduce jitter
66 *
67 * The default values correspond to Mainstone II in QVGA mode
68 *
69 * Please read
70 * Documentation/input/input-programming.txt for more details.
71 */
72
73static int abs_x[3] = {350, 3900, 5};
74module_param_array(abs_x, int, NULL, 0);
75MODULE_PARM_DESC(abs_x, "Touchscreen absolute X min, max, fuzz");
76
77static int abs_y[3] = {320, 3750, 40};
78module_param_array(abs_y, int, NULL, 0);
79MODULE_PARM_DESC(abs_y, "Touchscreen absolute Y min, max, fuzz");
80
81static int abs_p[3] = {0, 150, 4};
82module_param_array(abs_p, int, NULL, 0);
83MODULE_PARM_DESC(abs_p, "Touchscreen absolute Pressure min, max, fuzz");
84
85/*
86 * wm97xx IO access, all IO locking done by AC97 layer
87 */
88int wm97xx_reg_read(struct wm97xx *wm, u16 reg)
89{
90 if (wm->ac97)
91 return wm->ac97->bus->ops->read(wm->ac97, reg);
92 else
93 return -1;
94}
95EXPORT_SYMBOL_GPL(wm97xx_reg_read);
96
97void wm97xx_reg_write(struct wm97xx *wm, u16 reg, u16 val)
98{
99 /* cache digitiser registers */
100 if (reg >= AC97_WM9713_DIG1 && reg <= AC97_WM9713_DIG3)
101 wm->dig[(reg - AC97_WM9713_DIG1) >> 1] = val;
102
103 /* cache gpio regs */
104 if (reg >= AC97_GPIO_CFG && reg <= AC97_MISC_AFE)
105 wm->gpio[(reg - AC97_GPIO_CFG) >> 1] = val;
106
107 /* wm9713 irq reg */
108 if (reg == 0x5a)
109 wm->misc = val;
110
111 if (wm->ac97)
112 wm->ac97->bus->ops->write(wm->ac97, reg, val);
113}
114EXPORT_SYMBOL_GPL(wm97xx_reg_write);
115
116/**
117 * wm97xx_read_aux_adc - Read the aux adc.
118 * @wm: wm97xx device.
119 * @adcsel: codec ADC to be read
120 *
121 * Reads the selected AUX ADC.
122 */
123
124int wm97xx_read_aux_adc(struct wm97xx *wm, u16 adcsel)
125{
126 int power_adc = 0, auxval;
127 u16 power = 0;
128 int rc = 0;
129 int timeout = 0;
130
131 /* get codec */
132 mutex_lock(&wm->codec_mutex);
133
134 /* When the touchscreen is not in use, we may have to power up
135 * the AUX ADC before we can use sample the AUX inputs->
136 */
137 if (wm->id == WM9713_ID2 &&
138 (power = wm97xx_reg_read(wm, AC97_EXTENDED_MID)) & 0x8000) {
139 power_adc = 1;
140 wm97xx_reg_write(wm, AC97_EXTENDED_MID, power & 0x7fff);
141 }
142
143 /* Prepare the codec for AUX reading */
144 wm->codec->aux_prepare(wm);
145
146 /* Turn polling mode on to read AUX ADC */
147 wm->pen_probably_down = 1;
148
149 while (rc != RC_VALID && timeout++ < 5)
150 rc = wm->codec->poll_sample(wm, adcsel, &auxval);
151
152 if (power_adc)
153 wm97xx_reg_write(wm, AC97_EXTENDED_MID, power | 0x8000);
154
155 wm->codec->dig_restore(wm);
156
157 wm->pen_probably_down = 0;
158
159 if (timeout >= 5) {
160 dev_err(wm->dev,
161 "timeout reading auxadc %d, disabling digitiser\n",
162 adcsel);
163 wm->codec->dig_enable(wm, false);
164 }
165
166 mutex_unlock(&wm->codec_mutex);
167 return (rc == RC_VALID ? auxval & 0xfff : -EBUSY);
168}
169EXPORT_SYMBOL_GPL(wm97xx_read_aux_adc);
170
171/**
172 * wm97xx_get_gpio - Get the status of a codec GPIO.
173 * @wm: wm97xx device.
174 * @gpio: gpio
175 *
176 * Get the status of a codec GPIO pin
177 */
178
179enum wm97xx_gpio_status wm97xx_get_gpio(struct wm97xx *wm, u32 gpio)
180{
181 u16 status;
182 enum wm97xx_gpio_status ret;
183
184 mutex_lock(&wm->codec_mutex);
185 status = wm97xx_reg_read(wm, AC97_GPIO_STATUS);
186
187 if (status & gpio)
188 ret = WM97XX_GPIO_HIGH;
189 else
190 ret = WM97XX_GPIO_LOW;
191
192 mutex_unlock(&wm->codec_mutex);
193 return ret;
194}
195EXPORT_SYMBOL_GPL(wm97xx_get_gpio);
196
197/**
198 * wm97xx_set_gpio - Set the status of a codec GPIO.
199 * @wm: wm97xx device.
200 * @gpio: gpio
201 *
202 *
203 * Set the status of a codec GPIO pin
204 */
205
206void wm97xx_set_gpio(struct wm97xx *wm, u32 gpio,
207 enum wm97xx_gpio_status status)
208{
209 u16 reg;
210
211 mutex_lock(&wm->codec_mutex);
212 reg = wm97xx_reg_read(wm, AC97_GPIO_STATUS);
213
214 if (status == WM97XX_GPIO_HIGH)
215 reg |= gpio;
216 else
217 reg &= ~gpio;
218
219 if (wm->id == WM9712_ID2 && wm->variant != WM97xx_WM1613)
220 wm97xx_reg_write(wm, AC97_GPIO_STATUS, reg << 1);
221 else
222 wm97xx_reg_write(wm, AC97_GPIO_STATUS, reg);
223 mutex_unlock(&wm->codec_mutex);
224}
225EXPORT_SYMBOL_GPL(wm97xx_set_gpio);
226
227/*
228 * Codec GPIO pin configuration, this sets pin direction, polarity,
229 * stickyness and wake up.
230 */
231void wm97xx_config_gpio(struct wm97xx *wm, u32 gpio, enum wm97xx_gpio_dir dir,
232 enum wm97xx_gpio_pol pol, enum wm97xx_gpio_sticky sticky,
233 enum wm97xx_gpio_wake wake)
234{
235 u16 reg;
236
237 mutex_lock(&wm->codec_mutex);
238 reg = wm97xx_reg_read(wm, AC97_GPIO_POLARITY);
239
240 if (pol == WM97XX_GPIO_POL_HIGH)
241 reg |= gpio;
242 else
243 reg &= ~gpio;
244
245 wm97xx_reg_write(wm, AC97_GPIO_POLARITY, reg);
246 reg = wm97xx_reg_read(wm, AC97_GPIO_STICKY);
247
248 if (sticky == WM97XX_GPIO_STICKY)
249 reg |= gpio;
250 else
251 reg &= ~gpio;
252
253 wm97xx_reg_write(wm, AC97_GPIO_STICKY, reg);
254 reg = wm97xx_reg_read(wm, AC97_GPIO_WAKEUP);
255
256 if (wake == WM97XX_GPIO_WAKE)
257 reg |= gpio;
258 else
259 reg &= ~gpio;
260
261 wm97xx_reg_write(wm, AC97_GPIO_WAKEUP, reg);
262 reg = wm97xx_reg_read(wm, AC97_GPIO_CFG);
263
264 if (dir == WM97XX_GPIO_IN)
265 reg |= gpio;
266 else
267 reg &= ~gpio;
268
269 wm97xx_reg_write(wm, AC97_GPIO_CFG, reg);
270 mutex_unlock(&wm->codec_mutex);
271}
272EXPORT_SYMBOL_GPL(wm97xx_config_gpio);
273
274/*
275 * Configure the WM97XX_PRP value to use while system is suspended.
276 * If a value other than 0 is set then WM97xx pen detection will be
277 * left enabled in the configured mode while the system is in suspend,
278 * the device has users and suspend has not been disabled via the
279 * wakeup sysfs entries.
280 *
281 * @wm: WM97xx device to configure
282 * @mode: WM97XX_PRP value to configure while suspended
283 */
284void wm97xx_set_suspend_mode(struct wm97xx *wm, u16 mode)
285{
286 wm->suspend_mode = mode;
287 device_init_wakeup(&wm->input_dev->dev, mode != 0);
288}
289EXPORT_SYMBOL_GPL(wm97xx_set_suspend_mode);
290
291/*
292 * Handle a pen down interrupt.
293 */
294static void wm97xx_pen_irq_worker(struct work_struct *work)
295{
296 struct wm97xx *wm = container_of(work, struct wm97xx, pen_event_work);
297 int pen_was_down = wm->pen_is_down;
298
299 /* do we need to enable the touch panel reader */
300 if (wm->id == WM9705_ID2) {
301 if (wm97xx_reg_read(wm, AC97_WM97XX_DIGITISER_RD) &
302 WM97XX_PEN_DOWN)
303 wm->pen_is_down = 1;
304 else
305 wm->pen_is_down = 0;
306 } else {
307 u16 status, pol;
308 mutex_lock(&wm->codec_mutex);
309 status = wm97xx_reg_read(wm, AC97_GPIO_STATUS);
310 pol = wm97xx_reg_read(wm, AC97_GPIO_POLARITY);
311
312 if (WM97XX_GPIO_13 & pol & status) {
313 wm->pen_is_down = 1;
314 wm97xx_reg_write(wm, AC97_GPIO_POLARITY, pol &
315 ~WM97XX_GPIO_13);
316 } else {
317 wm->pen_is_down = 0;
318 wm97xx_reg_write(wm, AC97_GPIO_POLARITY, pol |
319 WM97XX_GPIO_13);
320 }
321
322 if (wm->id == WM9712_ID2 && wm->variant != WM97xx_WM1613)
323 wm97xx_reg_write(wm, AC97_GPIO_STATUS, (status &
324 ~WM97XX_GPIO_13) << 1);
325 else
326 wm97xx_reg_write(wm, AC97_GPIO_STATUS, status &
327 ~WM97XX_GPIO_13);
328 mutex_unlock(&wm->codec_mutex);
329 }
330
331 /* If the system is not using continuous mode or it provides a
332 * pen down operation then we need to schedule polls while the
333 * pen is down. Otherwise the machine driver is responsible
334 * for scheduling reads.
335 */
336 if (!wm->mach_ops->acc_enabled || wm->mach_ops->acc_pen_down) {
337 if (wm->pen_is_down && !pen_was_down) {
338 /* Data is not available immediately on pen down */
339 queue_delayed_work(wm->ts_workq, &wm->ts_reader, 1);
340 }
341
342 /* Let ts_reader report the pen up for debounce. */
343 if (!wm->pen_is_down && pen_was_down)
344 wm->pen_is_down = 1;
345 }
346
347 if (!wm->pen_is_down && wm->mach_ops->acc_enabled)
348 wm->mach_ops->acc_pen_up(wm);
349
350 wm->mach_ops->irq_enable(wm, 1);
351}
352
353/*
354 * Codec PENDOWN irq handler
355 *
356 * We have to disable the codec interrupt in the handler because it
357 * can take up to 1ms to clear the interrupt source. We schedule a task
358 * in a work queue to do the actual interaction with the chip. The
359 * interrupt is then enabled again in the slow handler when the source
360 * has been cleared.
361 */
362static irqreturn_t wm97xx_pen_interrupt(int irq, void *dev_id)
363{
364 struct wm97xx *wm = dev_id;
365
366 if (!work_pending(&wm->pen_event_work)) {
367 wm->mach_ops->irq_enable(wm, 0);
368 queue_work(wm->ts_workq, &wm->pen_event_work);
369 }
370
371 return IRQ_HANDLED;
372}
373
374/*
375 * initialise pen IRQ handler and workqueue
376 */
377static int wm97xx_init_pen_irq(struct wm97xx *wm)
378{
379 u16 reg;
380
381 /* If an interrupt is supplied an IRQ enable operation must also be
382 * provided. */
383 BUG_ON(!wm->mach_ops->irq_enable);
384
385 if (request_irq(wm->pen_irq, wm97xx_pen_interrupt, IRQF_SHARED,
386 "wm97xx-pen", wm)) {
387 dev_err(wm->dev,
388 "Failed to register pen down interrupt, polling");
389 wm->pen_irq = 0;
390 return -EINVAL;
391 }
392
393 /* Configure GPIO as interrupt source on WM971x */
394 if (wm->id != WM9705_ID2) {
395 BUG_ON(!wm->mach_ops->irq_gpio);
396 reg = wm97xx_reg_read(wm, AC97_MISC_AFE);
397 wm97xx_reg_write(wm, AC97_MISC_AFE,
398 reg & ~(wm->mach_ops->irq_gpio));
399 reg = wm97xx_reg_read(wm, 0x5a);
400 wm97xx_reg_write(wm, 0x5a, reg & ~0x0001);
401 }
402
403 return 0;
404}
405
406static int wm97xx_read_samples(struct wm97xx *wm)
407{
408 struct wm97xx_data data;
409 int rc;
410
411 mutex_lock(&wm->codec_mutex);
412
413 if (wm->mach_ops && wm->mach_ops->acc_enabled)
414 rc = wm->mach_ops->acc_pen_down(wm);
415 else
416 rc = wm->codec->poll_touch(wm, &data);
417
418 if (rc & RC_PENUP) {
419 if (wm->pen_is_down) {
420 wm->pen_is_down = 0;
421 dev_dbg(wm->dev, "pen up\n");
422 input_report_abs(wm->input_dev, ABS_PRESSURE, 0);
423 input_report_key(wm->input_dev, BTN_TOUCH, 0);
424 input_sync(wm->input_dev);
425 } else if (!(rc & RC_AGAIN)) {
426 /* We need high frequency updates only while
427 * pen is down, the user never will be able to
428 * touch screen faster than a few times per
429 * second... On the other hand, when the user
430 * is actively working with the touchscreen we
431 * don't want to lose the quick response. So we
432 * will slowly increase sleep time after the
433 * pen is up and quicky restore it to ~one task
434 * switch when pen is down again.
435 */
436 if (wm->ts_reader_interval < HZ / 10)
437 wm->ts_reader_interval++;
438 }
439
440 } else if (rc & RC_VALID) {
441 dev_dbg(wm->dev,
442 "pen down: x=%x:%d, y=%x:%d, pressure=%x:%d\n",
443 data.x >> 12, data.x & 0xfff, data.y >> 12,
444 data.y & 0xfff, data.p >> 12, data.p & 0xfff);
445
446 if (abs_x[0] > (data.x & 0xfff) ||
447 abs_x[1] < (data.x & 0xfff) ||
448 abs_y[0] > (data.y & 0xfff) ||
449 abs_y[1] < (data.y & 0xfff)) {
450 dev_dbg(wm->dev, "Measurement out of range, dropping it\n");
451 rc = RC_AGAIN;
452 goto out;
453 }
454
455 input_report_abs(wm->input_dev, ABS_X, data.x & 0xfff);
456 input_report_abs(wm->input_dev, ABS_Y, data.y & 0xfff);
457 input_report_abs(wm->input_dev, ABS_PRESSURE, data.p & 0xfff);
458 input_report_key(wm->input_dev, BTN_TOUCH, 1);
459 input_sync(wm->input_dev);
460 wm->pen_is_down = 1;
461 wm->ts_reader_interval = wm->ts_reader_min_interval;
462 } else if (rc & RC_PENDOWN) {
463 dev_dbg(wm->dev, "pen down\n");
464 wm->pen_is_down = 1;
465 wm->ts_reader_interval = wm->ts_reader_min_interval;
466 }
467
468out:
469 mutex_unlock(&wm->codec_mutex);
470 return rc;
471}
472
473/*
474* The touchscreen sample reader.
475*/
476static void wm97xx_ts_reader(struct work_struct *work)
477{
478 int rc;
479 struct wm97xx *wm = container_of(work, struct wm97xx, ts_reader.work);
480
481 BUG_ON(!wm->codec);
482
483 do {
484 rc = wm97xx_read_samples(wm);
485 } while (rc & RC_AGAIN);
486
487 if (wm->pen_is_down || !wm->pen_irq)
488 queue_delayed_work(wm->ts_workq, &wm->ts_reader,
489 wm->ts_reader_interval);
490}
491
492/**
493 * wm97xx_ts_input_open - Open the touch screen input device.
494 * @idev: Input device to be opened.
495 *
496 * Called by the input sub system to open a wm97xx touchscreen device.
497 * Starts the touchscreen thread and touch digitiser.
498 */
499static int wm97xx_ts_input_open(struct input_dev *idev)
500{
501 struct wm97xx *wm = input_get_drvdata(idev);
502
503 wm->ts_workq = create_singlethread_workqueue("kwm97xx");
504 if (wm->ts_workq == NULL) {
505 dev_err(wm->dev,
506 "Failed to create workqueue\n");
507 return -EINVAL;
508 }
509
510 /* start digitiser */
511 if (wm->mach_ops && wm->mach_ops->acc_enabled)
512 wm->codec->acc_enable(wm, 1);
513 wm->codec->dig_enable(wm, 1);
514
515 INIT_DELAYED_WORK(&wm->ts_reader, wm97xx_ts_reader);
516 INIT_WORK(&wm->pen_event_work, wm97xx_pen_irq_worker);
517
518 wm->ts_reader_min_interval = HZ >= 100 ? HZ / 100 : 1;
519 if (wm->ts_reader_min_interval < 1)
520 wm->ts_reader_min_interval = 1;
521 wm->ts_reader_interval = wm->ts_reader_min_interval;
522
523 wm->pen_is_down = 0;
524 if (wm->pen_irq)
525 wm97xx_init_pen_irq(wm);
526 else
527 dev_err(wm->dev, "No IRQ specified\n");
528
529 /* If we either don't have an interrupt for pen down events or
530 * failed to acquire it then we need to poll.
531 */
532 if (wm->pen_irq == 0)
533 queue_delayed_work(wm->ts_workq, &wm->ts_reader,
534 wm->ts_reader_interval);
535
536 return 0;
537}
538
539/**
540 * wm97xx_ts_input_close - Close the touch screen input device.
541 * @idev: Input device to be closed.
542 *
543 * Called by the input sub system to close a wm97xx touchscreen
544 * device. Kills the touchscreen thread and stops the touch
545 * digitiser.
546 */
547
548static void wm97xx_ts_input_close(struct input_dev *idev)
549{
550 struct wm97xx *wm = input_get_drvdata(idev);
551 u16 reg;
552
553 if (wm->pen_irq) {
554 /* Return the interrupt to GPIO usage (disabling it) */
555 if (wm->id != WM9705_ID2) {
556 BUG_ON(!wm->mach_ops->irq_gpio);
557 reg = wm97xx_reg_read(wm, AC97_MISC_AFE);
558 wm97xx_reg_write(wm, AC97_MISC_AFE,
559 reg | wm->mach_ops->irq_gpio);
560 }
561
562 free_irq(wm->pen_irq, wm);
563 }
564
565 wm->pen_is_down = 0;
566
567 /* Balance out interrupt disables/enables */
568 if (cancel_work_sync(&wm->pen_event_work))
569 wm->mach_ops->irq_enable(wm, 1);
570
571 /* ts_reader rearms itself so we need to explicitly stop it
572 * before we destroy the workqueue.
573 */
574 cancel_delayed_work_sync(&wm->ts_reader);
575
576 destroy_workqueue(wm->ts_workq);
577
578 /* stop digitiser */
579 wm->codec->dig_enable(wm, 0);
580 if (wm->mach_ops && wm->mach_ops->acc_enabled)
581 wm->codec->acc_enable(wm, 0);
582}
583
584static int wm97xx_probe(struct device *dev)
585{
586 struct wm97xx *wm;
587 struct wm97xx_pdata *pdata = dev_get_platdata(dev);
588 int ret = 0, id = 0;
589
590 wm = kzalloc(sizeof(struct wm97xx), GFP_KERNEL);
591 if (!wm)
592 return -ENOMEM;
593 mutex_init(&wm->codec_mutex);
594
595 wm->dev = dev;
596 dev_set_drvdata(dev, wm);
597 wm->ac97 = to_ac97_t(dev);
598
599 /* check that we have a supported codec */
600 id = wm97xx_reg_read(wm, AC97_VENDOR_ID1);
601 if (id != WM97XX_ID1) {
602 dev_err(dev, "Device with vendor %04x is not a wm97xx\n", id);
603 ret = -ENODEV;
604 goto alloc_err;
605 }
606
607 wm->id = wm97xx_reg_read(wm, AC97_VENDOR_ID2);
608
609 wm->variant = WM97xx_GENERIC;
610
611 dev_info(wm->dev, "detected a wm97%02x codec\n", wm->id & 0xff);
612
613 switch (wm->id & 0xff) {
614#ifdef CONFIG_TOUCHSCREEN_WM9705
615 case 0x05:
616 wm->codec = &wm9705_codec;
617 break;
618#endif
619#ifdef CONFIG_TOUCHSCREEN_WM9712
620 case 0x12:
621 wm->codec = &wm9712_codec;
622 break;
623#endif
624#ifdef CONFIG_TOUCHSCREEN_WM9713
625 case 0x13:
626 wm->codec = &wm9713_codec;
627 break;
628#endif
629 default:
630 dev_err(wm->dev, "Support for wm97%02x not compiled in.\n",
631 wm->id & 0xff);
632 ret = -ENODEV;
633 goto alloc_err;
634 }
635
636 /* set up physical characteristics */
637 wm->codec->phy_init(wm);
638
639 /* load gpio cache */
640 wm->gpio[0] = wm97xx_reg_read(wm, AC97_GPIO_CFG);
641 wm->gpio[1] = wm97xx_reg_read(wm, AC97_GPIO_POLARITY);
642 wm->gpio[2] = wm97xx_reg_read(wm, AC97_GPIO_STICKY);
643 wm->gpio[3] = wm97xx_reg_read(wm, AC97_GPIO_WAKEUP);
644 wm->gpio[4] = wm97xx_reg_read(wm, AC97_GPIO_STATUS);
645 wm->gpio[5] = wm97xx_reg_read(wm, AC97_MISC_AFE);
646
647 wm->input_dev = input_allocate_device();
648 if (wm->input_dev == NULL) {
649 ret = -ENOMEM;
650 goto alloc_err;
651 }
652
653 /* set up touch configuration */
654 wm->input_dev->name = "wm97xx touchscreen";
655 wm->input_dev->phys = "wm97xx";
656 wm->input_dev->open = wm97xx_ts_input_open;
657 wm->input_dev->close = wm97xx_ts_input_close;
658
659 __set_bit(EV_ABS, wm->input_dev->evbit);
660 __set_bit(EV_KEY, wm->input_dev->evbit);
661 __set_bit(BTN_TOUCH, wm->input_dev->keybit);
662
663 input_set_abs_params(wm->input_dev, ABS_X, abs_x[0], abs_x[1],
664 abs_x[2], 0);
665 input_set_abs_params(wm->input_dev, ABS_Y, abs_y[0], abs_y[1],
666 abs_y[2], 0);
667 input_set_abs_params(wm->input_dev, ABS_PRESSURE, abs_p[0], abs_p[1],
668 abs_p[2], 0);
669
670 input_set_drvdata(wm->input_dev, wm);
671 wm->input_dev->dev.parent = dev;
672
673 ret = input_register_device(wm->input_dev);
674 if (ret < 0)
675 goto dev_alloc_err;
676
677 /* register our battery device */
678 wm->battery_dev = platform_device_alloc("wm97xx-battery", -1);
679 if (!wm->battery_dev) {
680 ret = -ENOMEM;
681 goto batt_err;
682 }
683 platform_set_drvdata(wm->battery_dev, wm);
684 wm->battery_dev->dev.parent = dev;
685 wm->battery_dev->dev.platform_data = pdata;
686 ret = platform_device_add(wm->battery_dev);
687 if (ret < 0)
688 goto batt_reg_err;
689
690 /* register our extended touch device (for machine specific
691 * extensions) */
692 wm->touch_dev = platform_device_alloc("wm97xx-touch", -1);
693 if (!wm->touch_dev) {
694 ret = -ENOMEM;
695 goto touch_err;
696 }
697 platform_set_drvdata(wm->touch_dev, wm);
698 wm->touch_dev->dev.parent = dev;
699 wm->touch_dev->dev.platform_data = pdata;
700 ret = platform_device_add(wm->touch_dev);
701 if (ret < 0)
702 goto touch_reg_err;
703
704 return ret;
705
706 touch_reg_err:
707 platform_device_put(wm->touch_dev);
708 touch_err:
709 platform_device_del(wm->battery_dev);
710 batt_reg_err:
711 platform_device_put(wm->battery_dev);
712 batt_err:
713 input_unregister_device(wm->input_dev);
714 wm->input_dev = NULL;
715 dev_alloc_err:
716 input_free_device(wm->input_dev);
717 alloc_err:
718 kfree(wm);
719
720 return ret;
721}
722
723static int wm97xx_remove(struct device *dev)
724{
725 struct wm97xx *wm = dev_get_drvdata(dev);
726
727 platform_device_unregister(wm->battery_dev);
728 platform_device_unregister(wm->touch_dev);
729 input_unregister_device(wm->input_dev);
730 kfree(wm);
731
732 return 0;
733}
734
735#ifdef CONFIG_PM
736static int wm97xx_suspend(struct device *dev, pm_message_t state)
737{
738 struct wm97xx *wm = dev_get_drvdata(dev);
739 u16 reg;
740 int suspend_mode;
741
742 if (device_may_wakeup(&wm->input_dev->dev))
743 suspend_mode = wm->suspend_mode;
744 else
745 suspend_mode = 0;
746
747 if (wm->input_dev->users)
748 cancel_delayed_work_sync(&wm->ts_reader);
749
750 /* Power down the digitiser (bypassing the cache for resume) */
751 reg = wm97xx_reg_read(wm, AC97_WM97XX_DIGITISER2);
752 reg &= ~WM97XX_PRP_DET_DIG;
753 if (wm->input_dev->users)
754 reg |= suspend_mode;
755 wm->ac97->bus->ops->write(wm->ac97, AC97_WM97XX_DIGITISER2, reg);
756
757 /* WM9713 has an additional power bit - turn it off if there
758 * are no users or if suspend mode is zero. */
759 if (wm->id == WM9713_ID2 &&
760 (!wm->input_dev->users || !suspend_mode)) {
761 reg = wm97xx_reg_read(wm, AC97_EXTENDED_MID) | 0x8000;
762 wm97xx_reg_write(wm, AC97_EXTENDED_MID, reg);
763 }
764
765 return 0;
766}
767
768static int wm97xx_resume(struct device *dev)
769{
770 struct wm97xx *wm = dev_get_drvdata(dev);
771
772 /* restore digitiser and gpios */
773 if (wm->id == WM9713_ID2) {
774 wm97xx_reg_write(wm, AC97_WM9713_DIG1, wm->dig[0]);
775 wm97xx_reg_write(wm, 0x5a, wm->misc);
776 if (wm->input_dev->users) {
777 u16 reg;
778 reg = wm97xx_reg_read(wm, AC97_EXTENDED_MID) & 0x7fff;
779 wm97xx_reg_write(wm, AC97_EXTENDED_MID, reg);
780 }
781 }
782
783 wm97xx_reg_write(wm, AC97_WM9713_DIG2, wm->dig[1]);
784 wm97xx_reg_write(wm, AC97_WM9713_DIG3, wm->dig[2]);
785
786 wm97xx_reg_write(wm, AC97_GPIO_CFG, wm->gpio[0]);
787 wm97xx_reg_write(wm, AC97_GPIO_POLARITY, wm->gpio[1]);
788 wm97xx_reg_write(wm, AC97_GPIO_STICKY, wm->gpio[2]);
789 wm97xx_reg_write(wm, AC97_GPIO_WAKEUP, wm->gpio[3]);
790 wm97xx_reg_write(wm, AC97_GPIO_STATUS, wm->gpio[4]);
791 wm97xx_reg_write(wm, AC97_MISC_AFE, wm->gpio[5]);
792
793 if (wm->input_dev->users && !wm->pen_irq) {
794 wm->ts_reader_interval = wm->ts_reader_min_interval;
795 queue_delayed_work(wm->ts_workq, &wm->ts_reader,
796 wm->ts_reader_interval);
797 }
798
799 return 0;
800}
801
802#else
803#define wm97xx_suspend NULL
804#define wm97xx_resume NULL
805#endif
806
807/*
808 * Machine specific operations
809 */
810int wm97xx_register_mach_ops(struct wm97xx *wm,
811 struct wm97xx_mach_ops *mach_ops)
812{
813 mutex_lock(&wm->codec_mutex);
814 if (wm->mach_ops) {
815 mutex_unlock(&wm->codec_mutex);
816 return -EINVAL;
817 }
818 wm->mach_ops = mach_ops;
819 mutex_unlock(&wm->codec_mutex);
820
821 return 0;
822}
823EXPORT_SYMBOL_GPL(wm97xx_register_mach_ops);
824
825void wm97xx_unregister_mach_ops(struct wm97xx *wm)
826{
827 mutex_lock(&wm->codec_mutex);
828 wm->mach_ops = NULL;
829 mutex_unlock(&wm->codec_mutex);
830}
831EXPORT_SYMBOL_GPL(wm97xx_unregister_mach_ops);
832
833static struct device_driver wm97xx_driver = {
834 .name = "wm97xx-ts",
835 .bus = &ac97_bus_type,
836 .owner = THIS_MODULE,
837 .probe = wm97xx_probe,
838 .remove = wm97xx_remove,
839 .suspend = wm97xx_suspend,
840 .resume = wm97xx_resume,
841};
842
843static int __init wm97xx_init(void)
844{
845 return driver_register(&wm97xx_driver);
846}
847
848static void __exit wm97xx_exit(void)
849{
850 driver_unregister(&wm97xx_driver);
851}
852
853module_init(wm97xx_init);
854module_exit(wm97xx_exit);
855
856/* Module information */
857MODULE_AUTHOR("Liam Girdwood <lrg@slimlogic.co.uk>");
858MODULE_DESCRIPTION("WM97xx Core - Touch Screen / AUX ADC / GPIO Driver");
859MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * wm97xx-core.c -- Touch screen driver core for Wolfson WM9705, WM9712
4 * and WM9713 AC97 Codecs.
5 *
6 * Copyright 2003, 2004, 2005, 2006, 2007, 2008 Wolfson Microelectronics PLC.
7 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
8 * Parts Copyright : Ian Molton <spyro@f2s.com>
9 * Andrew Zabolotny <zap@homelink.ru>
10 * Russell King <rmk@arm.linux.org.uk>
11 *
12 * Notes:
13 *
14 * Features:
15 * - supports WM9705, WM9712, WM9713
16 * - polling mode
17 * - continuous mode (arch-dependent)
18 * - adjustable rpu/dpp settings
19 * - adjustable pressure current
20 * - adjustable sample settle delay
21 * - 4 and 5 wire touchscreens (5 wire is WM9712 only)
22 * - pen down detection
23 * - battery monitor
24 * - sample AUX adcs
25 * - power management
26 * - codec GPIO
27 * - codec event notification
28 * Todo
29 * - Support for async sampling control for noisy LCDs.
30 */
31
32#include <linux/module.h>
33#include <linux/moduleparam.h>
34#include <linux/kernel.h>
35#include <linux/init.h>
36#include <linux/delay.h>
37#include <linux/string.h>
38#include <linux/proc_fs.h>
39#include <linux/pm.h>
40#include <linux/interrupt.h>
41#include <linux/bitops.h>
42#include <linux/mfd/wm97xx.h>
43#include <linux/workqueue.h>
44#include <linux/wm97xx.h>
45#include <linux/uaccess.h>
46#include <linux/io.h>
47#include <linux/slab.h>
48
49#define TS_NAME "wm97xx"
50#define WM_CORE_VERSION "1.00"
51#define DEFAULT_PRESSURE 0xb0c0
52
53
54/*
55 * Touchscreen absolute values
56 *
57 * These parameters are used to help the input layer discard out of
58 * range readings and reduce jitter etc.
59 *
60 * o min, max:- indicate the min and max values your touch screen returns
61 * o fuzz:- use a higher number to reduce jitter
62 *
63 * The default values correspond to Mainstone II in QVGA mode
64 *
65 * Please read
66 * Documentation/input/input-programming.rst for more details.
67 */
68
69static int abs_x[3] = {150, 4000, 5};
70module_param_array(abs_x, int, NULL, 0);
71MODULE_PARM_DESC(abs_x, "Touchscreen absolute X min, max, fuzz");
72
73static int abs_y[3] = {200, 4000, 40};
74module_param_array(abs_y, int, NULL, 0);
75MODULE_PARM_DESC(abs_y, "Touchscreen absolute Y min, max, fuzz");
76
77static int abs_p[3] = {0, 150, 4};
78module_param_array(abs_p, int, NULL, 0);
79MODULE_PARM_DESC(abs_p, "Touchscreen absolute Pressure min, max, fuzz");
80
81/*
82 * wm97xx IO access, all IO locking done by AC97 layer
83 */
84int wm97xx_reg_read(struct wm97xx *wm, u16 reg)
85{
86 if (wm->ac97)
87 return wm->ac97->bus->ops->read(wm->ac97, reg);
88 else
89 return -1;
90}
91EXPORT_SYMBOL_GPL(wm97xx_reg_read);
92
93void wm97xx_reg_write(struct wm97xx *wm, u16 reg, u16 val)
94{
95 /* cache digitiser registers */
96 if (reg >= AC97_WM9713_DIG1 && reg <= AC97_WM9713_DIG3)
97 wm->dig[(reg - AC97_WM9713_DIG1) >> 1] = val;
98
99 /* cache gpio regs */
100 if (reg >= AC97_GPIO_CFG && reg <= AC97_MISC_AFE)
101 wm->gpio[(reg - AC97_GPIO_CFG) >> 1] = val;
102
103 /* wm9713 irq reg */
104 if (reg == 0x5a)
105 wm->misc = val;
106
107 if (wm->ac97)
108 wm->ac97->bus->ops->write(wm->ac97, reg, val);
109}
110EXPORT_SYMBOL_GPL(wm97xx_reg_write);
111
112/**
113 * wm97xx_read_aux_adc - Read the aux adc.
114 * @wm: wm97xx device.
115 * @adcsel: codec ADC to be read
116 *
117 * Reads the selected AUX ADC.
118 */
119
120int wm97xx_read_aux_adc(struct wm97xx *wm, u16 adcsel)
121{
122 int power_adc = 0, auxval;
123 u16 power = 0;
124 int rc = 0;
125 int timeout = 0;
126
127 /* get codec */
128 mutex_lock(&wm->codec_mutex);
129
130 /* When the touchscreen is not in use, we may have to power up
131 * the AUX ADC before we can use sample the AUX inputs->
132 */
133 if (wm->id == WM9713_ID2 &&
134 (power = wm97xx_reg_read(wm, AC97_EXTENDED_MID)) & 0x8000) {
135 power_adc = 1;
136 wm97xx_reg_write(wm, AC97_EXTENDED_MID, power & 0x7fff);
137 }
138
139 /* Prepare the codec for AUX reading */
140 wm->codec->aux_prepare(wm);
141
142 /* Turn polling mode on to read AUX ADC */
143 wm->pen_probably_down = 1;
144
145 while (rc != RC_VALID && timeout++ < 5)
146 rc = wm->codec->poll_sample(wm, adcsel, &auxval);
147
148 if (power_adc)
149 wm97xx_reg_write(wm, AC97_EXTENDED_MID, power | 0x8000);
150
151 wm->codec->dig_restore(wm);
152
153 wm->pen_probably_down = 0;
154
155 if (timeout >= 5) {
156 dev_err(wm->dev,
157 "timeout reading auxadc %d, disabling digitiser\n",
158 adcsel);
159 wm->codec->dig_enable(wm, false);
160 }
161
162 mutex_unlock(&wm->codec_mutex);
163 return (rc == RC_VALID ? auxval & 0xfff : -EBUSY);
164}
165EXPORT_SYMBOL_GPL(wm97xx_read_aux_adc);
166
167/**
168 * wm97xx_get_gpio - Get the status of a codec GPIO.
169 * @wm: wm97xx device.
170 * @gpio: gpio
171 *
172 * Get the status of a codec GPIO pin
173 */
174
175enum wm97xx_gpio_status wm97xx_get_gpio(struct wm97xx *wm, u32 gpio)
176{
177 u16 status;
178 enum wm97xx_gpio_status ret;
179
180 mutex_lock(&wm->codec_mutex);
181 status = wm97xx_reg_read(wm, AC97_GPIO_STATUS);
182
183 if (status & gpio)
184 ret = WM97XX_GPIO_HIGH;
185 else
186 ret = WM97XX_GPIO_LOW;
187
188 mutex_unlock(&wm->codec_mutex);
189 return ret;
190}
191EXPORT_SYMBOL_GPL(wm97xx_get_gpio);
192
193/**
194 * wm97xx_set_gpio - Set the status of a codec GPIO.
195 * @wm: wm97xx device.
196 * @gpio: gpio
197 * @status: status
198 *
199 * Set the status of a codec GPIO pin
200 */
201
202void wm97xx_set_gpio(struct wm97xx *wm, u32 gpio,
203 enum wm97xx_gpio_status status)
204{
205 u16 reg;
206
207 mutex_lock(&wm->codec_mutex);
208 reg = wm97xx_reg_read(wm, AC97_GPIO_STATUS);
209
210 if (status == WM97XX_GPIO_HIGH)
211 reg |= gpio;
212 else
213 reg &= ~gpio;
214
215 if (wm->id == WM9712_ID2 && wm->variant != WM97xx_WM1613)
216 wm97xx_reg_write(wm, AC97_GPIO_STATUS, reg << 1);
217 else
218 wm97xx_reg_write(wm, AC97_GPIO_STATUS, reg);
219 mutex_unlock(&wm->codec_mutex);
220}
221EXPORT_SYMBOL_GPL(wm97xx_set_gpio);
222
223/*
224 * Codec GPIO pin configuration, this sets pin direction, polarity,
225 * stickiness and wake up.
226 */
227void wm97xx_config_gpio(struct wm97xx *wm, u32 gpio, enum wm97xx_gpio_dir dir,
228 enum wm97xx_gpio_pol pol, enum wm97xx_gpio_sticky sticky,
229 enum wm97xx_gpio_wake wake)
230{
231 u16 reg;
232
233 mutex_lock(&wm->codec_mutex);
234 reg = wm97xx_reg_read(wm, AC97_GPIO_POLARITY);
235
236 if (pol == WM97XX_GPIO_POL_HIGH)
237 reg |= gpio;
238 else
239 reg &= ~gpio;
240
241 wm97xx_reg_write(wm, AC97_GPIO_POLARITY, reg);
242 reg = wm97xx_reg_read(wm, AC97_GPIO_STICKY);
243
244 if (sticky == WM97XX_GPIO_STICKY)
245 reg |= gpio;
246 else
247 reg &= ~gpio;
248
249 wm97xx_reg_write(wm, AC97_GPIO_STICKY, reg);
250 reg = wm97xx_reg_read(wm, AC97_GPIO_WAKEUP);
251
252 if (wake == WM97XX_GPIO_WAKE)
253 reg |= gpio;
254 else
255 reg &= ~gpio;
256
257 wm97xx_reg_write(wm, AC97_GPIO_WAKEUP, reg);
258 reg = wm97xx_reg_read(wm, AC97_GPIO_CFG);
259
260 if (dir == WM97XX_GPIO_IN)
261 reg |= gpio;
262 else
263 reg &= ~gpio;
264
265 wm97xx_reg_write(wm, AC97_GPIO_CFG, reg);
266 mutex_unlock(&wm->codec_mutex);
267}
268EXPORT_SYMBOL_GPL(wm97xx_config_gpio);
269
270/*
271 * Configure the WM97XX_PRP value to use while system is suspended.
272 * If a value other than 0 is set then WM97xx pen detection will be
273 * left enabled in the configured mode while the system is in suspend,
274 * the device has users and suspend has not been disabled via the
275 * wakeup sysfs entries.
276 *
277 * @wm: WM97xx device to configure
278 * @mode: WM97XX_PRP value to configure while suspended
279 */
280void wm97xx_set_suspend_mode(struct wm97xx *wm, u16 mode)
281{
282 wm->suspend_mode = mode;
283 device_init_wakeup(&wm->input_dev->dev, mode != 0);
284}
285EXPORT_SYMBOL_GPL(wm97xx_set_suspend_mode);
286
287/*
288 * Codec PENDOWN irq handler
289 *
290 */
291static irqreturn_t wm97xx_pen_interrupt(int irq, void *dev_id)
292{
293 struct wm97xx *wm = dev_id;
294 int pen_was_down = wm->pen_is_down;
295
296 /* do we need to enable the touch panel reader */
297 if (wm->id == WM9705_ID2) {
298 if (wm97xx_reg_read(wm, AC97_WM97XX_DIGITISER_RD) &
299 WM97XX_PEN_DOWN)
300 wm->pen_is_down = 1;
301 else
302 wm->pen_is_down = 0;
303 } else {
304 u16 status, pol;
305 mutex_lock(&wm->codec_mutex);
306 status = wm97xx_reg_read(wm, AC97_GPIO_STATUS);
307 pol = wm97xx_reg_read(wm, AC97_GPIO_POLARITY);
308
309 if (WM97XX_GPIO_13 & pol & status) {
310 wm->pen_is_down = 1;
311 wm97xx_reg_write(wm, AC97_GPIO_POLARITY, pol &
312 ~WM97XX_GPIO_13);
313 } else {
314 wm->pen_is_down = 0;
315 wm97xx_reg_write(wm, AC97_GPIO_POLARITY, pol |
316 WM97XX_GPIO_13);
317 }
318
319 if (wm->id == WM9712_ID2 && wm->variant != WM97xx_WM1613)
320 wm97xx_reg_write(wm, AC97_GPIO_STATUS, (status &
321 ~WM97XX_GPIO_13) << 1);
322 else
323 wm97xx_reg_write(wm, AC97_GPIO_STATUS, status &
324 ~WM97XX_GPIO_13);
325 mutex_unlock(&wm->codec_mutex);
326 }
327
328 /* If the system is not using continuous mode or it provides a
329 * pen down operation then we need to schedule polls while the
330 * pen is down. Otherwise the machine driver is responsible
331 * for scheduling reads.
332 */
333 if (!wm->mach_ops->acc_enabled || wm->mach_ops->acc_pen_down) {
334 if (wm->pen_is_down && !pen_was_down) {
335 /* Data is not available immediately on pen down */
336 queue_delayed_work(wm->ts_workq, &wm->ts_reader, 1);
337 }
338
339 /* Let ts_reader report the pen up for debounce. */
340 if (!wm->pen_is_down && pen_was_down)
341 wm->pen_is_down = 1;
342 }
343
344 if (!wm->pen_is_down && wm->mach_ops->acc_enabled)
345 wm->mach_ops->acc_pen_up(wm);
346
347 return IRQ_HANDLED;
348}
349
350/*
351 * initialise pen IRQ handler and workqueue
352 */
353static int wm97xx_init_pen_irq(struct wm97xx *wm)
354{
355 u16 reg;
356
357 if (request_threaded_irq(wm->pen_irq, NULL, wm97xx_pen_interrupt,
358 IRQF_SHARED | IRQF_ONESHOT,
359 "wm97xx-pen", wm)) {
360 dev_err(wm->dev,
361 "Failed to register pen down interrupt, polling");
362 wm->pen_irq = 0;
363 return -EINVAL;
364 }
365
366 /* Configure GPIO as interrupt source on WM971x */
367 if (wm->id != WM9705_ID2) {
368 BUG_ON(!wm->mach_ops->irq_gpio);
369 reg = wm97xx_reg_read(wm, AC97_MISC_AFE);
370 wm97xx_reg_write(wm, AC97_MISC_AFE,
371 reg & ~(wm->mach_ops->irq_gpio));
372 reg = wm97xx_reg_read(wm, 0x5a);
373 wm97xx_reg_write(wm, 0x5a, reg & ~0x0001);
374 }
375
376 return 0;
377}
378
379static int wm97xx_read_samples(struct wm97xx *wm)
380{
381 struct wm97xx_data data;
382 int rc;
383
384 mutex_lock(&wm->codec_mutex);
385
386 if (wm->mach_ops && wm->mach_ops->acc_enabled)
387 rc = wm->mach_ops->acc_pen_down(wm);
388 else
389 rc = wm->codec->poll_touch(wm, &data);
390
391 if (rc & RC_PENUP) {
392 if (wm->pen_is_down) {
393 wm->pen_is_down = 0;
394 dev_dbg(wm->dev, "pen up\n");
395 input_report_abs(wm->input_dev, ABS_PRESSURE, 0);
396 input_report_key(wm->input_dev, BTN_TOUCH, 0);
397 input_sync(wm->input_dev);
398 } else if (!(rc & RC_AGAIN)) {
399 /* We need high frequency updates only while
400 * pen is down, the user never will be able to
401 * touch screen faster than a few times per
402 * second... On the other hand, when the user
403 * is actively working with the touchscreen we
404 * don't want to lose the quick response. So we
405 * will slowly increase sleep time after the
406 * pen is up and quickly restore it to ~one task
407 * switch when pen is down again.
408 */
409 if (wm->ts_reader_interval < HZ / 10)
410 wm->ts_reader_interval++;
411 }
412
413 } else if (rc & RC_VALID) {
414 dev_dbg(wm->dev,
415 "pen down: x=%x:%d, y=%x:%d, pressure=%x:%d\n",
416 data.x >> 12, data.x & 0xfff, data.y >> 12,
417 data.y & 0xfff, data.p >> 12, data.p & 0xfff);
418
419 if (abs_x[0] > (data.x & 0xfff) ||
420 abs_x[1] < (data.x & 0xfff) ||
421 abs_y[0] > (data.y & 0xfff) ||
422 abs_y[1] < (data.y & 0xfff)) {
423 dev_dbg(wm->dev, "Measurement out of range, dropping it\n");
424 rc = RC_AGAIN;
425 goto out;
426 }
427
428 input_report_abs(wm->input_dev, ABS_X, data.x & 0xfff);
429 input_report_abs(wm->input_dev, ABS_Y, data.y & 0xfff);
430 input_report_abs(wm->input_dev, ABS_PRESSURE, data.p & 0xfff);
431 input_report_key(wm->input_dev, BTN_TOUCH, 1);
432 input_sync(wm->input_dev);
433 wm->pen_is_down = 1;
434 wm->ts_reader_interval = wm->ts_reader_min_interval;
435 } else if (rc & RC_PENDOWN) {
436 dev_dbg(wm->dev, "pen down\n");
437 wm->pen_is_down = 1;
438 wm->ts_reader_interval = wm->ts_reader_min_interval;
439 }
440
441out:
442 mutex_unlock(&wm->codec_mutex);
443 return rc;
444}
445
446/*
447* The touchscreen sample reader.
448*/
449static void wm97xx_ts_reader(struct work_struct *work)
450{
451 int rc;
452 struct wm97xx *wm = container_of(work, struct wm97xx, ts_reader.work);
453
454 BUG_ON(!wm->codec);
455
456 do {
457 rc = wm97xx_read_samples(wm);
458 } while (rc & RC_AGAIN);
459
460 if (wm->pen_is_down || !wm->pen_irq)
461 queue_delayed_work(wm->ts_workq, &wm->ts_reader,
462 wm->ts_reader_interval);
463}
464
465/**
466 * wm97xx_ts_input_open - Open the touch screen input device.
467 * @idev: Input device to be opened.
468 *
469 * Called by the input sub system to open a wm97xx touchscreen device.
470 * Starts the touchscreen thread and touch digitiser.
471 */
472static int wm97xx_ts_input_open(struct input_dev *idev)
473{
474 struct wm97xx *wm = input_get_drvdata(idev);
475
476 wm->ts_workq = alloc_ordered_workqueue("kwm97xx", 0);
477 if (wm->ts_workq == NULL) {
478 dev_err(wm->dev,
479 "Failed to create workqueue\n");
480 return -EINVAL;
481 }
482
483 /* start digitiser */
484 if (wm->mach_ops && wm->mach_ops->acc_enabled)
485 wm->codec->acc_enable(wm, 1);
486 wm->codec->dig_enable(wm, 1);
487
488 INIT_DELAYED_WORK(&wm->ts_reader, wm97xx_ts_reader);
489
490 wm->ts_reader_min_interval = HZ >= 100 ? HZ / 100 : 1;
491 if (wm->ts_reader_min_interval < 1)
492 wm->ts_reader_min_interval = 1;
493 wm->ts_reader_interval = wm->ts_reader_min_interval;
494
495 wm->pen_is_down = 0;
496 if (wm->pen_irq)
497 wm97xx_init_pen_irq(wm);
498 else
499 dev_err(wm->dev, "No IRQ specified\n");
500
501 /* If we either don't have an interrupt for pen down events or
502 * failed to acquire it then we need to poll.
503 */
504 if (wm->pen_irq == 0)
505 queue_delayed_work(wm->ts_workq, &wm->ts_reader,
506 wm->ts_reader_interval);
507
508 return 0;
509}
510
511/**
512 * wm97xx_ts_input_close - Close the touch screen input device.
513 * @idev: Input device to be closed.
514 *
515 * Called by the input sub system to close a wm97xx touchscreen
516 * device. Kills the touchscreen thread and stops the touch
517 * digitiser.
518 */
519
520static void wm97xx_ts_input_close(struct input_dev *idev)
521{
522 struct wm97xx *wm = input_get_drvdata(idev);
523 u16 reg;
524
525 if (wm->pen_irq) {
526 /* Return the interrupt to GPIO usage (disabling it) */
527 if (wm->id != WM9705_ID2) {
528 BUG_ON(!wm->mach_ops->irq_gpio);
529 reg = wm97xx_reg_read(wm, AC97_MISC_AFE);
530 wm97xx_reg_write(wm, AC97_MISC_AFE,
531 reg | wm->mach_ops->irq_gpio);
532 }
533
534 free_irq(wm->pen_irq, wm);
535 }
536
537 wm->pen_is_down = 0;
538
539 /* ts_reader rearms itself so we need to explicitly stop it
540 * before we destroy the workqueue.
541 */
542 cancel_delayed_work_sync(&wm->ts_reader);
543
544 destroy_workqueue(wm->ts_workq);
545
546 /* stop digitiser */
547 wm->codec->dig_enable(wm, 0);
548 if (wm->mach_ops && wm->mach_ops->acc_enabled)
549 wm->codec->acc_enable(wm, 0);
550}
551
552static int wm97xx_register_touch(struct wm97xx *wm)
553{
554 struct wm97xx_pdata *pdata = dev_get_platdata(wm->dev);
555 int ret;
556
557 wm->input_dev = devm_input_allocate_device(wm->dev);
558 if (wm->input_dev == NULL)
559 return -ENOMEM;
560
561 /* set up touch configuration */
562 wm->input_dev->name = "wm97xx touchscreen";
563 wm->input_dev->phys = "wm97xx";
564 wm->input_dev->open = wm97xx_ts_input_open;
565 wm->input_dev->close = wm97xx_ts_input_close;
566
567 __set_bit(EV_ABS, wm->input_dev->evbit);
568 __set_bit(EV_KEY, wm->input_dev->evbit);
569 __set_bit(BTN_TOUCH, wm->input_dev->keybit);
570
571 input_set_abs_params(wm->input_dev, ABS_X, abs_x[0], abs_x[1],
572 abs_x[2], 0);
573 input_set_abs_params(wm->input_dev, ABS_Y, abs_y[0], abs_y[1],
574 abs_y[2], 0);
575 input_set_abs_params(wm->input_dev, ABS_PRESSURE, abs_p[0], abs_p[1],
576 abs_p[2], 0);
577
578 input_set_drvdata(wm->input_dev, wm);
579 wm->input_dev->dev.parent = wm->dev;
580
581 ret = input_register_device(wm->input_dev);
582 if (ret)
583 return ret;
584
585 /*
586 * register our extended touch device (for machine specific
587 * extensions)
588 */
589 wm->touch_dev = platform_device_alloc("wm97xx-touch", -1);
590 if (!wm->touch_dev)
591 return -ENOMEM;
592
593 platform_set_drvdata(wm->touch_dev, wm);
594 wm->touch_dev->dev.parent = wm->dev;
595 wm->touch_dev->dev.platform_data = pdata;
596 ret = platform_device_add(wm->touch_dev);
597 if (ret < 0)
598 goto touch_reg_err;
599
600 return 0;
601touch_reg_err:
602 platform_device_put(wm->touch_dev);
603
604 return ret;
605}
606
607static void wm97xx_unregister_touch(struct wm97xx *wm)
608{
609 platform_device_unregister(wm->touch_dev);
610}
611
612static int _wm97xx_probe(struct wm97xx *wm)
613{
614 int id = 0;
615
616 mutex_init(&wm->codec_mutex);
617 dev_set_drvdata(wm->dev, wm);
618
619 /* check that we have a supported codec */
620 id = wm97xx_reg_read(wm, AC97_VENDOR_ID1);
621 if (id != WM97XX_ID1) {
622 dev_err(wm->dev,
623 "Device with vendor %04x is not a wm97xx\n", id);
624 return -ENODEV;
625 }
626
627 wm->id = wm97xx_reg_read(wm, AC97_VENDOR_ID2);
628
629 wm->variant = WM97xx_GENERIC;
630
631 dev_info(wm->dev, "detected a wm97%02x codec\n", wm->id & 0xff);
632
633 switch (wm->id & 0xff) {
634#ifdef CONFIG_TOUCHSCREEN_WM9705
635 case 0x05:
636 wm->codec = &wm9705_codec;
637 break;
638#endif
639#ifdef CONFIG_TOUCHSCREEN_WM9712
640 case 0x12:
641 wm->codec = &wm9712_codec;
642 break;
643#endif
644#ifdef CONFIG_TOUCHSCREEN_WM9713
645 case 0x13:
646 wm->codec = &wm9713_codec;
647 break;
648#endif
649 default:
650 dev_err(wm->dev, "Support for wm97%02x not compiled in.\n",
651 wm->id & 0xff);
652 return -ENODEV;
653 }
654
655 /* set up physical characteristics */
656 wm->codec->phy_init(wm);
657
658 /* load gpio cache */
659 wm->gpio[0] = wm97xx_reg_read(wm, AC97_GPIO_CFG);
660 wm->gpio[1] = wm97xx_reg_read(wm, AC97_GPIO_POLARITY);
661 wm->gpio[2] = wm97xx_reg_read(wm, AC97_GPIO_STICKY);
662 wm->gpio[3] = wm97xx_reg_read(wm, AC97_GPIO_WAKEUP);
663 wm->gpio[4] = wm97xx_reg_read(wm, AC97_GPIO_STATUS);
664 wm->gpio[5] = wm97xx_reg_read(wm, AC97_MISC_AFE);
665
666 return wm97xx_register_touch(wm);
667}
668
669static void wm97xx_remove_battery(struct wm97xx *wm)
670{
671 platform_device_unregister(wm->battery_dev);
672}
673
674static int wm97xx_add_battery(struct wm97xx *wm,
675 struct wm97xx_batt_pdata *pdata)
676{
677 int ret;
678
679 wm->battery_dev = platform_device_alloc("wm97xx-battery", -1);
680 if (!wm->battery_dev)
681 return -ENOMEM;
682
683 platform_set_drvdata(wm->battery_dev, wm);
684 wm->battery_dev->dev.parent = wm->dev;
685 wm->battery_dev->dev.platform_data = pdata;
686 ret = platform_device_add(wm->battery_dev);
687 if (ret)
688 platform_device_put(wm->battery_dev);
689
690 return ret;
691}
692
693static int wm97xx_probe(struct device *dev)
694{
695 struct wm97xx *wm;
696 int ret;
697 struct wm97xx_pdata *pdata = dev_get_platdata(dev);
698
699 wm = devm_kzalloc(dev, sizeof(struct wm97xx), GFP_KERNEL);
700 if (!wm)
701 return -ENOMEM;
702
703 wm->dev = dev;
704 wm->ac97 = to_ac97_t(dev);
705
706 ret = _wm97xx_probe(wm);
707 if (ret)
708 return ret;
709
710 ret = wm97xx_add_battery(wm, pdata ? pdata->batt_pdata : NULL);
711 if (ret < 0)
712 goto batt_err;
713
714 return ret;
715
716batt_err:
717 wm97xx_unregister_touch(wm);
718 return ret;
719}
720
721static int wm97xx_remove(struct device *dev)
722{
723 struct wm97xx *wm = dev_get_drvdata(dev);
724
725 wm97xx_remove_battery(wm);
726 wm97xx_unregister_touch(wm);
727
728 return 0;
729}
730
731static int wm97xx_mfd_probe(struct platform_device *pdev)
732{
733 struct wm97xx *wm;
734 struct wm97xx_platform_data *mfd_pdata = dev_get_platdata(&pdev->dev);
735 int ret;
736
737 wm = devm_kzalloc(&pdev->dev, sizeof(struct wm97xx), GFP_KERNEL);
738 if (!wm)
739 return -ENOMEM;
740
741 wm->dev = &pdev->dev;
742 wm->ac97 = mfd_pdata->ac97;
743
744 ret = _wm97xx_probe(wm);
745 if (ret)
746 return ret;
747
748 ret = wm97xx_add_battery(wm, mfd_pdata->batt_pdata);
749 if (ret < 0)
750 goto batt_err;
751
752 return ret;
753
754batt_err:
755 wm97xx_unregister_touch(wm);
756 return ret;
757}
758
759static void wm97xx_mfd_remove(struct platform_device *pdev)
760{
761 wm97xx_remove(&pdev->dev);
762}
763
764static int wm97xx_suspend(struct device *dev)
765{
766 struct wm97xx *wm = dev_get_drvdata(dev);
767 u16 reg;
768 int suspend_mode;
769
770 if (device_may_wakeup(&wm->input_dev->dev))
771 suspend_mode = wm->suspend_mode;
772 else
773 suspend_mode = 0;
774
775 mutex_lock(&wm->input_dev->mutex);
776 if (input_device_enabled(wm->input_dev))
777 cancel_delayed_work_sync(&wm->ts_reader);
778
779 /* Power down the digitiser (bypassing the cache for resume) */
780 reg = wm97xx_reg_read(wm, AC97_WM97XX_DIGITISER2);
781 reg &= ~WM97XX_PRP_DET_DIG;
782 if (input_device_enabled(wm->input_dev))
783 reg |= suspend_mode;
784 wm->ac97->bus->ops->write(wm->ac97, AC97_WM97XX_DIGITISER2, reg);
785
786 /* WM9713 has an additional power bit - turn it off if there
787 * are no users or if suspend mode is zero. */
788 if (wm->id == WM9713_ID2 &&
789 (!input_device_enabled(wm->input_dev) || !suspend_mode)) {
790 reg = wm97xx_reg_read(wm, AC97_EXTENDED_MID) | 0x8000;
791 wm97xx_reg_write(wm, AC97_EXTENDED_MID, reg);
792 }
793 mutex_unlock(&wm->input_dev->mutex);
794
795 return 0;
796}
797
798static int wm97xx_resume(struct device *dev)
799{
800 struct wm97xx *wm = dev_get_drvdata(dev);
801
802 mutex_lock(&wm->input_dev->mutex);
803 /* restore digitiser and gpios */
804 if (wm->id == WM9713_ID2) {
805 wm97xx_reg_write(wm, AC97_WM9713_DIG1, wm->dig[0]);
806 wm97xx_reg_write(wm, 0x5a, wm->misc);
807 if (input_device_enabled(wm->input_dev)) {
808 u16 reg;
809 reg = wm97xx_reg_read(wm, AC97_EXTENDED_MID) & 0x7fff;
810 wm97xx_reg_write(wm, AC97_EXTENDED_MID, reg);
811 }
812 }
813
814 wm97xx_reg_write(wm, AC97_WM9713_DIG2, wm->dig[1]);
815 wm97xx_reg_write(wm, AC97_WM9713_DIG3, wm->dig[2]);
816
817 wm97xx_reg_write(wm, AC97_GPIO_CFG, wm->gpio[0]);
818 wm97xx_reg_write(wm, AC97_GPIO_POLARITY, wm->gpio[1]);
819 wm97xx_reg_write(wm, AC97_GPIO_STICKY, wm->gpio[2]);
820 wm97xx_reg_write(wm, AC97_GPIO_WAKEUP, wm->gpio[3]);
821 wm97xx_reg_write(wm, AC97_GPIO_STATUS, wm->gpio[4]);
822 wm97xx_reg_write(wm, AC97_MISC_AFE, wm->gpio[5]);
823
824 if (input_device_enabled(wm->input_dev) && !wm->pen_irq) {
825 wm->ts_reader_interval = wm->ts_reader_min_interval;
826 queue_delayed_work(wm->ts_workq, &wm->ts_reader,
827 wm->ts_reader_interval);
828 }
829 mutex_unlock(&wm->input_dev->mutex);
830
831 return 0;
832}
833
834static DEFINE_SIMPLE_DEV_PM_OPS(wm97xx_pm_ops, wm97xx_suspend, wm97xx_resume);
835
836/*
837 * Machine specific operations
838 */
839int wm97xx_register_mach_ops(struct wm97xx *wm,
840 struct wm97xx_mach_ops *mach_ops)
841{
842 mutex_lock(&wm->codec_mutex);
843 if (wm->mach_ops) {
844 mutex_unlock(&wm->codec_mutex);
845 return -EINVAL;
846 }
847 wm->mach_ops = mach_ops;
848 mutex_unlock(&wm->codec_mutex);
849
850 return 0;
851}
852EXPORT_SYMBOL_GPL(wm97xx_register_mach_ops);
853
854void wm97xx_unregister_mach_ops(struct wm97xx *wm)
855{
856 mutex_lock(&wm->codec_mutex);
857 wm->mach_ops = NULL;
858 mutex_unlock(&wm->codec_mutex);
859}
860EXPORT_SYMBOL_GPL(wm97xx_unregister_mach_ops);
861
862static struct device_driver wm97xx_driver = {
863 .name = "wm97xx-ts",
864#ifdef CONFIG_AC97_BUS
865 .bus = &ac97_bus_type,
866#endif
867 .owner = THIS_MODULE,
868 .probe = wm97xx_probe,
869 .remove = wm97xx_remove,
870 .pm = pm_sleep_ptr(&wm97xx_pm_ops),
871};
872
873static struct platform_driver wm97xx_mfd_driver = {
874 .driver = {
875 .name = "wm97xx-ts",
876 .pm = pm_sleep_ptr(&wm97xx_pm_ops),
877 },
878 .probe = wm97xx_mfd_probe,
879 .remove = wm97xx_mfd_remove,
880};
881
882static int __init wm97xx_init(void)
883{
884 int ret;
885
886 ret = platform_driver_register(&wm97xx_mfd_driver);
887 if (ret)
888 return ret;
889
890 if (IS_BUILTIN(CONFIG_AC97_BUS))
891 ret = driver_register(&wm97xx_driver);
892 return ret;
893}
894
895static void __exit wm97xx_exit(void)
896{
897 if (IS_BUILTIN(CONFIG_AC97_BUS))
898 driver_unregister(&wm97xx_driver);
899 platform_driver_unregister(&wm97xx_mfd_driver);
900}
901
902module_init(wm97xx_init);
903module_exit(wm97xx_exit);
904
905/* Module information */
906MODULE_AUTHOR("Liam Girdwood <lrg@slimlogic.co.uk>");
907MODULE_DESCRIPTION("WM97xx Core - Touch Screen / AUX ADC / GPIO Driver");
908MODULE_LICENSE("GPL");