drivers/input/touchscreen/atmel_mxt_ts.c

   1 /*
   2  * Atmel maXTouch Touchscreen driver
   3  *
   4  * Copyright (C) 2010 Samsung Electronics Co.Ltd
   5  * Author: Joonyoung Shim <jy0922.shim@samsung.com>
   6  *
   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.
  11  *
  12  */
  13
  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/mt.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/slab.h>
  23
  24 /* Version */
  25 #define MXT_VER_20              20
  26 #define MXT_VER_21              21
  27 #define MXT_VER_22              22
  28
  29 /* Slave addresses */
  30 #define MXT_APP_LOW             0x4a
  31 #define MXT_APP_HIGH            0x4b
  32 #define MXT_BOOT_LOW            0x24
  33 #define MXT_BOOT_HIGH           0x25
  34
  35 /* Firmware */
  36 #define MXT_FW_NAME             "maxtouch.fw"
  37
  38 /* Registers */
  39 #define MXT_INFO                0x00
  40 #define MXT_FAMILY_ID           0x00
  41 #define MXT_VARIANT_ID          0x01
  42 #define MXT_VERSION             0x02
  43 #define MXT_BUILD               0x03
  44 #define MXT_MATRIX_X_SIZE       0x04
  45 #define MXT_MATRIX_Y_SIZE       0x05
  46 #define MXT_OBJECT_NUM          0x06
  47 #define MXT_OBJECT_START        0x07
  48
  49 #define MXT_OBJECT_SIZE         6
  50
  51 /* Object types */
  52 #define MXT_DEBUG_DIAGNOSTIC_T37        37
  53 #define MXT_GEN_MESSAGE_T5              5
  54 #define MXT_GEN_COMMAND_T6              6
  55 #define MXT_GEN_POWER_T7                7
  56 #define MXT_GEN_ACQUIRE_T8              8
  57 #define MXT_GEN_DATASOURCE_T53          53
  58 #define MXT_TOUCH_MULTI_T9              9
  59 #define MXT_TOUCH_KEYARRAY_T15          15
  60 #define MXT_TOUCH_PROXIMITY_T23         23
  61 #define MXT_TOUCH_PROXKEY_T52           52
  62 #define MXT_PROCI_GRIPFACE_T20          20
  63 #define MXT_PROCG_NOISE_T22             22
  64 #define MXT_PROCI_ONETOUCH_T24          24
  65 #define MXT_PROCI_TWOTOUCH_T27          27
  66 #define MXT_PROCI_GRIP_T40              40
  67 #define MXT_PROCI_PALM_T41              41
  68 #define MXT_PROCI_TOUCHSUPPRESSION_T42  42
  69 #define MXT_PROCI_STYLUS_T47            47
  70 #define MXT_PROCG_NOISESUPPRESSION_T48  48
  71 #define MXT_SPT_COMMSCONFIG_T18         18
  72 #define MXT_SPT_GPIOPWM_T19             19
  73 #define MXT_SPT_SELFTEST_T25            25
  74 #define MXT_SPT_CTECONFIG_T28           28
  75 #define MXT_SPT_USERDATA_T38            38
  76 #define MXT_SPT_DIGITIZER_T43           43
  77 #define MXT_SPT_MESSAGECOUNT_T44        44
  78 #define MXT_SPT_CTECONFIG_T46           46
  79
  80 /* MXT_GEN_COMMAND_T6 field */
  81 #define MXT_COMMAND_RESET       0
  82 #define MXT_COMMAND_BACKUPNV    1
  83 #define MXT_COMMAND_CALIBRATE   2
  84 #define MXT_COMMAND_REPORTALL   3
  85 #define MXT_COMMAND_DIAGNOSTIC  5
  86
  87 /* MXT_GEN_POWER_T7 field */
  88 #define MXT_POWER_IDLEACQINT    0
  89 #define MXT_POWER_ACTVACQINT    1
  90 #define MXT_POWER_ACTV2IDLETO   2
  91
  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
 100
 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
 130
 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
 143
 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
 160
 161 /* MXT_SPT_COMMSCONFIG_T18 */
 162 #define MXT_COMMS_CTRL          0
 163 #define MXT_COMMS_CMD           1
 164
 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
 172
 173 #define MXT_VOLTAGE_DEFAULT     2700000
 174 #define MXT_VOLTAGE_STEP        10000
 175
 176 /* Define for MXT_GEN_COMMAND_T6 */
 177 #define MXT_BOOT_VALUE          0xa5
 178 #define MXT_BACKUP_VALUE        0x55
 179 #define MXT_BACKUP_TIME         25      /* msec */
 180 #define MXT_RESET_TIME          65      /* msec */
 181
 182 #define MXT_FWRESET_TIME        175     /* msec */
 183
 184 /* Command to unlock bootloader */
 185 #define MXT_UNLOCK_CMD_MSB      0xaa
 186 #define MXT_UNLOCK_CMD_LSB      0xdc
 187
 188 /* Bootloader mode status */
 189 #define MXT_WAITING_BOOTLOAD_CMD        0xc0    /* valid 7 6 bit only */
 190 #define MXT_WAITING_FRAME_DATA  0x80    /* valid 7 6 bit only */
 191 #define MXT_FRAME_CRC_CHECK     0x02
 192 #define MXT_FRAME_CRC_FAIL      0x03
 193 #define MXT_FRAME_CRC_PASS      0x04
 194 #define MXT_APP_CRC_FAIL        0x40    /* valid 7 8 bit only */
 195 #define MXT_BOOT_STATUS_MASK    0x3f
 196
 197 /* Touch status */
 198 #define MXT_UNGRIP              (1 << 0)
 199 #define MXT_SUPPRESS            (1 << 1)
 200 #define MXT_AMP                 (1 << 2)
 201 #define MXT_VECTOR              (1 << 3)
 202 #define MXT_MOVE                (1 << 4)
 203 #define MXT_RELEASE             (1 << 5)
 204 #define MXT_PRESS               (1 << 6)
 205 #define MXT_DETECT              (1 << 7)
 206
 207 /* Touch orient bits */
 208 #define MXT_XY_SWITCH           (1 << 0)
 209 #define MXT_X_INVERT            (1 << 1)
 210 #define MXT_Y_INVERT            (1 << 2)
 211
 212 /* Touchscreen absolute values */
 213 #define MXT_MAX_AREA            0xff
 214
 215 struct mxt_info {
 216         u8 family_id;
 217         u8 variant_id;
 218         u8 version;
 219         u8 build;
 220         u8 matrix_xsize;
 221         u8 matrix_ysize;
 222         u8 object_num;
 223 };
 224
 225 struct mxt_object {
 226         u8 type;
 227         u16 start_address;
 228         u8 size;                /* Size of each instance - 1 */
 229         u8 instances;           /* Number of instances - 1 */
 230         u8 num_report_ids;
 231 } __packed;
 232
 233 struct mxt_message {
 234         u8 reportid;
 235         u8 message[7];
 236 };
 237
 238 /* Each client has this additional data */
 239 struct mxt_data {
 240         struct i2c_client *client;
 241         struct input_dev *input_dev;
 242         char phys[64];          /* device physical location */
 243         const struct mxt_platform_data *pdata;
 244         struct mxt_object *object_table;
 245         struct mxt_info info;
 246         unsigned int irq;
 247         unsigned int max_x;
 248         unsigned int max_y;
 249
 250         /* Cached parameters from object table */
 251         u8 T6_reportid;
 252         u8 T9_reportid_min;
 253         u8 T9_reportid_max;
 254 };
 255
 256 static bool mxt_object_readable(unsigned int type)
 257 {
 258         switch (type) {
 259         case MXT_GEN_COMMAND_T6:
 260         case MXT_GEN_POWER_T7:
 261         case MXT_GEN_ACQUIRE_T8:
 262         case MXT_GEN_DATASOURCE_T53:
 263         case MXT_TOUCH_MULTI_T9:
 264         case MXT_TOUCH_KEYARRAY_T15:
 265         case MXT_TOUCH_PROXIMITY_T23:
 266         case MXT_TOUCH_PROXKEY_T52:
 267         case MXT_PROCI_GRIPFACE_T20:
 268         case MXT_PROCG_NOISE_T22:
 269         case MXT_PROCI_ONETOUCH_T24:
 270         case MXT_PROCI_TWOTOUCH_T27:
 271         case MXT_PROCI_GRIP_T40:
 272         case MXT_PROCI_PALM_T41:
 273         case MXT_PROCI_TOUCHSUPPRESSION_T42:
 274         case MXT_PROCI_STYLUS_T47:
 275         case MXT_PROCG_NOISESUPPRESSION_T48:
 276         case MXT_SPT_COMMSCONFIG_T18:
 277         case MXT_SPT_GPIOPWM_T19:
 278         case MXT_SPT_SELFTEST_T25:
 279         case MXT_SPT_CTECONFIG_T28:
 280         case MXT_SPT_USERDATA_T38:
 281         case MXT_SPT_DIGITIZER_T43:
 282         case MXT_SPT_CTECONFIG_T46:
 283                 return true;
 284         default:
 285                 return false;
 286         }
 287 }
 288
 289 static bool mxt_object_writable(unsigned int type)
 290 {
 291         switch (type) {
 292         case MXT_GEN_COMMAND_T6:
 293         case MXT_GEN_POWER_T7:
 294         case MXT_GEN_ACQUIRE_T8:
 295         case MXT_TOUCH_MULTI_T9:
 296         case MXT_TOUCH_KEYARRAY_T15:
 297         case MXT_TOUCH_PROXIMITY_T23:
 298         case MXT_TOUCH_PROXKEY_T52:
 299         case MXT_PROCI_GRIPFACE_T20:
 300         case MXT_PROCG_NOISE_T22:
 301         case MXT_PROCI_ONETOUCH_T24:
 302         case MXT_PROCI_TWOTOUCH_T27:
 303         case MXT_PROCI_GRIP_T40:
 304         case MXT_PROCI_PALM_T41:
 305         case MXT_PROCI_TOUCHSUPPRESSION_T42:
 306         case MXT_PROCI_STYLUS_T47:
 307         case MXT_PROCG_NOISESUPPRESSION_T48:
 308         case MXT_SPT_COMMSCONFIG_T18:
 309         case MXT_SPT_GPIOPWM_T19:
 310         case MXT_SPT_SELFTEST_T25:
 311         case MXT_SPT_CTECONFIG_T28:
 312         case MXT_SPT_DIGITIZER_T43:
 313         case MXT_SPT_CTECONFIG_T46:
 314                 return true;
 315         default:
 316                 return false;
 317         }
 318 }
 319
 320 static void mxt_dump_message(struct device *dev,
 321                              struct mxt_message *message)
 322 {
 323         dev_dbg(dev, "reportid: %u\tmessage: %02x %02x %02x %02x %02x %02x %02x\n",
 324                 message->reportid, message->message[0], message->message[1],
 325                 message->message[2], message->message[3], message->message[4],
 326                 message->message[5], message->message[6]);
 327 }
 328
 329 static int mxt_check_bootloader(struct i2c_client *client,
 330                                      unsigned int state)
 331 {
 332         u8 val;
 333
 334 recheck:
 335         if (i2c_master_recv(client, &val, 1) != 1) {
 336                 dev_err(&client->dev, "%s: i2c recv failed\n", __func__);
 337                 return -EIO;
 338         }
 339
 340         switch (state) {
 341         case MXT_WAITING_BOOTLOAD_CMD:
 342         case MXT_WAITING_FRAME_DATA:
 343                 val &= ~MXT_BOOT_STATUS_MASK;
 344                 break;
 345         case MXT_FRAME_CRC_PASS:
 346                 if (val == MXT_FRAME_CRC_CHECK)
 347                         goto recheck;
 348                 break;
 349         default:
 350                 return -EINVAL;
 351         }
 352
 353         if (val != state) {
 354                 dev_err(&client->dev, "Unvalid bootloader mode state\n");
 355                 return -EINVAL;
 356         }
 357
 358         return 0;
 359 }
 360
 361 static int mxt_unlock_bootloader(struct i2c_client *client)
 362 {
 363         u8 buf[2];
 364
 365         buf[0] = MXT_UNLOCK_CMD_LSB;
 366         buf[1] = MXT_UNLOCK_CMD_MSB;
 367
 368         if (i2c_master_send(client, buf, 2) != 2) {
 369                 dev_err(&client->dev, "%s: i2c send failed\n", __func__);
 370                 return -EIO;
 371         }
 372
 373         return 0;
 374 }
 375
 376 static int mxt_fw_write(struct i2c_client *client,
 377                              const u8 *data, unsigned int frame_size)
 378 {
 379         if (i2c_master_send(client, data, frame_size) != frame_size) {
 380                 dev_err(&client->dev, "%s: i2c send failed\n", __func__);
 381                 return -EIO;
 382         }
 383
 384         return 0;
 385 }
 386
 387 static int __mxt_read_reg(struct i2c_client *client,
 388                                u16 reg, u16 len, void *val)
 389 {
 390         struct i2c_msg xfer[2];
 391         u8 buf[2];
 392         int ret;
 393
 394         buf[0] = reg & 0xff;
 395         buf[1] = (reg >> 8) & 0xff;
 396
 397         /* Write register */
 398         xfer[0].addr = client->addr;
 399         xfer[0].flags = 0;
 400         xfer[0].len = 2;
 401         xfer[0].buf = buf;
 402
 403         /* Read data */
 404         xfer[1].addr = client->addr;
 405         xfer[1].flags = I2C_M_RD;
 406         xfer[1].len = len;
 407         xfer[1].buf = val;
 408
 409         ret = i2c_transfer(client->adapter, xfer, 2);
 410         if (ret == 2) {
 411                 ret = 0;
 412         } else {
 413                 if (ret >= 0)
 414                         ret = -EIO;
 415                 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
 416                         __func__, ret);
 417         }
 418
 419         return ret;
 420 }
 421
 422 static int mxt_read_reg(struct i2c_client *client, u16 reg, u8 *val)
 423 {
 424         return __mxt_read_reg(client, reg, 1, val);
 425 }
 426
 427 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
 428                            const void *val)
 429 {
 430         u8 *buf;
 431         size_t count;
 432         int ret;
 433
 434         count = len + 2;
 435         buf = kmalloc(count, GFP_KERNEL);
 436         if (!buf)
 437                 return -ENOMEM;
 438
 439         buf[0] = reg & 0xff;
 440         buf[1] = (reg >> 8) & 0xff;
 441         memcpy(&buf[2], val, len);
 442
 443         ret = i2c_master_send(client, buf, count);
 444         if (ret == count) {
 445                 ret = 0;
 446         } else {
 447                 if (ret >= 0)
 448                         ret = -EIO;
 449                 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
 450                         __func__, ret);
 451         }
 452
 453         kfree(buf);
 454         return ret;
 455 }
 456
 457 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
 458 {
 459         return __mxt_write_reg(client, reg, 1, &val);
 460 }
 461
 462 static struct mxt_object *
 463 mxt_get_object(struct mxt_data *data, u8 type)
 464 {
 465         struct mxt_object *object;
 466         int i;
 467
 468         for (i = 0; i < data->info.object_num; i++) {
 469                 object = data->object_table + i;
 470                 if (object->type == type)
 471                         return object;
 472         }
 473
 474         dev_err(&data->client->dev, "Invalid object type\n");
 475         return NULL;
 476 }
 477
 478 static int mxt_read_message(struct mxt_data *data,
 479                                  struct mxt_message *message)
 480 {
 481         struct mxt_object *object;
 482         u16 reg;
 483
 484         object = mxt_get_object(data, MXT_GEN_MESSAGE_T5);
 485         if (!object)
 486                 return -EINVAL;
 487
 488         reg = object->start_address;
 489         return __mxt_read_reg(data->client, reg,
 490                         sizeof(struct mxt_message), message);
 491 }
 492
 493 static int mxt_write_object(struct mxt_data *data,
 494                                  u8 type, u8 offset, u8 val)
 495 {
 496         struct mxt_object *object;
 497         u16 reg;
 498
 499         object = mxt_get_object(data, type);
 500         if (!object || offset >= object->size + 1)
 501                 return -EINVAL;
 502
 503         reg = object->start_address;
 504         return mxt_write_reg(data->client, reg + offset, val);
 505 }
 506
 507 static void mxt_input_touchevent(struct mxt_data *data,
 508                                       struct mxt_message *message, int id)
 509 {
 510         struct device *dev = &data->client->dev;
 511         u8 status = message->message[0];
 512         struct input_dev *input_dev = data->input_dev;
 513         int x;
 514         int y;
 515         int area;
 516         int pressure;
 517
 518         x = (message->message[1] << 4) | ((message->message[3] >> 4) & 0xf);
 519         y = (message->message[2] << 4) | ((message->message[3] & 0xf));
 520         if (data->max_x < 1024)
 521                 x = x >> 2;
 522         if (data->max_y < 1024)
 523                 y = y >> 2;
 524
 525         area = message->message[4];
 526         pressure = message->message[5];
 527
 528         dev_dbg(dev,
 529                 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
 530                 id,
 531                 (status & MXT_DETECT) ? 'D' : '.',
 532                 (status & MXT_PRESS) ? 'P' : '.',
 533                 (status & MXT_RELEASE) ? 'R' : '.',
 534                 (status & MXT_MOVE) ? 'M' : '.',
 535                 (status & MXT_VECTOR) ? 'V' : '.',
 536                 (status & MXT_AMP) ? 'A' : '.',
 537                 (status & MXT_SUPPRESS) ? 'S' : '.',
 538                 (status & MXT_UNGRIP) ? 'U' : '.',
 539                 x, y, area, pressure);
 540
 541         input_mt_slot(input_dev, id);
 542         input_mt_report_slot_state(input_dev, MT_TOOL_FINGER,
 543                                    status & MXT_DETECT);
 544
 545         if (status & MXT_DETECT) {
 546                 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
 547                 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
 548                 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
 549                 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
 550         }
 551 }
 552
 553 static unsigned mxt_extract_T6_csum(const u8 *csum)
 554 {
 555         return csum[0] | (csum[1] << 8) | (csum[2] << 16);
 556 }
 557
 558 static bool mxt_is_T9_message(struct mxt_data *data, struct mxt_message *msg)
 559 {
 560         u8 id = msg->reportid;
 561         return (id >= data->T9_reportid_min && id <= data->T9_reportid_max);
 562 }
 563
 564 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
 565 {
 566         struct mxt_data *data = dev_id;
 567         struct mxt_message message;
 568         const u8 *payload = &message.message[0];
 569         struct device *dev = &data->client->dev;
 570         u8 reportid;
 571         bool update_input = false;
 572
 573         do {
 574                 if (mxt_read_message(data, &message)) {
 575                         dev_err(dev, "Failed to read message\n");
 576                         goto end;
 577                 }
 578
 579                 reportid = message.reportid;
 580
 581                 if (reportid == data->T6_reportid) {
 582                         u8 status = payload[0];
 583                         unsigned csum = mxt_extract_T6_csum(&payload[1]);
 584                         dev_dbg(dev, "Status: %02x Config Checksum: %06x\n",
 585                                 status, csum);
 586                 } else if (mxt_is_T9_message(data, &message)) {
 587                         int id = reportid - data->T9_reportid_min;
 588                         mxt_input_touchevent(data, &message, id);
 589                         update_input = true;
 590                 } else {
 591                         mxt_dump_message(dev, &message);
 592                 }
 593         } while (reportid != 0xff);
 594
 595         if (update_input) {
 596                 input_mt_report_pointer_emulation(data->input_dev, false);
 597                 input_sync(data->input_dev);
 598         }
 599
 600 end:
 601         return IRQ_HANDLED;
 602 }
 603
 604 static int mxt_check_reg_init(struct mxt_data *data)
 605 {
 606         const struct mxt_platform_data *pdata = data->pdata;
 607         struct mxt_object *object;
 608         struct device *dev = &data->client->dev;
 609         int index = 0;
 610         int i, size;
 611         int ret;
 612
 613         if (!pdata->config) {
 614                 dev_dbg(dev, "No cfg data defined, skipping reg init\n");
 615                 return 0;
 616         }
 617
 618         for (i = 0; i < data->info.object_num; i++) {
 619                 object = data->object_table + i;
 620
 621                 if (!mxt_object_writable(object->type))
 622                         continue;
 623
 624                 size = (object->size + 1) * (object->instances + 1);
 625                 if (index + size > pdata->config_length) {
 626                         dev_err(dev, "Not enough config data!\n");
 627                         return -EINVAL;
 628                 }
 629
 630                 ret = __mxt_write_reg(data->client, object->start_address,
 631                                 size, &pdata->config[index]);
 632                 if (ret)
 633                         return ret;
 634                 index += size;
 635         }
 636
 637         return 0;
 638 }
 639
 640 static int mxt_make_highchg(struct mxt_data *data)
 641 {
 642         struct device *dev = &data->client->dev;
 643         struct mxt_message message;
 644         int count = 10;
 645         int error;
 646
 647         /* Read dummy message to make high CHG pin */
 648         do {
 649                 error = mxt_read_message(data, &message);
 650                 if (error)
 651                         return error;
 652         } while (message.reportid != 0xff && --count);
 653
 654         if (!count) {
 655                 dev_err(dev, "CHG pin isn't cleared\n");
 656                 return -EBUSY;
 657         }
 658
 659         return 0;
 660 }
 661
 662 static void mxt_handle_pdata(struct mxt_data *data)
 663 {
 664         const struct mxt_platform_data *pdata = data->pdata;
 665         u8 voltage;
 666
 667         /* Set touchscreen lines */
 668         mxt_write_object(data, MXT_TOUCH_MULTI_T9, MXT_TOUCH_XSIZE,
 669                         pdata->x_line);
 670         mxt_write_object(data, MXT_TOUCH_MULTI_T9, MXT_TOUCH_YSIZE,
 671                         pdata->y_line);
 672
 673         /* Set touchscreen orient */
 674         mxt_write_object(data, MXT_TOUCH_MULTI_T9, MXT_TOUCH_ORIENT,
 675                         pdata->orient);
 676
 677         /* Set touchscreen burst length */
 678         mxt_write_object(data, MXT_TOUCH_MULTI_T9,
 679                         MXT_TOUCH_BLEN, pdata->blen);
 680
 681         /* Set touchscreen threshold */
 682         mxt_write_object(data, MXT_TOUCH_MULTI_T9,
 683                         MXT_TOUCH_TCHTHR, pdata->threshold);
 684
 685         /* Set touchscreen resolution */
 686         mxt_write_object(data, MXT_TOUCH_MULTI_T9,
 687                         MXT_TOUCH_XRANGE_LSB, (pdata->x_size - 1) & 0xff);
 688         mxt_write_object(data, MXT_TOUCH_MULTI_T9,
 689                         MXT_TOUCH_XRANGE_MSB, (pdata->x_size - 1) >> 8);
 690         mxt_write_object(data, MXT_TOUCH_MULTI_T9,
 691                         MXT_TOUCH_YRANGE_LSB, (pdata->y_size - 1) & 0xff);
 692         mxt_write_object(data, MXT_TOUCH_MULTI_T9,
 693                         MXT_TOUCH_YRANGE_MSB, (pdata->y_size - 1) >> 8);
 694
 695         /* Set touchscreen voltage */
 696         if (pdata->voltage) {
 697                 if (pdata->voltage < MXT_VOLTAGE_DEFAULT) {
 698                         voltage = (MXT_VOLTAGE_DEFAULT - pdata->voltage) /
 699                                 MXT_VOLTAGE_STEP;
 700                         voltage = 0xff - voltage + 1;
 701                 } else
 702                         voltage = (pdata->voltage - MXT_VOLTAGE_DEFAULT) /
 703                                 MXT_VOLTAGE_STEP;
 704
 705                 mxt_write_object(data, MXT_SPT_CTECONFIG_T28,
 706                                 MXT_CTE_VOLTAGE, voltage);
 707         }
 708 }
 709
 710 static int mxt_get_info(struct mxt_data *data)
 711 {
 712         struct i2c_client *client = data->client;
 713         struct mxt_info *info = &data->info;
 714         int error;
 715
 716         /* Read 7-byte info block starting at address 0 */
 717         error = __mxt_read_reg(client, MXT_INFO, sizeof(*info), info);
 718         if (error)
 719                 return error;
 720
 721         return 0;
 722 }
 723
 724 static int mxt_get_object_table(struct mxt_data *data)
 725 {
 726         struct i2c_client *client = data->client;
 727         size_t table_size;
 728         int error;
 729         int i;
 730         u8 reportid;
 731
 732         table_size = data->info.object_num * sizeof(struct mxt_object);
 733         error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
 734                         data->object_table);
 735         if (error)
 736                 return error;
 737
 738         /* Valid Report IDs start counting from 1 */
 739         reportid = 1;
 740         for (i = 0; i < data->info.object_num; i++) {
 741                 struct mxt_object *object = data->object_table + i;
 742                 u8 min_id, max_id;
 743
 744                 le16_to_cpus(&object->start_address);
 745
 746                 if (object->num_report_ids) {
 747                         min_id = reportid;
 748                         reportid += object->num_report_ids *
 749                                         (object->instances + 1);
 750                         max_id = reportid - 1;
 751                 } else {
 752                         min_id = 0;
 753                         max_id = 0;
 754                 }
 755
 756                 dev_dbg(&data->client->dev,
 757                         "Type %2d Start %3d Size %3d Instances %2d ReportIDs %3u : %3u\n",
 758                         object->type, object->start_address, object->size + 1,
 759                         object->instances + 1, min_id, max_id);
 760
 761                 switch (object->type) {
 762                 case MXT_GEN_COMMAND_T6:
 763                         data->T6_reportid = min_id;
 764                         break;
 765                 case MXT_TOUCH_MULTI_T9:
 766                         data->T9_reportid_min = min_id;
 767                         data->T9_reportid_max = max_id;
 768                         break;
 769                 }
 770         }
 771
 772         return 0;
 773 }
 774
 775 static void mxt_free_object_table(struct mxt_data *data)
 776 {
 777         kfree(data->object_table);
 778         data->object_table = NULL;
 779         data->T6_reportid = 0;
 780         data->T9_reportid_min = 0;
 781         data->T9_reportid_max = 0;
 782
 783 }
 784
 785 static int mxt_initialize(struct mxt_data *data)
 786 {
 787         struct i2c_client *client = data->client;
 788         struct mxt_info *info = &data->info;
 789         int error;
 790         u8 val;
 791
 792         error = mxt_get_info(data);
 793         if (error)
 794                 return error;
 795
 796         data->object_table = kcalloc(info->object_num,
 797                                      sizeof(struct mxt_object),
 798                                      GFP_KERNEL);
 799         if (!data->object_table) {
 800                 dev_err(&client->dev, "Failed to allocate memory\n");
 801                 return -ENOMEM;
 802         }
 803
 804         /* Get object table information */
 805         error = mxt_get_object_table(data);
 806         if (error)
 807                 goto err_free_object_table;
 808
 809         /* Check register init values */
 810         error = mxt_check_reg_init(data);
 811         if (error)
 812                 goto err_free_object_table;
 813
 814         mxt_handle_pdata(data);
 815
 816         /* Backup to memory */
 817         mxt_write_object(data, MXT_GEN_COMMAND_T6,
 818                         MXT_COMMAND_BACKUPNV,
 819                         MXT_BACKUP_VALUE);
 820         msleep(MXT_BACKUP_TIME);
 821
 822         /* Soft reset */
 823         mxt_write_object(data, MXT_GEN_COMMAND_T6,
 824                         MXT_COMMAND_RESET, 1);
 825         msleep(MXT_RESET_TIME);
 826
 827         /* Update matrix size at info struct */
 828         error = mxt_read_reg(client, MXT_MATRIX_X_SIZE, &val);
 829         if (error)
 830                 goto err_free_object_table;
 831         info->matrix_xsize = val;
 832
 833         error = mxt_read_reg(client, MXT_MATRIX_Y_SIZE, &val);
 834         if (error)
 835                 goto err_free_object_table;
 836         info->matrix_ysize = val;
 837
 838         dev_info(&client->dev,
 839                         "Family ID: %u Variant ID: %u Major.Minor.Build: %u.%u.%02X\n",
 840                         info->family_id, info->variant_id, info->version >> 4,
 841                         info->version & 0xf, info->build);
 842
 843         dev_info(&client->dev,
 844                         "Matrix X Size: %u Matrix Y Size: %u Object Num: %u\n",
 845                         info->matrix_xsize, info->matrix_ysize,
 846                         info->object_num);
 847
 848         return 0;
 849
 850 err_free_object_table:
 851         mxt_free_object_table(data);
 852         return error;
 853 }
 854
 855 static void mxt_calc_resolution(struct mxt_data *data)
 856 {
 857         unsigned int max_x = data->pdata->x_size - 1;
 858         unsigned int max_y = data->pdata->y_size - 1;
 859
 860         if (data->pdata->orient & MXT_XY_SWITCH) {
 861                 data->max_x = max_y;
 862                 data->max_y = max_x;
 863         } else {
 864                 data->max_x = max_x;
 865                 data->max_y = max_y;
 866         }
 867 }
 868
 869 /* Firmware Version is returned as Major.Minor.Build */
 870 static ssize_t mxt_fw_version_show(struct device *dev,
 871                                    struct device_attribute *attr, char *buf)
 872 {
 873         struct mxt_data *data = dev_get_drvdata(dev);
 874         struct mxt_info *info = &data->info;
 875         return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
 876                          info->version >> 4, info->version & 0xf, info->build);
 877 }
 878
 879 /* Hardware Version is returned as FamilyID.VariantID */
 880 static ssize_t mxt_hw_version_show(struct device *dev,
 881                                    struct device_attribute *attr, char *buf)
 882 {
 883         struct mxt_data *data = dev_get_drvdata(dev);
 884         struct mxt_info *info = &data->info;
 885         return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
 886                          info->family_id, info->variant_id);
 887 }
 888
 889 static ssize_t mxt_show_instance(char *buf, int count,
 890                                  struct mxt_object *object, int instance,
 891                                  const u8 *val)
 892 {
 893         int i;
 894
 895         if (object->instances > 0)
 896                 count += scnprintf(buf + count, PAGE_SIZE - count,
 897                                    "Instance %u\n", instance);
 898
 899         for (i = 0; i < object->size + 1; i++)
 900                 count += scnprintf(buf + count, PAGE_SIZE - count,
 901                                 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
 902         count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
 903
 904         return count;
 905 }
 906
 907 static ssize_t mxt_object_show(struct device *dev,
 908                                     struct device_attribute *attr, char *buf)
 909 {
 910         struct mxt_data *data = dev_get_drvdata(dev);
 911         struct mxt_object *object;
 912         int count = 0;
 913         int i, j;
 914         int error;
 915         u8 *obuf;
 916
 917         /* Pre-allocate buffer large enough to hold max sized object. */
 918         obuf = kmalloc(256, GFP_KERNEL);
 919         if (!obuf)
 920                 return -ENOMEM;
 921
 922         error = 0;
 923         for (i = 0; i < data->info.object_num; i++) {
 924                 object = data->object_table + i;
 925
 926                 if (!mxt_object_readable(object->type))
 927                         continue;
 928
 929                 count += scnprintf(buf + count, PAGE_SIZE - count,
 930                                 "T%u:\n", object->type);
 931
 932                 for (j = 0; j < object->instances + 1; j++) {
 933                         u16 size = object->size + 1;
 934                         u16 addr = object->start_address + j * size;
 935
 936                         error = __mxt_read_reg(data->client, addr, size, obuf);
 937                         if (error)
 938                                 goto done;
 939
 940                         count = mxt_show_instance(buf, count, object, j, obuf);
 941                 }
 942         }
 943
 944 done:
 945         kfree(obuf);
 946         return error ?: count;
 947 }
 948
 949 static int mxt_load_fw(struct device *dev, const char *fn)
 950 {
 951         struct mxt_data *data = dev_get_drvdata(dev);
 952         struct i2c_client *client = data->client;
 953         const struct firmware *fw = NULL;
 954         unsigned int frame_size;
 955         unsigned int pos = 0;
 956         int ret;
 957
 958         ret = request_firmware(&fw, fn, dev);
 959         if (ret) {
 960                 dev_err(dev, "Unable to open firmware %s\n", fn);
 961                 return ret;
 962         }
 963
 964         /* Change to the bootloader mode */
 965         mxt_write_object(data, MXT_GEN_COMMAND_T6,
 966                         MXT_COMMAND_RESET, MXT_BOOT_VALUE);
 967         msleep(MXT_RESET_TIME);
 968
 969         /* Change to slave address of bootloader */
 970         if (client->addr == MXT_APP_LOW)
 971                 client->addr = MXT_BOOT_LOW;
 972         else
 973                 client->addr = MXT_BOOT_HIGH;
 974
 975         ret = mxt_check_bootloader(client, MXT_WAITING_BOOTLOAD_CMD);
 976         if (ret)
 977                 goto out;
 978
 979         /* Unlock bootloader */
 980         mxt_unlock_bootloader(client);
 981
 982         while (pos < fw->size) {
 983                 ret = mxt_check_bootloader(client,
 984                                                 MXT_WAITING_FRAME_DATA);
 985                 if (ret)
 986                         goto out;
 987
 988                 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
 989
 990                 /* We should add 2 at frame size as the the firmware data is not
 991                  * included the CRC bytes.
 992                  */
 993                 frame_size += 2;
 994
 995                 /* Write one frame to device */
 996                 mxt_fw_write(client, fw->data + pos, frame_size);
 997
 998                 ret = mxt_check_bootloader(client,
 999                                                 MXT_FRAME_CRC_PASS);
1000                 if (ret)
1001                         goto out;
1002
1003                 pos += frame_size;
1004
1005                 dev_dbg(dev, "Updated %d bytes / %zd bytes\n", pos, fw->size);
1006         }
1007
1008 out:
1009         release_firmware(fw);
1010
1011         /* Change to slave address of application */
1012         if (client->addr == MXT_BOOT_LOW)
1013                 client->addr = MXT_APP_LOW;
1014         else
1015                 client->addr = MXT_APP_HIGH;
1016
1017         return ret;
1018 }
1019
1020 static ssize_t mxt_update_fw_store(struct device *dev,
1021                                         struct device_attribute *attr,
1022                                         const char *buf, size_t count)
1023 {
1024         struct mxt_data *data = dev_get_drvdata(dev);
1025         int error;
1026
1027         disable_irq(data->irq);
1028
1029         error = mxt_load_fw(dev, MXT_FW_NAME);
1030         if (error) {
1031                 dev_err(dev, "The firmware update failed(%d)\n", error);
1032                 count = error;
1033         } else {
1034                 dev_dbg(dev, "The firmware update succeeded\n");
1035
1036                 /* Wait for reset */
1037                 msleep(MXT_FWRESET_TIME);
1038
1039                 mxt_free_object_table(data);
1040
1041                 mxt_initialize(data);
1042         }
1043
1044         enable_irq(data->irq);
1045
1046         error = mxt_make_highchg(data);
1047         if (error)
1048                 return error;
1049
1050         return count;
1051 }
1052
1053 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
1054 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
1055 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
1056 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
1057
1058 static struct attribute *mxt_attrs[] = {
1059         &dev_attr_fw_version.attr,
1060         &dev_attr_hw_version.attr,
1061         &dev_attr_object.attr,
1062         &dev_attr_update_fw.attr,
1063         NULL
1064 };
1065
1066 static const struct attribute_group mxt_attr_group = {
1067         .attrs = mxt_attrs,
1068 };
1069
1070 static void mxt_start(struct mxt_data *data)
1071 {
1072         /* Touch enable */
1073         mxt_write_object(data,
1074                         MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0x83);
1075 }
1076
1077 static void mxt_stop(struct mxt_data *data)
1078 {
1079         /* Touch disable */
1080         mxt_write_object(data,
1081                         MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0);
1082 }
1083
1084 static int mxt_input_open(struct input_dev *dev)
1085 {
1086         struct mxt_data *data = input_get_drvdata(dev);
1087
1088         mxt_start(data);
1089
1090         return 0;
1091 }
1092
1093 static void mxt_input_close(struct input_dev *dev)
1094 {
1095         struct mxt_data *data = input_get_drvdata(dev);
1096
1097         mxt_stop(data);
1098 }
1099
1100 static int __devinit mxt_probe(struct i2c_client *client,
1101                 const struct i2c_device_id *id)
1102 {
1103         const struct mxt_platform_data *pdata = client->dev.platform_data;
1104         struct mxt_data *data;
1105         struct input_dev *input_dev;
1106         int error;
1107         unsigned int num_mt_slots;
1108
1109         if (!pdata)
1110                 return -EINVAL;
1111
1112         data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
1113         input_dev = input_allocate_device();
1114         if (!data || !input_dev) {
1115                 dev_err(&client->dev, "Failed to allocate memory\n");
1116                 error = -ENOMEM;
1117                 goto err_free_mem;
1118         }
1119
1120         input_dev->name = "Atmel maXTouch Touchscreen";
1121         snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
1122                  client->adapter->nr, client->addr);
1123         input_dev->phys = data->phys;
1124
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;
1129
1130         data->client = client;
1131         data->input_dev = input_dev;
1132         data->pdata = pdata;
1133         data->irq = client->irq;
1134
1135         mxt_calc_resolution(data);
1136
1137         error = mxt_initialize(data);
1138         if (error)
1139                 goto err_free_mem;
1140
1141         __set_bit(EV_ABS, input_dev->evbit);
1142         __set_bit(EV_KEY, input_dev->evbit);
1143         __set_bit(BTN_TOUCH, input_dev->keybit);
1144
1145         /* For single touch */
1146         input_set_abs_params(input_dev, ABS_X,
1147                              0, data->max_x, 0, 0);
1148         input_set_abs_params(input_dev, ABS_Y,
1149                              0, data->max_y, 0, 0);
1150         input_set_abs_params(input_dev, ABS_PRESSURE,
1151                              0, 255, 0, 0);
1152
1153         /* For multi touch */
1154         num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1155         error = input_mt_init_slots(input_dev, num_mt_slots);
1156         if (error)
1157                 goto err_free_object;
1158         input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1159                              0, MXT_MAX_AREA, 0, 0);
1160         input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1161                              0, data->max_x, 0, 0);
1162         input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1163                              0, data->max_y, 0, 0);
1164         input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1165                              0, 255, 0, 0);
1166
1167         input_set_drvdata(input_dev, data);
1168         i2c_set_clientdata(client, data);
1169
1170         error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
1171                                      pdata->irqflags | IRQF_ONESHOT,
1172                                      client->name, data);
1173         if (error) {
1174                 dev_err(&client->dev, "Failed to register interrupt\n");
1175                 goto err_free_object;
1176         }
1177
1178         error = mxt_make_highchg(data);
1179         if (error)
1180                 goto err_free_irq;
1181
1182         error = input_register_device(input_dev);
1183         if (error)
1184                 goto err_free_irq;
1185
1186         error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
1187         if (error)
1188                 goto err_unregister_device;
1189
1190         return 0;
1191
1192 err_unregister_device:
1193         input_unregister_device(input_dev);
1194         input_dev = NULL;
1195 err_free_irq:
1196         free_irq(client->irq, data);
1197 err_free_object:
1198         kfree(data->object_table);
1199 err_free_mem:
1200         input_free_device(input_dev);
1201         kfree(data);
1202         return error;
1203 }
1204
1205 static int __devexit mxt_remove(struct i2c_client *client)
1206 {
1207         struct mxt_data *data = i2c_get_clientdata(client);
1208
1209         sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
1210         free_irq(data->irq, data);
1211         input_unregister_device(data->input_dev);
1212         kfree(data->object_table);
1213         kfree(data);
1214
1215         return 0;
1216 }
1217
1218 #ifdef CONFIG_PM_SLEEP
1219 static int mxt_suspend(struct device *dev)
1220 {
1221         struct i2c_client *client = to_i2c_client(dev);
1222         struct mxt_data *data = i2c_get_clientdata(client);
1223         struct input_dev *input_dev = data->input_dev;
1224
1225         mutex_lock(&input_dev->mutex);
1226
1227         if (input_dev->users)
1228                 mxt_stop(data);
1229
1230         mutex_unlock(&input_dev->mutex);
1231
1232         return 0;
1233 }
1234
1235 static int mxt_resume(struct device *dev)
1236 {
1237         struct i2c_client *client = to_i2c_client(dev);
1238         struct mxt_data *data = i2c_get_clientdata(client);
1239         struct input_dev *input_dev = data->input_dev;
1240
1241         /* Soft reset */
1242         mxt_write_object(data, MXT_GEN_COMMAND_T6,
1243                         MXT_COMMAND_RESET, 1);
1244
1245         msleep(MXT_RESET_TIME);
1246
1247         mutex_lock(&input_dev->mutex);
1248
1249         if (input_dev->users)
1250                 mxt_start(data);
1251
1252         mutex_unlock(&input_dev->mutex);
1253
1254         return 0;
1255 }
1256 #endif
1257
1258 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
1259
1260 static const struct i2c_device_id mxt_id[] = {
1261         { "qt602240_ts", 0 },
1262         { "atmel_mxt_ts", 0 },
1263         { "mXT224", 0 },
1264         { }
1265 };
1266 MODULE_DEVICE_TABLE(i2c, mxt_id);
1267
1268 static struct i2c_driver mxt_driver = {
1269         .driver = {
1270                 .name   = "atmel_mxt_ts",
1271                 .owner  = THIS_MODULE,
1272                 .pm     = &mxt_pm_ops,
1273         },
1274         .probe          = mxt_probe,
1275         .remove         = __devexit_p(mxt_remove),
1276         .id_table       = mxt_id,
1277 };
1278
1279 module_i2c_driver(mxt_driver);
1280
1281 /* Module information */
1282 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
1283 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
1284 MODULE_LICENSE("GPL");