2 * Atmel maXTouch Touchscreen driver
4 * Copyright (C) 2010 Samsung Electronics Co.Ltd
5 * Copyright (C) 2012 Google, Inc.
7 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2 of the License, or (at your
12 * option) any later version.
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/completion.h>
19 #include <linux/delay.h>
20 #include <linux/firmware.h>
21 #include <linux/i2c.h>
22 #include <linux/i2c/atmel_mxt_ts.h>
23 #include <linux/input/mt.h>
24 #include <linux/interrupt.h>
25 #include <linux/slab.h>
33 #define MXT_FW_NAME "maxtouch.fw"
37 #define MXT_FAMILY_ID 0x00
38 #define MXT_VARIANT_ID 0x01
39 #define MXT_VERSION 0x02
40 #define MXT_BUILD 0x03
41 #define MXT_MATRIX_X_SIZE 0x04
42 #define MXT_MATRIX_Y_SIZE 0x05
43 #define MXT_OBJECT_NUM 0x06
44 #define MXT_OBJECT_START 0x07
46 #define MXT_OBJECT_SIZE 6
49 #define MXT_DEBUG_DIAGNOSTIC_T37 37
50 #define MXT_GEN_MESSAGE_T5 5
51 #define MXT_GEN_COMMAND_T6 6
52 #define MXT_GEN_POWER_T7 7
53 #define MXT_GEN_ACQUIRE_T8 8
54 #define MXT_GEN_DATASOURCE_T53 53
55 #define MXT_TOUCH_MULTI_T9 9
56 #define MXT_TOUCH_KEYARRAY_T15 15
57 #define MXT_TOUCH_PROXIMITY_T23 23
58 #define MXT_TOUCH_PROXKEY_T52 52
59 #define MXT_PROCI_GRIPFACE_T20 20
60 #define MXT_PROCG_NOISE_T22 22
61 #define MXT_PROCI_ONETOUCH_T24 24
62 #define MXT_PROCI_TWOTOUCH_T27 27
63 #define MXT_PROCI_GRIP_T40 40
64 #define MXT_PROCI_PALM_T41 41
65 #define MXT_PROCI_TOUCHSUPPRESSION_T42 42
66 #define MXT_PROCI_STYLUS_T47 47
67 #define MXT_PROCG_NOISESUPPRESSION_T48 48
68 #define MXT_SPT_COMMSCONFIG_T18 18
69 #define MXT_SPT_GPIOPWM_T19 19
70 #define MXT_SPT_SELFTEST_T25 25
71 #define MXT_SPT_CTECONFIG_T28 28
72 #define MXT_SPT_USERDATA_T38 38
73 #define MXT_SPT_DIGITIZER_T43 43
74 #define MXT_SPT_MESSAGECOUNT_T44 44
75 #define MXT_SPT_CTECONFIG_T46 46
77 /* MXT_GEN_COMMAND_T6 field */
78 #define MXT_COMMAND_RESET 0
79 #define MXT_COMMAND_BACKUPNV 1
80 #define MXT_COMMAND_CALIBRATE 2
81 #define MXT_COMMAND_REPORTALL 3
82 #define MXT_COMMAND_DIAGNOSTIC 5
84 /* Define for T6 status byte */
85 #define MXT_T6_STATUS_RESET (1 << 7)
87 /* MXT_GEN_POWER_T7 field */
88 #define MXT_POWER_IDLEACQINT 0
89 #define MXT_POWER_ACTVACQINT 1
90 #define MXT_POWER_ACTV2IDLETO 2
92 /* MXT_GEN_ACQUIRE_T8 field */
93 #define MXT_ACQUIRE_CHRGTIME 0
94 #define MXT_ACQUIRE_TCHDRIFT 2
95 #define MXT_ACQUIRE_DRIFTST 3
96 #define MXT_ACQUIRE_TCHAUTOCAL 4
97 #define MXT_ACQUIRE_SYNC 5
98 #define MXT_ACQUIRE_ATCHCALST 6
99 #define MXT_ACQUIRE_ATCHCALSTHR 7
101 /* MXT_TOUCH_MULTI_T9 field */
102 #define MXT_TOUCH_CTRL 0
103 #define MXT_TOUCH_XORIGIN 1
104 #define MXT_TOUCH_YORIGIN 2
105 #define MXT_TOUCH_XSIZE 3
106 #define MXT_TOUCH_YSIZE 4
107 #define MXT_TOUCH_BLEN 6
108 #define MXT_TOUCH_TCHTHR 7
109 #define MXT_TOUCH_TCHDI 8
110 #define MXT_TOUCH_ORIENT 9
111 #define MXT_TOUCH_MOVHYSTI 11
112 #define MXT_TOUCH_MOVHYSTN 12
113 #define MXT_TOUCH_NUMTOUCH 14
114 #define MXT_TOUCH_MRGHYST 15
115 #define MXT_TOUCH_MRGTHR 16
116 #define MXT_TOUCH_AMPHYST 17
117 #define MXT_TOUCH_XRANGE_LSB 18
118 #define MXT_TOUCH_XRANGE_MSB 19
119 #define MXT_TOUCH_YRANGE_LSB 20
120 #define MXT_TOUCH_YRANGE_MSB 21
121 #define MXT_TOUCH_XLOCLIP 22
122 #define MXT_TOUCH_XHICLIP 23
123 #define MXT_TOUCH_YLOCLIP 24
124 #define MXT_TOUCH_YHICLIP 25
125 #define MXT_TOUCH_XEDGECTRL 26
126 #define MXT_TOUCH_XEDGEDIST 27
127 #define MXT_TOUCH_YEDGECTRL 28
128 #define MXT_TOUCH_YEDGEDIST 29
129 #define MXT_TOUCH_JUMPLIMIT 30
131 /* MXT_PROCI_GRIPFACE_T20 field */
132 #define MXT_GRIPFACE_CTRL 0
133 #define MXT_GRIPFACE_XLOGRIP 1
134 #define MXT_GRIPFACE_XHIGRIP 2
135 #define MXT_GRIPFACE_YLOGRIP 3
136 #define MXT_GRIPFACE_YHIGRIP 4
137 #define MXT_GRIPFACE_MAXTCHS 5
138 #define MXT_GRIPFACE_SZTHR1 7
139 #define MXT_GRIPFACE_SZTHR2 8
140 #define MXT_GRIPFACE_SHPTHR1 9
141 #define MXT_GRIPFACE_SHPTHR2 10
142 #define MXT_GRIPFACE_SUPEXTTO 11
144 /* MXT_PROCI_NOISE field */
145 #define MXT_NOISE_CTRL 0
146 #define MXT_NOISE_OUTFLEN 1
147 #define MXT_NOISE_GCAFUL_LSB 3
148 #define MXT_NOISE_GCAFUL_MSB 4
149 #define MXT_NOISE_GCAFLL_LSB 5
150 #define MXT_NOISE_GCAFLL_MSB 6
151 #define MXT_NOISE_ACTVGCAFVALID 7
152 #define MXT_NOISE_NOISETHR 8
153 #define MXT_NOISE_FREQHOPSCALE 10
154 #define MXT_NOISE_FREQ0 11
155 #define MXT_NOISE_FREQ1 12
156 #define MXT_NOISE_FREQ2 13
157 #define MXT_NOISE_FREQ3 14
158 #define MXT_NOISE_FREQ4 15
159 #define MXT_NOISE_IDLEGCAFVALID 16
161 /* MXT_SPT_COMMSCONFIG_T18 */
162 #define MXT_COMMS_CTRL 0
163 #define MXT_COMMS_CMD 1
165 /* MXT_SPT_CTECONFIG_T28 field */
166 #define MXT_CTE_CTRL 0
167 #define MXT_CTE_CMD 1
168 #define MXT_CTE_MODE 2
169 #define MXT_CTE_IDLEGCAFDEPTH 3
170 #define MXT_CTE_ACTVGCAFDEPTH 4
171 #define MXT_CTE_VOLTAGE 5
173 #define MXT_VOLTAGE_DEFAULT 2700000
174 #define MXT_VOLTAGE_STEP 10000
176 /* Define for MXT_GEN_COMMAND_T6 */
177 #define MXT_BOOT_VALUE 0xa5
178 #define MXT_RESET_VALUE 0x01
179 #define MXT_BACKUP_VALUE 0x55
182 #define MXT_BACKUP_TIME 50 /* msec */
183 #define MXT_RESET_TIME 200 /* msec */
184 #define MXT_RESET_TIMEOUT 3000 /* msec */
185 #define MXT_CRC_TIMEOUT 1000 /* msec */
186 #define MXT_FW_RESET_TIME 3000 /* msec */
187 #define MXT_FW_CHG_TIMEOUT 300 /* msec */
189 /* Command to unlock bootloader */
190 #define MXT_UNLOCK_CMD_MSB 0xaa
191 #define MXT_UNLOCK_CMD_LSB 0xdc
193 /* Bootloader mode status */
194 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
195 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
196 #define MXT_FRAME_CRC_CHECK 0x02
197 #define MXT_FRAME_CRC_FAIL 0x03
198 #define MXT_FRAME_CRC_PASS 0x04
199 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
200 #define MXT_BOOT_STATUS_MASK 0x3f
203 #define MXT_UNGRIP (1 << 0)
204 #define MXT_SUPPRESS (1 << 1)
205 #define MXT_AMP (1 << 2)
206 #define MXT_VECTOR (1 << 3)
207 #define MXT_MOVE (1 << 4)
208 #define MXT_RELEASE (1 << 5)
209 #define MXT_PRESS (1 << 6)
210 #define MXT_DETECT (1 << 7)
212 /* Touch orient bits */
213 #define MXT_XY_SWITCH (1 << 0)
214 #define MXT_X_INVERT (1 << 1)
215 #define MXT_Y_INVERT (1 << 2)
217 /* Touchscreen absolute values */
218 #define MXT_MAX_AREA 0xff
220 #define MXT_PIXELS_PER_MM 20
236 u8 instances_minus_one
;
245 /* Each client has this additional data */
247 struct i2c_client
*client
;
248 struct input_dev
*input_dev
;
249 char phys
[64]; /* device physical location */
250 const struct mxt_platform_data
*pdata
;
251 struct mxt_object
*object_table
;
252 struct mxt_info info
;
260 /* Cached parameters from object table */
267 /* for fw update in bootloader */
268 struct completion bl_completion
;
270 /* for reset handling */
271 struct completion reset_completion
;
273 /* for config update handling */
274 struct completion crc_completion
;
277 static size_t mxt_obj_size(const struct mxt_object
*obj
)
279 return obj
->size_minus_one
+ 1;
282 static size_t mxt_obj_instances(const struct mxt_object
*obj
)
284 return obj
->instances_minus_one
+ 1;
287 static bool mxt_object_readable(unsigned int type
)
290 case MXT_GEN_COMMAND_T6
:
291 case MXT_GEN_POWER_T7
:
292 case MXT_GEN_ACQUIRE_T8
:
293 case MXT_GEN_DATASOURCE_T53
:
294 case MXT_TOUCH_MULTI_T9
:
295 case MXT_TOUCH_KEYARRAY_T15
:
296 case MXT_TOUCH_PROXIMITY_T23
:
297 case MXT_TOUCH_PROXKEY_T52
:
298 case MXT_PROCI_GRIPFACE_T20
:
299 case MXT_PROCG_NOISE_T22
:
300 case MXT_PROCI_ONETOUCH_T24
:
301 case MXT_PROCI_TWOTOUCH_T27
:
302 case MXT_PROCI_GRIP_T40
:
303 case MXT_PROCI_PALM_T41
:
304 case MXT_PROCI_TOUCHSUPPRESSION_T42
:
305 case MXT_PROCI_STYLUS_T47
:
306 case MXT_PROCG_NOISESUPPRESSION_T48
:
307 case MXT_SPT_COMMSCONFIG_T18
:
308 case MXT_SPT_GPIOPWM_T19
:
309 case MXT_SPT_SELFTEST_T25
:
310 case MXT_SPT_CTECONFIG_T28
:
311 case MXT_SPT_USERDATA_T38
:
312 case MXT_SPT_DIGITIZER_T43
:
313 case MXT_SPT_CTECONFIG_T46
:
320 static bool mxt_object_writable(unsigned int type
)
323 case MXT_GEN_COMMAND_T6
:
324 case MXT_GEN_POWER_T7
:
325 case MXT_GEN_ACQUIRE_T8
:
326 case MXT_TOUCH_MULTI_T9
:
327 case MXT_TOUCH_KEYARRAY_T15
:
328 case MXT_TOUCH_PROXIMITY_T23
:
329 case MXT_TOUCH_PROXKEY_T52
:
330 case MXT_PROCI_GRIPFACE_T20
:
331 case MXT_PROCG_NOISE_T22
:
332 case MXT_PROCI_ONETOUCH_T24
:
333 case MXT_PROCI_TWOTOUCH_T27
:
334 case MXT_PROCI_GRIP_T40
:
335 case MXT_PROCI_PALM_T41
:
336 case MXT_PROCI_TOUCHSUPPRESSION_T42
:
337 case MXT_PROCI_STYLUS_T47
:
338 case MXT_PROCG_NOISESUPPRESSION_T48
:
339 case MXT_SPT_COMMSCONFIG_T18
:
340 case MXT_SPT_GPIOPWM_T19
:
341 case MXT_SPT_SELFTEST_T25
:
342 case MXT_SPT_CTECONFIG_T28
:
343 case MXT_SPT_DIGITIZER_T43
:
344 case MXT_SPT_CTECONFIG_T46
:
351 static void mxt_dump_message(struct device
*dev
,
352 struct mxt_message
*message
)
354 dev_dbg(dev
, "reportid: %u\tmessage: %*ph\n",
355 message
->reportid
, 7, message
->message
);
358 static int mxt_wait_for_completion(struct mxt_data
*data
,
359 struct completion
*comp
,
360 unsigned int timeout_ms
)
362 struct device
*dev
= &data
->client
->dev
;
363 unsigned long timeout
= msecs_to_jiffies(timeout_ms
);
366 ret
= wait_for_completion_interruptible_timeout(comp
, timeout
);
369 } else if (ret
== 0) {
370 dev_err(dev
, "Wait for completion timed out.\n");
376 static int mxt_bootloader_read(struct mxt_data
*data
,
377 u8
*val
, unsigned int count
)
382 msg
.addr
= data
->bootloader_addr
;
383 msg
.flags
= data
->client
->flags
& I2C_M_TEN
;
384 msg
.flags
|= I2C_M_RD
;
388 ret
= i2c_transfer(data
->client
->adapter
, &msg
, 1);
393 ret
= ret
< 0 ? ret
: -EIO
;
394 dev_err(&data
->client
->dev
, "%s: i2c recv failed (%d)\n",
401 static int mxt_bootloader_write(struct mxt_data
*data
,
402 const u8
* const val
, unsigned int count
)
407 msg
.addr
= data
->bootloader_addr
;
408 msg
.flags
= data
->client
->flags
& I2C_M_TEN
;
412 ret
= i2c_transfer(data
->client
->adapter
, &msg
, 1);
416 ret
= ret
< 0 ? ret
: -EIO
;
417 dev_err(&data
->client
->dev
, "%s: i2c send failed (%d)\n",
424 static int mxt_lookup_bootloader_address(struct mxt_data
*data
)
426 u8 appmode
= data
->client
->addr
;
436 bootloader
= appmode
- 0x26;
439 dev_err(&data
->client
->dev
,
440 "Appmode i2c address 0x%02x not found\n",
445 data
->bootloader_addr
= bootloader
;
449 static int mxt_check_bootloader(struct mxt_data
*data
, unsigned int state
)
451 struct device
*dev
= &data
->client
->dev
;
456 if (state
!= MXT_WAITING_BOOTLOAD_CMD
) {
458 * In application update mode, the interrupt
459 * line signals state transitions. We must wait for the
460 * CHG assertion before reading the status byte.
461 * Once the status byte has been read, the line is deasserted.
463 ret
= mxt_wait_for_completion(data
, &data
->bl_completion
,
467 * TODO: handle -ERESTARTSYS better by terminating
468 * fw update process before returning to userspace
469 * by writing length 0x000 to device (iff we are in
470 * WAITING_FRAME_DATA state).
472 dev_err(dev
, "Update wait error %d\n", ret
);
477 ret
= mxt_bootloader_read(data
, &val
, 1);
482 case MXT_WAITING_BOOTLOAD_CMD
:
483 case MXT_WAITING_FRAME_DATA
:
484 val
&= ~MXT_BOOT_STATUS_MASK
;
486 case MXT_FRAME_CRC_PASS
:
487 if (val
== MXT_FRAME_CRC_CHECK
)
495 dev_err(dev
, "Invalid bootloader state %02X != %02X\n",
503 static int mxt_unlock_bootloader(struct mxt_data
*data
)
508 buf
[0] = MXT_UNLOCK_CMD_LSB
;
509 buf
[1] = MXT_UNLOCK_CMD_MSB
;
511 ret
= mxt_bootloader_write(data
, buf
, 2);
518 static int __mxt_read_reg(struct i2c_client
*client
,
519 u16 reg
, u16 len
, void *val
)
521 struct i2c_msg xfer
[2];
526 buf
[1] = (reg
>> 8) & 0xff;
529 xfer
[0].addr
= client
->addr
;
535 xfer
[1].addr
= client
->addr
;
536 xfer
[1].flags
= I2C_M_RD
;
540 ret
= i2c_transfer(client
->adapter
, xfer
, 2);
546 dev_err(&client
->dev
, "%s: i2c transfer failed (%d)\n",
553 static int mxt_read_reg(struct i2c_client
*client
, u16 reg
, u8
*val
)
555 return __mxt_read_reg(client
, reg
, 1, val
);
558 static int __mxt_write_reg(struct i2c_client
*client
, u16 reg
, u16 len
,
566 buf
= kmalloc(count
, GFP_KERNEL
);
571 buf
[1] = (reg
>> 8) & 0xff;
572 memcpy(&buf
[2], val
, len
);
574 ret
= i2c_master_send(client
, buf
, count
);
580 dev_err(&client
->dev
, "%s: i2c send failed (%d)\n",
588 static int mxt_write_reg(struct i2c_client
*client
, u16 reg
, u8 val
)
590 return __mxt_write_reg(client
, reg
, 1, &val
);
593 static struct mxt_object
*
594 mxt_get_object(struct mxt_data
*data
, u8 type
)
596 struct mxt_object
*object
;
599 for (i
= 0; i
< data
->info
.object_num
; i
++) {
600 object
= data
->object_table
+ i
;
601 if (object
->type
== type
)
605 dev_err(&data
->client
->dev
, "Invalid object type T%u\n", type
);
609 static int mxt_read_message(struct mxt_data
*data
,
610 struct mxt_message
*message
)
612 struct mxt_object
*object
;
615 object
= mxt_get_object(data
, MXT_GEN_MESSAGE_T5
);
619 reg
= object
->start_address
;
620 return __mxt_read_reg(data
->client
, reg
,
621 sizeof(struct mxt_message
), message
);
624 static int mxt_write_object(struct mxt_data
*data
,
625 u8 type
, u8 offset
, u8 val
)
627 struct mxt_object
*object
;
630 object
= mxt_get_object(data
, type
);
631 if (!object
|| offset
>= mxt_obj_size(object
))
634 reg
= object
->start_address
;
635 return mxt_write_reg(data
->client
, reg
+ offset
, val
);
638 static void mxt_input_button(struct mxt_data
*data
, struct mxt_message
*message
)
640 struct input_dev
*input
= data
->input_dev
;
641 const struct mxt_platform_data
*pdata
= data
->pdata
;
645 /* Active-low switch */
646 for (i
= 0; i
< pdata
->t19_num_keys
; i
++) {
647 if (pdata
->t19_keymap
[i
] == KEY_RESERVED
)
649 button
= !(message
->message
[0] & (1 << i
));
650 input_report_key(input
, pdata
->t19_keymap
[i
], button
);
654 static void mxt_input_touchevent(struct mxt_data
*data
,
655 struct mxt_message
*message
, int id
)
657 struct device
*dev
= &data
->client
->dev
;
658 u8 status
= message
->message
[0];
659 struct input_dev
*input_dev
= data
->input_dev
;
665 x
= (message
->message
[1] << 4) | ((message
->message
[3] >> 4) & 0xf);
666 y
= (message
->message
[2] << 4) | ((message
->message
[3] & 0xf));
667 if (data
->max_x
< 1024)
669 if (data
->max_y
< 1024)
672 area
= message
->message
[4];
673 pressure
= message
->message
[5];
676 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
678 (status
& MXT_DETECT
) ? 'D' : '.',
679 (status
& MXT_PRESS
) ? 'P' : '.',
680 (status
& MXT_RELEASE
) ? 'R' : '.',
681 (status
& MXT_MOVE
) ? 'M' : '.',
682 (status
& MXT_VECTOR
) ? 'V' : '.',
683 (status
& MXT_AMP
) ? 'A' : '.',
684 (status
& MXT_SUPPRESS
) ? 'S' : '.',
685 (status
& MXT_UNGRIP
) ? 'U' : '.',
686 x
, y
, area
, pressure
);
688 input_mt_slot(input_dev
, id
);
689 input_mt_report_slot_state(input_dev
, MT_TOOL_FINGER
,
690 status
& MXT_DETECT
);
692 if (status
& MXT_DETECT
) {
693 input_report_abs(input_dev
, ABS_MT_POSITION_X
, x
);
694 input_report_abs(input_dev
, ABS_MT_POSITION_Y
, y
);
695 input_report_abs(input_dev
, ABS_MT_PRESSURE
, pressure
);
696 input_report_abs(input_dev
, ABS_MT_TOUCH_MAJOR
, area
);
700 static u16
mxt_extract_T6_csum(const u8
*csum
)
702 return csum
[0] | (csum
[1] << 8) | (csum
[2] << 16);
705 static bool mxt_is_T9_message(struct mxt_data
*data
, struct mxt_message
*msg
)
707 u8 id
= msg
->reportid
;
708 return (id
>= data
->T9_reportid_min
&& id
<= data
->T9_reportid_max
);
711 static irqreturn_t
mxt_process_messages_until_invalid(struct mxt_data
*data
)
713 struct mxt_message message
;
714 const u8
*payload
= &message
.message
[0];
715 struct device
*dev
= &data
->client
->dev
;
717 bool update_input
= false;
721 if (mxt_read_message(data
, &message
)) {
722 dev_err(dev
, "Failed to read message\n");
726 reportid
= message
.reportid
;
728 if (reportid
== data
->T6_reportid
) {
729 u8 status
= payload
[0];
731 crc
= mxt_extract_T6_csum(&payload
[1]);
732 if (crc
!= data
->config_crc
) {
733 data
->config_crc
= crc
;
734 complete(&data
->crc_completion
);
737 dev_dbg(dev
, "Status: %02x Config Checksum: %06x\n",
738 status
, data
->config_crc
);
740 if (status
& MXT_T6_STATUS_RESET
)
741 complete(&data
->reset_completion
);
742 } else if (mxt_is_T9_message(data
, &message
)) {
743 int id
= reportid
- data
->T9_reportid_min
;
744 mxt_input_touchevent(data
, &message
, id
);
746 } else if (message
.reportid
== data
->T19_reportid
) {
747 mxt_input_button(data
, &message
);
750 mxt_dump_message(dev
, &message
);
752 } while (reportid
!= 0xff);
755 input_mt_report_pointer_emulation(data
->input_dev
, false);
756 input_sync(data
->input_dev
);
762 static irqreturn_t
mxt_interrupt(int irq
, void *dev_id
)
764 struct mxt_data
*data
= dev_id
;
766 if (data
->in_bootloader
) {
767 /* bootloader state transition completion */
768 complete(&data
->bl_completion
);
772 return mxt_process_messages_until_invalid(data
);
775 static int mxt_t6_command(struct mxt_data
*data
, u16 cmd_offset
,
780 int timeout_counter
= 0;
783 reg
= data
->T6_address
+ cmd_offset
;
785 ret
= mxt_write_reg(data
->client
, reg
, value
);
794 ret
= __mxt_read_reg(data
->client
, reg
, 1, &command_register
);
797 } while (command_register
!= 0 && timeout_counter
++ <= 100);
799 if (timeout_counter
> 100) {
800 dev_err(&data
->client
->dev
, "Command failed!\n");
807 static int mxt_soft_reset(struct mxt_data
*data
)
809 struct device
*dev
= &data
->client
->dev
;
812 dev_info(dev
, "Resetting chip\n");
814 reinit_completion(&data
->reset_completion
);
816 ret
= mxt_t6_command(data
, MXT_COMMAND_RESET
, MXT_RESET_VALUE
, false);
820 ret
= mxt_wait_for_completion(data
, &data
->reset_completion
,
828 static void mxt_update_crc(struct mxt_data
*data
, u8 cmd
, u8 value
)
831 * On failure, CRC is set to 0 and config will always be
834 data
->config_crc
= 0;
835 reinit_completion(&data
->crc_completion
);
837 mxt_t6_command(data
, cmd
, value
, true);
840 * Wait for crc message. On failure, CRC is set to 0 and config will
841 * always be downloaded.
843 mxt_wait_for_completion(data
, &data
->crc_completion
, MXT_CRC_TIMEOUT
);
846 static int mxt_check_reg_init(struct mxt_data
*data
)
848 const struct mxt_platform_data
*pdata
= data
->pdata
;
849 struct mxt_object
*object
;
850 struct device
*dev
= &data
->client
->dev
;
855 if (!pdata
->config
) {
856 dev_dbg(dev
, "No cfg data defined, skipping reg init\n");
860 mxt_update_crc(data
, MXT_COMMAND_REPORTALL
, 1);
862 if (data
->config_crc
== pdata
->config_crc
) {
863 dev_info(dev
, "Config CRC 0x%06X: OK\n", data
->config_crc
);
867 dev_info(dev
, "Config CRC 0x%06X: does not match 0x%06X\n",
868 data
->config_crc
, pdata
->config_crc
);
870 for (i
= 0; i
< data
->info
.object_num
; i
++) {
871 object
= data
->object_table
+ i
;
873 if (!mxt_object_writable(object
->type
))
876 size
= mxt_obj_size(object
) * mxt_obj_instances(object
);
877 if (index
+ size
> pdata
->config_length
) {
878 dev_err(dev
, "Not enough config data!\n");
882 ret
= __mxt_write_reg(data
->client
, object
->start_address
,
883 size
, &pdata
->config
[index
]);
889 mxt_update_crc(data
, MXT_COMMAND_BACKUPNV
, MXT_BACKUP_VALUE
);
891 ret
= mxt_soft_reset(data
);
895 dev_info(dev
, "Config successfully updated\n");
900 static int mxt_make_highchg(struct mxt_data
*data
)
902 struct device
*dev
= &data
->client
->dev
;
903 struct mxt_message message
;
907 /* Read dummy message to make high CHG pin */
909 error
= mxt_read_message(data
, &message
);
912 } while (message
.reportid
!= 0xff && --count
);
915 dev_err(dev
, "CHG pin isn't cleared\n");
922 static int mxt_get_info(struct mxt_data
*data
)
924 struct i2c_client
*client
= data
->client
;
925 struct mxt_info
*info
= &data
->info
;
928 /* Read 7-byte info block starting at address 0 */
929 error
= __mxt_read_reg(client
, MXT_INFO
, sizeof(*info
), info
);
936 static int mxt_get_object_table(struct mxt_data
*data
)
938 struct i2c_client
*client
= data
->client
;
944 table_size
= data
->info
.object_num
* sizeof(struct mxt_object
);
945 error
= __mxt_read_reg(client
, MXT_OBJECT_START
, table_size
,
950 /* Valid Report IDs start counting from 1 */
952 for (i
= 0; i
< data
->info
.object_num
; i
++) {
953 struct mxt_object
*object
= data
->object_table
+ i
;
956 le16_to_cpus(&object
->start_address
);
958 if (object
->num_report_ids
) {
960 reportid
+= object
->num_report_ids
*
961 mxt_obj_instances(object
);
962 max_id
= reportid
- 1;
968 dev_dbg(&data
->client
->dev
,
969 "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
970 object
->type
, object
->start_address
,
971 mxt_obj_size(object
), mxt_obj_instances(object
),
974 switch (object
->type
) {
975 case MXT_GEN_COMMAND_T6
:
976 data
->T6_reportid
= min_id
;
977 data
->T6_address
= object
->start_address
;
979 case MXT_TOUCH_MULTI_T9
:
980 data
->T9_reportid_min
= min_id
;
981 data
->T9_reportid_max
= max_id
;
983 case MXT_SPT_GPIOPWM_T19
:
984 data
->T19_reportid
= min_id
;
992 static void mxt_free_object_table(struct mxt_data
*data
)
994 kfree(data
->object_table
);
995 data
->object_table
= NULL
;
996 data
->T6_reportid
= 0;
997 data
->T9_reportid_min
= 0;
998 data
->T9_reportid_max
= 0;
999 data
->T19_reportid
= 0;
1002 static int mxt_initialize(struct mxt_data
*data
)
1004 struct i2c_client
*client
= data
->client
;
1005 struct mxt_info
*info
= &data
->info
;
1009 error
= mxt_get_info(data
);
1013 data
->object_table
= kcalloc(info
->object_num
,
1014 sizeof(struct mxt_object
),
1016 if (!data
->object_table
) {
1017 dev_err(&client
->dev
, "Failed to allocate memory\n");
1021 /* Get object table information */
1022 error
= mxt_get_object_table(data
);
1024 dev_err(&client
->dev
, "Error %d reading object table\n", error
);
1025 goto err_free_object_table
;
1028 /* Check register init values */
1029 error
= mxt_check_reg_init(data
);
1031 dev_err(&client
->dev
, "Error %d initializing configuration\n",
1033 goto err_free_object_table
;
1036 /* Update matrix size at info struct */
1037 error
= mxt_read_reg(client
, MXT_MATRIX_X_SIZE
, &val
);
1039 goto err_free_object_table
;
1040 info
->matrix_xsize
= val
;
1042 error
= mxt_read_reg(client
, MXT_MATRIX_Y_SIZE
, &val
);
1044 goto err_free_object_table
;
1045 info
->matrix_ysize
= val
;
1047 dev_info(&client
->dev
,
1048 "Family: %u Variant: %u Firmware V%u.%u.%02X\n",
1049 info
->family_id
, info
->variant_id
, info
->version
>> 4,
1050 info
->version
& 0xf, info
->build
);
1052 dev_info(&client
->dev
,
1053 "Matrix X Size: %u Matrix Y Size: %u Objects: %u\n",
1054 info
->matrix_xsize
, info
->matrix_ysize
,
1059 err_free_object_table
:
1060 mxt_free_object_table(data
);
1064 static void mxt_calc_resolution(struct mxt_data
*data
)
1066 unsigned int max_x
= data
->pdata
->x_size
- 1;
1067 unsigned int max_y
= data
->pdata
->y_size
- 1;
1069 if (data
->pdata
->orient
& MXT_XY_SWITCH
) {
1070 data
->max_x
= max_y
;
1071 data
->max_y
= max_x
;
1073 data
->max_x
= max_x
;
1074 data
->max_y
= max_y
;
1078 /* Firmware Version is returned as Major.Minor.Build */
1079 static ssize_t
mxt_fw_version_show(struct device
*dev
,
1080 struct device_attribute
*attr
, char *buf
)
1082 struct mxt_data
*data
= dev_get_drvdata(dev
);
1083 struct mxt_info
*info
= &data
->info
;
1084 return scnprintf(buf
, PAGE_SIZE
, "%u.%u.%02X\n",
1085 info
->version
>> 4, info
->version
& 0xf, info
->build
);
1088 /* Hardware Version is returned as FamilyID.VariantID */
1089 static ssize_t
mxt_hw_version_show(struct device
*dev
,
1090 struct device_attribute
*attr
, char *buf
)
1092 struct mxt_data
*data
= dev_get_drvdata(dev
);
1093 struct mxt_info
*info
= &data
->info
;
1094 return scnprintf(buf
, PAGE_SIZE
, "%u.%u\n",
1095 info
->family_id
, info
->variant_id
);
1098 static ssize_t
mxt_show_instance(char *buf
, int count
,
1099 struct mxt_object
*object
, int instance
,
1104 if (mxt_obj_instances(object
) > 1)
1105 count
+= scnprintf(buf
+ count
, PAGE_SIZE
- count
,
1106 "Instance %u\n", instance
);
1108 for (i
= 0; i
< mxt_obj_size(object
); i
++)
1109 count
+= scnprintf(buf
+ count
, PAGE_SIZE
- count
,
1110 "\t[%2u]: %02x (%d)\n", i
, val
[i
], val
[i
]);
1111 count
+= scnprintf(buf
+ count
, PAGE_SIZE
- count
, "\n");
1116 static ssize_t
mxt_object_show(struct device
*dev
,
1117 struct device_attribute
*attr
, char *buf
)
1119 struct mxt_data
*data
= dev_get_drvdata(dev
);
1120 struct mxt_object
*object
;
1126 /* Pre-allocate buffer large enough to hold max sized object. */
1127 obuf
= kmalloc(256, GFP_KERNEL
);
1132 for (i
= 0; i
< data
->info
.object_num
; i
++) {
1133 object
= data
->object_table
+ i
;
1135 if (!mxt_object_readable(object
->type
))
1138 count
+= scnprintf(buf
+ count
, PAGE_SIZE
- count
,
1139 "T%u:\n", object
->type
);
1141 for (j
= 0; j
< mxt_obj_instances(object
); j
++) {
1142 u16 size
= mxt_obj_size(object
);
1143 u16 addr
= object
->start_address
+ j
* size
;
1145 error
= __mxt_read_reg(data
->client
, addr
, size
, obuf
);
1149 count
= mxt_show_instance(buf
, count
, object
, j
, obuf
);
1155 return error
?: count
;
1158 static int mxt_load_fw(struct device
*dev
, const char *fn
)
1160 struct mxt_data
*data
= dev_get_drvdata(dev
);
1161 const struct firmware
*fw
= NULL
;
1162 unsigned int frame_size
;
1163 unsigned int pos
= 0;
1166 ret
= request_firmware(&fw
, fn
, dev
);
1168 dev_err(dev
, "Unable to open firmware %s\n", fn
);
1172 ret
= mxt_lookup_bootloader_address(data
);
1174 goto release_firmware
;
1176 /* Change to the bootloader mode */
1177 data
->in_bootloader
= true;
1179 ret
= mxt_t6_command(data
, MXT_COMMAND_RESET
, MXT_BOOT_VALUE
, false);
1181 goto release_firmware
;
1183 msleep(MXT_RESET_TIME
);
1185 reinit_completion(&data
->bl_completion
);
1187 ret
= mxt_check_bootloader(data
, MXT_WAITING_BOOTLOAD_CMD
);
1191 /* Unlock bootloader */
1192 mxt_unlock_bootloader(data
);
1194 while (pos
< fw
->size
) {
1195 ret
= mxt_check_bootloader(data
, MXT_WAITING_FRAME_DATA
);
1199 frame_size
= ((*(fw
->data
+ pos
) << 8) | *(fw
->data
+ pos
+ 1));
1201 /* We should add 2 at frame size as the the firmware data is not
1202 * included the CRC bytes.
1206 /* Write one frame to device */
1207 ret
= mxt_bootloader_write(data
, fw
->data
+ pos
, frame_size
);
1211 ret
= mxt_check_bootloader(data
, MXT_FRAME_CRC_PASS
);
1217 dev_dbg(dev
, "Updated %d bytes / %zd bytes\n", pos
, fw
->size
);
1220 /* Wait for flash. */
1221 ret
= mxt_wait_for_completion(data
, &data
->bl_completion
,
1227 * Wait for device to reset. Some bootloader versions do not assert
1228 * the CHG line after bootloading has finished, so ignore potential
1231 mxt_wait_for_completion(data
, &data
->bl_completion
, MXT_FW_RESET_TIME
);
1233 data
->in_bootloader
= false;
1236 disable_irq(data
->irq
);
1238 release_firmware(fw
);
1242 static ssize_t
mxt_update_fw_store(struct device
*dev
,
1243 struct device_attribute
*attr
,
1244 const char *buf
, size_t count
)
1246 struct mxt_data
*data
= dev_get_drvdata(dev
);
1249 error
= mxt_load_fw(dev
, MXT_FW_NAME
);
1251 dev_err(dev
, "The firmware update failed(%d)\n", error
);
1254 dev_info(dev
, "The firmware update succeeded\n");
1256 mxt_free_object_table(data
);
1258 mxt_initialize(data
);
1260 enable_irq(data
->irq
);
1262 error
= mxt_make_highchg(data
);
1270 static DEVICE_ATTR(fw_version
, S_IRUGO
, mxt_fw_version_show
, NULL
);
1271 static DEVICE_ATTR(hw_version
, S_IRUGO
, mxt_hw_version_show
, NULL
);
1272 static DEVICE_ATTR(object
, S_IRUGO
, mxt_object_show
, NULL
);
1273 static DEVICE_ATTR(update_fw
, S_IWUSR
, NULL
, mxt_update_fw_store
);
1275 static struct attribute
*mxt_attrs
[] = {
1276 &dev_attr_fw_version
.attr
,
1277 &dev_attr_hw_version
.attr
,
1278 &dev_attr_object
.attr
,
1279 &dev_attr_update_fw
.attr
,
1283 static const struct attribute_group mxt_attr_group
= {
1287 static void mxt_start(struct mxt_data
*data
)
1290 mxt_write_object(data
,
1291 MXT_TOUCH_MULTI_T9
, MXT_TOUCH_CTRL
, 0x83);
1294 static void mxt_stop(struct mxt_data
*data
)
1297 mxt_write_object(data
,
1298 MXT_TOUCH_MULTI_T9
, MXT_TOUCH_CTRL
, 0);
1301 static int mxt_input_open(struct input_dev
*dev
)
1303 struct mxt_data
*data
= input_get_drvdata(dev
);
1310 static void mxt_input_close(struct input_dev
*dev
)
1312 struct mxt_data
*data
= input_get_drvdata(dev
);
1317 static int mxt_probe(struct i2c_client
*client
,
1318 const struct i2c_device_id
*id
)
1320 const struct mxt_platform_data
*pdata
= dev_get_platdata(&client
->dev
);
1321 struct mxt_data
*data
;
1322 struct input_dev
*input_dev
;
1324 unsigned int num_mt_slots
;
1325 unsigned int mt_flags
= 0;
1331 data
= kzalloc(sizeof(struct mxt_data
), GFP_KERNEL
);
1332 input_dev
= input_allocate_device();
1333 if (!data
|| !input_dev
) {
1334 dev_err(&client
->dev
, "Failed to allocate memory\n");
1339 input_dev
->name
= "Atmel maXTouch Touchscreen";
1340 snprintf(data
->phys
, sizeof(data
->phys
), "i2c-%u-%04x/input0",
1341 client
->adapter
->nr
, client
->addr
);
1343 input_dev
->phys
= data
->phys
;
1345 input_dev
->id
.bustype
= BUS_I2C
;
1346 input_dev
->dev
.parent
= &client
->dev
;
1347 input_dev
->open
= mxt_input_open
;
1348 input_dev
->close
= mxt_input_close
;
1350 data
->client
= client
;
1351 data
->input_dev
= input_dev
;
1352 data
->pdata
= pdata
;
1353 data
->irq
= client
->irq
;
1355 init_completion(&data
->bl_completion
);
1356 init_completion(&data
->reset_completion
);
1357 init_completion(&data
->crc_completion
);
1359 mxt_calc_resolution(data
);
1361 error
= mxt_initialize(data
);
1365 __set_bit(EV_ABS
, input_dev
->evbit
);
1366 __set_bit(EV_KEY
, input_dev
->evbit
);
1367 __set_bit(BTN_TOUCH
, input_dev
->keybit
);
1369 if (pdata
->t19_num_keys
) {
1370 __set_bit(INPUT_PROP_BUTTONPAD
, input_dev
->propbit
);
1372 for (i
= 0; i
< pdata
->t19_num_keys
; i
++)
1373 if (pdata
->t19_keymap
[i
] != KEY_RESERVED
)
1374 input_set_capability(input_dev
, EV_KEY
,
1375 pdata
->t19_keymap
[i
]);
1377 mt_flags
|= INPUT_MT_POINTER
;
1379 input_abs_set_res(input_dev
, ABS_X
, MXT_PIXELS_PER_MM
);
1380 input_abs_set_res(input_dev
, ABS_Y
, MXT_PIXELS_PER_MM
);
1381 input_abs_set_res(input_dev
, ABS_MT_POSITION_X
,
1383 input_abs_set_res(input_dev
, ABS_MT_POSITION_Y
,
1386 input_dev
->name
= "Atmel maXTouch Touchpad";
1389 /* For single touch */
1390 input_set_abs_params(input_dev
, ABS_X
,
1391 0, data
->max_x
, 0, 0);
1392 input_set_abs_params(input_dev
, ABS_Y
,
1393 0, data
->max_y
, 0, 0);
1394 input_set_abs_params(input_dev
, ABS_PRESSURE
,
1397 /* For multi touch */
1398 num_mt_slots
= data
->T9_reportid_max
- data
->T9_reportid_min
+ 1;
1399 error
= input_mt_init_slots(input_dev
, num_mt_slots
, mt_flags
);
1401 goto err_free_object
;
1402 input_set_abs_params(input_dev
, ABS_MT_TOUCH_MAJOR
,
1403 0, MXT_MAX_AREA
, 0, 0);
1404 input_set_abs_params(input_dev
, ABS_MT_POSITION_X
,
1405 0, data
->max_x
, 0, 0);
1406 input_set_abs_params(input_dev
, ABS_MT_POSITION_Y
,
1407 0, data
->max_y
, 0, 0);
1408 input_set_abs_params(input_dev
, ABS_MT_PRESSURE
,
1411 input_set_drvdata(input_dev
, data
);
1412 i2c_set_clientdata(client
, data
);
1414 error
= request_threaded_irq(client
->irq
, NULL
, mxt_interrupt
,
1415 pdata
->irqflags
| IRQF_ONESHOT
,
1416 client
->name
, data
);
1418 dev_err(&client
->dev
, "Failed to register interrupt\n");
1419 goto err_free_object
;
1422 error
= mxt_make_highchg(data
);
1426 error
= input_register_device(input_dev
);
1428 dev_err(&client
->dev
, "Error %d registering input device\n",
1433 error
= sysfs_create_group(&client
->dev
.kobj
, &mxt_attr_group
);
1435 dev_err(&client
->dev
, "Failure %d creating sysfs group\n",
1437 goto err_unregister_device
;
1442 err_unregister_device
:
1443 input_unregister_device(input_dev
);
1446 free_irq(client
->irq
, data
);
1448 kfree(data
->object_table
);
1450 input_free_device(input_dev
);
1455 static int mxt_remove(struct i2c_client
*client
)
1457 struct mxt_data
*data
= i2c_get_clientdata(client
);
1459 sysfs_remove_group(&client
->dev
.kobj
, &mxt_attr_group
);
1460 free_irq(data
->irq
, data
);
1461 input_unregister_device(data
->input_dev
);
1462 kfree(data
->object_table
);
1468 #ifdef CONFIG_PM_SLEEP
1469 static int mxt_suspend(struct device
*dev
)
1471 struct i2c_client
*client
= to_i2c_client(dev
);
1472 struct mxt_data
*data
= i2c_get_clientdata(client
);
1473 struct input_dev
*input_dev
= data
->input_dev
;
1475 mutex_lock(&input_dev
->mutex
);
1477 if (input_dev
->users
)
1480 mutex_unlock(&input_dev
->mutex
);
1485 static int mxt_resume(struct device
*dev
)
1487 struct i2c_client
*client
= to_i2c_client(dev
);
1488 struct mxt_data
*data
= i2c_get_clientdata(client
);
1489 struct input_dev
*input_dev
= data
->input_dev
;
1491 mxt_soft_reset(data
);
1493 mutex_lock(&input_dev
->mutex
);
1495 if (input_dev
->users
)
1498 mutex_unlock(&input_dev
->mutex
);
1504 static SIMPLE_DEV_PM_OPS(mxt_pm_ops
, mxt_suspend
, mxt_resume
);
1506 static const struct i2c_device_id mxt_id
[] = {
1507 { "qt602240_ts", 0 },
1508 { "atmel_mxt_ts", 0 },
1509 { "atmel_mxt_tp", 0 },
1513 MODULE_DEVICE_TABLE(i2c
, mxt_id
);
1515 static struct i2c_driver mxt_driver
= {
1517 .name
= "atmel_mxt_ts",
1518 .owner
= THIS_MODULE
,
1522 .remove
= mxt_remove
,
1526 module_i2c_driver(mxt_driver
);
1528 /* Module information */
1529 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
1530 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
1531 MODULE_LICENSE("GPL");