1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
|
/*
* Copyright 2006-2010, Cypress Semiconductor Corporation.
* Copyright (C) 2010, Samsung Electronics Co. Ltd. All Rights Reserved.
* Copyright (C) 2011 <kang@insecure.ws>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301, USA.
*
*/
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/timer.h>
#include <linux/init.h>
#include <linux/i2c.h>
#include <linux/slab.h>
#include <linux/interrupt.h>
#include <linux/delay.h>
#include <linux/input.h>
#include <linux/earlysuspend.h>
#include <linux/miscdevice.h>
#include <linux/input/cypress-touchkey.h>
#ifdef CONFIG_SAMSUNG_FASCINATE
#include <mach/gpio.h>
#include <mach/gpio-aries.h>
#include <mach/regs-gpio.h>
#endif
#define SCANCODE_MASK 0x07
#define UPDOWN_EVENT_MASK 0x08
#define ESD_STATE_MASK 0x10
#define BACKLIGHT_ON 0x10
#define BACKLIGHT_OFF 0x20
#define OLD_BACKLIGHT_ON 0x1
#define OLD_BACKLIGHT_OFF 0x2
#define DEVICE_NAME "cypress-touchkey"
#ifdef CONFIG_SAMSUNG_FASCINATE
extern const unsigned long touch_int_flt_width;
void touch_key_set_int_flt(unsigned long width);
#endif
int bl_on = 0;
static DEFINE_SEMAPHORE(enable_sem);
static DEFINE_SEMAPHORE(i2c_sem);
struct cypress_touchkey_devdata *bl_devdata;
static int bl_timeout = 1600; // This gets overridden by userspace AriesParts
static struct timer_list bl_timer;
static void bl_off(struct work_struct *bl_off_work);
static DECLARE_WORK(bl_off_work, bl_off);
struct cypress_touchkey_devdata {
struct i2c_client *client;
struct input_dev *input_dev;
struct touchkey_platform_data *pdata;
struct early_suspend early_suspend;
u8 backlight_on;
u8 backlight_off;
bool is_dead;
bool is_powering_on;
bool has_legacy_keycode;
bool is_sleeping;
};
static int i2c_touchkey_read_byte(struct cypress_touchkey_devdata *devdata,
u8 *val)
{
int ret;
int retry = 2;
down(&i2c_sem);
while (true) {
ret = i2c_smbus_read_byte(devdata->client);
if (ret >= 0) {
*val = ret;
ret = 0;
break;
}
if (!retry--) {
dev_err(&devdata->client->dev, "i2c read error\n");
break;
}
msleep(10);
}
up(&i2c_sem);
return ret;
}
static int i2c_touchkey_write_byte(struct cypress_touchkey_devdata *devdata,
u8 val)
{
int ret;
int retry = 2;
down(&i2c_sem);
while (true) {
ret = i2c_smbus_write_byte(devdata->client, val);
if (!ret) {
ret = 0;
break;
}
if (!retry--) {
dev_err(&devdata->client->dev, "i2c write error\n");
break;
}
msleep(10);
}
up(&i2c_sem);
return ret;
}
static void all_keys_up(struct cypress_touchkey_devdata *devdata)
{
int i;
for (i = 0; i < devdata->pdata->keycode_cnt; i++)
input_report_key(devdata->input_dev,
devdata->pdata->keycode[i], 0);
input_sync(devdata->input_dev);
}
static void bl_off(struct work_struct *bl_off_work)
{
if (bl_devdata == NULL || unlikely(bl_devdata->is_dead) ||
bl_devdata->is_powering_on || bl_on || bl_devdata->is_sleeping)
return;
i2c_touchkey_write_byte(bl_devdata, bl_devdata->backlight_off);
}
void bl_timer_callback(unsigned long data)
{
schedule_work(&bl_off_work);
}
static void bl_set_timeout() {
if (bl_timeout > 0) {
mod_timer(&bl_timer, jiffies + msecs_to_jiffies(bl_timeout));
}
}
static int recovery_routine(struct cypress_touchkey_devdata *devdata)
{
int ret = -1;
int retry = 10;
u8 data;
int irq_eint;
if (unlikely(devdata->is_dead)) {
dev_err(&devdata->client->dev, "%s: Device is already dead, "
"skipping recovery\n", __func__);
return -ENODEV;
}
irq_eint = devdata->client->irq;
down(&enable_sem);
all_keys_up(devdata);
disable_irq_nosync(irq_eint);
while (retry--) {
devdata->pdata->touchkey_onoff(TOUCHKEY_OFF);
devdata->pdata->touchkey_onoff(TOUCHKEY_ON);
ret = i2c_touchkey_read_byte(devdata, &data);
if (!ret) {
if (!devdata->is_sleeping) {
enable_irq(irq_eint);
#ifdef CONFIG_SAMSUNG_FASCINATE
touch_key_set_int_flt(touch_int_flt_width);
#endif
}
goto out;
}
dev_err(&devdata->client->dev, "%s: i2c transfer error retry = "
"%d\n", __func__, retry);
}
devdata->is_dead = true;
devdata->pdata->touchkey_onoff(TOUCHKEY_OFF);
dev_err(&devdata->client->dev, "%s: touchkey died\n", __func__);
out:
dev_err(&devdata->client->dev, "%s: recovery_routine\n", __func__);
up(&enable_sem);
return ret;
}
// Accidental touch key prevention (see mxt224.c)
extern unsigned int touch_state_val;
static irqreturn_t touchkey_interrupt_thread(int irq, void *touchkey_devdata)
{
u8 data;
int i;
int ret;
int scancode;
struct cypress_touchkey_devdata *devdata = touchkey_devdata;
#ifdef CONFIG_SAMSUNG_FASCINATE
for (i = 0; i < 10; ++i)
{
ret = gpio_get_value(_3_GPIO_TOUCH_INT);
if (ret & 1) {
dev_err(&devdata->client->dev, "%s: possible phantom key press... "
"ignore it!\n", __func__);
goto err;
}
}
#endif
ret = i2c_touchkey_read_byte(devdata, &data);
if (ret || (data & ESD_STATE_MASK)) {
ret = recovery_routine(devdata);
if (ret) {
dev_err(&devdata->client->dev, "%s: touchkey recovery "
"failed!\n", __func__);
goto err;
}
}
if (devdata->has_legacy_keycode) {
scancode = (data & SCANCODE_MASK) - 1;
if (scancode < 0 || scancode >= devdata->pdata->keycode_cnt) {
dev_err(&devdata->client->dev, "%s: scancode is out of "
"range\n", __func__);
goto err;
}
/* Don't send down event while the touch screen is being pressed
* to prevent accidental touch key hit.
*/
if ((data & UPDOWN_EVENT_MASK) || !touch_state_val) {
input_report_key(devdata->input_dev,
devdata->pdata->keycode[scancode],
!(data & UPDOWN_EVENT_MASK));
}
} else {
for (i = 0; i < devdata->pdata->keycode_cnt; i++)
input_report_key(devdata->input_dev,
devdata->pdata->keycode[i],
!!(data & (1U << i)));
}
input_sync(devdata->input_dev);
bl_set_timeout();
err:
return IRQ_HANDLED;
}
static irqreturn_t touchkey_interrupt_handler(int irq, void *touchkey_devdata)
{
struct cypress_touchkey_devdata *devdata = touchkey_devdata;
#ifdef CONFIG_SAMSUNG_FASCINATE
int i = gpio_get_value(_3_GPIO_TOUCH_INT);
if ((i & 1) || devdata->is_powering_on) {
#else
if (devdata->is_powering_on) {
#endif
dev_dbg(&devdata->client->dev, "%s: ignoring spurious boot "
"interrupt\n", __func__);
return IRQ_HANDLED;
}
return IRQ_WAKE_THREAD;
}
static void notify_led_on(void) {
down(&enable_sem);
if (unlikely(bl_devdata->is_dead) || bl_on)
goto out;
if (bl_devdata->is_sleeping) {
bl_devdata->pdata->touchkey_sleep_onoff(TOUCHKEY_ON);
bl_devdata->pdata->touchkey_onoff(TOUCHKEY_ON);
}
i2c_touchkey_write_byte(bl_devdata, bl_devdata->backlight_on);
bl_on = 1;
printk(KERN_DEBUG "%s: notification led enabled\n", __FUNCTION__);
out:
up(&enable_sem);
}
static void notify_led_off(void) {
// Avoid race condition with touch key resume
down(&enable_sem);
if (unlikely(bl_devdata->is_dead) || !bl_on)
goto out;
if (bl_on && bl_timer.expires < jiffies) // Don't disable if there's a timer scheduled
i2c_touchkey_write_byte(bl_devdata, bl_devdata->backlight_off);
bl_devdata->pdata->touchkey_sleep_onoff(TOUCHKEY_OFF);
if (bl_devdata->is_sleeping)
bl_devdata->pdata->touchkey_onoff(TOUCHKEY_OFF);
bl_on = 0;
printk(KERN_DEBUG "%s: notification led disabled\n", __FUNCTION__);
out:
up(&enable_sem);
}
#ifdef CONFIG_HAS_EARLYSUSPEND
static void cypress_touchkey_early_suspend(struct early_suspend *h)
{
struct cypress_touchkey_devdata *devdata =
container_of(h, struct cypress_touchkey_devdata, early_suspend);
down(&enable_sem);
devdata->is_powering_on = true;
if (unlikely(devdata->is_dead)) {
goto out;
}
disable_irq(devdata->client->irq);
if (!bl_on)
devdata->pdata->touchkey_onoff(TOUCHKEY_OFF);
all_keys_up(devdata);
devdata->is_sleeping = true;
out:
up(&enable_sem);
}
static void cypress_touchkey_early_resume(struct early_suspend *h)
{
struct cypress_touchkey_devdata *devdata =
container_of(h, struct cypress_touchkey_devdata, early_suspend);
// Avoid race condition with LED notification disable
down(&enable_sem);
devdata->pdata->touchkey_onoff(TOUCHKEY_ON);
if (i2c_touchkey_write_byte(devdata, devdata->backlight_on)) {
devdata->is_dead = true;
devdata->pdata->touchkey_onoff(TOUCHKEY_OFF);
dev_err(&devdata->client->dev, "%s: touch keypad not responding"
" to commands, disabling\n", __func__);
up(&enable_sem);
return;
}
devdata->is_dead = false;
enable_irq(devdata->client->irq);
#ifdef CONFIG_SAMSUNG_FASCINATE
touch_key_set_int_flt(touch_int_flt_width);
#endif
devdata->is_powering_on = false;
devdata->is_sleeping = false;
up(&enable_sem);
bl_set_timeout();
}
#endif
static ssize_t led_status_read(struct device *dev, struct device_attribute *attr, char *buf) {
return sprintf(buf,"%u\n", bl_on);
}
static ssize_t led_status_write(struct device *dev, struct device_attribute *attr, const char *buf, size_t size)
{
unsigned int data;
if (sscanf(buf, "%u\n", &data)) {
if (data == 1)
notify_led_on();
else
notify_led_off();
}
return size;
}
static ssize_t bl_timeout_read(struct device *dev, struct device_attribute *attr, char *buf) {
return sprintf(buf,"%d\n", bl_timeout);
}
static ssize_t bl_timeout_write(struct device *dev, struct device_attribute *attr, const char *buf, size_t size)
{
sscanf(buf, "%d\n", &bl_timeout);
return size;
}
static DEVICE_ATTR(led, S_IRUGO | S_IWUGO , led_status_read, led_status_write);
static DEVICE_ATTR(bl_timeout, S_IRUGO | S_IWUGO, bl_timeout_read, bl_timeout_write);
static struct attribute *bl_led_attributes[] = {
&dev_attr_led.attr,
&dev_attr_bl_timeout.attr, // Not the best place, but creating a new device is more trouble that it's worth
NULL
};
static struct attribute_group bl_led_group = {
.attrs = bl_led_attributes,
};
static struct miscdevice bl_led_device = {
.minor = MISC_DYNAMIC_MINOR,
.name = "notification",
};
static int cypress_touchkey_probe(struct i2c_client *client,
const struct i2c_device_id *id)
{
struct device *dev = &client->dev;
struct input_dev *input_dev;
struct cypress_touchkey_devdata *devdata;
u8 data[3];
int err;
int cnt;
if (!dev->platform_data) {
dev_err(dev, "%s: Platform data is NULL\n", __func__);
return -EINVAL;
}
devdata = kzalloc(sizeof(*devdata), GFP_KERNEL);
if (devdata == NULL) {
dev_err(dev, "%s: failed to create our state\n", __func__);
return -ENODEV;
}
devdata->client = client;
i2c_set_clientdata(client, devdata);
devdata->pdata = client->dev.platform_data;
if (!devdata->pdata->keycode) {
dev_err(dev, "%s: Invalid platform data\n", __func__);
err = -EINVAL;
goto err_null_keycodes;
}
strlcpy(devdata->client->name, DEVICE_NAME, I2C_NAME_SIZE);
input_dev = input_allocate_device();
if (!input_dev) {
err = -ENOMEM;
goto err_input_alloc_dev;
}
devdata->input_dev = input_dev;
dev_set_drvdata(&input_dev->dev, devdata);
input_dev->name = DEVICE_NAME;
input_dev->id.bustype = BUS_HOST;
for (cnt = 0; cnt < devdata->pdata->keycode_cnt; cnt++)
input_set_capability(input_dev, EV_KEY,
devdata->pdata->keycode[cnt]);
err = input_register_device(input_dev);
if (err)
goto err_input_reg_dev;
devdata->is_powering_on = true;
devdata->is_sleeping = false;
devdata->pdata->touchkey_onoff(TOUCHKEY_ON);
err = i2c_master_recv(client, data, sizeof(data));
if (err < sizeof(data)) {
if (err >= 0)
err = -EIO;
dev_err(dev, "%s: error reading hardware version\n", __func__);
goto err_read;
}
dev_info(dev, "%s: hardware rev1 = %#02x, rev2 = %#02x\n", __func__,
data[1], data[2]);
#ifdef CONFIG_KEYPAD_CYPRESS_TOUCH_HAS_LEGACY_KEYCODE
devdata->has_legacy_keycode = true;
#else
devdata->has_legacy_keycode = data[1] >= 0xc4 || data[1] < 0x9 ||
(data[1] == 0x9 && data[2] < 0x9);
#endif
if (data[1] < 0xc4 && (data[1] >= 0x8 ||
(data[1] == 0x8 && data[2] >= 0x9)) &&
devdata->has_legacy_keycode == false) {
devdata->backlight_on = BACKLIGHT_ON;
devdata->backlight_off = BACKLIGHT_OFF;
} else {
devdata->backlight_on = OLD_BACKLIGHT_ON;
devdata->backlight_off = OLD_BACKLIGHT_OFF;
}
err = i2c_touchkey_write_byte(devdata, devdata->backlight_off);
if (err) {
dev_err(dev, "%s: touch keypad backlight on failed\n",
__func__);
/* The device may not be responding because of bad firmware
*/
goto err_backlight_off;
}
err = request_threaded_irq(client->irq, touchkey_interrupt_handler,
touchkey_interrupt_thread, IRQF_TRIGGER_FALLING,
DEVICE_NAME, devdata);
if (err) {
dev_err(dev, "%s: Can't allocate irq.\n", __func__);
goto err_req_irq;
}
#ifdef CONFIG_SAMSUNG_FASCINATE
touch_key_set_int_flt(touch_int_flt_width);
#endif
#ifdef CONFIG_HAS_EARLYSUSPEND
devdata->early_suspend.suspend = cypress_touchkey_early_suspend;
devdata->early_suspend.resume = cypress_touchkey_early_resume;
#endif
register_early_suspend(&devdata->early_suspend);
devdata->is_powering_on = false;
if (misc_register(&bl_led_device))
printk("%s misc_register(%s) failed\n", __FUNCTION__, bl_led_device.name);
else {
if (sysfs_create_group(&bl_led_device.this_device->kobj, &bl_led_group) < 0)
pr_err("failed to create sysfs group for device %s\n", bl_led_device.name);
}
bl_devdata = devdata;
setup_timer(&bl_timer, bl_timer_callback, 0);
return 0;
err_req_irq:
err_backlight_off:
input_unregister_device(input_dev);
goto touchkey_off;
err_input_reg_dev:
err_read:
input_free_device(input_dev);
touchkey_off:
devdata->is_powering_on = false;
devdata->pdata->touchkey_onoff(TOUCHKEY_OFF);
err_input_alloc_dev:
err_null_keycodes:
kfree(devdata);
return err;
}
static int __devexit i2c_touchkey_remove(struct i2c_client *client)
{
struct cypress_touchkey_devdata *devdata = i2c_get_clientdata(client);
dev_err(&client->dev, "%s: i2c_touchkey_remove\n", __func__);
misc_deregister(&bl_led_device);
unregister_early_suspend(&devdata->early_suspend);
/* If the device is dead IRQs are disabled, we need to rebalance them */
if (unlikely(devdata->is_dead))
enable_irq(client->irq);
else {
devdata->pdata->touchkey_onoff(TOUCHKEY_OFF);
devdata->is_powering_on = false;
}
free_irq(client->irq, devdata);
all_keys_up(devdata);
input_unregister_device(devdata->input_dev);
del_timer(&bl_timer);
kfree(devdata);
return 0;
}
static const struct i2c_device_id cypress_touchkey_id[] = {
{ CYPRESS_TOUCHKEY_DEV_NAME, 0 },
};
MODULE_DEVICE_TABLE(i2c, cypress_touchkey_id);
struct i2c_driver touchkey_i2c_driver = {
.driver = {
.name = "cypress_touchkey_driver",
},
.id_table = cypress_touchkey_id,
.probe = cypress_touchkey_probe,
.remove = __devexit_p(i2c_touchkey_remove),
};
static int __init touchkey_init(void)
{
int ret = 0;
ret = i2c_add_driver(&touchkey_i2c_driver);
if (ret)
pr_err("%s: cypress touch keypad registration failed. (%d)\n",
__func__, ret);
return ret;
}
static void __exit touchkey_exit(void)
{
i2c_del_driver(&touchkey_i2c_driver);
}
late_initcall(touchkey_init);
module_exit(touchkey_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("@@@");
MODULE_DESCRIPTION("cypress touch keypad");
|