2 * Atmel maXTouch Touchscreen driver
4 * Copyright (C) 2010 Samsung Electronics Co.Ltd
5 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version.
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/delay.h>
17 #include <linux/firmware.h>
18 #include <linux/i2c.h>
19 #include <linux/i2c/atmel_mxt_ts.h>
20 #include <linux/input.h>
21 #include <linux/interrupt.h>
22 #include <linux/slab.h>
30 #define MXT_APP_LOW 0x4a
31 #define MXT_APP_HIGH 0x4b
32 #define MXT_BOOT_LOW 0x24
33 #define MXT_BOOT_HIGH 0x25
36 #define MXT_FW_NAME "maxtouch.fw"
39 #define MXT_FAMILY_ID 0x00
40 #define MXT_VARIANT_ID 0x01
41 #define MXT_VERSION 0x02
42 #define MXT_BUILD 0x03
43 #define MXT_MATRIX_X_SIZE 0x04
44 #define MXT_MATRIX_Y_SIZE 0x05
45 #define MXT_OBJECT_NUM 0x06
46 #define MXT_OBJECT_START 0x07
48 #define MXT_OBJECT_SIZE 6
51 #define MXT_DEBUG_DIAGNOSTIC 37
52 #define MXT_GEN_MESSAGE 5
53 #define MXT_GEN_COMMAND 6
54 #define MXT_GEN_POWER 7
55 #define MXT_GEN_ACQUIRE 8
56 #define MXT_TOUCH_MULTI 9
57 #define MXT_TOUCH_KEYARRAY 15
58 #define MXT_TOUCH_PROXIMITY 23
59 #define MXT_PROCI_GRIPFACE 20
60 #define MXT_PROCG_NOISE 22
61 #define MXT_PROCI_ONETOUCH 24
62 #define MXT_PROCI_TWOTOUCH 27
63 #define MXT_SPT_COMMSCONFIG 18 /* firmware ver 21 over */
64 #define MXT_SPT_GPIOPWM 19
65 #define MXT_SPT_SELFTEST 25
66 #define MXT_SPT_CTECONFIG 28
67 #define MXT_SPT_USERDATA 38 /* firmware ver 21 over */
69 /* MXT_GEN_COMMAND field */
70 #define MXT_COMMAND_RESET 0
71 #define MXT_COMMAND_BACKUPNV 1
72 #define MXT_COMMAND_CALIBRATE 2
73 #define MXT_COMMAND_REPORTALL 3
74 #define MXT_COMMAND_DIAGNOSTIC 5
76 /* MXT_GEN_POWER field */
77 #define MXT_POWER_IDLEACQINT 0
78 #define MXT_POWER_ACTVACQINT 1
79 #define MXT_POWER_ACTV2IDLETO 2
81 /* MXT_GEN_ACQUIRE field */
82 #define MXT_ACQUIRE_CHRGTIME 0
83 #define MXT_ACQUIRE_TCHDRIFT 2
84 #define MXT_ACQUIRE_DRIFTST 3
85 #define MXT_ACQUIRE_TCHAUTOCAL 4
86 #define MXT_ACQUIRE_SYNC 5
87 #define MXT_ACQUIRE_ATCHCALST 6
88 #define MXT_ACQUIRE_ATCHCALSTHR 7
90 /* MXT_TOUCH_MULTI field */
91 #define MXT_TOUCH_CTRL 0
92 #define MXT_TOUCH_XORIGIN 1
93 #define MXT_TOUCH_YORIGIN 2
94 #define MXT_TOUCH_XSIZE 3
95 #define MXT_TOUCH_YSIZE 4
96 #define MXT_TOUCH_BLEN 6
97 #define MXT_TOUCH_TCHTHR 7
98 #define MXT_TOUCH_TCHDI 8
99 #define MXT_TOUCH_ORIENT 9
100 #define MXT_TOUCH_MOVHYSTI 11
101 #define MXT_TOUCH_MOVHYSTN 12
102 #define MXT_TOUCH_NUMTOUCH 14
103 #define MXT_TOUCH_MRGHYST 15
104 #define MXT_TOUCH_MRGTHR 16
105 #define MXT_TOUCH_AMPHYST 17
106 #define MXT_TOUCH_XRANGE_LSB 18
107 #define MXT_TOUCH_XRANGE_MSB 19
108 #define MXT_TOUCH_YRANGE_LSB 20
109 #define MXT_TOUCH_YRANGE_MSB 21
110 #define MXT_TOUCH_XLOCLIP 22
111 #define MXT_TOUCH_XHICLIP 23
112 #define MXT_TOUCH_YLOCLIP 24
113 #define MXT_TOUCH_YHICLIP 25
114 #define MXT_TOUCH_XEDGECTRL 26
115 #define MXT_TOUCH_XEDGEDIST 27
116 #define MXT_TOUCH_YEDGECTRL 28
117 #define MXT_TOUCH_YEDGEDIST 29
118 #define MXT_TOUCH_JUMPLIMIT 30 /* firmware ver 22 over */
120 /* MXT_PROCI_GRIPFACE field */
121 #define MXT_GRIPFACE_CTRL 0
122 #define MXT_GRIPFACE_XLOGRIP 1
123 #define MXT_GRIPFACE_XHIGRIP 2
124 #define MXT_GRIPFACE_YLOGRIP 3
125 #define MXT_GRIPFACE_YHIGRIP 4
126 #define MXT_GRIPFACE_MAXTCHS 5
127 #define MXT_GRIPFACE_SZTHR1 7
128 #define MXT_GRIPFACE_SZTHR2 8
129 #define MXT_GRIPFACE_SHPTHR1 9
130 #define MXT_GRIPFACE_SHPTHR2 10
131 #define MXT_GRIPFACE_SUPEXTTO 11
133 /* MXT_PROCI_NOISE field */
134 #define MXT_NOISE_CTRL 0
135 #define MXT_NOISE_OUTFLEN 1
136 #define MXT_NOISE_GCAFUL_LSB 3
137 #define MXT_NOISE_GCAFUL_MSB 4
138 #define MXT_NOISE_GCAFLL_LSB 5
139 #define MXT_NOISE_GCAFLL_MSB 6
140 #define MXT_NOISE_ACTVGCAFVALID 7
141 #define MXT_NOISE_NOISETHR 8
142 #define MXT_NOISE_FREQHOPSCALE 10
143 #define MXT_NOISE_FREQ0 11
144 #define MXT_NOISE_FREQ1 12
145 #define MXT_NOISE_FREQ2 13
146 #define MXT_NOISE_FREQ3 14
147 #define MXT_NOISE_FREQ4 15
148 #define MXT_NOISE_IDLEGCAFVALID 16
150 /* MXT_SPT_COMMSCONFIG */
151 #define MXT_COMMS_CTRL 0
152 #define MXT_COMMS_CMD 1
154 /* MXT_SPT_CTECONFIG field */
155 #define MXT_CTE_CTRL 0
156 #define MXT_CTE_CMD 1
157 #define MXT_CTE_MODE 2
158 #define MXT_CTE_IDLEGCAFDEPTH 3
159 #define MXT_CTE_ACTVGCAFDEPTH 4
160 #define MXT_CTE_VOLTAGE 5 /* firmware ver 21 over */
162 #define MXT_VOLTAGE_DEFAULT 2700000
163 #define MXT_VOLTAGE_STEP 10000
165 /* Define for MXT_GEN_COMMAND */
166 #define MXT_BOOT_VALUE 0xa5
167 #define MXT_BACKUP_VALUE 0x55
168 #define MXT_BACKUP_TIME 25 /* msec */
169 #define MXT_RESET_TIME 65 /* msec */
171 #define MXT_FWRESET_TIME 175 /* msec */
173 /* Command to unlock bootloader */
174 #define MXT_UNLOCK_CMD_MSB 0xaa
175 #define MXT_UNLOCK_CMD_LSB 0xdc
177 /* Bootloader mode status */
178 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */
179 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */
180 #define MXT_FRAME_CRC_CHECK 0x02
181 #define MXT_FRAME_CRC_FAIL 0x03
182 #define MXT_FRAME_CRC_PASS 0x04
183 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */
184 #define MXT_BOOT_STATUS_MASK 0x3f
187 #define MXT_SUPPRESS (1 << 1)
188 #define MXT_AMP (1 << 2)
189 #define MXT_VECTOR (1 << 3)
190 #define MXT_MOVE (1 << 4)
191 #define MXT_RELEASE (1 << 5)
192 #define MXT_PRESS (1 << 6)
193 #define MXT_DETECT (1 << 7)
195 /* Touchscreen absolute values */
196 #define MXT_MAX_XC 0x3ff
197 #define MXT_MAX_YC 0x3ff
198 #define MXT_MAX_AREA 0xff
200 #define MXT_MAX_FINGER 10
219 /* to map object and message */
236 /* Each client has this additional data */
238 struct i2c_client *client;
239 struct input_dev *input_dev;
240 const struct mxt_platform_data *pdata;
241 struct mxt_object *object_table;
242 struct mxt_info info;
243 struct mxt_finger finger[MXT_MAX_FINGER];
247 static bool mxt_object_readable(unsigned int type)
250 case MXT_GEN_MESSAGE:
251 case MXT_GEN_COMMAND:
253 case MXT_GEN_ACQUIRE:
254 case MXT_TOUCH_MULTI:
255 case MXT_TOUCH_KEYARRAY:
256 case MXT_TOUCH_PROXIMITY:
257 case MXT_PROCI_GRIPFACE:
258 case MXT_PROCG_NOISE:
259 case MXT_PROCI_ONETOUCH:
260 case MXT_PROCI_TWOTOUCH:
261 case MXT_SPT_COMMSCONFIG:
262 case MXT_SPT_GPIOPWM:
263 case MXT_SPT_SELFTEST:
264 case MXT_SPT_CTECONFIG:
265 case MXT_SPT_USERDATA:
272 static bool mxt_object_writable(unsigned int type)
275 case MXT_GEN_COMMAND:
277 case MXT_GEN_ACQUIRE:
278 case MXT_TOUCH_MULTI:
279 case MXT_TOUCH_KEYARRAY:
280 case MXT_TOUCH_PROXIMITY:
281 case MXT_PROCI_GRIPFACE:
282 case MXT_PROCG_NOISE:
283 case MXT_PROCI_ONETOUCH:
284 case MXT_PROCI_TWOTOUCH:
285 case MXT_SPT_GPIOPWM:
286 case MXT_SPT_SELFTEST:
287 case MXT_SPT_CTECONFIG:
294 static void mxt_dump_message(struct device *dev,
295 struct mxt_message *message)
297 dev_dbg(dev, "reportid:\t0x%x\n", message->reportid);
298 dev_dbg(dev, "message1:\t0x%x\n", message->message[0]);
299 dev_dbg(dev, "message2:\t0x%x\n", message->message[1]);
300 dev_dbg(dev, "message3:\t0x%x\n", message->message[2]);
301 dev_dbg(dev, "message4:\t0x%x\n", message->message[3]);
302 dev_dbg(dev, "message5:\t0x%x\n", message->message[4]);
303 dev_dbg(dev, "message6:\t0x%x\n", message->message[5]);
304 dev_dbg(dev, "message7:\t0x%x\n", message->message[6]);
305 dev_dbg(dev, "checksum:\t0x%x\n", message->checksum);
308 static int mxt_check_bootloader(struct i2c_client *client,
314 if (i2c_master_recv(client, &val, 1) != 1) {
315 dev_err(&client->dev, "%s: i2c recv failed\n", __func__);
320 case MXT_WAITING_BOOTLOAD_CMD:
321 case MXT_WAITING_FRAME_DATA:
322 val &= ~MXT_BOOT_STATUS_MASK;
324 case MXT_FRAME_CRC_PASS:
325 if (val == MXT_FRAME_CRC_CHECK)
333 dev_err(&client->dev, "Unvalid bootloader mode state\n");
340 static int mxt_unlock_bootloader(struct i2c_client *client)
344 buf[0] = MXT_UNLOCK_CMD_LSB;
345 buf[1] = MXT_UNLOCK_CMD_MSB;
347 if (i2c_master_send(client, buf, 2) != 2) {
348 dev_err(&client->dev, "%s: i2c send failed\n", __func__);
355 static int mxt_fw_write(struct i2c_client *client,
356 const u8 *data, unsigned int frame_size)
358 if (i2c_master_send(client, data, frame_size) != frame_size) {
359 dev_err(&client->dev, "%s: i2c send failed\n", __func__);
366 static int __mxt_read_reg(struct i2c_client *client,
367 u16 reg, u16 len, void *val)
369 struct i2c_msg xfer[2];
373 buf[1] = (reg >> 8) & 0xff;
376 xfer[0].addr = client->addr;
382 xfer[1].addr = client->addr;
383 xfer[1].flags = I2C_M_RD;
387 if (i2c_transfer(client->adapter, xfer, 2) != 2) {
388 dev_err(&client->dev, "%s: i2c transfer failed\n", __func__);
395 static int mxt_read_reg(struct i2c_client *client, u16 reg, u8 *val)
397 return __mxt_read_reg(client, reg, 1, val);
400 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
405 buf[1] = (reg >> 8) & 0xff;
408 if (i2c_master_send(client, buf, 3) != 3) {
409 dev_err(&client->dev, "%s: i2c send failed\n", __func__);
416 static int mxt_read_object_table(struct i2c_client *client,
417 u16 reg, u8 *object_buf)
419 return __mxt_read_reg(client, reg, MXT_OBJECT_SIZE,
423 static struct mxt_object *
424 mxt_get_object(struct mxt_data *data, u8 type)
426 struct mxt_object *object;
429 for (i = 0; i < data->info.object_num; i++) {
430 object = data->object_table + i;
431 if (object->type == type)
435 dev_err(&data->client->dev, "Invalid object type\n");
439 static int mxt_read_message(struct mxt_data *data,
440 struct mxt_message *message)
442 struct mxt_object *object;
445 object = mxt_get_object(data, MXT_GEN_MESSAGE);
449 reg = object->start_address;
450 return __mxt_read_reg(data->client, reg,
451 sizeof(struct mxt_message), message);
454 static int mxt_read_object(struct mxt_data *data,
455 u8 type, u8 offset, u8 *val)
457 struct mxt_object *object;
460 object = mxt_get_object(data, type);
464 reg = object->start_address;
465 return __mxt_read_reg(data->client, reg + offset, 1, val);
468 static int mxt_write_object(struct mxt_data *data,
469 u8 type, u8 offset, u8 val)
471 struct mxt_object *object;
474 object = mxt_get_object(data, type);
478 reg = object->start_address;
479 return mxt_write_reg(data->client, reg + offset, val);
482 static void mxt_input_report(struct mxt_data *data, int single_id)
484 struct mxt_finger *finger = data->finger;
485 struct input_dev *input_dev = data->input_dev;
486 int status = finger[single_id].status;
490 for (id = 0; id < MXT_MAX_FINGER; id++) {
491 if (!finger[id].status)
494 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR,
495 finger[id].status != MXT_RELEASE ?
496 finger[id].area : 0);
497 input_report_abs(input_dev, ABS_MT_POSITION_X,
499 input_report_abs(input_dev, ABS_MT_POSITION_Y,
501 input_mt_sync(input_dev);
503 if (finger[id].status == MXT_RELEASE)
504 finger[id].status = 0;
509 input_report_key(input_dev, BTN_TOUCH, finger_num > 0);
511 if (status != MXT_RELEASE) {
512 input_report_abs(input_dev, ABS_X, finger[single_id].x);
513 input_report_abs(input_dev, ABS_Y, finger[single_id].y);
516 input_sync(input_dev);
519 static void mxt_input_touchevent(struct mxt_data *data,
520 struct mxt_message *message, int id)
522 struct mxt_finger *finger = data->finger;
523 struct device *dev = &data->client->dev;
524 u8 status = message->message[0];
529 /* Check the touch is present on the screen */
530 if (!(status & MXT_DETECT)) {
531 if (status & MXT_RELEASE) {
532 dev_dbg(dev, "[%d] released\n", id);
534 finger[id].status = MXT_RELEASE;
535 mxt_input_report(data, id);
540 /* Check only AMP detection */
541 if (!(status & (MXT_PRESS | MXT_MOVE)))
544 x = (message->message[1] << 2) | ((message->message[3] & ~0x3f) >> 6);
545 y = (message->message[2] << 2) | ((message->message[3] & ~0xf3) >> 2);
546 area = message->message[4];
548 dev_dbg(dev, "[%d] %s x: %d, y: %d, area: %d\n", id,
549 status & MXT_MOVE ? "moved" : "pressed",
552 finger[id].status = status & MXT_MOVE ?
553 MXT_MOVE : MXT_PRESS;
556 finger[id].area = area;
558 mxt_input_report(data, id);
561 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
563 struct mxt_data *data = dev_id;
564 struct mxt_message message;
565 struct mxt_object *object;
566 struct device *dev = &data->client->dev;
573 if (mxt_read_message(data, &message)) {
574 dev_err(dev, "Failed to read message\n");
578 reportid = message.reportid;
580 /* whether reportid is thing of MXT_TOUCH_MULTI */
581 object = mxt_get_object(data, MXT_TOUCH_MULTI);
585 max_reportid = object->max_reportid;
586 min_reportid = max_reportid - object->num_report_ids + 1;
587 id = reportid - min_reportid;
589 if (reportid >= min_reportid && reportid <= max_reportid)
590 mxt_input_touchevent(data, &message, id);
592 mxt_dump_message(dev, &message);
593 } while (reportid != 0xff);
599 static int mxt_check_reg_init(struct mxt_data *data)
601 const struct mxt_platform_data *pdata = data->pdata;
602 struct mxt_object *object;
603 struct device *dev = &data->client->dev;
605 int i, j, config_offset;
607 if (!pdata->config) {
608 dev_dbg(dev, "No cfg data defined, skipping reg init\n");
612 for (i = 0; i < data->info.object_num; i++) {
613 object = data->object_table + i;
615 if (!mxt_object_writable(object->type))
618 for (j = 0; j < object->size + 1; j++) {
619 config_offset = index + j;
620 if (config_offset > pdata->config_length) {
621 dev_err(dev, "Not enough config data!\n");
624 mxt_write_object(data, object->type, j,
625 pdata->config[config_offset]);
627 index += object->size + 1;
633 static int mxt_check_matrix_size(struct mxt_data *data)
635 const struct mxt_platform_data *pdata = data->pdata;
636 struct device *dev = &data->client->dev;
641 dev_dbg(dev, "Number of X lines: %d\n", pdata->x_line);
642 dev_dbg(dev, "Number of Y lines: %d\n", pdata->y_line);
644 switch (pdata->x_line) {
646 if (pdata->y_line <= 14)
650 if (pdata->y_line <= 12)
652 if (pdata->y_line == 13 || pdata->y_line == 14)
656 if (pdata->y_line <= 11)
658 if (pdata->y_line == 12 || pdata->y_line == 13)
662 if (pdata->y_line <= 10)
664 if (pdata->y_line == 11 || pdata->y_line == 12)
668 if (pdata->y_line <= 9)
670 if (pdata->y_line == 10 || pdata->y_line == 11)
678 dev_err(dev, "Invalid X/Y lines\n");
682 error = mxt_read_object(data, MXT_SPT_CTECONFIG,
690 /* Change the CTE configuration */
691 mxt_write_object(data, MXT_SPT_CTECONFIG,
693 mxt_write_object(data, MXT_SPT_CTECONFIG,
695 mxt_write_object(data, MXT_SPT_CTECONFIG,
701 static int mxt_make_highchg(struct mxt_data *data)
703 struct device *dev = &data->client->dev;
704 struct mxt_message message;
708 /* Read dummy message to make high CHG pin */
710 error = mxt_read_message(data, &message);
713 } while (message.reportid != 0xff && --count);
716 dev_err(dev, "CHG pin isn't cleared\n");
723 static void mxt_handle_pdata(struct mxt_data *data)
725 const struct mxt_platform_data *pdata = data->pdata;
728 /* Set touchscreen lines */
729 mxt_write_object(data, MXT_TOUCH_MULTI, MXT_TOUCH_XSIZE,
731 mxt_write_object(data, MXT_TOUCH_MULTI, MXT_TOUCH_YSIZE,
734 /* Set touchscreen orient */
735 mxt_write_object(data, MXT_TOUCH_MULTI, MXT_TOUCH_ORIENT,
738 /* Set touchscreen burst length */
739 mxt_write_object(data, MXT_TOUCH_MULTI,
740 MXT_TOUCH_BLEN, pdata->blen);
742 /* Set touchscreen threshold */
743 mxt_write_object(data, MXT_TOUCH_MULTI,
744 MXT_TOUCH_TCHTHR, pdata->threshold);
746 /* Set touchscreen resolution */
747 mxt_write_object(data, MXT_TOUCH_MULTI,
748 MXT_TOUCH_XRANGE_LSB, (pdata->x_size - 1) & 0xff);
749 mxt_write_object(data, MXT_TOUCH_MULTI,
750 MXT_TOUCH_XRANGE_MSB, (pdata->x_size - 1) >> 8);
751 mxt_write_object(data, MXT_TOUCH_MULTI,
752 MXT_TOUCH_YRANGE_LSB, (pdata->y_size - 1) & 0xff);
753 mxt_write_object(data, MXT_TOUCH_MULTI,
754 MXT_TOUCH_YRANGE_MSB, (pdata->y_size - 1) >> 8);
756 /* Set touchscreen voltage */
757 if (data->info.version >= MXT_VER_21 && pdata->voltage) {
758 if (pdata->voltage < MXT_VOLTAGE_DEFAULT) {
759 voltage = (MXT_VOLTAGE_DEFAULT - pdata->voltage) /
761 voltage = 0xff - voltage + 1;
763 voltage = (pdata->voltage - MXT_VOLTAGE_DEFAULT) /
766 mxt_write_object(data, MXT_SPT_CTECONFIG,
767 MXT_CTE_VOLTAGE, voltage);
771 static int mxt_get_info(struct mxt_data *data)
773 struct i2c_client *client = data->client;
774 struct mxt_info *info = &data->info;
778 error = mxt_read_reg(client, MXT_FAMILY_ID, &val);
781 info->family_id = val;
783 error = mxt_read_reg(client, MXT_VARIANT_ID, &val);
786 info->variant_id = val;
788 error = mxt_read_reg(client, MXT_VERSION, &val);
793 error = mxt_read_reg(client, MXT_BUILD, &val);
798 error = mxt_read_reg(client, MXT_OBJECT_NUM, &val);
801 info->object_num = val;
806 static int mxt_get_object_table(struct mxt_data *data)
812 u8 buf[MXT_OBJECT_SIZE];
814 for (i = 0; i < data->info.object_num; i++) {
815 struct mxt_object *object = data->object_table + i;
817 reg = MXT_OBJECT_START + MXT_OBJECT_SIZE * i;
818 error = mxt_read_object_table(data->client, reg, buf);
822 object->type = buf[0];
823 object->start_address = (buf[2] << 8) | buf[1];
824 object->size = buf[3];
825 object->instances = buf[4];
826 object->num_report_ids = buf[5];
828 if (object->num_report_ids) {
829 reportid += object->num_report_ids *
830 (object->instances + 1);
831 object->max_reportid = reportid;
838 static int mxt_initialize(struct mxt_data *data)
840 struct i2c_client *client = data->client;
841 struct mxt_info *info = &data->info;
845 error = mxt_get_info(data);
849 data->object_table = kcalloc(info->object_num,
850 sizeof(struct mxt_object),
852 if (!data->object_table) {
853 dev_err(&client->dev, "Failed to allocate memory\n");
857 /* Get object table information */
858 error = mxt_get_object_table(data);
862 /* Check register init values */
863 error = mxt_check_reg_init(data);
867 /* Check X/Y matrix size */
868 error = mxt_check_matrix_size(data);
872 error = mxt_make_highchg(data);
876 mxt_handle_pdata(data);
878 /* Backup to memory */
879 mxt_write_object(data, MXT_GEN_COMMAND,
880 MXT_COMMAND_BACKUPNV,
882 msleep(MXT_BACKUP_TIME);
885 mxt_write_object(data, MXT_GEN_COMMAND,
886 MXT_COMMAND_RESET, 1);
887 msleep(MXT_RESET_TIME);
889 /* Update matrix size at info struct */
890 error = mxt_read_reg(client, MXT_MATRIX_X_SIZE, &val);
893 info->matrix_xsize = val;
895 error = mxt_read_reg(client, MXT_MATRIX_Y_SIZE, &val);
898 info->matrix_ysize = val;
900 dev_info(&client->dev,
901 "Family ID: %d Variant ID: %d Version: %d Build: %d\n",
902 info->family_id, info->variant_id, info->version,
905 dev_info(&client->dev,
906 "Matrix X Size: %d Matrix Y Size: %d Object Num: %d\n",
907 info->matrix_xsize, info->matrix_ysize,
913 static ssize_t mxt_object_show(struct device *dev,
914 struct device_attribute *attr, char *buf)
916 struct mxt_data *data = dev_get_drvdata(dev);
917 struct mxt_object *object;
923 for (i = 0; i < data->info.object_num; i++) {
924 object = data->object_table + i;
926 count += sprintf(buf + count,
927 "Object Table Element %d(Type %d)\n",
928 i + 1, object->type);
930 if (!mxt_object_readable(object->type)) {
931 count += sprintf(buf + count, "\n");
935 for (j = 0; j < object->size + 1; j++) {
936 error = mxt_read_object(data,
937 object->type, j, &val);
941 count += sprintf(buf + count,
942 " Byte %d: 0x%x (%d)\n", j, val, val);
945 count += sprintf(buf + count, "\n");
951 static int mxt_load_fw(struct device *dev, const char *fn)
953 struct mxt_data *data = dev_get_drvdata(dev);
954 struct i2c_client *client = data->client;
955 const struct firmware *fw = NULL;
956 unsigned int frame_size;
957 unsigned int pos = 0;
960 ret = request_firmware(&fw, fn, dev);
962 dev_err(dev, "Unable to open firmware %s\n", fn);
966 /* Change to the bootloader mode */
967 mxt_write_object(data, MXT_GEN_COMMAND,
968 MXT_COMMAND_RESET, MXT_BOOT_VALUE);
969 msleep(MXT_RESET_TIME);
971 /* Change to slave address of bootloader */
972 if (client->addr == MXT_APP_LOW)
973 client->addr = MXT_BOOT_LOW;
975 client->addr = MXT_BOOT_HIGH;
977 ret = mxt_check_bootloader(client, MXT_WAITING_BOOTLOAD_CMD);
981 /* Unlock bootloader */
982 mxt_unlock_bootloader(client);
984 while (pos < fw->size) {
985 ret = mxt_check_bootloader(client,
986 MXT_WAITING_FRAME_DATA);
990 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
992 /* We should add 2 at frame size as the the firmware data is not
993 * included the CRC bytes.
997 /* Write one frame to device */
998 mxt_fw_write(client, fw->data + pos, frame_size);
1000 ret = mxt_check_bootloader(client,
1001 MXT_FRAME_CRC_PASS);
1007 dev_dbg(dev, "Updated %d bytes / %zd bytes\n", pos, fw->size);
1011 release_firmware(fw);
1013 /* Change to slave address of application */
1014 if (client->addr == MXT_BOOT_LOW)
1015 client->addr = MXT_APP_LOW;
1017 client->addr = MXT_APP_HIGH;
1022 static ssize_t mxt_update_fw_store(struct device *dev,
1023 struct device_attribute *attr,
1024 const char *buf, size_t count)
1026 struct mxt_data *data = dev_get_drvdata(dev);
1027 unsigned int version;
1030 if (sscanf(buf, "%u", &version) != 1) {
1031 dev_err(dev, "Invalid values\n");
1035 if (data->info.version < MXT_VER_21 || version < MXT_VER_21) {
1036 dev_err(dev, "FW update supported starting with version 21\n");
1040 disable_irq(data->irq);
1042 error = mxt_load_fw(dev, MXT_FW_NAME);
1044 dev_err(dev, "The firmware update failed(%d)\n", error);
1047 dev_dbg(dev, "The firmware update succeeded\n");
1049 /* Wait for reset */
1050 msleep(MXT_FWRESET_TIME);
1052 kfree(data->object_table);
1053 data->object_table = NULL;
1055 mxt_initialize(data);
1058 enable_irq(data->irq);
1063 static DEVICE_ATTR(object, 0444, mxt_object_show, NULL);
1064 static DEVICE_ATTR(update_fw, 0664, NULL, mxt_update_fw_store);
1066 static struct attribute *mxt_attrs[] = {
1067 &dev_attr_object.attr,
1068 &dev_attr_update_fw.attr,
1072 static const struct attribute_group mxt_attr_group = {
1076 static void mxt_start(struct mxt_data *data)
1079 mxt_write_object(data,
1080 MXT_TOUCH_MULTI, MXT_TOUCH_CTRL, 0x83);
1083 static void mxt_stop(struct mxt_data *data)
1086 mxt_write_object(data,
1087 MXT_TOUCH_MULTI, MXT_TOUCH_CTRL, 0);
1090 static int mxt_input_open(struct input_dev *dev)
1092 struct mxt_data *data = input_get_drvdata(dev);
1099 static void mxt_input_close(struct input_dev *dev)
1101 struct mxt_data *data = input_get_drvdata(dev);
1106 static int __devinit mxt_probe(struct i2c_client *client,
1107 const struct i2c_device_id *id)
1109 struct mxt_data *data;
1110 struct input_dev *input_dev;
1113 if (!client->dev.platform_data)
1116 data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
1117 input_dev = input_allocate_device();
1118 if (!data || !input_dev) {
1119 dev_err(&client->dev, "Failed to allocate memory\n");
1124 input_dev->name = "Atmel maXTouch Touchscreen";
1125 input_dev->id.bustype = BUS_I2C;
1126 input_dev->dev.parent = &client->dev;
1127 input_dev->open = mxt_input_open;
1128 input_dev->close = mxt_input_close;
1130 __set_bit(EV_ABS, input_dev->evbit);
1131 __set_bit(EV_KEY, input_dev->evbit);
1132 __set_bit(BTN_TOUCH, input_dev->keybit);
1134 /* For single touch */
1135 input_set_abs_params(input_dev, ABS_X,
1136 0, MXT_MAX_XC, 0, 0);
1137 input_set_abs_params(input_dev, ABS_Y,
1138 0, MXT_MAX_YC, 0, 0);
1140 /* For multi touch */
1141 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1142 0, MXT_MAX_AREA, 0, 0);
1143 input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1144 0, MXT_MAX_XC, 0, 0);
1145 input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1146 0, MXT_MAX_YC, 0, 0);
1148 input_set_drvdata(input_dev, data);
1150 data->client = client;
1151 data->input_dev = input_dev;
1152 data->pdata = client->dev.platform_data;
1153 data->irq = client->irq;
1155 i2c_set_clientdata(client, data);
1157 error = mxt_initialize(data);
1159 goto err_free_object;
1161 error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
1162 IRQF_TRIGGER_FALLING, client->dev.driver->name, data);
1164 dev_err(&client->dev, "Failed to register interrupt\n");
1165 goto err_free_object;
1168 error = input_register_device(input_dev);
1172 error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
1174 goto err_unregister_device;
1178 err_unregister_device:
1179 input_unregister_device(input_dev);
1182 free_irq(client->irq, data);
1184 kfree(data->object_table);
1186 input_free_device(input_dev);
1191 static int __devexit mxt_remove(struct i2c_client *client)
1193 struct mxt_data *data = i2c_get_clientdata(client);
1195 sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
1196 free_irq(data->irq, data);
1197 input_unregister_device(data->input_dev);
1198 kfree(data->object_table);
1205 static int mxt_suspend(struct device *dev)
1207 struct i2c_client *client = to_i2c_client(dev);
1208 struct mxt_data *data = i2c_get_clientdata(client);
1209 struct input_dev *input_dev = data->input_dev;
1211 mutex_lock(&input_dev->mutex);
1213 if (input_dev->users)
1216 mutex_unlock(&input_dev->mutex);
1221 static int mxt_resume(struct device *dev)
1223 struct i2c_client *client = to_i2c_client(dev);
1224 struct mxt_data *data = i2c_get_clientdata(client);
1225 struct input_dev *input_dev = data->input_dev;
1228 mxt_write_object(data, MXT_GEN_COMMAND,
1229 MXT_COMMAND_RESET, 1);
1231 msleep(MXT_RESET_TIME);
1233 mutex_lock(&input_dev->mutex);
1235 if (input_dev->users)
1238 mutex_unlock(&input_dev->mutex);
1243 static const struct dev_pm_ops mxt_pm_ops = {
1244 .suspend = mxt_suspend,
1245 .resume = mxt_resume,
1249 static const struct i2c_device_id mxt_id[] = {
1250 { "qt602240_ts", 0 },
1251 { "atmel_mxt_ts", 0 },
1255 MODULE_DEVICE_TABLE(i2c, mxt_id);
1257 static struct i2c_driver mxt_driver = {
1259 .name = "atmel_mxt_ts",
1260 .owner = THIS_MODULE,
1266 .remove = __devexit_p(mxt_remove),
1270 static int __init mxt_init(void)
1272 return i2c_add_driver(&mxt_driver);
1275 static void __exit mxt_exit(void)
1277 i2c_del_driver(&mxt_driver);
1280 module_init(mxt_init);
1281 module_exit(mxt_exit);
1283 /* Module information */
1284 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
1285 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
1286 MODULE_LICENSE("GPL");