1
2
3
4
5
6
7
8
9
10
11
12
13#include <linux/module.h>
14#include <linux/i2c.h>
15#include <linux/irq.h>
16#include <linux/interrupt.h>
17#include <linux/input.h>
18#include <linux/delay.h>
19#include <linux/workqueue.h>
20#include <linux/slab.h>
21
22#define DRIVER_NAME "synaptics_i2c"
23
24#define PRODUCT_ID_LENGTH 15
25#define REGISTER_LENGTH 8
26
27
28
29
30
31#define SOFT_RESET_DELAY_MS 3
32
33#define HARD_RESET_DELAY_MS 500
34
35
36#define PAGE_SEL_REG 0xff
37#define DEVICE_STATUS_REG 0x09
38
39
40#define DEV_CONTROL_REG 0x0000
41#define INTERRUPT_EN_REG 0x0001
42#define ERR_STAT_REG 0x0002
43#define INT_REQ_STAT_REG 0x0003
44#define DEV_COMMAND_REG 0x0004
45
46#define RMI_PROT_VER_REG 0x0200
47#define MANUFACT_ID_REG 0x0201
48#define PHYS_INT_VER_REG 0x0202
49#define PROD_PROPERTY_REG 0x0203
50#define INFO_QUERY_REG0 0x0204
51#define INFO_QUERY_REG1 (INFO_QUERY_REG0 + 1)
52#define INFO_QUERY_REG2 (INFO_QUERY_REG0 + 2)
53#define INFO_QUERY_REG3 (INFO_QUERY_REG0 + 3)
54
55#define PRODUCT_ID_REG0 0x0210
56#define PRODUCT_ID_REG1 (PRODUCT_ID_REG0 + 1)
57#define PRODUCT_ID_REG2 (PRODUCT_ID_REG0 + 2)
58#define PRODUCT_ID_REG3 (PRODUCT_ID_REG0 + 3)
59#define PRODUCT_ID_REG4 (PRODUCT_ID_REG0 + 4)
60#define PRODUCT_ID_REG5 (PRODUCT_ID_REG0 + 5)
61#define PRODUCT_ID_REG6 (PRODUCT_ID_REG0 + 6)
62#define PRODUCT_ID_REG7 (PRODUCT_ID_REG0 + 7)
63#define PRODUCT_ID_REG8 (PRODUCT_ID_REG0 + 8)
64#define PRODUCT_ID_REG9 (PRODUCT_ID_REG0 + 9)
65#define PRODUCT_ID_REG10 (PRODUCT_ID_REG0 + 10)
66#define PRODUCT_ID_REG11 (PRODUCT_ID_REG0 + 11)
67#define PRODUCT_ID_REG12 (PRODUCT_ID_REG0 + 12)
68#define PRODUCT_ID_REG13 (PRODUCT_ID_REG0 + 13)
69#define PRODUCT_ID_REG14 (PRODUCT_ID_REG0 + 14)
70#define PRODUCT_ID_REG15 (PRODUCT_ID_REG0 + 15)
71
72#define DATA_REG0 0x0400
73#define ABS_PRESSURE_REG 0x0401
74#define ABS_MSB_X_REG 0x0402
75#define ABS_LSB_X_REG (ABS_MSB_X_REG + 1)
76#define ABS_MSB_Y_REG 0x0404
77#define ABS_LSB_Y_REG (ABS_MSB_Y_REG + 1)
78#define REL_X_REG 0x0406
79#define REL_Y_REG 0x0407
80
81#define DEV_QUERY_REG0 0x1000
82#define DEV_QUERY_REG1 (DEV_QUERY_REG0 + 1)
83#define DEV_QUERY_REG2 (DEV_QUERY_REG0 + 2)
84#define DEV_QUERY_REG3 (DEV_QUERY_REG0 + 3)
85#define DEV_QUERY_REG4 (DEV_QUERY_REG0 + 4)
86#define DEV_QUERY_REG5 (DEV_QUERY_REG0 + 5)
87#define DEV_QUERY_REG6 (DEV_QUERY_REG0 + 6)
88#define DEV_QUERY_REG7 (DEV_QUERY_REG0 + 7)
89#define DEV_QUERY_REG8 (DEV_QUERY_REG0 + 8)
90
91#define GENERAL_2D_CONTROL_REG 0x1041
92#define SENSOR_SENSITIVITY_REG 0x1044
93#define SENS_MAX_POS_MSB_REG 0x1046
94#define SENS_MAX_POS_LSB_REG (SENS_MAX_POS_UPPER_REG + 1)
95
96
97
98#define REPORT_RATE_1ST_BIT 6
99
100
101#define F10_ABS_INT_ENA 0
102#define F10_REL_INT_ENA 1
103#define F20_INT_ENA 2
104
105
106#define F10_ABS_INT_REQ 0
107#define F10_REL_INT_REQ 1
108#define F20_INT_REQ 2
109
110#define STAT_CONFIGURED 6
111#define STAT_ERROR 7
112
113
114#define RESET_COMMAND 0x01
115#define REZERO_COMMAND 0x02
116
117
118#define GESTURE 3
119
120
121
122#define HAS_PALM_DETECT 1
123#define HAS_MULTI_FING 2
124#define HAS_SCROLLER 4
125#define HAS_2D_SCROLL 5
126
127
128#define NO_DECELERATION 1
129#define REDUCE_REPORTING 3
130#define NO_FILTER 5
131
132
133
134#define REPORT_RATE_MSK 0xc0
135#define SLEEP_MODE_MSK 0x07
136
137
138#define FULL_AWAKE 0x0
139#define NORMAL_OP 0x1
140#define LOW_PWR_OP 0x2
141#define VERY_LOW_PWR_OP 0x3
142#define SENS_SLEEP 0x4
143#define SLEEP_MOD 0x5
144#define DEEP_SLEEP 0x6
145#define HIBERNATE 0x7
146
147
148
149#define INT_ENA_REQ_MSK 0x07
150#define INT_ENA_ABS_MSK 0x01
151#define INT_ENA_REL_MSK 0x02
152#define INT_ENA_F20_MSK 0x04
153
154
155#define CONFIGURED_MSK 0x40
156#define ERROR_MSK 0x80
157
158
159#define FINGER_WIDTH_MSK 0xf0
160#define GESTURE_MSK 0x08
161#define SENSOR_STATUS_MSK 0x07
162
163
164
165
166
167
168#define MSB_POSITION_MSK 0x1f
169
170
171
172
173#define NUM_EXTRA_POS_MSK 0x07
174
175
176#define THREAD_IRQ_SLEEP_SECS 2
177#define THREAD_IRQ_SLEEP_MSECS (THREAD_IRQ_SLEEP_SECS * MSEC_PER_SEC)
178
179
180
181
182
183#define NO_DATA_THRES (MSEC_PER_SEC)
184#define NO_DATA_SLEEP_MSECS (MSEC_PER_SEC / 4)
185
186
187static int no_decel = 1;
188module_param(no_decel, bool, 0644);
189MODULE_PARM_DESC(no_decel, "No Deceleration. Default = 1 (on)");
190
191
192static int reduce_report;
193module_param(reduce_report, bool, 0644);
194MODULE_PARM_DESC(reduce_report, "Reduced Reporting. Default = 0 (off)");
195
196
197static int no_filter;
198module_param(no_filter, bool, 0644);
199MODULE_PARM_DESC(no_filter, "No Filter. Default = 0 (off)");
200
201
202
203
204
205
206
207static bool polling_req;
208module_param(polling_req, bool, 0444);
209MODULE_PARM_DESC(polling_req, "Request Polling. Default = 0 (use irq)");
210
211
212static int scan_rate = 80;
213module_param(scan_rate, int, 0644);
214MODULE_PARM_DESC(scan_rate, "Polling rate in times/sec. Default = 80");
215
216
217struct synaptics_i2c {
218 struct i2c_client *client;
219 struct input_dev *input;
220 struct delayed_work dwork;
221 spinlock_t lock;
222 int no_data_count;
223 int no_decel_param;
224 int reduce_report_param;
225 int no_filter_param;
226 int scan_rate_param;
227 int scan_ms;
228};
229
230static inline void set_scan_rate(struct synaptics_i2c *touch, int scan_rate)
231{
232 touch->scan_ms = MSEC_PER_SEC / scan_rate;
233 touch->scan_rate_param = scan_rate;
234}
235
236
237
238
239
240
241static s32 synaptics_i2c_reg_get(struct i2c_client *client, u16 reg)
242{
243 int ret;
244
245 ret = i2c_smbus_write_byte_data(client, PAGE_SEL_REG, reg >> 8);
246 if (ret == 0)
247 ret = i2c_smbus_read_byte_data(client, reg & 0xff);
248
249 return ret;
250}
251
252static s32 synaptics_i2c_reg_set(struct i2c_client *client, u16 reg, u8 val)
253{
254 int ret;
255
256 ret = i2c_smbus_write_byte_data(client, PAGE_SEL_REG, reg >> 8);
257 if (ret == 0)
258 ret = i2c_smbus_write_byte_data(client, reg & 0xff, val);
259
260 return ret;
261}
262
263static s32 synaptics_i2c_word_get(struct i2c_client *client, u16 reg)
264{
265 int ret;
266
267 ret = i2c_smbus_write_byte_data(client, PAGE_SEL_REG, reg >> 8);
268 if (ret == 0)
269 ret = i2c_smbus_read_word_data(client, reg & 0xff);
270
271 return ret;
272}
273
274static int synaptics_i2c_config(struct i2c_client *client)
275{
276 int ret, control;
277 u8 int_en;
278
279
280 ret = synaptics_i2c_reg_set(client, DEV_CONTROL_REG, 0xc1);
281 if (ret)
282 return ret;
283
284
285 int_en = (polling_req) ? 0 : INT_ENA_ABS_MSK | INT_ENA_REL_MSK;
286 ret = synaptics_i2c_reg_set(client, INTERRUPT_EN_REG, int_en);
287 if (ret)
288 return ret;
289
290 control = synaptics_i2c_reg_get(client, GENERAL_2D_CONTROL_REG);
291
292 control |= no_decel ? 1 << NO_DECELERATION : 0;
293
294 control |= reduce_report ? 1 << REDUCE_REPORTING : 0;
295
296 control |= no_filter ? 1 << NO_FILTER : 0;
297 ret = synaptics_i2c_reg_set(client, GENERAL_2D_CONTROL_REG, control);
298 if (ret)
299 return ret;
300
301 return 0;
302}
303
304static int synaptics_i2c_reset_config(struct i2c_client *client)
305{
306 int ret;
307
308
309 ret = synaptics_i2c_reg_set(client, DEV_COMMAND_REG, RESET_COMMAND);
310 if (ret) {
311 dev_err(&client->dev, "Unable to reset device\n");
312 } else {
313 msleep(SOFT_RESET_DELAY_MS);
314 ret = synaptics_i2c_config(client);
315 if (ret)
316 dev_err(&client->dev, "Unable to config device\n");
317 }
318
319 return ret;
320}
321
322static int synaptics_i2c_check_error(struct i2c_client *client)
323{
324 int status, ret = 0;
325
326 status = i2c_smbus_read_byte_data(client, DEVICE_STATUS_REG) &
327 (CONFIGURED_MSK | ERROR_MSK);
328
329 if (status != CONFIGURED_MSK)
330 ret = synaptics_i2c_reset_config(client);
331
332 return ret;
333}
334
335static bool synaptics_i2c_get_input(struct synaptics_i2c *touch)
336{
337 struct input_dev *input = touch->input;
338 int xy_delta, gesture;
339 s32 data;
340 s8 x_delta, y_delta;
341
342
343 if (synaptics_i2c_check_error(touch->client))
344 return 0;
345
346
347 data = synaptics_i2c_reg_get(touch->client, DATA_REG0);
348 gesture = (data >> GESTURE) & 0x1;
349
350
351
352
353
354 xy_delta = synaptics_i2c_word_get(touch->client, REL_X_REG) & 0xffff;
355
356
357 x_delta = xy_delta & 0xff;
358 y_delta = (xy_delta >> REGISTER_LENGTH) & 0xff;
359
360
361 input_report_key(input, BTN_LEFT, gesture);
362
363
364 input_report_rel(input, REL_X, x_delta);
365 input_report_rel(input, REL_Y, -y_delta);
366 input_sync(input);
367
368 return xy_delta || gesture;
369}
370
371static void synaptics_i2c_reschedule_work(struct synaptics_i2c *touch,
372 unsigned long delay)
373{
374 unsigned long flags;
375
376 spin_lock_irqsave(&touch->lock, flags);
377
378
379
380
381
382 __cancel_delayed_work(&touch->dwork);
383 schedule_delayed_work(&touch->dwork, delay);
384
385 spin_unlock_irqrestore(&touch->lock, flags);
386}
387
388static irqreturn_t synaptics_i2c_irq(int irq, void *dev_id)
389{
390 struct synaptics_i2c *touch = dev_id;
391
392 synaptics_i2c_reschedule_work(touch, 0);
393
394 return IRQ_HANDLED;
395}
396
397static void synaptics_i2c_check_params(struct synaptics_i2c *touch)
398{
399 bool reset = false;
400
401 if (scan_rate != touch->scan_rate_param)
402 set_scan_rate(touch, scan_rate);
403
404 if (no_decel != touch->no_decel_param) {
405 touch->no_decel_param = no_decel;
406 reset = true;
407 }
408
409 if (no_filter != touch->no_filter_param) {
410 touch->no_filter_param = no_filter;
411 reset = true;
412 }
413
414 if (reduce_report != touch->reduce_report_param) {
415 touch->reduce_report_param = reduce_report;
416 reset = true;
417 }
418
419 if (reset)
420 synaptics_i2c_reset_config(touch->client);
421}
422
423
424static unsigned long synaptics_i2c_adjust_delay(struct synaptics_i2c *touch,
425 bool have_data)
426{
427 unsigned long delay, nodata_count_thres;
428
429 if (polling_req) {
430 delay = touch->scan_ms;
431 if (have_data) {
432 touch->no_data_count = 0;
433 } else {
434 nodata_count_thres = NO_DATA_THRES / touch->scan_ms;
435 if (touch->no_data_count < nodata_count_thres)
436 touch->no_data_count++;
437 else
438 delay = NO_DATA_SLEEP_MSECS;
439 }
440 return msecs_to_jiffies(delay);
441 } else {
442 delay = msecs_to_jiffies(THREAD_IRQ_SLEEP_MSECS);
443 return round_jiffies_relative(delay);
444 }
445}
446
447
448static void synaptics_i2c_work_handler(struct work_struct *work)
449{
450 bool have_data;
451 struct synaptics_i2c *touch =
452 container_of(work, struct synaptics_i2c, dwork.work);
453 unsigned long delay;
454
455 synaptics_i2c_check_params(touch);
456
457 have_data = synaptics_i2c_get_input(touch);
458 delay = synaptics_i2c_adjust_delay(touch, have_data);
459
460
461
462
463
464
465
466
467
468 synaptics_i2c_reschedule_work(touch, delay);
469}
470
471static int synaptics_i2c_open(struct input_dev *input)
472{
473 struct synaptics_i2c *touch = input_get_drvdata(input);
474 int ret;
475
476 ret = synaptics_i2c_reset_config(touch->client);
477 if (ret)
478 return ret;
479
480 if (polling_req)
481 synaptics_i2c_reschedule_work(touch,
482 msecs_to_jiffies(NO_DATA_SLEEP_MSECS));
483
484 return 0;
485}
486
487static void synaptics_i2c_close(struct input_dev *input)
488{
489 struct synaptics_i2c *touch = input_get_drvdata(input);
490
491 if (!polling_req)
492 synaptics_i2c_reg_set(touch->client, INTERRUPT_EN_REG, 0);
493
494 cancel_delayed_work_sync(&touch->dwork);
495
496
497 synaptics_i2c_reg_set(touch->client, DEV_CONTROL_REG, DEEP_SLEEP);
498}
499
500static void synaptics_i2c_set_input_params(struct synaptics_i2c *touch)
501{
502 struct input_dev *input = touch->input;
503
504 input->name = touch->client->name;
505 input->phys = touch->client->adapter->name;
506 input->id.bustype = BUS_I2C;
507 input->id.version = synaptics_i2c_word_get(touch->client,
508 INFO_QUERY_REG0);
509 input->dev.parent = &touch->client->dev;
510 input->open = synaptics_i2c_open;
511 input->close = synaptics_i2c_close;
512 input_set_drvdata(input, touch);
513
514
515 __set_bit(EV_REL, input->evbit);
516 __set_bit(REL_X, input->relbit);
517 __set_bit(REL_Y, input->relbit);
518
519
520 __set_bit(EV_KEY, input->evbit);
521 __set_bit(BTN_LEFT, input->keybit);
522}
523
524static struct synaptics_i2c *synaptics_i2c_touch_create(struct i2c_client *client)
525{
526 struct synaptics_i2c *touch;
527
528 touch = kzalloc(sizeof(struct synaptics_i2c), GFP_KERNEL);
529 if (!touch)
530 return NULL;
531
532 touch->client = client;
533 touch->no_decel_param = no_decel;
534 touch->scan_rate_param = scan_rate;
535 set_scan_rate(touch, scan_rate);
536 INIT_DELAYED_WORK(&touch->dwork, synaptics_i2c_work_handler);
537 spin_lock_init(&touch->lock);
538
539 return touch;
540}
541
542static int __devinit synaptics_i2c_probe(struct i2c_client *client,
543 const struct i2c_device_id *dev_id)
544{
545 int ret;
546 struct synaptics_i2c *touch;
547
548 touch = synaptics_i2c_touch_create(client);
549 if (!touch)
550 return -ENOMEM;
551
552 ret = synaptics_i2c_reset_config(client);
553 if (ret)
554 goto err_mem_free;
555
556 if (client->irq < 1)
557 polling_req = true;
558
559 touch->input = input_allocate_device();
560 if (!touch->input) {
561 ret = -ENOMEM;
562 goto err_mem_free;
563 }
564
565 synaptics_i2c_set_input_params(touch);
566
567 if (!polling_req) {
568 dev_dbg(&touch->client->dev,
569 "Requesting IRQ: %d\n", touch->client->irq);
570
571 ret = request_irq(touch->client->irq, synaptics_i2c_irq,
572 IRQF_DISABLED|IRQ_TYPE_EDGE_FALLING,
573 DRIVER_NAME, touch);
574 if (ret) {
575 dev_warn(&touch->client->dev,
576 "IRQ request failed: %d, "
577 "falling back to polling\n", ret);
578 polling_req = true;
579 synaptics_i2c_reg_set(touch->client,
580 INTERRUPT_EN_REG, 0);
581 }
582 }
583
584 if (polling_req)
585 dev_dbg(&touch->client->dev,
586 "Using polling at rate: %d times/sec\n", scan_rate);
587
588
589 ret = input_register_device(touch->input);
590 if (ret) {
591 dev_err(&client->dev,
592 "Input device register failed: %d\n", ret);
593 goto err_input_free;
594 }
595
596 i2c_set_clientdata(client, touch);
597
598 return 0;
599
600err_input_free:
601 input_free_device(touch->input);
602err_mem_free:
603 kfree(touch);
604
605 return ret;
606}
607
608static int __devexit synaptics_i2c_remove(struct i2c_client *client)
609{
610 struct synaptics_i2c *touch = i2c_get_clientdata(client);
611
612 if (!polling_req)
613 free_irq(client->irq, touch);
614
615 input_unregister_device(touch->input);
616 kfree(touch);
617
618 return 0;
619}
620
621#ifdef CONFIG_PM
622static int synaptics_i2c_suspend(struct i2c_client *client, pm_message_t mesg)
623{
624 struct synaptics_i2c *touch = i2c_get_clientdata(client);
625
626 cancel_delayed_work_sync(&touch->dwork);
627
628
629 synaptics_i2c_reg_set(touch->client, DEV_CONTROL_REG, DEEP_SLEEP);
630
631 return 0;
632}
633
634static int synaptics_i2c_resume(struct i2c_client *client)
635{
636 int ret;
637 struct synaptics_i2c *touch = i2c_get_clientdata(client);
638
639 ret = synaptics_i2c_reset_config(client);
640 if (ret)
641 return ret;
642
643 synaptics_i2c_reschedule_work(touch,
644 msecs_to_jiffies(NO_DATA_SLEEP_MSECS));
645
646 return 0;
647}
648#else
649#define synaptics_i2c_suspend NULL
650#define synaptics_i2c_resume NULL
651#endif
652
653static const struct i2c_device_id synaptics_i2c_id_table[] = {
654 { "synaptics_i2c", 0 },
655 { },
656};
657MODULE_DEVICE_TABLE(i2c, synaptics_i2c_id_table);
658
659static struct i2c_driver synaptics_i2c_driver = {
660 .driver = {
661 .name = DRIVER_NAME,
662 .owner = THIS_MODULE,
663 },
664
665 .probe = synaptics_i2c_probe,
666 .remove = __devexit_p(synaptics_i2c_remove),
667
668 .suspend = synaptics_i2c_suspend,
669 .resume = synaptics_i2c_resume,
670 .id_table = synaptics_i2c_id_table,
671};
672
673static int __init synaptics_i2c_init(void)
674{
675 return i2c_add_driver(&synaptics_i2c_driver);
676}
677
678static void __exit synaptics_i2c_exit(void)
679{
680 i2c_del_driver(&synaptics_i2c_driver);
681}
682
683module_init(synaptics_i2c_init);
684module_exit(synaptics_i2c_exit);
685
686MODULE_DESCRIPTION("Synaptics I2C touchpad driver");
687MODULE_AUTHOR("Mike Rapoport, Igor Grinberg, Compulab");
688MODULE_LICENSE("GPL");
689
690